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.

Sign up for GitHub

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

Fix licensing client error logging #329

Merged
merged 2 commits into from
Jul 17, 2024
Merged

Fix licensing client error logging #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47bce28
licensing: Fix error log when deleting reservation
Cristi1324 Jul 16, 2024
6160f71
Edit unit tests for `coriolis.licensing.client`
Cristi1324 Jul 17, 2024
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
36 changes: 19 additions & 17 deletions coriolis/licensing/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@ def _get_url_for_appliance_resource(self, resource):
return "%s/appliances/%s/%s" % (
self._base_url, self._appliance_id, resource.strip('/'))

def _raise_response_error(self, resp):
error = None
try:
error = resp.json().get('error', {})
except (Exception, KeyboardInterrupt):
LOG.debug(
"Exception occured during error extraction from licensing "
"response: '%s'\nException:\n%s",
resp.text, utils.get_exception_details())
if error and all([x in error for x in ['code', 'message']]):
raise exception.Conflict(
message=error['message'],
code=int(error['code']))
else:
resp.raise_for_status()

@utils.retry_on_error()
def _do_req(
self, method_name, resource, body=None,
Expand Down Expand Up @@ -98,21 +114,7 @@ def _do_req(
return resp

if not resp.ok:
# try to extract error from licensing server:
error = None
try:
error = resp.json().get('error', {})
except (Exception, KeyboardInterrupt):
LOG.debug(
"Exception occured during error extraction from licensing "
"response: '%s'\nException:\n%s",
resp.text, utils.get_exception_details())
if error and all([x in error for x in ['code', 'message']]):
raise exception.Conflict(
message=error['message'],
code=int(error['code']))
else:
resp.raise_for_status()
self._raise_response_error(resp)

resp_data = resp.json()
if response_key:
Expand Down Expand Up @@ -221,8 +223,8 @@ def delete_reservation(self, reservation_id, raise_on_404=False):
if not resp.ok:
if resp.status_code == 404:
if raise_on_404:
resp.raise_for_status()
self._raise_response_error(resp)
LOG.warn(
"Got 404 when deleting reservation '%s'", reservation_id)
else:
resp.raise_for_status()
self._raise_response_error(resp)
185 changes: 137 additions & 48 deletions coriolis/tests/licensing/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import os
from unittest import mock

from coriolis import exception
from coriolis.licensing import client as licensing_module
from coriolis.tests import test_base
from coriolis.tests import testutils
Expand All @@ -21,6 +22,7 @@ def setUp(self):
self.body = {'test_key': 'test_value'}
self.reservation_id = "reservation_id"
self.client._appliance_id = "appliance_id"
licensing_module.CONF = mock.Mock()

# Helper function to setup a mock response
def setup_mock_response(self, mock_request, ok=True,
Expand Down Expand Up @@ -67,7 +69,7 @@ def test_from_env_multiple_appliances(self, mock_get_appliances):
{"id": "appliance_id1"}, {"id": "appliance_id2"}
]

self.assertRaises(licensing_module.exception.CoriolisException,
self.assertRaises(exception.CoriolisException,
licensing_module.LicensingClient.from_env)

@mock.patch.object(licensing_module.LicensingClient, 'get_appliances')
Expand Down Expand Up @@ -100,9 +102,53 @@ def test__get_url_for_appliance_resource(self):
"https://10.7.2.3:37667/v1/appliances/appliance_id/licences"
)

def test_raise_response_error(self):
mock_response = mock.Mock()
mock_response.json.return_value = {'test_key': 'test_value'}

self.client._raise_response_error(mock_response)

mock_response.raise_for_status.assert_called_once()

def test_raise_response_error_conflict(self):
mock_response = mock.Mock()
mock_response.json.return_value = {
'error': {'code': 409, 'message': 'test_message'}}

self.assertRaises(
exception.Conflict,
self.client._raise_response_error,
mock_response
)

mock_response.raise_for_status.assert_not_called()

def test_raise_response_error_json_exception(self):
mock_response = mock.Mock()
mock_response.json.side_effect = KeyboardInterrupt()

with self.assertLogs('coriolis.licensing.client', level=logging.DEBUG):
self.client._raise_response_error(mock_response)

mock_response.raise_for_status.assert_called_once()

mock_response.reset_mock()
mock_response.json.side_effect = Exception()

with self.assertLogs('coriolis.licensing.client', level=logging.DEBUG):
self.client._raise_response_error(mock_response)

mock_response.raise_for_status.assert_called_once()

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch('requests.post')
def test__do_req(self, mock_post):
mock_respone = self.setup_mock_response(
def test__do_req(
self,
mock_post,
mock_raise_response_error
):
mock_response = self.setup_mock_response(
mock_post, json_return_value={'test_key': 'test_value'})

original_do_req = testutils.get_wrapped_function(self.client._do_req)
Expand All @@ -121,8 +167,8 @@ def test__do_req(self, mock_post):
timeout=licensing_module.CONF.default_requests_timeout,
data=licensing_module.json.dumps(self.body)
)
mock_respone.json.assert_called_once()
mock_respone.raise_for_status.assert_not_called()
mock_response.json.assert_called_once()
mock_raise_response_error.assert_not_called()

def test__do_req_invalid_method(self):
original_do_req = testutils.get_wrapped_function(self.client._do_req)
Expand All @@ -132,8 +178,14 @@ def test__do_req_invalid_method(self):
self.resource
)

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch('requests.get')
def test__do_req_raw_response(self, mock_get):
def test__do_req_raw_response(
self,
mock_get,
mock_raise_response_error
):
mock_response = self.setup_mock_response(mock_get)

original_do_req = testutils.get_wrapped_function(self.client._do_req)
Expand All @@ -149,25 +201,16 @@ def test__do_req_raw_response(self, mock_get):
timeout=licensing_module.CONF.default_requests_timeout
)
mock_response.json.assert_not_called()
mock_response.raise_for_status.assert_not_called()
mock_raise_response_error.assert_not_called()

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch('requests.get')
def test__do_req_res_not_ok_exception_extracting_error(self, mock_get):
self.setup_mock_response(
mock_get, ok=False, status_code=409,
side_effect=KeyboardInterrupt()
)

