Merge branch 'master' into versionchange_after_arc

Author: nikhim-um

src/core/src/bootstrap/ConfigurationFactory.py

@@ -17,6 +17,7 @@
 """ Configure factory. This module populates configuration based on package manager and environment, e.g. TEST/DEV/PROD"""
 from __future__ import print_function
 import os
+import time
 from core.src.bootstrap.Constants import Constants
 from core.src.bootstrap.EnvLayer import EnvLayer
 
@@ -40,15 +41,25 @@
 from core.src.package_managers.ZypperPackageManager import ZypperPackageManager
 
 from core.src.service_interfaces.LifecycleManager import LifecycleManager
+from core.src.service_interfaces.LifecycleManagerAzure import LifecycleManagerAzure
+from core.src.service_interfaces.LifecycleManagerArc import LifecycleManagerArc                                                      
 from core.src.service_interfaces.StatusHandler import StatusHandler
 from core.src.service_interfaces.TelemetryWriter import TelemetryWriter
 
+try:
+    import urllib2 as urlreq   #Python 2.x
+except:
+    import urllib.request as urlreq   #Python 3.x
+
 
 class ConfigurationFactory(object):
     """ Class for generating module definitions. Configuration is list of key value pairs. Please DON'T change key name.
     DI container relies on the key name to find and resolve dependencies. If you do need change it, please make sure to
     update the key name in all places that reference it. """
     def __init__(self, log_file_path, real_record_path, recorder_enabled, emulator_enabled, events_folder):
