External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-02-28 00:08:44 -03:30
Code Issues Packages Projects Releases Wiki Activity

Factor out the response handling boilerplate from HostInsights.get_insights

Browse Source 
We'll want to reuse it for the API call to /hosts as well.
This commit is contained in:
Jeff Bradberry
2019-03-18 16:37:48 -04:00
parent 8fdc53cb21
commit 95b17892ee
2 changed files with 38 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
awx/api/views/__init__.py
View File

@@ -1635,49 +1635,72 @@ class HostInsights(GenericAPIView):
} }
return session.get(url, headers=headers, timeout=120) return session.get(url, headers=headers, timeout=120)
def get_insights(self, url, username, password): def _call_insights_api(self, url, username, password):
try: try:
res = self._get_insights(url, username, password) res = self._get_insights(url, username, password)
except requests.exceptions.SSLError: except requests.exceptions.SSLError:
return (dict(error=_('SSLError while trying to connect to {}').format(url)), status.HTTP_502_BAD_GATEWAY) return (dict(error=_('SSLError while trying to connect to {}').format(url)),
status.HTTP_502_BAD_GATEWAY)
except requests.exceptions.Timeout: except requests.exceptions.Timeout:
return (dict(error=_('Request to {} timed out.').format(url)), status.HTTP_504_GATEWAY_TIMEOUT) return (dict(error=_('Request to {} timed out.').format(url)),
status.HTTP_504_GATEWAY_TIMEOUT)
except requests.exceptions.RequestException as e: except requests.exceptions.RequestException as e:
return (dict(error=_('Unknown exception {} while trying to GET {}').format(e, url)), status.HTTP_502_BAD_GATEWAY) return (dict(error=_('Unknown exception {} while trying to GET {}').format(e, url)),
status.HTTP_502_BAD_GATEWAY)
if res.status_code == 401: if res.status_code == 401:
return (dict(error=_('Unauthorized access. Please check your Insights Credential username and password.')), status.HTTP_502_BAD_GATEWAY) msg = _('Unauthorized access. Please check your Insights Credential username and password.')
return (dict(error=msg), status.HTTP_502_BAD_GATEWAY)
elif res.status_code != 200: elif res.status_code != 200:
return (dict(error=_( msg = _(
'Failed to gather reports and maintenance plans from Insights API at URL {}. Server responded with {} status code and message {}' 'Failed to access the Insights API at URL {}.'
).format(url, res.status_code, res.content)), status.HTTP_502_BAD_GATEWAY) ' Server responded with {} status code and message {}'
).format(url, res.status_code, res.content)
return (dict(error=msg), status.HTTP_502_BAD_GATEWAY)
try: try:
filtered_insights_content = filter_insights_api_response(res.json()) res.json()
return (dict(insights_content=filtered_insights_content), status.HTTP_200_OK)
except ValueError: except ValueError:
return (dict(error=_('Expected JSON response from Insights but instead got {}').format(res.content)), status.HTTP_502_BAD_GATEWAY) return (dict(error=_('Expected JSON response from Insights but instead got {}').format(res.content)),
status.HTTP_502_BAD_GATEWAY)
return res
def get_insights(self, url, username, password):
res = self._call_insights_api(url, username, password)
if isinstance(res, tuple): # This value was constructed based on a bad response from the API.
return res
filtered_insights_content = filter_insights_api_response(res.json())
return (dict(insights_content=filtered_insights_content), status.HTTP_200_OK)
def get(self, request, *args, **kwargs): def get(self, request, *args, **kwargs):
host = self.get_object() host = self.get_object()
cred = None cred = None
if host.insights_system_id is None: if host.insights_system_id is None:
return Response(dict(error=_('This host is not recognized as an Insights host.')), status=status.HTTP_404_NOT_FOUND) return Response(
dict(error=_('This host is not recognized as an Insights host.')),
status=status.HTTP_404_NOT_FOUND
)
if host.inventory and host.inventory.insights_credential: if host.inventory and host.inventory.insights_credential:
cred = host.inventory.insights_credential cred = host.inventory.insights_credential
else: else:
return Response(dict(error=_('The Insights Credential for "{}" was not found.').format(host.inventory.name)), status=status.HTTP_404_NOT_FOUND) return Response(
dict(error=_('The Insights Credential for "{}" was not found.').format(host.inventory.name)),
status=status.HTTP_404_NOT_FOUND
)
# FIXME: I know that this isn't correct, we need to do an # FIXME: I know that this isn't correct, we need to do an
# additional API call to /hosts to find what the Platform ID # additional API call to /hosts to find what the Platform ID
# is for this host based on its Insights system ID. # is for this host based on its Insights system ID.
platform_id = host.insights_system_id platform_id = host.insights_system_id
(username, password) = self._extract_insights_creds(cred)
url = '{}/r/insights/platform/advisor/v1/system/{}/reports/'.format( url = '{}/r/insights/platform/advisor/v1/system/{}/reports/'.format(
settings.INSIGHTS_URL_BASE, platform_id) settings.INSIGHTS_URL_BASE, platform_id)
(username, password) = self._extract_insights_creds(cred)
(msg, err_code) = self.get_insights(url, username, password) (msg, err_code) = self.get_insights(url, username, password)
return Response(msg, status=err_code) return Response(msg, status=err_code)

2
awx/main/tests/unit/api/test_views.py
View File

@@ -148,7 +148,7 @@ class TestHostInsights():
(msg, code) = view.get_insights('https://myexample.com/whocares/me/', 'ignore', 'ignore') (msg, code) = view.get_insights('https://myexample.com/whocares/me/', 'ignore', 'ignore')
assert msg['error'] == ( assert msg['error'] == (
'Failed to gather reports and maintenance plans from Insights API at URL' 'Failed to access the Insights API at URL'
' https://myexample.com/whocares/me/. Server responded with 500 status code ' ' https://myexample.com/whocares/me/. Server responded with 500 status code '
'and message mock 500 err msg') 'and message mock 500 err msg')