fix: correcting teardown for integ test and code cleanup

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
     "editor.codeActionsOnSave": {
-        "source.organizeImports": true
+      "source.organizeImports": "explicit"
     },
     "editor.formatOnSave": true,
     "editor.formatOnPaste": true,

source/common/config/rush/repo-state.json

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "a91e3cdfb0f70338c98919f90c62b3eb5bfe08c0",
+  "pnpmShrinkwrapHash": "def9633ab3e27f220d855c6f5ccdf1e7bdf6dfb9",
   "preferredVersionsHash": "14c05a7722342014cec64c4bef7d9bed0d0b7b7f"
 }

source/packages/integration-tests/features/device-patcher/patch.feature

@@ -39,27 +39,27 @@ Feature: Device Patching
       | $.patches[?(@.deviceId=="IntegrationTestCore1")].statusMessage        | DEVICE_ACTIVATION_NOT_FOUND                                                            |
       | $.patches[?(@.deviceId=="IntegrationTestCore1")].associationId        | null                                                                                   |
 
-  # This test disabled because it is flaky. To-be investigated
-  # Scenario: Create a patch task for an EC2 Simulated edge device
-  #   Given patch template "integration_test_template" exists
-  #   And I create an activation for "ec2_edge_device_01" edge device
-  #   When I launch an EC2 Instance "ec2_edge_device_01" emulating as an edge device
-  #   And I pause for 180000ms
-  #   When I create a patch Task for "ec2_edge_device_01" edge device with attributes
-  #     | patchTemplateName | integration_test_template                                       |
-  #     | extraVars         | { "uniqueVar1": "uniqueVarVal1", "uniqueVar2": "uniqueVarVal2"} |
-  #   And I pause for 360000ms
-  #   And last patch for device exists with following attributes
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].deviceId             | ec2_edge_device_01                                                                     |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].patchId              | ___regex___:^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$ |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].taskId               | ___regex___:^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$ |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].createdAt            | ___regex___:^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).(\d{3})Z$                 |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].updatedAt            | ___regex___:^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).(\d{3})Z$                 |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].extraVars.uniqueVar1 | uniqueVarVal1                                                                          |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].extraVars.uniqueVar2 | uniqueVarVal2                                                                          |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].patchType            | agentbased                                                                             |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].patchStatus          | success                                                                                |
-  #     | $.patches[?(@.deviceId=="ec2_edge_device_01")].associationId        | ___regex___:^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$ |
+  # TODO: validate this test is no longer flaky with teardown cleanup
+  Scenario: Create a patch task for an EC2 Simulated edge device
+    Given patch template "integration_test_template" exists
+    And I create an activation for "ec2_edge_device_01" edge device
+    When I launch an EC2 Instance "ec2_edge_device_01" emulating as an edge device
+    And I pause for 90000ms
+    When I create a patch Task for "ec2_edge_device_01" edge device with attributes
+      | patchTemplateName | integration_test_template                                       |
+      | extraVars         | { "uniqueVar1": "uniqueVarVal1", "uniqueVar2": "uniqueVarVal2"} |
+    And I pause for 120000ms
+    And last patch for device exists with following attributes
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].deviceId             | ec2_edge_device_01                                                                     |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].patchId              | ___regex___:^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$ |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].taskId               | ___regex___:^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$ |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].createdAt            | ___regex___:^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).(\d{3})Z$                 |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].updatedAt            | ___regex___:^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}).(\d{3})Z$                 |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].extraVars.uniqueVar1 | uniqueVarVal1                                                                          |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].extraVars.uniqueVar2 | uniqueVarVal2                                                                          |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].patchType            | agentbased                                                                             |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].patchStatus          | success                                                                                |
+      | $.patches[?(@.deviceId=="ec2_edge_device_01")].associationId        | ___regex___:^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$ |
 
   @teardown_patch_features
   Scenario: Teardown

source/packages/integration-tests/src/step_definitions/commandandcontrol/messages.steps.ts

@@ -12,18 +12,18 @@
  *********************************************************************************************************************/
 import 'reflect-metadata';
 
+import { DataTable, Then, When, setDefaultTimeout } from '@cucumber/cucumber';
 import { expect, use } from 'chai';
-import { setDefaultTimeout, DataTable, Then, When } from '@cucumber/cucumber';
 
-import { container } from '../../di/inversify.config';
-import { buildModel, validateExpectedAttributes } from '../common/common.steps';
-import { getAdditionalHeaders } from '../notifications/notifications.utils';
-import { world } from './commandandcontrol.world';
 import {
     COMMANDANDCONTROL_CLIENT_TYPES,
     MessageResource,
     MessagesService,
 } from '@awssolutions/cdf-commandandcontrol-client';
