Improved naming + fixed destroy after modify

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-test",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -17,14 +17,16 @@
     "ajv-formats": "^3.0.1",
     "codify-schemas": "1.0.52",
     "lodash.matches": "^4.6.0",
-    "lodash.differencewith": "4.5.0"
+    "lodash.differencewith": "4.5.0",
+    "lodash.unionby": "^4.8.0"
   },
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",
     "@types/debug": "^4.1.12",
     "@types/node": "^18",
     "@types/lodash.matches": "^4.6.9",
     "@types/lodash.differencewith": "^4.5.9",
+    "@types/lodash.unionby": "^4.8.9",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",
     "eslint-config-oclif-typescript": "^3",

src/plugin-tester.ts

@@ -17,8 +17,8 @@ import {
   ValidateResponseData
 } from 'codify-schemas';
 import { ChildProcess, SpawnOptions, fork, spawn } from 'node:child_process';
-import inspector from 'node:inspector'
 import path from 'node:path';
+import unionBy from 'lodash.unionby';
 
 import { CodifyTestUtils } from './test-utils.js';
 
@@ -65,8 +65,8 @@ export class PluginTester {
       validateDestroy?: (plans: PlanResponseData[]) => Promise<void> | void,
       validateImport?: (importResults: (ImportResponseData['result'][0])[]) => Promise<void> | void,
       testModify?: {
-        configs: ResourceConfig[],
-        validate?: (plans: PlanResponseData[]) => Promise<void> | void,
+        modifiedConfigs: ResourceConfig[],
+        validateModify?: (plans: PlanResponseData[]) => Promise<void> | void,
       }
   }): Promise<void> {
     const {
@@ -152,7 +152,7 @@ ${JSON.stringify(unsuccessfulImports, null, 2)}`);
 
     if (options?.testModify) {
       const modifyPlans = [];
-      for (const config of options.testModify.configs) {
+      for (const config of options.testModify.modifiedConfigs) {
         modifyPlans.push(await this.plan({
           desired: config,
           isStateful: false,
@@ -171,13 +171,16 @@ ${JSON.stringify(modifyPlans, null, 2)}`)
         });
       }
 
-      if (options.testModify.validate) {
-        await options.testModify.validate(modifyPlans);
+      if (options.testModify.validateModify) {
+        await options.testModify.validateModify(modifyPlans);
       }
     }
 
     if (!skipUninstall) {
-      await this.uninstall(configs.toReversed(), options);
+      const id = (config: ResourceConfig) => config.type + config.name ? `.${config.name}` : '';
+
+      const configsToDestroy = unionBy(options?.testModify?.modifiedConfigs ?? [], configs, id);
+      await this.uninstall(configsToDestroy.toReversed(), options);
     }
   }
 

test/plugin-tester.test.ts

@@ -232,12 +232,49 @@ describe('Plugin tester integration tests', () => {
     }], {
       skipUninstall: true,
       testModify: {
-        configs: [{
+        modifiedConfigs: [{
           type: 'test-modify',
           propA: 'Modify',
           propB: 10,
         }]
       }
     })
   })
+
+  it('Will call destory with the correct parameters (modify)', { timeout: 50000000 }, async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    await expect(async () => await plugin.fullTest([{
+      type: 'test-modify',
+      propA: 'a',
+      propB: 10,
+    }], {
+      testModify: {
+        modifiedConfigs: [{
+          type: 'test-modify',
+          propA: 'Modify',
+          propB: 10,
+        }]
+      }
+    })).rejects.toThrow(
+`
+  "parameters": [
+    {
+      "name": "propA",
+      "previousValue": "Modify__",
+      "newValue": "Modify",
+      "operation": "modify"
+    },
+    {
+      "name": "propB",
+      "previousValue": "10",
+      "newValue": "10",
+      "operation": "noop"
+    }
+  ]
+}
+`
+    )
+  })
+
 })

test/test-plugin.ts

@@ -112,6 +112,10 @@ export class TestModifyResource extends Resource<TestConfig> {
   }
 
   async refresh(parameters: Partial<TestConfig>): Promise<Array<Partial<TestConfig>> | Partial<TestConfig> | null> {
+    if (parameters === null) {
+      return null;
+    }
+
     if (parameters.propA === 'Modify') {
       parameters.propA = 'Modify__';
     }