+        self.vm_cloud_type = self.get_vm_cloud_type()
+        self.lifecycle_manager_component = self.get_lifecycle_manager_component(self.vm_cloud_type)
+
         self.bootstrap_configurations = {
             'prod_config':  self.new_bootstrap_configuration(Constants.PROD, log_file_path, real_record_path, recorder_enabled, emulator_enabled, events_folder),
             'dev_config':   self.new_bootstrap_configuration(Constants.DEV, log_file_path, real_record_path, recorder_enabled, emulator_enabled, events_folder),
@@ -155,18 +166,21 @@ def new_bootstrap_configuration(config_env, log_file_path, real_record_path, rec
 
     def new_prod_configuration(self, package_manager_name, package_manager_component):
         """ Base configuration for Prod V2. """
+
         configuration = {
             'config_env': Constants.PROD,
             'package_manager_name': package_manager_name,
             'lifecycle_manager': {
-                'component': LifecycleManager,
+                'component': self.lifecycle_manager_component,
                 'component_args': ['env_layer', 'execution_config', 'composite_logger', 'telemetry_writer'],
                 'component_kwargs': {}
             },
             'status_handler': {
                 'component': StatusHandler,
                 'component_args': ['env_layer', 'execution_config', 'composite_logger', 'telemetry_writer'],
-                'component_kwargs': {}
+                'component_kwargs': {
+                    'vm_cloud_type': self.vm_cloud_type
+                }
             },
             'package_manager': {
                 'component': package_manager_component,
@@ -187,7 +201,7 @@ def new_prod_configuration(self, package_manager_name, package_manager_component
             },
             'patch_assessor': {
                 'component': PatchAssessor,
-                'component_args': ['env_layer', 'execution_config', 'composite_logger', 'telemetry_writer', 'status_handler', 'package_manager'],
+                'component_args': ['env_layer', 'execution_config', 'composite_logger', 'telemetry_writer', 'status_handler', 'package_manager', 'lifecycle_manager'],
                 'component_kwargs': {}
             },
             'patch_installer': {
@@ -216,7 +230,7 @@ def new_prod_configuration(self, package_manager_name, package_manager_component
             },
             'configure_patching_processor': {
                 'component': ConfigurePatchingProcessor,
-                'component_args': ['env_layer', 'execution_config', 'composite_logger', 'telemetry_writer', 'status_handler', 'package_manager', 'auto_assess_service_manager', 'auto_assess_timer_manager'],
+                'component_args': ['env_layer', 'execution_config', 'composite_logger', 'telemetry_writer', 'status_handler', 'package_manager', 'auto_assess_service_manager', 'auto_assess_timer_manager', 'lifecycle_manager'],
                 'component_kwargs': {}
             },
             'maintenance_window': {
@@ -240,4 +254,43 @@ def new_test_configuration(self, package_manager_name, package_manager_component
         configuration['config_env'] = Constants.TEST
         # perform desired modifications to configuration
         return configuration
+
+    def get_lifecycle_manager_component(self, vm_cloud_type):
+        """ finding life cycle manager based on vm and returning component name added in the prod configuration """
+        azure_lifecycle_manager_component = LifecycleManagerAzure
+        arc_lifecycle_manager_component = LifecycleManagerArc
+        if (vm_cloud_type == Constants.VMCloudType.AZURE):
+            return azure_lifecycle_manager_component
+        elif (vm_cloud_type == Constants.VMCloudType.ARC):
+            return arc_lifecycle_manager_component
+        
+        return azure_lifecycle_manager_component
+   
+    def get_vm_cloud_type(self):
+        """ detects vm type. logic taken from HCRP code: https://github.com/PowerShell/DesiredStateConfiguration/blob/dev/src/dsc/dsc_service/service_main.cpp#L115
+        Todo:  how to check this only when it is Auto Assessment operation??? """
+        metadata_value = "True"
+        user_agent_value = "ArcAgent"
+        request = urlreq.Request(Constants.IMDS_END_POINT)
+        request.add_header('Metadata', metadata_value)
+        request.add_header('UserAgent', user_agent_value)
+        print("\nTrying to connect IMDS end point. URL:{0}.".format(str(Constants.IMDS_END_POINT)))
+        for i in range(0, Constants.MAX_IMDS_CONNECTION_RETRY_COUNT):
+            try:
+                res = urlreq.urlopen(request, timeout=2)
+                print(res.get_code())
+                if(res.getcode() == 200):
+                    print("Connection to IMDS end point successfully established. VMCloudType is Azure\n")
+                    return Constants.VMCloudType.AZURE
+                else:
+                    raise
+            except:
+                """ Failed to connect to Azure IMDS endpoint. This is expected on Arc machine - but not expected on Azure machine."""
+                if i < Constants.MAX_IMDS_CONNECTION_RETRY_COUNT - 1:
+                    print("Failed to connect to IMDS end point. [Retry Count={0}].".format(str(i)))
+                    time.sleep(i+1)
+                else:
+                    print("Failed to connect IMDS end point. This is expected in ARC VM. VMCloudType is Arc\n")
+                    return Constants.VMCloudType.ARC
+            
     # endregion

src/core/src/bootstrap/Constants.py

@@ -155,6 +155,7 @@ class AutoAssessmentStates(EnumBackport):
     MAX_FILE_OPERATION_RETRY_COUNT = 5
     MAX_ASSESSMENT_RETRY_COUNT = 5
     MAX_INSTALLATION_RETRY_COUNT = 3
+    MAX_IMDS_CONNECTION_RETRY_COUNT = 5
 
     class PackageClassification(EnumBackport):
         UNCLASSIFIED = 'Unclassified'
@@ -185,6 +186,14 @@ class RebootStatus(EnumBackport):
         STARTED = "Started"
         COMPLETED = "Completed"
         FAILED = "Failed"
+    
+    # Enum for VM Cloud Type
+    class VMCloudType(EnumBackport):
+        UNKNOWN = "Unknown"
+        AZURE = "Azure"
+        ARC = "Arc"
+
+    IMDS_END_POINT = "http://169.254.169.254/metadata/instance/compute?api-version=2019-06-01"
 
     # StartedBy Patch Assessment Summary Status Values
     class PatchAssessmentSummaryStartedBy(EnumBackport):

src/core/src/core_logic/ConfigurePatchingProcessor.py

@@ -19,7 +19,7 @@
 
 
 class ConfigurePatchingProcessor(object):
-    def __init__(self, env_layer, execution_config, composite_logger, telemetry_writer, status_handler, package_manager, auto_assess_service_manager, auto_assess_timer_manager):
+    def __init__(self, env_layer, execution_config, composite_logger, telemetry_writer, status_handler, package_manager, auto_assess_service_manager, auto_assess_timer_manager, lifecycle_manager):
         self.env_layer = env_layer
         self.execution_config = execution_config
 
@@ -30,6 +30,7 @@ def __init__(self, env_layer, execution_config, composite_logger, telemetry_writ
         self.package_manager = package_manager
         self.auto_assess_service_manager = auto_assess_service_manager
         self.auto_assess_timer_manager = auto_assess_timer_manager
+        self.lifecycle_manager = lifecycle_manager
 
         self.current_auto_os_patch_state = Constants.AutomaticOsPatchStates.UNKNOWN
         self.current_auto_assessment_state = Constants.AutoAssessmentStates.UNKNOWN
@@ -128,6 +129,9 @@ def __report_consolidated_configure_patch_status(self, status=Constants.STATUS_T
                                                                   auto_assessment_state=self.current_auto_assessment_state)
 
     def __raise_if_agent_incompatible(self):
+        if self.lifecycle_manager.get_vm_cloud_type() == Constants.VMCloudType.ARC and self.execution_config.operation not in [Constants.ASSESSMENT, Constants.INSTALLATION]:
+            self.composite_logger.log("Skipping agent compatibility check for Arc cloud type when operation is not manual")
+            return
         if not self.telemetry_writer.is_agent_compatible():
             error_msg = Constants.TELEMETRY_AT_AGENT_NOT_COMPATIBLE_ERROR_MSG
             self.composite_logger.log_error(error_msg)

src/core/src/core_logic/PatchAssessor.py

@@ -21,14 +21,14 @@
 
 class PatchAssessor(object):
     """ Wrapper class of a single patch assessment """
-    def __init__(self, env_layer, execution_config, composite_logger, telemetry_writer, status_handler, package_manager):
+    def __init__(self, env_layer, execution_config, composite_logger, telemetry_writer, status_handler, package_manager, lifecycle_manager):
         self.env_layer = env_layer
         self.execution_config = execution_config
 
         self.composite_logger = composite_logger
         self.telemetry_writer = telemetry_writer
         self.status_handler = status_handler
-
+        self.lifecycle_manager = lifecycle_manager
         self.package_manager = package_manager
 
     def start_assessment(self):
@@ -49,9 +49,13 @@ def start_assessment(self):
 
         for i in range(0, Constants.MAX_ASSESSMENT_RETRY_COUNT):
             try:
+                if self.lifecycle_manager is not None:
+                    self.lifecycle_manager.lifecycle_status_check()     # may terminate the code abruptly, as designed
                 packages, package_versions = self.package_manager.get_all_updates()
                 self.telemetry_writer.write_event("Full assessment: " + str(packages), Constants.TelemetryEventLevel.Verbose)
                 self.status_handler.set_package_assessment_status(packages, package_versions)
+                if self.lifecycle_manager is not None:
+                    self.lifecycle_manager.lifecycle_status_check()     # may terminate the code abruptly, as designed
                 sec_packages, sec_package_versions = self.package_manager.get_security_updates()
                 self.telemetry_writer.write_event("Security assessment: " + str(sec_packages), Constants.TelemetryEventLevel.Verbose)
                 self.status_handler.set_package_assessment_status(sec_packages, sec_package_versions, "Security")
@@ -76,6 +80,9 @@ def start_assessment(self):
         return True
 
     def raise_if_agent_incompatible(self):
+        if self.lifecycle_manager.get_vm_cloud_type() == Constants.VMCloudType.ARC and self.execution_config.operation not in [Constants.ASSESSMENT, Constants.INSTALLATION]:
+            self.composite_logger.log("Skipping agent compatibility check for Arc cloud type when operation is not manual")
+            return
         if not self.telemetry_writer.is_agent_compatible():
             error_msg = Constants.TELEMETRY_AT_AGENT_NOT_COMPATIBLE_ERROR_MSG
             self.composite_logger.log_error(error_msg)

src/core/src/core_logic/PatchInstaller.py

@@ -99,6 +99,9 @@ def start_installation(self, simulate=False):
         return overall_patch_installation_successful
 
     def raise_if_agent_incompatible(self):
+        if self.lifecycle_manager.get_vm_cloud_type() == Constants.VMCloudType.ARC and self.execution_config.operation not in [Constants.ASSESSMENT, Constants.INSTALLATION]:
+            self.composite_logger.log("Skipping agent compatibility check for Arc cloud type when operation is not manual")
+            return
         if not self.telemetry_writer.is_agent_compatible():
             error_msg = Constants.TELEMETRY_AT_AGENT_NOT_COMPATIBLE_ERROR_MSG
             self.composite_logger.log_error(error_msg)

src/core/src/package_managers/PackageManager.py

@@ -304,7 +304,7 @@ def get_package_size(self, output):
 
     # region Package Manager Settings
     def get_package_manager_setting(self, setting_key, default_value='d5414abb-62f9-40e3-96e1-d579f85a79ba'):
-        # type: (str, object) -> ""  # type hinting to remove a warning
+        # type: (str, object) -> "" # type hinting to remove a warning
         """Gets any set package manager setting"""
         if setting_key in self.package_manager_settings:
             return self.package_manager_settings[setting_key]
@@ -316,7 +316,7 @@ def get_package_manager_setting(self, setting_key, default_value='d5414abb-62f9-
             raise Exception(error_msg, "[{0}]".format(Constants.ERROR_ADDED_TO_STATUS))
 
     def set_package_manager_setting(self, setting_key, setting_value=""):
-        # type: (str, object) -> ""  # type hinting to remove a warning
+        # type: (str, object) -> "" # type hinting to remove a warning
         """Sets package manager setting"""
         self.package_manager_settings[setting_key] = setting_value
     # endregion