Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #16822 from edx/tasawer/learner-3165/fix-error-logging-on-program-certificate-error

Browse Source 
update logging in award program certificate task
This commit is contained in:
Tasawer Nawaz
2017-12-11 18:26:16 +05:00
committed by GitHub
parent 02ddf4d321 a6f4f1762b
commit e7ff0230c6
2 changed files with 47 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
openedx/core/djangoapps/programs/tasks/v1/tasks.py
View File

@@ -194,8 +194,14 @@ def award_program_certificates(self, username):
)
except Exception: # pylint: disable=broad-except
# keep trying to award other certs, but retry the whole task to fix any missing entries
LOGGER.exception('Failed to award certificate for program %s to user %s', program_uuid, username)
retry = True
warning_message = 'Failed to award certificate for program {uuid} to user {username}.'.format(
uuid=program_uuid, username=username)
if countdown < MAX_RETRIES:
LOGGER.warning(warning_message)
retry = True
else:
LOGGER.exception("Max retries exceeded. {msg}".format(msg=warning_message))
if retry:
# N.B. This logic assumes that this task is idempotent

43
openedx/core/djangoapps/programs/tasks/v1/tests/test_tasks.py
View File

@@ -255,22 +255,57 @@ class AwardProgramCertificatesTestCase(CatalogIntegrationMixin, CredentialsApiCo
"""
Checks that a single failure to award one of several certificates
does not cause the entire task to fail. Also ensures that
successfully awarded certs are logged as INFO and exceptions
that arise are logged also.
successfully awarded certs are logged as INFO and warning is logged
for failed requests if there are retries available.
"""
mock_get_completed_programs.return_value = [1, 2]
mock_get_certified_programs.side_effect = [[], [2]]
mock_award_program_certificate.side_effect = self._make_side_effect([Exception('boom'), None])
with mock.patch(TASKS_MODULE + '.LOGGER.info') as mock_info, \
mock.patch(TASKS_MODULE + '.LOGGER.exception') as mock_exception:
mock.patch(TASKS_MODULE + '.LOGGER.warning') as mock_warning:
tasks.award_program_certificates.delay(self.student.username).get()
self.assertEqual(mock_award_program_certificate.call_count, 3)
mock_exception.assert_called_once_with(mock.ANY, 1, self.student.username)
mock_warning.assert_called_once_with(
'Failed to award certificate for program {uuid} to user {username}.'.format(
uuid=1,
username=self.student.username)
)
mock_info.assert_any_call(mock.ANY, 1, self.student.username)
mock_info.assert_any_call(mock.ANY, 2, self.student.username)
@mock.patch(TASKS_MODULE + '.MAX_RETRIES', 0)
def test_retries_exceeded(
self,
mock_get_completed_programs,
mock_get_certified_programs,
mock_award_program_certificate,
):
"""
Checks that a single failure to award one of several certificates
does not cause the entire task to fail. Also ensures that
successfully awarded certs are logged as INFO and exception is logged
for failed requests if retires are exceeded.
"""
mock_get_completed_programs.return_value = [1, 2]
mock_get_certified_programs.side_effect = [[], [2]]
mock_award_program_certificate.side_effect = self._make_side_effect([Exception('boom'), None])
with mock.patch(TASKS_MODULE + '.LOGGER.info') as mock_info, \
mock.patch(TASKS_MODULE + '.LOGGER.exception') as mock_exception:
tasks.award_program_certificates.delay(self.student.username).get(retries=0)
self.assertEqual(mock_award_program_certificate.call_count, 2)
mock_exception.assert_called_once_with(
'Max retries exceeded. Failed to award certificate for program {uuid} to user {username}.'.format(
uuid=1,
username=self.student.username)
)
mock_info.assert_any_call(mock.ANY, 2, self.student.username)
def test_retry_on_programs_api_errors(
self,
mock_get_completed_programs,