Fixed error where scripts were unable to report errors from adu-shell…

… back to the main adu process (#570)

* Adding check to see who fails the apt deployment

* Fixed error where adu-shell was unable to report failures to the main adu process

* fixed formatting in CMakeLists.txt file

* fixed type in test

* corrected error code

* fixed wrong wrapping of process_utils

azurepipelines/e2e_test/scenarios/test_runner/apt_deployment.py

@@ -152,8 +152,6 @@ def test_AptDeployment(self):
 
         deviceClassId = deploymentStatus.subgroupStatuses[0].deviceClassId
 
-        # self.assertEqual(self.duTestHelper.StopDeployment(self.deploymentId,test_adu_group,deviceClassId),200)
-        # time.sleep(retry_wait_time_in_seconds)
 
         # Once stopped we can delete the deployment
         self.assertEqual(self.duTestHelper.DeleteDeployment(

azurepipelines/e2e_test/scenarios/test_runner/bad_apt_deployment.py

@@ -0,0 +1,181 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+import io
+import sys
+import time
+import unittest
+import xmlrunner
+
+# Note: the intention is that this script is called like:
+# python ./scenarios/test_runner/testscript.py
+sys.path.append('./scenarios/')
+from testingtoolkit import DeviceUpdateTestHelper
+from testingtoolkit import UpdateId
+from testingtoolkit import DeploymentStatusResponse
+from testingtoolkit import DuAutomatedTestConfigurationManager
+from xmlrunner.extra.xunit_plugin import transform
+
+# Note: the intention is that this script is called like:
+# python ./scenarios/test_runner/<test-script-name>.py
+sys.path.append('./scenarios/test_runner/')
+from scenario_definitions import DuScenarioDefinitionManager
+
+#
+# Global Test Variables
+#
+bad_bad_apt_deployment_status_retries = 15
+test_result_file_prefix = ""
+
+class AptFailsDeployment(unittest.TestCase):
+
+    #
+    # Every test within a subclass of a unittest.TestCase to be run by unittest must have the prefix test_
+    #
+    def test_AptFailsDeployment(self):
+
+        #
+        # The first step to any test is to create the test helper that allows us to make calls to both the DU account and the
+        # IotHub. In the pipeline the parameters to create the test helper are passed to the environment from which we can read them
+        # here.
+        #
+        # For testing it might be convenient to simply define these above and directly instantiate the object or if you're not planning
+        # on running the tests as apart of a unittest.TestCase you can simply pass them via the CLI to the python program
+        # and create the test helper using the helper method
+        # DuAutomatedTestConfigurationManager.FromCliArgs()
+        #
+        self.aduTestConfig = DuAutomatedTestConfigurationManager.FromOSEnvironment()
+        self.duTestHelper = self.aduTestConfig.CreateDeviceUpdateTestHelper()
+
+        self.aduScenarioDefinition = DuScenarioDefinitionManager.FromOSEnvironment()
+
+        test_device_id = self.aduScenarioDefinition.test_device_id
+        test_adu_group = self.aduScenarioDefinition.test_adu_group
+        global test_result_file_prefix
+        test_result_file_prefix = self.aduScenarioDefinition.test_result_file_prefix
+        test_apt_fails_deployment_id = self.aduScenarioDefinition.test_apt_fails_deployment_id
+        test_connection_timeout_tries = self.aduScenarioDefinition.test_connection_timeout_tries
+        retry_wait_time_in_seconds = self.aduScenarioDefinition.retry_wait_time_in_seconds
+        config_method = self.aduScenarioDefinition.config_method
+
+        #
+        # We retrieve the apt deployment id to be used by the script from the scenario definitions file. It's important to keep
+        # things like the deployment id, device-id, module-id, and other scenario level definitions that might effect other
+        # tests in the scenario_definitions.py file.
+        #
+        self.deploymentId = test_apt_fails_deployment_id
+
+        self.deploymentUpdateId = UpdateId(
+            provider="Contoso1", name="Virtual", version="1.2.3")
+
+        #
+        # Before anything else we need to wait and check the device connection status
+        # We expect the device to connect within the configured amount of time of setting up the device in the step previous
+        #
+        connectionStatus = ""
+        for i in range(0, test_connection_timeout_tries):
+            if config_method == "AIS":
+                connectionStatus = self.duTestHelper.GetConnectionStatusForModule(test_device_id, "IoTHubDeviceUpdate")
+            else:
+                connectionStatus = self.duTestHelper.GetConnectionStatusForDevice(test_device_id)
+
+            if connectionStatus == "Connected":
+                break
+            time.sleep(retry_wait_time_in_seconds)
+
+        self.assertEqual(connectionStatus, "Connected")
+
+        #
+        # The assumption is that we've already imported the update targeting the manufacturer and
+        # model for the device created in the devicesetup.py. Now we have to create the deployment for
+        # the device using the update-id for the update
+        #
+        # Note: ALL UPDATES SHOULD BE UPLOADED TO THE TEST AUTOMATION HUB NOTHING SHOULD BE IMPORTED AT TEST TIME
+        #
+        status_code = self.duTestHelper.StartDeploymentForGroup(
+            deploymentId=self.deploymentId, groupName=test_adu_group, updateId=self.deploymentUpdateId)
+
+        self.assertEqual(status_code, 200)
+
+        #
+        # Once we've started the deployment for the group we can then query for the status of the deployment
+        # to see if/when the deployment finishes. We expect a timeout of the configured amount of time
+        #
+        deploymentStatus = None
+
+        for i in range(0, test_connection_timeout_tries):
+            deploymentStatus = self.duTestHelper.GetDeploymentStatusForGroup(
+                self.deploymentId, test_adu_group)
+
+            #
+            # If we see all the devices have completed the deployment then we can exit early
+            #
+            if (len(deploymentStatus.subgroupStatuses) != 0):
+                if (deploymentStatus.subgroupStatuses[0].devicesCompletedFailedCount == 1):
+                    break
+            time.sleep(retry_wait_time_in_seconds)
+
+        #
+        # Should only be one device group in the deployment
+        #
+        self.assertEqual(len(deploymentStatus.subgroupStatuses), 1)
+
+        #
+        # Devices in the group should have succeeded
+        #
+        self.assertEqual(deploymentStatus.subgroupStatuses[0].totalDevices,
+                         deploymentStatus.subgroupStatuses[0].devicesCompletedFailedCount)
+
+        # Sleep to give time for changes to propagate and for DU to switch it's state back to idle
+        time.sleep(retry_wait_time_in_seconds)
+
+        #
+        # Once we've checked that we've reached the proper outcome for the
+        # deployment we need to check that the device itself has reported it
+        # is back in the idle state.
+        #
+        if config_method == "AIS":
+            twin = self.duTestHelper.GetModuleTwinForModule(test_device_id, "IoTHubDeviceUpdate")
+        else:
+            twin = self.duTestHelper.GetDeviceTwinForDevice(test_device_id)
+
+        self.assertEqual(
+            twin.properties.reported["deviceUpdate"]["agent"]["state"], 255)
+
+        #
+        # In case of a succeeded deployment we need to clean up the resources we created.
+        # mainly the deletion of the deployment
+        #
+        time.sleep(retry_wait_time_in_seconds)
+
+        deviceClassId = deploymentStatus.subgroupStatuses[0].deviceClassId
+
+        # Once stopped we can delete the deployment
+        self.assertEqual(self.duTestHelper.DeleteDeployment(
+            self.deploymentId, test_adu_group), 204)
+
+
+#
+# Below is the section of code that uses the above class to run the test. It starts by running the test, capturing the output, transforming
+# the output from Python Unittest to X/JUnit format. Then the function exports the values to an xml file in the testresults directory which is
+# then uploaded by the Azure Pipelines PostTestResults job
+#
+if (__name__ == "__main__"):
+    #
+    # Create the IO pipe
+    #
+    out = io.BytesIO()
+
+    #
+    # Exercise the TestCase and all the tests within it.
+    #
+    unittest.main(testRunner=xmlrunner.XMLTestRunner(output=out),
+                  failfast=False, buffer=False, catchbreak=False, exit=False)
+
+    #
+    # Finally transform the output unto the X/JUnit XML file format
+    #
+    with open('./testresults/' + test_result_file_prefix + 'bad-apt-deployment-test.xml', 'wb') as report:
+        report.write(transform(out.getvalue()))

azurepipelines/e2e_test/scenarios/test_runner/scenario_definitions.py

@@ -23,6 +23,7 @@ def __init__(self):
         self.test_device_id = ""
         self.test_adu_group = ""
         self.test_apt_deployment_id = str(uuid.uuid4())
+        self.test_apt_fails_deployment_id = str(uuid.uuid4())
         self.test_operation_id = str(uuid.uuid4()).replace('-', '')
         self.test_mcu_deployment_id = str(uuid.uuid4())
         self.test_bundle_update_deployment_id = str(uuid.uuid4())

azurepipelines/e2e_test/templates/e2e_test_run.yaml

@@ -60,6 +60,24 @@ steps:
           DISTRONAME: ${{ parameters.distroName }}
           DEVICEID: ${{ parameters.device_id_under_test }}
 
+    - task: PythonScript@0
+      displayName: Run script to test apt-deployment fails
+      continueOnError: True
+      inputs:
+          scriptSource: "filePath"
+          scriptPath: "$(E2E_WORKING_DIR)/scenarios/test_runner/bad_apt_deployment.py"
+          workingDirectory: $(E2E_WORKING_DIR)
+      env:
+          IOTHUB_URL: $(IOTHUB_URL)
+          IOTHUB_CONNECTION_STRING: $(IOTHUB_CONNECTION_STRING)
+          ADU_ENDPOINT: $(ADU_ENDPOINT)
+          ADU_INSTANCE_ID: $(ADU_INSTANCE_ID)
+          AAD_REGISTRAR_CLIENT_ID: $(AAD_REGISTRAR_CLIENT_ID)
+          AAD_REGISTRAR_TENANT_ID: $(AAD_REGISTRAR_TENANT_ID)
+          AAD_CLIENT_SECRET: $(AAD_CLIENT_SECRET)
+          DISTRONAME: ${{ parameters.distroName }}
+          DEVICEID: ${{ parameters.device_id_under_test }}
+
     - task: PythonScript@0
       displayName: Run script to test diagnostics
       continueOnError: True

src/adu-shell/src/aptget_tasks.cpp

@@ -233,7 +233,9 @@ ADUShellTaskResult Install(const ADUShell_LaunchArguments& launchArgs)
         return taskResult;
     }
 
-    taskResult.SetExitStatus(ADUC_LaunchChildProcess(aptget_command, aptArgs, taskResult.Output()));
+    int ret = ADUC_LaunchChildProcess(aptget_command, aptArgs, taskResult.Output());
+
+    taskResult.SetExitStatus(ret);
     return taskResult;
 }
 

src/utils/process_utils/CMakeLists.txt

@@ -11,16 +11,16 @@ set_property (TARGET ${target_name} PROPERTY POSITION_INDEPENDENT_CODE ON)
 
 target_include_directories (${target_name} PUBLIC inc)
 
-target_link_libraries (
-    ${target_name}
-    PRIVATE aduc::logging
-            aduc::c_utils
-            aduc::config_utils
-            aduc::string_utils)
+target_link_libraries (${target_name} PRIVATE aduc::logging aduc::c_utils aduc::config_utils
+                                              aduc::string_utils)
 
 target_link_aziotsharedutil (${target_name} PUBLIC)
 target_link_libraries (${target_name} PUBLIC libaducpal)
 
+if (WIN32)
+    target_compile_definitions (${target_name} PRIVATE WIN32="${WIN32}")
+endif ()
+
 if (ADUC_BUILD_UNIT_TESTS)
     add_subdirectory (tests)
     add_subdirectory (test_helper)