original_do_req = testutils.get_wrapped_function(self.client._do_req)

with self.assertLogs('coriolis.licensing.client', level=logging.DEBUG):
self.assertRaises(
KeyboardInterrupt,
original_do_req, self.client, 'GET', self.resource
)

@mock.patch('requests.get')
def test__do_req_response_not_ok_with_error(self, mock_get):
def test__do_req_response_not_ok(
self,
mock_get,
mock_raise_response_error
):
mock_response = self.setup_mock_response(
mock_get, ok=False, status_code=409,
json_return_value={
Expand All @@ -176,28 +219,22 @@ def test__do_req_response_not_ok_with_error(self, mock_get):

original_do_req = testutils.get_wrapped_function(self.client._do_req)

self.assertRaises(
licensing_module.exception.Conflict,
original_do_req, self.client, 'GET', self.resource
)
mock_response.json.assert_called_once()
mock_response.raise_for_status.assert_not_called()

@mock.patch('requests.get')
def test_do_req_raise_for_status(self, mock_get):
mock_response = self.setup_mock_response(
mock_get, ok=False, json_return_value={})

original_do_req = testutils.get_wrapped_function(self.client._do_req)

result = original_do_req(self.client, 'GET', self.resource)
self.assertEqual(result, mock_response.json.return_value)

mock_response.json.assert_called()
mock_response.raise_for_status.assert_called_once()
self.assertEqual(
result,
{'error': {'code': 409, 'message': 'test_message'}}
)
mock_raise_response_error.assert_called_once_with(mock_response)

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch('requests.get')
def test__do_req_no_response_key(self, mock_get):
def test__do_req_no_response_key(
self,
mock_get,
mock_raise_response_error
):
mock_response = self.setup_mock_response(
mock_get, json_return_value={'test_key': 'test_value'})

Expand All @@ -209,7 +246,7 @@ def test__do_req_no_response_key(self, mock_get):
)

mock_response.json.assert_called_once()
mock_response.raise_for_status.assert_not_called()
mock_raise_response_error.assert_not_called()

@mock.patch.object(licensing_module.LicensingClient, '_do_req')
def test__get(self, mock_do_req):
Expand Down Expand Up @@ -379,23 +416,75 @@ def test_check_refresh_reservation(self, mock_post):
None, response_key='reservation'
)

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch.object(licensing_module.LicensingClient, '_do_req')
def test_delete_reservation_404_status_code(self, mock_do_req):
def test_delete_reservation_404_status_code(
self,
mock_do_req,
mock_raise_response_error
):
self.setup_mock_response(mock_do_req, ok=False, status_code=404)

with self.assertLogs('coriolis.licensing.client', level=logging.WARN):
self.client.delete_reservation(
self.reservation_id, raise_on_404=False)

mock_do_req.assert_called_once_with(
'delete', '/reservations/%s' % self.reservation_id,
raw_response=True
)
mock_raise_response_error.assert_not_called()

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch.object(licensing_module.LicensingClient, '_do_req')
def test_delete_reservation_404_status_code_raise(
self,
mock_do_req,
mock_raise_response_error
):
mock_response = self.setup_mock_response(
mock_do_req, ok=False, status_code=404)

with self.assertLogs('coriolis.licensing.client', level=logging.WARN):
self.client.delete_reservation(
self.reservation_id, raise_on_404=True)
self.client.delete_reservation(
self.reservation_id, raise_on_404=True)

mock_do_req.assert_called_once_with(
'delete', '/reservations/%s' % self.reservation_id,
raw_response=True
)
mock_response.raise_for_status.assert_called_once()
mock_raise_response_error.assert_called_once_with(mock_response)

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch.object(licensing_module.LicensingClient, '_do_req')
def test_delete_reservation_status_code_raise(
self,
mock_do_req,
mock_raise_response_error
):
mock_response = self.setup_mock_response(
mock_do_req, ok=False, status_code=400)

self.client.delete_reservation(
self.reservation_id, raise_on_404=True)

mock_do_req.assert_called_once_with(
'delete', '/reservations/%s' % self.reservation_id,
raw_response=True
)
mock_raise_response_error.assert_called_once_with(mock_response)

@mock.patch.object(licensing_module.LicensingClient,
'_raise_response_error')
@mock.patch.object(licensing_module.LicensingClient, '_do_req')
def test_delete_reservation(self, mock_do_req):
def test_delete_reservation(
self,
mock_do_req,
mock_raise_response_error
):
mock_response = self.setup_mock_response(
mock_do_req, ok=False, status_code=200)

Expand All @@ -405,4 +494,4 @@ def test_delete_reservation(self, mock_do_req):
'delete', '/reservations/%s' % self.reservation_id,
raw_response=True
)
mock_response.raise_for_status.assert_called_once()
mock_raise_response_error.assert_called_once_with(mock_response)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add a case for delete_reservation where the response if not ok, and the error code is different from 404.

Loading