Fix SUSE error codes 6 and 106 (#111)

* Add mitigations for codes 106 and 6

* Add UTs

* Update position and naming of retriable exit codes

* Adjust exception throwing

* Also adjust refresh_repo to only raise if error persists after reboot

Co-authored-by: benank <[email protected]>

Author: benank

src/core/src/package_managers/ZypperPackageManager.py

@@ -40,6 +40,7 @@ def __init__(self, env_layer, execution_config, composite_logger, telemetry_writ
         # Repo refresh
         self.repo_clean = 'sudo zypper clean -a'
         self.repo_refresh = 'sudo zypper refresh'
+        self.repo_refresh_services = 'sudo zypper refresh --services'
 
         # Support to get updates and their dependencies
         self.zypper_check = 'sudo LANG=en_US.UTF8 zypper list-updates'
@@ -54,11 +55,14 @@ def __init__(self, env_layer, execution_config, composite_logger, telemetry_writ
 
         # Package manager exit code(s)
         self.zypper_exitcode_ok = 0
+        self.zypper_exitcode_zypp_lib_exit_err = 4
+        self.zypper_exitcode_no_repos = 6
+        self.zypper_exitcode_zypp_locked = 7
         self.zypper_exitcode_reboot_required = 102
         self.zypper_exitcode_zypper_updated = 103
-        self.zypper_exitcode_zypp_locked = 7
-        self.zypper_exitcode_zypp_lib_exit_err = 4
+        self.zypper_exitcode_repos_skipped = 106
         self.zypper_success_exit_codes = [self.zypper_exitcode_ok, self.zypper_exitcode_zypper_updated, self.zypper_exitcode_reboot_required]
+        self.zypper_retriable_exit_codes = [self.zypper_exitcode_zypp_locked, self.zypper_exitcode_zypp_lib_exit_err, self.zypper_exitcode_repos_skipped]
 
         # Support to check for processes requiring restart
         self.zypper_ps = "sudo zypper ps -s"
@@ -67,7 +71,6 @@ def __init__(self, env_layer, execution_config, composite_logger, telemetry_writ
         self.set_package_manager_setting(Constants.PKG_MGR_SETTING_IDENTITY, Constants.ZYPPER)
         self.zypper_get_process_tree_cmd = 'ps --forest -o pid,cmd -g $(ps -o sid= -p {})'
         self.package_manager_max_retries = 5
-        self.error_codes_to_retry = [self.zypper_exitcode_zypp_locked, self.zypper_exitcode_zypp_lib_exit_err]
         self.zypp_lock_timeout_backup = None
 
         # auto OS updates
@@ -89,11 +92,24 @@ def refresh_repo(self):
             # Reboot if not already done
             if self.status_handler.get_installation_reboot_status() == Constants.RebootStatus.COMPLETED:
                 self.composite_logger.log_warning("Unable to refresh repo (retries exhausted after reboot).")
+                raise
             else:
                 self.composite_logger.log_warning("Setting force_reboot flag to True.")
                 self.force_reboot = True
-                
-            raise
+
+    def __refresh_repo_services(self):
+        """ Similar to refresh_repo, but refreshes services in case no repos are defined. """
+        self.composite_logger.log("Refreshing local repo services...")
+        try:
+            self.invoke_package_manager(self.repo_refresh_services)
+        except Exception as error:
+            # Reboot if not already done
+            if self.status_handler.get_installation_reboot_status() == Constants.RebootStatus.COMPLETED:
+                self.composite_logger.log_warning("Unable to refresh repo services (retries exhausted after reboot).")
+                raise
+            else:
+                self.composite_logger.log_warning("Setting force_reboot flag to True after refreshing repo services.")
+                self.force_reboot = True
 
     # region Get Available Updates
     def invoke_package_manager(self, command):
@@ -106,12 +122,18 @@ def invoke_package_manager(self, command):
             self.restore_original_lock_timeout()
 
             if code not in self.zypper_success_exit_codes:  # more known return codes should be added as appropriate
+                # Refresh repo services if no repos are defined
+                if code == self.zypper_exitcode_no_repos and command != self.repo_refresh_services:
+                    self.composite_logger.log_warning("Warning: no repos defined on command: {0}".format(str(command)))
+                    self.__refresh_repo_services()
+                    continue
+
                 self.log_errors_on_invoke(command, out, code)
                 error_msg = 'Unexpected return code (' + str(code) + ') from package manager on command: ' + command
                 self.status_handler.add_error_to_status(error_msg, Constants.PatchOperationErrorCodes.PACKAGE_MANAGER_FAILURE)
 
                 # Not a retriable error code, so raise an exception
-                if code not in self.error_codes_to_retry:
+                if code not in self.zypper_retriable_exit_codes:
                     raise Exception(error_msg, "[{0}]".format(Constants.ERROR_ADDED_TO_STATUS))
 
                 # Retriable error code, so check number of retries and wait then retry if applicable; otherwise, raise error after max retries

src/core/tests/Test_ZypperPackageManager.py

@@ -482,6 +482,66 @@ def mock_run_command_output(cmd, no_output=False, chk_err=False):
 
         package_manager.env_layer.run_command_output = backup_mocked_method
 
+    def test_package_manager_no_repos(self):
+        package_manager = self.container.get('package_manager')
+        # Setting operation to assessment to add all errors under assessment substatus
+        self.runtime.status_handler.set_current_operation(Constants.ASSESSMENT)
+        cmd_to_run = 'sudo zypper refresh'
+
+        # Wrap count in a mutable container to modify in mocked method to keep track of retries
+        counter = [0]
+        backup_mocked_method = package_manager.env_layer.run_command_output
+
+        def mock_run_command_output(cmd, no_output=False, chk_err=False):
+            # Only check for refresh services cmd
+            if cmd == 'sudo zypper refresh --services':
+                # After refreshing, allow it to succeed
+                self.runtime.set_legacy_test_type('HappyPath')
+            elif cmd == 'sudo zypper refresh':
+                counter[0] += 1
+            return backup_mocked_method(cmd, no_output, chk_err)
+
+        package_manager.env_layer.run_command_output = mock_run_command_output
+
+        # Case 1: AnotherSadPath to HappyPath (no repos defined -> repos defined)
+
+        # AnotherSadPath uses return code 6
+        self.runtime.set_legacy_test_type('AnotherSadPath')
+
+        # Invoke should not raise an exception here
+        try:
+            package_manager.invoke_package_manager(cmd_to_run)
+        except Exception as error:
+            self.fail(repr(error))
+
+        # Should try twice: once fail, fix repos, then try again and succeed
+        self.assertEqual(counter[0], 2)
+        self.assertFalse(self.is_string_in_status_file('Unexpected return code (6) from package manager on command'))
+
+        # Case 2: AnotherSadPath (no repos defined -> still no repos defined)
+        counter = [0]
+
+        # AnotherSadPath uses return code 6
+        self.runtime.set_legacy_test_type('AnotherSadPath')
+
+        def mock_run_command_output(cmd, no_output=False, chk_err=False):
+            # Only count the number of command invocations and do not change to HappyPath
+            if cmd == 'sudo zypper refresh':
+                counter[0] += 1
+            return backup_mocked_method(cmd, no_output, chk_err)
+
+        package_manager.env_layer.run_command_output = mock_run_command_output
+
+        # Invoke should raise an exception here
+        try:
+            package_manager.invoke_package_manager(cmd_to_run)
+        except Exception as error:
+            # Should only try once since this is not a retriable error code
+            self.assertEqual(counter[0], 1)
+            self.assertTrue(self.is_string_in_status_file('Unexpected return code (6) from package manager on command: sudo zypper refresh'))
+            self.assertTrue('Unexpected return code (6) from package manager on command: sudo zypper refresh' in repr(error))
+
+        package_manager.env_layer.run_command_output = backup_mocked_method
 
 if __name__ == '__main__':
     unittest.main()

src/core/tests/library/LegacyEnvLayerExtensions.py

@@ -231,6 +231,10 @@ def run_command_output(self, cmd, no_output=False, chk_err=True):
                                  "7984  |               \_ /usr/bin/python3 /usr/bin/azuremetadata --api latest --subscriptionId --billingTag --attestedData --signature\n" + \
                                  "7986  \_ python3 package_test.py\n" + \
                                  "8298      \_ sudo LANG=en_US.UTF8 zypper --non-interactive update --dry-run grub2-i386-pc\n"
+                    elif cmd.find('sudo zypper refresh --services') > -1:
+                        code = 0
+                        output = "Refreshing service \'Web_and_Scripting_Module_x86_64\'." + \
+                                 "All services have been refreshed."
                     elif cmd.find('sudo zypper refresh') > -1:
                         code = 0
                         output = "Retrieving repository 'SLE-Module-Basesystem15-SP3-Pool' metadata ................................................................[done]\n" + \
@@ -570,6 +574,11 @@ def run_command_output(self, cmd, no_output=False, chk_err=True):
                     if cmd.find('sudo zypper refresh') > -1:
                         code = 999999
                         output = 'Unexpected return code (100) from package manager on command: LANG=en_US.UTF8 sudo apt-get -s dist-upgrade'
+            elif self.legacy_test_type == 'AnotherSadPath':
+                if self.legacy_package_manager_name is Constants.ZYPPER:
+                    if cmd.find('sudo zypper refresh') > -1:
+                        code = 6
+                        output = 'Warning: There are no enabled repositories defined. | Use \'zypper addrepo\' or \'zypper modifyrepo\' commands to add or enable repositories.'
             elif self.legacy_test_type == 'ExceptionPath':
                 code = -1
                 output = ''