Merge pull request #52 from edx/hammad/ENT-4202

ENT-4202 | Updated logging.

Author: HammadAhmadWaqas

CHANGELOG.rst

@@ -14,7 +14,12 @@ Change Log
 Unreleased
 --------------------
 
-[1.5.0] - 2021-03-04
+[1.6.1] - 2021-03-10
+--------------------
+
+* Updated logging structure for `refresh_course_skills` command.
+
+[1.6.0] - 2021-03-09
 --------------------
 
 * Added support for --all param in `refresh_course_skills` command to back populate data.

taxonomy/__init__.py

@@ -15,6 +15,6 @@
 # 2. MINOR version when you add functionality in a backwards compatible manner, and
 # 3. PATCH version when you make backwards compatible bug fixes.
 # More details can be found at https://semver.org/
-__version__ = '1.6.0'
+__version__ = '1.6.1'
 
 default_app_config = 'taxonomy.apps.TaxonomyConfig'  # pylint: disable=invalid-name

taxonomy/management/commands/refresh_course_skills.py

@@ -90,19 +90,15 @@ def handle(self, *args, **options):
             raise InvalidCommandOptionsError('Either course or all argument must be provided.')
 
         LOGGER.info('[TAXONOMY] Refresh course skills process started.')
-        success_courses, skipped_courses, failures = utils.refresh_course_skills(courses, options['commit'])
+        success_courses_count, skipped_courses_count, failures = utils.refresh_course_skills(courses, options['commit'])
         LOGGER.info(
             '[TAXONOMY] Refresh course skills process completed. \n'
-            'Courses Updated Successfully: %s \n'
-            'Courses Skipped: %s \n'
             'Failures: %s \n'
             'Total Courses Updated Successfully: %s \n'
             'Total Courses Skipped: %s \n'
             'Total Failures: %s \n',
-            success_courses,
-            skipped_courses,
             failures,
-            len(success_courses),
-            len(skipped_courses),
+            success_courses_count,
+            skipped_courses_count,
             len(failures),
         )

taxonomy/utils.py

@@ -66,8 +66,8 @@ def refresh_course_skills(courses, should_commit_to_db):
     Refresh the skills associated with the provided courses.
     """
     all_failures = []
-    success_courses = []
-    skipped_courses = []
+    success_courses_count = 0
+    skipped_courses_count = 0
 
     client = EMSISkillsApiClient()
 
@@ -81,15 +81,15 @@ def refresh_course_skills(courses, should_commit_to_db):
                 if failures:
                     all_failures += failures
                 else:
-                    success_courses.append((course['uuid'], course['key']))
+                    success_courses_count += 1
             except TaxonomyAPIError:
                 message = f'[TAXONOMY] API Error for course_key: {course["key"]}'
                 LOGGER.error(message)
                 all_failures.append((course['uuid'], message))
         else:
-            skipped_courses.append((course['uuid'], course['key']))
+            skipped_courses_count += 1
 
-    return success_courses, skipped_courses, all_failures
+    return success_courses_count, skipped_courses_count, all_failures
 
 
 def blacklist_course_skill(course_key, skill_id):

tests/management/test_refresh_course_skills.py

@@ -100,11 +100,10 @@ def test_course_without_description(self, get_course_provider_mock):
                     '[TAXONOMY] Refresh Course Skills. Options: [%s]',
                     '[TAXONOMY] Refresh course skills process started.',
                     '[TAXONOMY] Refresh course skills process completed. \n'
-                    'Courses Updated Successfully: %s \n'
-                    'Courses Skipped: %s \n'
                     'Failures: %s \n'
                     'Total Courses Updated Successfully: %s \n'
-                    'Total Courses Skipped: %s \nTotal Failures: %s \n'
+                    'Total Courses Skipped: %s \n'
+                    'Total Failures: %s \n'
                 ]
             )
 
@@ -193,11 +192,10 @@ def test_course_skill_not_saved_upon_exception(self, get_course_skills_mock, get
                     f'[TAXONOMY] API Error for course_key: {self.course_1.key}',
                     f'[TAXONOMY] API Error for course_key: {self.course_2.key}',
                     '[TAXONOMY] Refresh course skills process completed. \n'
-                    'Courses Updated Successfully: %s \n'
-                    'Courses Skipped: %s \n'
                     'Failures: %s \n'
                     'Total Courses Updated Successfully: %s \n'
-                    'Total Courses Skipped: %s \nTotal Failures: %s \n'
+                    'Total Courses Skipped: %s \n'
+                    'Total Failures: %s \n'
                 ]
             )
 
@@ -267,8 +265,6 @@ def test_course_skill_not_saved_for_key_error(self, get_course_skills_mock, get_
                     '[TAXONOMY] Skills data received from EMSI. Skills: [%s]',
                     f'[TAXONOMY] Missing keys in skills data for course_key: {self.course_2.key}',
                     '[TAXONOMY] Refresh course skills process completed. \n'
-                    'Courses Updated Successfully: %s \n'
-                    'Courses Skipped: %s \n'
                     'Failures: %s \n'
                     'Total Courses Updated Successfully: %s \n'
                     'Total Courses Skipped: %s \n'
@@ -310,8 +306,6 @@ def test_course_skill_not_saved_for_type_error(self, get_course_skills_mock, get
                     '[TAXONOMY] Skills data received from EMSI. Skills: [%s]',
                     f'[TAXONOMY] Invalid type for `confidence` in course skills for course_key: {self.course_2.key}',
                     '[TAXONOMY] Refresh course skills process completed. \n'
-                    'Courses Updated Successfully: %s \n'
-                    'Courses Skipped: %s \n'
                     'Failures: %s \n'
                     'Total Courses Updated Successfully: %s \n'
                     'Total Courses Skipped: %s \n'