+import { container } from '../../di/inversify.config';
+import { buildModel, validateExpectedAttributes } from '../common/common.steps';
+import { getAdditionalHeaders } from '../notifications/notifications.utils';
+import { world } from './commandandcontrol.world';
 
 import chai_string = require('chai-string');
 use(chai_string);

source/packages/integration-tests/src/step_definitions/device-patcher/deployment.step.ts

@@ -267,7 +267,6 @@ Then(
         const artifacts_certs_key = this['core']?.artifacts?.certs?.key;
         const artifacts_config_bucket = this['core']?.artifacts?.config?.bucket;
         const artifacts_config_key = this['core']?.artifacts?.config?.key;
-
         const patch: CreatePatchRequest = {
             deviceId,
             patchTemplateName: template,
@@ -295,6 +294,7 @@ Then(
                 patchTask,
                 getAdditionalHeaders(world.authToken)
             );
+            // console.log('patchTaskId: ' + this['patchTaskId']);
         } catch (e) {
             this[RESPONSE_STATUS] = e.status;
         }

source/packages/integration-tests/src/support/device_patcher_hooks.ts

@@ -14,27 +14,33 @@
 import { Before, setDefaultTimeout } from '@cucumber/cucumber';
 import { resolve } from 'path';
 
-import { Dictionary } from '@awssolutions/cdf-lambda-invoke';
 import {
-    TemplatesService,
-    PatchType,
     CreatePatchTemplateParams,
+    DEVICE_PATCHER_CLIENT_TYPES,
+    ListPatchResponse,
+    PatchResponse,
+    PatchService,
+    PatchType,
+    TemplatesService,
 } from '@awssolutions/cdf-device-patcher-client';
-import { DEVICE_PATCHER_CLIENT_TYPES } from '@awssolutions/cdf-device-patcher-client';
+import { Dictionary } from '@awssolutions/cdf-lambda-invoke';
 
-import { container } from '../di/inversify.config';
-import { AUTHORIZATION_TOKEN } from '../step_definitions/common/common.steps';
-import { logger } from '@awssolutions/simple-cdf-logger';
 import {
     DescribeInstancesCommand,
     EC2Client,
     TerminateInstancesCommand,
 } from '@aws-sdk/client-ec2';
+import { logger } from '@awssolutions/simple-cdf-logger';
+import { container } from '../di/inversify.config';
+import { AUTHORIZATION_TOKEN } from '../step_definitions/common/common.steps';
 
 setDefaultTimeout(30 * 1000);
 
 const INTEGRATION_TEST_PATCH_TEMPLATE = 'integration_test_template';
 const GGV2_CORE_INSTALLATION_TEMPLATE = 'ggv2_ec2_amazonlinux2_template';
+const PATCH_ENHANCED_DEVICE_ID = 'DevicePatcherIntegrationTestCore';
+const PATCH_DEVICE_ID_1 = 'IntegrationTestCore1';
+const PATCH_DEVICE_ID_2 = 'ec2_edge_device_01';
 
 const ec2 = new EC2Client({ region: process.env.AWS_REGION });
 
@@ -45,12 +51,34 @@ function getAdditionalHeaders(world: unknown): Dictionary {
 }
 
 const templatesSvc: TemplatesService = container.get(DEVICE_PATCHER_CLIENT_TYPES.TemplatesService);
+const patchSvc: PatchService = container.get(DEVICE_PATCHER_CLIENT_TYPES.PatchService);
 
 async function deletePatchTemplate(world: unknown, name: string) {
     try {
         await templatesSvc.deleteTemplate(name, getAdditionalHeaders(world));
     } catch (e) {
-        logger.error(e);
+        logger.error(`deletePatchTemplate: ${JSON.stringify(e)}`);
+    }
+}
+
+async function deletePatchesForDevice(world: unknown, deviceId: string) {
+    try {
+        // get all patches for the given device
+        const patchList: ListPatchResponse = await patchSvc.listPatchesByDeviceId(
+            deviceId,
+            undefined,
+            getAdditionalHeaders(world)
+        );
+        const patches: PatchResponse[] = patchList.patches;
+
+        // delete all patches for the given device
+        const deletionPromises = patches.map((patch): Promise<void> => {
+            console.log(`deleting: ${patch.patchId}`);
+            return patchSvc.deletePatch(patch.patchId, getAdditionalHeaders(world));
+        });
+        await Promise.all(deletionPromises);
+    } catch (e) {
+        logger.error(`deletePatchesForDevice: ${JSON.stringify(e)}`);
     }
 }
 
@@ -71,7 +99,7 @@ async function createIntegrationTestPatchTemplate(world: unknown, name: string)
         };
         await templatesSvc.createTemplate(template, getAdditionalHeaders(world));
     } catch (e) {
-        logger.error(e);
+        logger.error(`createIntegrationTestPatchTemplate: ${JSON.stringify(e)}`);
     }
 }
 
