Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove deprecated method for pulling AnsibleTower host facts #329

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 8 additions & 63 deletions broker/providers/ansible_tower.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@
from broker.providers import Provider


def convert_psuedonamespaces(attr_dict):
def convert_pseudonamespaces(attr_dict):
tpapaioa marked this conversation as resolved.
Show resolved Hide resolved
"""Recursively convert PsuedoNamespace objects into dictionaries."""
out_dict = {}
for key, value in attr_dict.items():
if isinstance(value, awxkit.utils.PseudoNamespace):
out_dict[key] = dict(value)
elif isinstance(value, dict):
out_dict[key] = convert_psuedonamespaces(value)
out_dict[key] = convert_pseudonamespaces(value)
else:
out_dict[key] = value
return out_dict
Expand Down Expand Up @@ -216,11 +216,11 @@ def _set_attributes(self, host_inst, broker_args=None, misc_attrs=None):
"release": self._host_release,
"_prov_inst": self,
"_broker_provider": "AnsibleTower",
"_broker_args": convert_psuedonamespaces(broker_args),
"_broker_args": convert_pseudonamespaces(broker_args),
}
)
if isinstance(misc_attrs, dict):
host_inst.__dict__.update(convert_psuedonamespaces(misc_attrs))
host_inst.__dict__.update(convert_pseudonamespaces(misc_attrs))

def _translate_inventory(self, inventory):
if isinstance(inventory, int): # already an id, silly
Expand Down Expand Up @@ -390,9 +390,7 @@ def _compile_host_info(self, host):
)

# Get broker_args from host facts if present
broker_args = getattr(host_facts, "_broker_args", None) or self._get_broker_args_from_job(
host
)
broker_args = getattr(host_facts, "_broker_args", {})

host_info = {
"name": host.name,
Expand All @@ -417,35 +415,9 @@ def _compile_host_info(self, host):

return host_info

def _get_broker_args_from_job(self, host):
"""Get _broker_args from the source workflow job or last job."""
_broker_args = {}

try:
create_job = self._v2.jobs.get(id=host.get_related("job_events").results[0].job)
create_job = create_job.results[0].get_related("source_workflow_job")
_broker_args["workflow"] = create_job.name
# Unknown is a Gateway Timeout
except (IndexError, awxkit.exceptions.Unknown, awxkit.exceptions.Forbidden):
if "last_job" in host.related:
# potentially not create job, but easier processing below
create_job = host.get_related("last_job")
try:
_broker_args["workflow"] = create_job.summary_fields.source_workflow_job.name
except Exception as err: # noqa: BLE001
logger.debug(f"Tell Jake that the exception here is: {err}!")
logger.warning(f"Unable to determine workflow for {host.name}")
else:
return _broker_args
create_vars = json.loads(create_job.extra_vars)
_broker_args.update(
{arg: val for arg, val in create_vars.items() if val and isinstance(val, str)}
)
return _broker_args

@staticmethod
def _pull_extra_vars(extra_vars):
"""Pull extra vars from a json string or psuedo-dictionary."""
"""Pull extra vars from a json string or pseudo-dictionary."""
if not extra_vars:
return {}
try:
Expand Down Expand Up @@ -531,7 +503,7 @@ def _get_fields_from_facts(facts):
job = provider_params
artifacts = self._merge_artifacts(job, strategy=strategy)

# Use new host fact based method, if available
# Get host facts from job artifacts
if "_broker_args" in artifacts and "_broker_facts" in artifacts:
broker_args = {k: v for k, v in artifacts._broker_args.items() if v}
broker_facts = {k: v for k, v in artifacts._broker_facts.items() if v}
Expand All @@ -548,36 +520,9 @@ def _get_fields_from_facts(facts):
)
broker_facts["name"] = name
broker_facts["hostname"] = hostname

# Fallback to old method
else:
# Get initial extra vars passed to workflow
job_extra_vars = self._pull_extra_vars(job.extra_vars)

# Update with resolved values stored on job
for key in job_extra_vars:
job_extra_vars[key] = artifacts.get(key)

# Add all non-empty workflow variables and job artifacts
broker_args.update({key: val for key, val in job_extra_vars.items() if val})
broker_args.update({key: val for key, val in artifacts.items() if val})

# Get inventory name
broker_args["tower_inventory"] = broker_facts.pop(
"tower_inventory", self._translate_inventory(job.summary_fields.inventory)
)
artifacts = helpers.flatten_dict(artifacts)
logger.debug(artifacts)

# Get hostname, VM name, and host type
hostname, name, host_type = _get_fields_from_facts(artifacts)
if not hostname:
logger.warning(f"No hostname found in job artifacts:\n{artifacts}")
logger.debug(f"hostname: {hostname}, name: {name}, host type: {host_type}")
logger.debug(f"Host facts not found in artifacts for job: {job}")

host_inst = host_classes[host_type](
**{**broker_args, "hostname": hostname, "name": name}
)
else:
host_inst = host_classes[kwargs.get("type")](**broker_args)

Expand Down
28 changes: 17 additions & 11 deletions tests/data/ansible_tower/fake_jobs.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,24 @@
"name": "deploy-set-stats-for-jenkins",
"artifacts": {
"provider": "rhv",
"reported_devices": {
"nics": [
"lo",
"eth0"
]
"_broker_args": {
"host_type": "host"
},
"host_type": "host",
"os_distribution_version": "7.8",
"fqdn": "fake.host.test.com",
"template": "",
"os_distribution": "RedHat",
"name": "fake-physical-host"
"_broker_facts": {
"fqdn": "fake.host.test.com",
"name": [
"fake-physical-host"
],
"os_distribution": "RedHat",
"os_distribution_version": "9.4",
"reported_devices": {
"nics": [
"lo",
"eth0"
]
},
"template": ""
}
}
}
]
2 changes: 1 addition & 1 deletion tests/providers/test_ansible_tower.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ def test_host_creation(tower_stub):
host = tower_stub.construct_host(job, bx.host_classes)
assert isinstance(host, bx.host_classes["host"])
assert host.hostname == "fake.host.test.com"
assert host._broker_args["os_distribution_version"] == "7.8"
assert host.os_distribution_version == "9.4"


def test_workflow_lookup_failure(tower_stub):
Expand Down