Added ability to test modify in full tests

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-test",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/plugin-tester.ts

@@ -64,6 +64,10 @@ export class PluginTester {
       validateApply?: (plans: PlanResponseData[]) => Promise<void> | void,
       validateDestroy?: (plans: PlanResponseData[]) => Promise<void> | void,
       validateImport?: (importResults: (ImportResponseData['result'][0])[]) => Promise<void> | void,
+      testModify?: {
+        configs: ResourceConfig[],
+        validate?: (plans: PlanResponseData[]) => Promise<void> | void,
+      }
   }): Promise<void> {
     const {
       skipUninstall = false,
@@ -146,6 +150,32 @@ ${JSON.stringify(unsuccessfulImports, null, 2)}`);
       await options.validateImport(importResults.map((r) => r.result[0]));
     }
 
+    if (options?.testModify) {
+      const modifyPlans = [];
+      for (const config of options.testModify.configs) {
+        modifyPlans.push(await this.plan({
+          desired: config,
+          isStateful: false,
+          state: undefined,
+        }));
+      }
+
+      if (modifyPlans.some((p) => p.operation !== ResourceOperation.MODIFY)) {
+        throw new Error(`Error while testing modify. Non-modify results were found in the plan: 
+${JSON.stringify(modifyPlans, null, 2)}`)
+      }
+
+      for (const plan of modifyPlans) {
+        await this.apply({
+          planId: plan.planId
+        });
+      }
+
+      if (options.testModify.validate) {
+        await options.testModify.validate(modifyPlans);
+      }
+    }
+
     if (!skipUninstall) {
       await this.uninstall(configs.toReversed(), options);
     }

test/plugin-tester.test.ts

@@ -222,4 +222,22 @@ describe('Plugin tester integration tests', () => {
   })
 
 
+  it('Can test modify', { timeout: 50000000 }, async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    await plugin.fullTest([{
+      type: 'test-modify',
+      propA: 'a',
+      propB: 10,
+    }], {
+      skipUninstall: true,
+      testModify: {
+        configs: [{
+          type: 'test-modify',
+          propA: 'Modify',
+          propB: 10,
+        }]
+      }
+    })
+  })
 })

test/test-plugin.ts

@@ -1,4 +1,12 @@
-import { CreatePlan, DestroyPlan, Plugin, Resource, ResourceSettings, runPlugin } from 'codify-plugin-lib';
+import {
+  CreatePlan,
+  DestroyPlan, ModifyPlan,
+  ParameterChange,
+  Plugin,
+  Resource,
+  ResourceSettings,
+  runPlugin
+} from 'codify-plugin-lib';
 import { StringIndexedObject } from 'codify-schemas';
 
 export interface TestConfig extends StringIndexedObject {
@@ -91,11 +99,41 @@ export class TestUninstallResource extends Resource<TestConfig> {
   }
 }
 
+export class TestModifyResource extends Resource<TestConfig> {
+  getSettings(): ResourceSettings<TestConfig> {
+    return {
+      id: 'test-modify',
+      parameterSettings: {
+        propA: { type: 'string', canModify: true },
+        propB: { type: 'string', canModify: true },
+        propC: { type: 'string', canModify: true }
+      }
+    }
+  }
+
+  async refresh(parameters: Partial<TestConfig>): Promise<Array<Partial<TestConfig>> | Partial<TestConfig> | null> {
+    if (parameters.propA === 'Modify') {
+      parameters.propA = 'Modify__';
+    }
+
+    return parameters;
+  }
+
+  async modify(pc: ParameterChange<TestConfig>, plan: ModifyPlan<TestConfig>): Promise<void> {
+    return super.modify(pc, plan);
+  }
+
+  async create(plan: CreatePlan<TestConfig>): Promise<void> {}
+
+  async destroy(plan: DestroyPlan<TestConfig>): Promise<void> {}
+}
+
 runPlugin(Plugin.create(
   'default',
   [
     new TestResource(),
     new TestResource2(),
-    new TestUninstallResource()
+    new TestUninstallResource(),
+    new TestModifyResource()
   ]
 ));