@@ -88,7 +116,7 @@ async function createGGV2CorePatchTemplate(world: unknown, name: string) {
         };
         await templatesSvc.createTemplate(template, getAdditionalHeaders(world));
     } catch (e) {
-        logger.error(e);
+        logger.error(`createGGV2CorePatchTemplate: ${JSON.stringify(e)}`);
     }
 }
 
@@ -111,7 +139,10 @@ async function cleanupEC2Instances() {
     }
 }
 
-async function teardown_patches_feature() {
+async function teardown_patches_feature(world: unknown) {
+    await deletePatchesForDevice(world, PATCH_DEVICE_ID_1);
+    await deletePatchesForDevice(world, PATCH_DEVICE_ID_2);
+    await deletePatchTemplate(world, INTEGRATION_TEST_PATCH_TEMPLATE);
     await cleanupEC2Instances();
 }
 
@@ -120,6 +151,7 @@ async function teardown_activation_features() {
 }
 
 async function teardown_enhanced_patch_templates_features(world: unknown) {
+    await deletePatchesForDevice(world, PATCH_ENHANCED_DEVICE_ID);
     await deletePatchTemplate(world, GGV2_CORE_INSTALLATION_TEMPLATE);
     await cleanupEC2Instances();
 }
@@ -130,7 +162,7 @@ Before({ tags: '@setup_patch_features' }, async function () {
 });
 
 Before({ tags: '@teardown_patch_features' }, async function () {
-    await teardown_patches_feature();
+    await teardown_patches_feature(this);
 });
 
 Before({ tags: '@setup_activation_features' }, async function () {

source/packages/integration-tests/src/support/greengrass2_provisioning_hooks.ts

@@ -29,7 +29,7 @@ import { container } from '../di/inversify.config';
 import { AUTHORIZATION_TOKEN } from '../step_definitions/common/common.steps';
 import { getAdditionalHeaders } from '../step_definitions/notifications/notifications.utils';
 
-import { logger } from '@awssolutions/simple-cdf-logger';
+// import { logger } from '@awssolutions/simple-cdf-logger';
 import AWS from 'aws-sdk';
 import { world } from '../step_definitions/greengrass2-provisioning/greengrass2.world';
 setDefaultTimeout(30 * 1000);
@@ -56,16 +56,13 @@ const templateBucket = process.env.PROVISIONING_TEMPLATES_BUCKET;
 const templatePrefix = process.env.PROVISIONING_TEMPLATES_PREFIX;
 
 async function teardown(world: unknown) {
-    // logger.debug(`\ngreengrass_provisioning_hooks: teardown: in:`);
-
-    logger.debug(`\ngreengrass_provisioning_hooks: teardown: in: ${JSON.stringify(world)}`);
-
     // service cleanup
     const templates = ['IntegrationTest'];
     for (const t of templates) {
         try {
             await templatesSvc.deleteTemplate(t, getAdditionalHeaders(world[AUTHORIZATION_TOKEN]));
         } catch (err) {
+            // logger.error(`teardown: deleteTemplate: ${JSON.stringify(err)}`);
             // swallow the error
         }
     }
@@ -75,6 +72,7 @@ async function teardown(world: unknown) {
         try {
             await deviceSvc.deleteDevice(clientDevice);
         } catch (err) {
+            // logger.error(`teardown: deleteDevice: ${JSON.stringify(err)}`);
             // swallow the error
         }
     }
@@ -95,6 +93,7 @@ async function teardown(world: unknown) {
             }),
         });
     } catch (err) {
+        // logger.error(`teardown: createCoreTask: ${JSON.stringify(err)}`);
         // swallow the error
     }
 

source/packages/libraries/core/simple-cdf-logger/package.json

@@ -18,6 +18,7 @@
     "winston-transport": "4.4.0"
   },
   "devDependencies": {
+    "@awssolutions/cdf-config-inject": "workspace:^2.5.2",
     "@awssolutions/eslint-config-custom": "workspace:~0.0.0",
     "@typescript-eslint/eslint-plugin": "6.2.0",
     "eslint": "8.46.0",

source/packages/libraries/core/simple-cdf-logger/src/index.ts

@@ -1,3 +1,5 @@
+import '@awssolutions/cdf-config-inject';
+
 import { format } from 'logform';
 import { LoggerOptions, createLogger, transports } from 'winston';
 const { combine, timestamp, printf } = format;
@@ -19,19 +21,25 @@ export function setRequestId(newRequestId: string) {
     }
 }
 
