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

Merge pull request #16900 from edx/tasawer/learner-3165-fix-retries-logic-in-award-program-certificate

Browse Source 
Fix retries logic in award program certificate task
This commit is contained in:
Tasawer Nawaz
2017-12-14 12:15:50 +05:00
committed by GitHub
parent 6a3227743a a02dac29f1
commit 0a0a17c8fe
2 changed files with 3 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -194,14 +194,9 @@ 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
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))
LOGGER.warning('Failed to award certificate for program {uuid} to user {username}.'.format(
uuid=program_uuid, username=username))
retry = True
if retry:
# N.B. This logic assumes that this task is idempotent

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

@@ -275,37 +275,6 @@ class AwardProgramCertificatesTestCase(CatalogIntegrationMixin, CredentialsApiCo
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,