Bug fix for status handler writes (#45)

* Bug fix for status handler writes

* Removed stray debug statement

Author: kjohn-msft

src/core/src/core_logic/PatchInstaller.py

@@ -100,7 +100,7 @@ def start_installation(self, simulate=False):
                     #todo: temp fix to test auto patching, this will be reset to using the maintenanceRunId string as is, once the corresponding changes in RSM are made
                     # patch_version = str(self.execution_config.maintenance_run_id)
                     patch_version = datetime.datetime.strptime(self.execution_config.maintenance_run_id.split(" ")[0], "%m/%d/%Y").strftime('%Y.%m.%d')
-                    self.status_handler.set_patch_metadata_for_healthstore_substatus_json(patch_version=patch_version if patch_version is not None and patch_version is not "" else Constants.PATCH_VERSION_UNKNOWN,
+                    self.status_handler.set_patch_metadata_for_healthstore_substatus_json(patch_version=patch_version if patch_version is not None and patch_version != "" else Constants.PATCH_VERSION_UNKNOWN,
                                                                                           report_to_healthstore=True,
                                                                                           wait_after_update=False)
                 except ValueError as e:
@@ -209,11 +209,11 @@ def install_updates(self, maintenance_window, package_manager, simulate=False):
             self.status_handler.set_reboot_pending(self.is_reboot_pending())
 
             if install_result == Constants.FAILED:
-                self.status_handler.set_package_install_status(package_manager.get_product_name(package_and_dependencies[0]), package_and_dependency_versions[0], Constants.FAILED)
+                self.status_handler.set_package_install_status(package_manager.get_product_name(str(package_and_dependencies[0])), str(package_and_dependency_versions[0]), Constants.FAILED)
                 failed_parent_update_count += 1
                 patch_installation_successful = False
             elif install_result == Constants.INSTALLED:
-                self.status_handler.set_package_install_status(package_manager.get_product_name(package_and_dependencies[0]), package_and_dependency_versions[0], Constants.INSTALLED)
+                self.status_handler.set_package_install_status(package_manager.get_product_name(str(package_and_dependencies[0])), str(package_and_dependency_versions[0]), Constants.INSTALLED)
                 successful_parent_update_count += 1
                 if package in self.last_still_needed_packages:
                     index = self.last_still_needed_packages.index(package)
@@ -229,7 +229,7 @@ def install_updates(self, maintenance_window, package_manager, simulate=False):
 
                 if package_manager.is_package_version_installed(dependency, dependency_version):
                     self.composite_logger.log_debug(" - Marking dependency as succeeded: " + str(dependency) + "(" + str(dependency_version) + ")")
-                    self.status_handler.set_package_install_status(package_manager.get_product_name(str(dependency)), dependency_version, Constants.INSTALLED)
+                    self.status_handler.set_package_install_status(package_manager.get_product_name(str(dependency)), str(dependency_version), Constants.INSTALLED)
                     index = self.last_still_needed_packages.index(dependency)
                     self.last_still_needed_packages.pop(index)
                     self.last_still_needed_package_versions.pop(index)

src/core/src/service_interfaces/StatusHandler.py

@@ -116,6 +116,15 @@ def set_package_assessment_status(self, package_names, package_versions, classif
     def set_package_install_status(self, package_names, package_versions, status="Pending", classification=None):
         """ Externally available method to set installation status for one or more packages of the **SAME classification and status** """
         self.composite_logger.log_debug("Setting package installation status in bulk. [Count={0}]".format(str(len(package_names))))
+
+        # Data normalization and corruption guards - if these exceptions hit, a bug has been introduced elsewhere
+        if isinstance(package_names, str) != isinstance(package_versions, str):
+            raise Exception("Internal error: Package name and version data corruption detected.")
+        if isinstance(package_names, str):
+            package_names, package_versions = [package_names], [package_versions]
+        if len(package_names) != len(package_versions):
+            raise Exception("Internal error: Bad package name and version data received for status reporting. [Names={0}][Versions={1}]".format(str(len(package_names)), str(len(package_versions))))
+
         for package_name, package_version in zip(package_names, package_versions):
             self.composite_logger.log_debug("Logging progress [Package: " + package_name + "; Status: " + status + "]")
             patch_already_saved = False

src/core/tests/TestStatusHandler.py

@@ -57,6 +57,20 @@ def test_set_package_install_status(self):
         self.assertTrue("python-samba_2:4.4.5+dfsg-2ubuntu5.4" in str(json.loads(substatus_file_data["formattedMessage"]["message"])["patches"][0]["patchId"]))
         self.assertEqual(json.loads(substatus_file_data["formattedMessage"]["message"])["patches"][2]["patchInstallationState"], "Pending")
 
+    def test_set_package_install_status_extended(self):
+        packages, package_versions = self.runtime.package_manager.get_all_updates()
+        self.runtime.status_handler.set_package_install_status(packages, package_versions)
+        with self.runtime.env_layer.file_system.open(self.runtime.execution_config.status_file_path, 'r') as file_handle:
+            substatus_file_data = json.load(file_handle)[0]["status"]["substatus"][0]
+        self.assertEqual(substatus_file_data["name"], Constants.PATCH_INSTALLATION_SUMMARY)
+        self.assertEqual(json.loads(substatus_file_data["formattedMessage"]["message"])["patches"][1]["name"], "samba-common-bin")
+        self.assertEqual(json.loads(substatus_file_data["formattedMessage"]["message"])["patches"][1]["patchInstallationState"], Constants.PENDING)
+        self.runtime.status_handler.set_package_install_status("samba-common-bin", "2:4.4.5+dfsg-2ubuntu5.4", Constants.INSTALLED)
+        with self.runtime.env_layer.file_system.open(self.runtime.execution_config.status_file_path, 'r') as file_handle:
+            substatus_file_data = json.load(file_handle)[0]["status"]["substatus"][0]
+        self.assertEqual(json.loads(substatus_file_data["formattedMessage"]["message"])["patches"][1]["name"], "samba-common-bin")
+        self.assertEqual(json.loads(substatus_file_data["formattedMessage"]["message"])["patches"][1]["patchInstallationState"], Constants.INSTALLED)
+
     def test_set_installation_reboot_status(self):
         self.assertRaises(Exception, self.runtime.status_handler.set_installation_reboot_status, "INVALID_STATUS")
 

src/extension/src/manifest.xml

@@ -2,7 +2,7 @@
 <ExtensionImage xmlns="http://schemas.microsoft.com/windowsazure">
   <ProviderNameSpace>Microsoft.CPlat.Core</ProviderNameSpace>
   <Type>LinuxPatchExtension</Type>
-  <Version>1.6.10</Version>
+  <Version>1.6.11</Version>
   <Label>Microsoft Azure VM InGuest Patch Extension for Linux Virtual Machines</Label>
   <HostingResources>VmRole</HostingResources>
   <MediaLink></MediaLink>