-export const logger = createLogger(<LoggerOptions>{
-    level,
-    exitOnError: false,
-    transports: [new transports.Console()],
-    format: combine(
-        timestamp(),
-        printf((nfo) => {
-            return `${nfo.timestamp} ${nfo.level}: rid-${requestId ? requestId : 'not-set-yet'}: ${
-                nfo.message
-            }`;
-        })
-    ),
-});
+export const logger = (function () {
+    if (typeof level == 'undefined') {
+        // this indicates that no log level was set through .env (see: cdf-config-inject)
+        console.error('LOGGING_LEVEL not set');
+    }
+    return createLogger(<LoggerOptions>{
+        level,
+        exitOnError: false,
+        transports: [new transports.Console()],
+        format: combine(
+            timestamp(),
+            printf((nfo) => {
+                return `${nfo.timestamp} ${nfo.level}: rid-${
+                    requestId ? requestId : 'not-set-yet'
+                }: ${nfo.message}`;
+            })
+        ),
+    });
+})();
 
 export function getRequestIdFromContext(context: any) {
     let requestId;

source/packages/services/assetlibraryhistory/src/lambda_iot_rule.ts

@@ -12,8 +12,8 @@
  *********************************************************************************************************************/
 import 'reflect-metadata';
 
-import { logger } from '@awssolutions/simple-cdf-logger';
 import { container } from './di/inversify.config';
+import { logger } from '@awssolutions/simple-cdf-logger';
 import { TYPES } from './di/types';
 import { EventModel } from './events/events.models';
 import { EventsService } from './events/events.service';

source/packages/services/bulkcerts/src/lambda_sns_handler.ts

@@ -10,12 +10,13 @@
  *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions    *
  *  and limitations under the License.                                                                                *
  *********************************************************************************************************************/
+import { container } from './di/inversify.config';
+
 import { logger } from '@awssolutions/simple-cdf-logger';
 import { Context, SNSEvent } from 'aws-lambda';
 import ow from 'ow';
 import { CertificateChunkRequest } from './certificates/certificates.models';
 import { CertificatesService } from './certificates/certificates.service';
-import { container } from './di/inversify.config';
 import { TYPES } from './di/types';
 
 let service: CertificatesService;

source/packages/services/command-and-control/src/lambda_shadow_command_response_handler.ts

@@ -13,8 +13,8 @@
 
 import ow from 'ow';
 
-import { logger } from '@awssolutions/simple-cdf-logger';
 import { container } from './di/inversify.config';
+import { logger } from '@awssolutions/simple-cdf-logger';
 import { TYPES } from './di/types';
 import { Response } from './responses/responses.models';
 import { ResponsesService } from './responses/responses.service';

source/packages/services/command-and-control/src/lambda_topic_command_response_handler.ts

@@ -13,8 +13,8 @@
 
 import ow from 'ow';
 
-import { logger } from '@awssolutions/simple-cdf-logger';
 import { container } from './di/inversify.config';
+import { logger } from '@awssolutions/simple-cdf-logger';
 import { TYPES } from './di/types';
 import { Response } from './responses/responses.models';
 import { ResponsesService } from './responses/responses.service';

source/packages/services/command-and-control/src/messages/workflow/workflow.createEphemeralGroup.ts

@@ -80,8 +80,10 @@ export class CreateEphemeralGroupAction extends WorkflowPublishAction {
                 thingNames.map((t) => t.id)
             );
 
-            // as we have created an ephemeral group from the target, we can remove the things from the resolved targets lit
-            // TODO: removing resolved targets means their status will never change from 'pending'. This is to address issues with batching. if status is required then a rethink and redesign of job batching is required. As a workaround, if recipient status is needed it can be retrieved directly from the AWS IoT job execution status.
+            // as we have created an ephemeral group from the target, we can remove the things from the resolved targets list
+            // TODO: removing resolved targets means their status will never change from 'pending'.
+            // This is to address issues with batching. if status is required then a rethink and redesign of job batching is required.
+            // As a workaround, if recipient status is needed it can be retrieved directly from the AWS IoT job execution status.
             resolvedTargets = resolvedTargets.filter((o) => o.type !== 'thing');
             resolvedTargets.push({
                 id: ephemeralGroupResponse.groupName,