Core fails if telemetery is missing at agent (#54)

Author: rane-rajasi

src/core/src/CoreMain.py

@@ -65,6 +65,7 @@ def __init__(self, argv):
                 status_handler.set_current_operation(Constants.INSTALLATION)
                 patch_installer = container.get('patch_installer')
                 patch_installation_successful = patch_installer.start_installation()
+                patch_assessment_successful = False
                 patch_assessment_successful = patch_assessor.start_assessment()
 
         except Exception as error:

src/core/src/bootstrap/Constants.py

@@ -47,6 +47,7 @@ class EnvSettings(EnumBackport):
         LOG_FOLDER = "logFolder"
         CONFIG_FOLDER = "configFolder"
         STATUS_FOLDER = "statusFolder"
+        EVENTS_FOLDER = "eventsFolder"
 
     class ConfigSettings(EnumBackport):
         OPERATION = 'operation'
@@ -171,6 +172,8 @@ class PatchOperationErrorCodes(EnumBackport):
     TELEMETRY_INFO = "Info"
     TELEMETRY_DEBUG = "Debug"
 
+    UTC_DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%SZ"
+
     # EnvLayer Constants
     class EnvLayer(EnumBackport):
         PRIVILEGED_OP_MARKER = "Privileged_Op_e6df678d-d09b-436a-a08a-65f2f70a6798"

src/core/src/bootstrap/EnvLayer.py

@@ -419,7 +419,7 @@ def __write_record(self, operation, code, output, delay, timestamp=None):
 
         try:
             record = {
-                "timestamp": str(timestamp) if timestamp is not None else datetime.datetime.strptime(str(datetime.datetime.utcnow()).split(".")[0], "%Y-%m-%dT%H:%M:%SZ"), #WRONG
+                "timestamp": str(timestamp) if timestamp is not None else datetime.datetime.strptime(str(datetime.datetime.utcnow()).split(".")[0], Constants.UTC_DATETIME_FORMAT), #WRONG
                 "operation": str(operation),
                 "code": int(code),
                 "output": base64.b64encode(str(output)),

src/core/src/core_logic/ExecutionConfig.py

@@ -41,6 +41,7 @@ def __init__(self, env_layer, composite_logger, execution_parameters):
         self.log_folder = self.environment_settings[Constants.EnvSettings.LOG_FOLDER]
         self.config_folder = self.environment_settings[Constants.EnvSettings.CONFIG_FOLDER]
         self.status_folder = self.environment_settings[Constants.EnvSettings.STATUS_FOLDER]
+        self.events_folder = self.environment_settings[Constants.EnvSettings.EVENTS_FOLDER]
 
         # Config Settings
         self.composite_logger.log_debug(" - Parsing configuration settings... [ConfigSettings={0}]".format(str(self.config_settings)))

src/core/src/core_logic/PatchAssessor.py

@@ -33,8 +33,10 @@ def __init__(self, env_layer, execution_config, composite_logger, telemetry_writ
 
     def start_assessment(self):
         """ Start an update assessment """
-        self.composite_logger.log('\nStarting patch assessment...')
         self.status_handler.set_current_operation(Constants.ASSESSMENT)
+        self.telemetry_setup()
+
+        self.composite_logger.log('\nStarting patch assessment...')
 
         self.status_handler.set_assessment_substatus_json(status=Constants.STATUS_TRANSITIONING)
         self.composite_logger.log("\nMachine Id: " + self.env_layer.platform.node())
@@ -72,3 +74,14 @@ def start_assessment(self):
 
         self.composite_logger.log("\nPatch assessment completed.\n")
         return True
+
+    def telemetry_setup(self):
+        """ Verifies if telemetry is available. Stops execution is not available """
+        if self.execution_config.events_folder is None:
+            error_msg = "The minimum Azure Linux Agent version prerequisite for Linux patching was not met. Please update the Azure Linux Agent on this machine."
+            self.composite_logger.log_error(error_msg)
+            raise Exception(error_msg)
+
+        #ToDo: Ensure telemetry is setup correctly at this point
+        self.composite_logger.log("The minimum Azure Linux Agent version prerequisite for Linux patching was met.")
+

src/core/tests/TestCoreMain.py

@@ -209,6 +209,43 @@ def test_assessment_operation_fail(self):
         self.assertEqual(len(json.loads(substatus_file_data[0]["formattedMessage"]["message"])["errors"]["details"]), 2)
         runtime.stop()
 
+    def test_assessment_operation_fail_due_to_no_telemetry(self):
+        argument_composer = ArgumentComposer()
+        argument_composer.operation = Constants.ASSESSMENT
+        runtime = RuntimeCompositor(argument_composer.get_composed_arguments(), True, Constants.ZYPPER)
+        runtime.set_legacy_test_type('HappyPath')
+        runtime.execution_config.events_folder = None
+        CoreMain(argument_composer.get_composed_arguments())
+
+        with runtime.env_layer.file_system.open(runtime.execution_config.status_file_path, 'r') as file_handle:
+            substatus_file_data = json.load(file_handle)[0]["status"]["substatus"]
+        self.assertEquals(len(substatus_file_data), 1)
+        self.assertTrue(substatus_file_data[0]["name"] == Constants.PATCH_ASSESSMENT_SUMMARY)
+        self.assertTrue(substatus_file_data[0]["status"] == Constants.STATUS_ERROR.lower())
+        self.assertEqual(len(json.loads(substatus_file_data[0]["formattedMessage"]["message"])["errors"]["details"]), 1)
+        self.assertTrue("The minimum Azure Linux Agent version prerequisite for Linux patching was not met" in json.loads(substatus_file_data[0]["formattedMessage"]["message"])["errors"]["details"][0]["message"])
+        runtime.stop()
+
+    def test_installation_operation_fail_due_to_no_telemetry(self):
+        # testing on auto patching request
+        argument_composer = ArgumentComposer()
+        argument_composer.maintenance_run_id = str(datetime.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%S.%fZ"))
+        runtime = RuntimeCompositor(argument_composer.get_composed_arguments(), True, Constants.ZYPPER)
+        runtime.set_legacy_test_type('SuccessInstallPath')
+        runtime.execution_config.events_folder = None
+        CoreMain(argument_composer.get_composed_arguments())
+
+        with runtime.env_layer.file_system.open(runtime.execution_config.status_file_path, 'r') as file_handle:
+            substatus_file_data = json.load(file_handle)[0]["status"]["substatus"]
+        self.assertEquals(len(substatus_file_data), 3)
+        self.assertTrue(substatus_file_data[0]["name"] == Constants.PATCH_ASSESSMENT_SUMMARY)
+        self.assertTrue(substatus_file_data[0]["status"] == Constants.STATUS_ERROR.lower())
+        self.assertEqual(len(json.loads(substatus_file_data[0]["formattedMessage"]["message"])["errors"]["details"]), 1)
+        self.assertTrue("The minimum Azure Linux Agent version prerequisite for Linux patching was not met" in json.loads(substatus_file_data[0]["formattedMessage"]["message"])["errors"]["details"][0]["message"])
+        self.assertTrue(substatus_file_data[1]["name"] == Constants.PATCH_INSTALLATION_SUMMARY)
+        self.assertTrue(substatus_file_data[1]["status"] == Constants.STATUS_ERROR.lower())
+        runtime.stop()
+
 
 if __name__ == '__main__':
     unittest.main()

src/core/tests/library/ArgumentComposer.py

@@ -36,7 +36,7 @@ def __init__(self):
         self.sequence_number = 1
 
         # environment settings
-        self.__log_folder = self.__config_folder = self.__status_folder = self.__get_scratch_folder()
+        self.__log_folder = self.__config_folder = self.__status_folder = self.__events_folder = self.__get_scratch_folder()
 
         # config settings
         self.operation = Constants.INSTALLATION
@@ -57,7 +57,8 @@ def get_composed_arguments(self):
         environment_settings = {
             "logFolder": self.__log_folder,
             "configFolder": self.__config_folder,
-            "statusFolder": self.__status_folder
+            "statusFolder": self.__status_folder,
+            "eventsFolder": self.__events_folder
         }
 
         config_settings = {