Add uninstall method to PluginTester + tests.

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-test",
-  "version": "0.0.0",
+  "version": "0.0.3",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -28,7 +28,7 @@
     "tsx": "^4.7.3",
     "typescript": "^5",
     "vitest": "^1.4.0",
-    "codify-plugin-lib": "../codify-plugin-lib"
+    "codify-plugin-lib": "1.0.59"
   },
   "engines": {
     "node": ">=18.0.0"

src/plugin-tester.ts

@@ -1,13 +1,21 @@
 import Ajv2020 from 'ajv/dist/2020.js';
 import {
-  ApplyRequestData, InitializeResponseData, IpcMessageSchema,
+  ApplyRequestData,
+  InitializeResponseData,
+  IpcMessageSchema,
   MessageCmd,
+  ParameterOperation,
   PlanRequestData,
-  PlanResponseData, ResourceConfig, ResourceOperation,
+  PlanResponseData,
+  ResourceConfig,
+  ResourceOperation,
   SpawnStatus,
-  SudoRequestData, SudoRequestDataSchema, ValidateRequestData, ValidateResponseData
+  SudoRequestData,
+  SudoRequestDataSchema,
+  ValidateRequestData,
+  ValidateResponseData
 } from 'codify-schemas';
-import { ChildProcess, SpawnOptions, fork, spawn } from 'node:child_process';
+import { ChildProcess, fork, spawn, SpawnOptions } from 'node:child_process';
 
 import { CodifyTestUtils } from './test-utils.js';
 import path from 'node:path';
@@ -45,7 +53,7 @@ export class PluginTester {
     this.handleSudoRequests(this.childProcess);
   }
 
-  async test(configs: ResourceConfig[]): Promise<void> {
+  async fullTest(configs: ResourceConfig[]): Promise<void> {
     const initializeResult = await this.initialize();
 
     const unsupportedConfigs = configs.filter((c)  =>
@@ -81,7 +89,39 @@ export class PluginTester {
 
     const unsuccessfulPlans = validationPlans.filter((p) => p.operation !== ResourceOperation.NOOP);
     if (unsuccessfulPlans.length > 0) {
-      throw new Error(`The following applies were not successful.\n ${JSON.stringify(unsuccessfulPlans, null, 2)}`)
+      throw new Error(`The following applies were not successful. Re-running plan shows that the resources did not return no-op but instead returned:
+${JSON.stringify(unsuccessfulPlans, null, 2)}`
+      )
+    }
+  }
+
+  async uninstall(configs: ResourceConfig[]) {
+    for (const config of configs) {
+      const { type, dependsOn, name, ...parameters } = config
+
+      await this.apply({
+        plan: {
+          operation: ResourceOperation.DESTROY,
+          resourceType: config.type,
+          parameters: Object.entries(parameters).map(([key, value]) => ({
+            name: key,
+            previousValue: value,
+            newValue: null,
+            operation: ParameterOperation.REMOVE,
+          })),
+        }
+      });
+
+      // Validate that the destroy was successful
+      const validationPlan = await this.plan(config);
+      if (validationPlan.operation !== ResourceOperation.CREATE) {
+        throw new Error(`Resource ${config.type} was not successfully destroyed.
+Validation plan shows:
+${JSON.stringify(validationPlan, null, 2)}
+Previous config:
+${JSON.stringify(config, null, 2)}`
+        );
+      }
     }
   }
 

test/plugin-tester.test.ts

@@ -97,7 +97,7 @@ describe('Plugin tester integration tests', () => {
     const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
 
     // No expect needed here. This passes if it doesn't throw.
-    await plugin.test([{
+    await plugin.fullTest([{
       type: 'test',
       propA: 'a',
       propB: 10,
@@ -109,4 +109,28 @@ describe('Plugin tester integration tests', () => {
       propC: 'c',
     }]);
   })
+
+  it('Has helpers that can uninstall a resource', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    // No expect needed here. This passes if it doesn't throw.
+    await plugin.uninstall([{
+      type: 'test-uninstall',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    }]);
+  })
+
+  it('Has helpers that can uninstall a resource (errors out when unsuccessful)', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    // No expect needed here. This passes if it doesn't throw.
+    expect(async () => plugin.uninstall([{
+      type: 'test',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    }])).rejects.toThrowError();
+  })
 })

test/test-plugin.ts

@@ -37,12 +37,37 @@ export class TestResource extends Resource<TestConfig> {
   }
 }
 
+export class TestUninstallResource extends Resource<TestConfig> {
+  constructor() {
+    super({
+      type: 'test-uninstall'
+    });
+  }
+
+  async applyCreate(plan: Plan<TestConfig>): Promise<void> {}
+
+  async applyDestroy(plan: Plan<TestConfig>): Promise<void> {}
+
+  async refresh(keys: Map<string, unknown>): Promise<Partial<TestConfig> | null> {
+    return null;
+  }
+
+  async validateResource(config: unknown): Promise<ValidationResult> {
+    return {
+      isValid: true
+    }
+  }
+}
+
 function buildPlugin(): Plugin {
   const resourceMap = new Map();
 
   const testResource = new TestResource();
   resourceMap.set(testResource.typeId, testResource);
 
+  const testUninstallResource = new TestUninstallResource();
+  resourceMap.set(testUninstallResource.typeId, testUninstallResource);
+
   return new Plugin('test', resourceMap);
 }
 

tsconfig.json

@@ -1,24 +1,25 @@
 {
   "compilerOptions": {
-    "declaration": true,
     "module": "NodeNext",
-    "moduleResolution": "Node16",
+    "moduleResolution": "NodeNext",
+    "sourceMap": true,
     "esModuleInterop": true,
     "resolveJsonModule": true,
-    "jsx": "react",
-    "outDir": "dist",
+    "alwaysStrict": true,
+    "noImplicitAny": true,
+    "removeComments": true,
+    "strictNullChecks": true,
+    "declaration": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
     "rootDir": "src",
-    "strict": true,
-    "target": "es2022"
+    "outDir": "./dist"
   },
-  "include": [
-    "src/**/*"
-  ],
   "exclude": [
-    "src/**/*.test.ts",
-    "node_modules"
+    "node_modules",
+    "src/**/*.test.ts"
   ],
-  "ts-node": {
-    "esm": true
-  }
+  "include": [
+    "src/**/*.ts"
+  ]
 }

tsconfig.test.json

@@ -5,7 +5,6 @@
   },
   "include": [
     "src/**/*.test.ts",
-    "test/**/*.test.ts",
-    "test/**/*.integration-test.ts"
+    "test/**/*.test.ts"
   ]
 }