codify-plugin-test 0.0.0

package/.eslintignore

@@ -0,0 +1 @@
+/dist

package/.eslintrc.json

@@ -0,0 +1,23 @@
+{
+  "extends": [
+    "oclif",
+    "oclif-typescript",
+    "prettier"
+  ],
+  "rules": {
+    "object-curly-spacing": [
+      "warn",
+      "always"
+    ],
+    "perfectionist/sort-classes": [
+      "off"
+    ],
+    "quotes": [
+      "error",
+      "single"
+    ]
+  },
+  "ignorePatterns": [
+    "*.test.ts"
+  ]
+}

package/.prettierrc.json

@@ -0,0 +1 @@
+"@oclif/prettier-config"

package/codify.json

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "nvm",
+    "global": "18.20",
+    "nodeVersions": [
+      "18.20"
+    ]
+  }
+]

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './plugin-tester.js';
+export * from './test-utils.js';

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from './plugin-tester.js';
+export * from './test-utils.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,iBAAiB,CAAA"}

package/dist/plugin-tester.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" resolution-mode="require"/>
+import { ApplyRequestData, InitializeResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
+import { ChildProcess } from 'node:child_process';
+export declare class PluginTester {
+    childProcess: ChildProcess;
+    constructor(pluginPath: string);
+    test(configs: ResourceConfig[]): Promise<void>;
+    initialize(): Promise<InitializeResponseData>;
+    validate(data: ValidateRequestData): Promise<ValidateResponseData>;
+    plan(data: PlanRequestData): Promise<PlanResponseData>;
+    apply(data: ApplyRequestData): Promise<void>;
+    private handleSudoRequests;
+}

package/dist/plugin-tester.js

@@ -0,0 +1,126 @@
+import Ajv2020 from 'ajv/dist/2020.js';
+import { IpcMessageSchema, MessageCmd, ResourceOperation, SpawnStatus, SudoRequestDataSchema } from 'codify-schemas';
+import { fork, spawn } from 'node:child_process';
+import { CodifyTestUtils } from './test-utils.js';
+import path from 'node:path';
+const ajv = new Ajv2020.default({
+    strict: true
+});
+const ipcMessageValidator = ajv.compile(IpcMessageSchema);
+const sudoRequestValidator = ajv.compile(SudoRequestDataSchema);
+export class PluginTester {
+    childProcess;
+    constructor(pluginPath) {
+        if (!path.isAbsolute(pluginPath)) {
+            throw new Error('A fully qualified path must be supplied to PluginTester');
+        }
+        this.childProcess = fork(pluginPath, [], {
+            detached: true,
+            env: { ...process.env },
+            execArgv: ['--import', 'tsx/esm'],
+        });
+        this.handleSudoRequests(this.childProcess);
+    }
+    async test(configs) {
+        const initializeResult = await this.initialize();
+        const unsupportedConfigs = configs.filter((c) => !initializeResult.resourceDefinitions.some((rd) => rd.type === c.type));
+        if (unsupportedConfigs.length > 0) {
+            throw new Error(`The plugin does not support the following configs supplied:\n ${JSON.stringify(unsupportedConfigs, null, 2)}\n Initialize result: ${JSON.stringify(initializeResult)}`);
+        }
+        const validate = await this.validate({ configs });
+        const invalidConfigs = validate.validationResults.filter((v) => !v.isValid);
+        if (invalidConfigs.length > 0) {
+            throw new Error(`The following configs did not validate:\n ${JSON.stringify(invalidConfigs, null, 2)}`);
+        }
+        const plans = [];
+        for (const config of configs) {
+            plans.push(await this.plan(config));
+        }
+        for (const plan of plans) {
+            await this.apply({
+                planId: plan.planId
+            });
+        }
+        const validationPlans = [];
+        for (const config of configs) {
+            validationPlans.push(await this.plan(config));
+        }
+        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)}`);
+        }
+    }
+    async initialize() {
+        return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+            cmd: 'initialize',
+            data: {},
+        });
+    }
+    async validate(data) {
+        return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+            cmd: 'validate',
+            data,
+        });
+    }
+    async plan(data) {
+        return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+            cmd: 'plan',
+            data,
+        });
+    }
+    async apply(data) {
+        return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+            cmd: 'apply',
+            data,
+        });
+    }
+    handleSudoRequests(process) {
+        process.on('message', async (message) => {
+            if (!ipcMessageValidator(message)) {
+                throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
+            }
+            if (message.cmd === MessageCmd.SUDO_REQUEST) {
+                const { data } = message;
+                if (!sudoRequestValidator(data)) {
+                    throw new Error(`Invalid sudo request from plugin. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
+                }
+                const { command, options } = data;
+                console.log(`Running command with sudo: 'sudo ${command}'`);
+                const result = await sudoSpawn(command, options);
+                process.send({
+                    cmd: MessageCmd.SUDO_REQUEST + '_Response',
+                    data: result,
+                });
+            }
+        });
+    }
+}
+async function sudoSpawn(cmd, opts) {
+    return new Promise((resolve) => {
+        const output = [];
+        const _cmd = `sudo ${cmd}`;
+        const _process = spawn(`source ~/.zshrc; ${_cmd}`, [], {
+            ...opts,
+            shell: 'zsh',
+            stdio: ['ignore', 'pipe', 'pipe'],
+        });
+        const { stderr, stdout } = _process;
+        stdout.setEncoding('utf8');
+        stderr.setEncoding('utf8');
+        stdout.on('data', (data) => {
+            output.push(data.toString());
+        });
+        stderr.on('data', (data) => {
+            output.push(data.toString());
+        });
+        stdout.pipe(process.stdout);
+        stderr.pipe(process.stderr);
+        _process.on('close', (code) => {
+            resolve({
+                data: output.join(''),
+                status: code === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
+            });
+        });
+    });
+}
+//# sourceMappingURL=plugin-tester.js.map

package/dist/plugin-tester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-tester.js","sourceRoot":"","sources":["../src/plugin-tester.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,EACqC,gBAAgB,EAC1D,UAAU,EAEwB,iBAAiB,EACnD,WAAW,EACM,qBAAqB,EACvC,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAA8B,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAE7E,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;IAC9B,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AACH,MAAM,mBAAmB,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAC1D,MAAM,oBAAoB,GAAG,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAEhE,MAAM,OAAO,YAAY;IACvB,YAAY,CAAc;IAO1B,YAAY,UAAkB;QAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;QAC7E,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CACtB,UAAU,EACV,EAAE,EACF;YAEE,QAAQ,EAAE,IAAI;YACd,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE;YACvB,QAAQ,EAAE,CAAC,UAAU,EAAE,SAAS,CAAC;SAClC,CACF,CAAA;QAED,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAyB;QAClC,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAEjD,MAAM,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAG,EAAE,CAC/C,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,CACvE,CAAA;QACD,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,iEAAiE,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,yBAAyB,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAA;QAC1L,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAElD,MAAM,cAAc,GAAG,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;QAC3E,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,6CAA6C,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;QACzG,CAAC;QAED,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACtC,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,KAAK,CAAC;gBACf,MAAM,EAAE,IAAI,CAAC,MAAM;aACpB,CAAC,CAAC;QACL,CAAC;QAGD,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,eAAe,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,iBAAiB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAChG,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,gDAAgD,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;QAC/G,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU;QACd,OAAO,eAAe,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,EAAE;YACpE,GAAG,EAAE,YAAY;YACjB,IAAI,EAAE,EAAE;SACT,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,IAAyB;QACtC,OAAO,eAAe,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,EAAE;YACpE,GAAG,EAAE,UAAU;YACf,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAqB;QAC9B,OAAO,eAAe,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,EAAE;YACpE,GAAG,EAAE,MAAM;YACX,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAsB;QAChC,OAAO,eAAe,CAAC,2BAA2B,CAAC,IAAI,CAAC,YAAY,EAAE;YACpE,GAAG,EAAE,OAAO;YACZ,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAEO,kBAAkB,CAAC,OAAqB;QAE9C,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACtC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YACtF,CAAC;YAED,IAAI,OAAO,CAAC,GAAG,KAAK,UAAU,CAAC,YAAY,EAAE,CAAC;gBAC5C,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;gBACzB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChC,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC/G,CAAC;gBAED,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAkC,CAAC;gBAEhE,OAAO,CAAC,GAAG,CAAC,oCAAoC,OAAO,GAAG,CAAC,CAAA;gBAC3D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAEjD,OAAO,CAAC,IAAI,CAAC;oBACX,GAAG,EAAE,UAAU,CAAC,YAAY,GAAG,WAAW;oBAC1C,IAAI,EAAE,MAAM;iBACb,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAoBD,KAAK,UAAU,SAAS,CACtB,GAAW,EACX,IAAwB;IAExB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,MAAM,IAAI,GAAG,QAAQ,GAAG,EAAE,CAAC;QAI3B,MAAM,QAAQ,GAAG,KAAK,CAAC,oBAAoB,IAAI,EAAE,EAAE,EAAE,EAAE;YACrD,GAAG,IAAI;YACP,KAAK,EAAE,KAAK;YACZ,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;SAClC,CAAC,CAAC;QAEH,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,QAAQ,CAAA;QACnC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAE3B,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE;YACzB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE5B,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5B,OAAO,CAAC;gBACN,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrB,MAAM,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK;aAC7D,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/test-utils.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="node" resolution-mode="require"/>
+import { IpcMessage } from 'codify-schemas';
+import { ChildProcess } from 'node:child_process';
+export declare const CodifyTestUtils: {
+    sendMessageAndAwaitResponse(process: ChildProcess, message: IpcMessage): Promise<any>;
+};

package/dist/test-utils.js

@@ -0,0 +1,27 @@
+import Ajv2020 from 'ajv/dist/2020.js';
+import { IpcMessageSchema, MessageStatus } from 'codify-schemas';
+const ajv = new Ajv2020.default({
+    strict: true
+});
+const ipcMessageValidator = ajv.compile(IpcMessageSchema);
+export const CodifyTestUtils = {
+    sendMessageAndAwaitResponse(process, message) {
+        return new Promise((resolve, reject) => {
+            process.on('message', (response) => {
+                if (!ipcMessageValidator(response)) {
+                    throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
+                }
+                if (response.cmd === message.cmd + '_Response') {
+                    if (response.status === MessageStatus.SUCCESS) {
+                        resolve(response.data);
+                    }
+                    else {
+                        reject(new Error(String(response.data)));
+                    }
+                }
+            });
+            process.send(message);
+        });
+    },
+};
+//# sourceMappingURL=test-utils.js.map

package/dist/test-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-utils.js","sourceRoot":"","sources":["../src/test-utils.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAAc,gBAAgB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAG7E,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;IAC9B,MAAM,EAAE,IAAI;CACb,CAAC,CAAC;AACH,MAAM,mBAAmB,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAE1D,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,2BAA2B,CAAC,OAAqB,EAAE,OAAmB;QACpE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,QAAoB,EAAE,EAAE;gBAC7C,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACnC,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;gBACtF,CAAC;gBAGD,IAAI,QAAQ,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,GAAG,WAAW,EAAE,CAAC;oBAC/C,IAAI,QAAQ,CAAC,MAAM,KAAK,aAAa,CAAC,OAAO,EAAE,CAAC;wBAC9C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;oBACxB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBAC1C,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;YAGH,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACL,CAAC;CAEF,CAAC"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "codify-plugin-test",
+  "version": "0.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "type": "module",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "tsx ./src/index.ts"
+  },
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "ajv-formats": "^3.0.1",
+    "codify-schemas": "1.0.38"
+  },
+  "devDependencies": {
+    "@oclif/prettier-config": "^0.2.1",
+    "@types/debug": "^4.1.12",
+    "@types/node": "^18",
+    "eslint": "^8.51.0",
+    "eslint-config-oclif": "^5",
+    "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9.0.0",
+    "tsx": "^4.7.3",
+    "typescript": "^5",
+    "vitest": "^1.4.0",
+    "codify-plugin-lib": "../codify-plugin-lib"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './plugin-tester.js'
+export * from './test-utils.js'

package/src/plugin-tester.ts

@@ -0,0 +1,200 @@
+import Ajv2020 from 'ajv/dist/2020.js';
+import {
+  ApplyRequestData, InitializeResponseData, IpcMessageSchema,
+  MessageCmd,
+  PlanRequestData,
+  PlanResponseData, ResourceConfig, ResourceOperation,
+  SpawnStatus,
+  SudoRequestData, SudoRequestDataSchema, ValidateRequestData, ValidateResponseData
+} from 'codify-schemas';
+import { ChildProcess, SpawnOptions, fork, spawn } from 'node:child_process';
+
+import { CodifyTestUtils } from './test-utils.js';
+import path from 'node:path';
+
+const ajv = new Ajv2020.default({
+  strict: true
+});
+const ipcMessageValidator = ajv.compile(IpcMessageSchema);
+const sudoRequestValidator = ajv.compile(SudoRequestDataSchema);
+
+export class PluginTester {
+  childProcess: ChildProcess
+
+  /**
+   * PluginTester is a helper class to integration test plugins. It launches plugins via fork() just like CodifyCLI does.
+   *
+   * @param pluginPath A fully qualified path
+   */
+  constructor(pluginPath: string) {
+    if (!path.isAbsolute(pluginPath)) {
+      throw new Error('A fully qualified path must be supplied to PluginTester');
+    }
+
+    this.childProcess = fork(
+      pluginPath,
+      [],
+      {
+        // Use default true to test plugins in secure mode (un-able to request sudo directly)
+        detached: true,
+        env: { ...process.env },
+        execArgv: ['--import', 'tsx/esm'],
+      },
+    )
+
+    this.handleSudoRequests(this.childProcess);
+  }
+
+  async test(configs: ResourceConfig[]): Promise<void> {
+    const initializeResult = await this.initialize();
+
+    const unsupportedConfigs = configs.filter((c)  =>
+      !initializeResult.resourceDefinitions.some((rd) => rd.type === c.type)
+    )
+    if (unsupportedConfigs.length > 0) {
+      throw new Error(`The plugin does not support the following configs supplied:\n ${JSON.stringify(unsupportedConfigs, null, 2)}\n Initialize result: ${JSON.stringify(initializeResult)}`)
+    }
+
+    const validate = await this.validate({ configs });
+
+    const invalidConfigs = validate.validationResults.filter((v) => !v.isValid)
+    if (invalidConfigs.length > 0) {
+      throw new Error(`The following configs did not validate:\n ${JSON.stringify(invalidConfigs, null, 2)}`)
+    }
+
+    const plans = [];
+    for (const config of configs) {
+      plans.push(await this.plan(config));
+    }
+
+    for (const plan of plans) {
+      await this.apply({
+        planId: plan.planId
+      });
+    }
+
+    // Check that all applys were successful by re-planning
+    const validationPlans = [];
+    for (const config of configs) {
+      validationPlans.push(await this.plan(config));
+    }
+
+    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)}`)
+    }
+  }
+
+  async initialize(): Promise<InitializeResponseData> {
+    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+      cmd: 'initialize',
+      data: {},
+    });
+  }
+
+  async validate(data: ValidateRequestData): Promise<ValidateResponseData> {
+    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+      cmd: 'validate',
+      data,
+    });
+  }
+
+  async plan(data: PlanRequestData): Promise<PlanResponseData> {
+    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+      cmd: 'plan',
+      data,
+    });
+  }
+
+  async apply(data: ApplyRequestData): Promise<void> {
+    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+      cmd: 'apply',
+      data,
+    });
+  }
+  
+  private handleSudoRequests(process: ChildProcess) {
+    // Listen for incoming sudo incoming sudo requests
+    process.on('message', async (message) => {
+      if (!ipcMessageValidator(message)) {
+        throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
+      }
+
+      if (message.cmd === MessageCmd.SUDO_REQUEST) {
+        const { data } = message;
+        if (!sudoRequestValidator(data)) {
+          throw new Error(`Invalid sudo request from plugin. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
+        }
+
+        const { command, options } = data as unknown as SudoRequestData;
+
+        console.log(`Running command with sudo: 'sudo ${command}'`)
+        const result = await sudoSpawn(command, options);
+
+        process.send({
+          cmd: MessageCmd.SUDO_REQUEST + '_Response',
+          data: result,
+        })
+      }
+    })
+  }
+}
+
+
+type CodifySpawnOptions = {
+  cwd?: string;
+  throws?: boolean,
+} & Omit<SpawnOptions, 'detached' | 'shell' | 'stdio'>
+
+/**
+ *
+ * @param cmd Command to run. Ex: `rm -rf`
+ * @param opts Options for spawn
+ * @param secureMode Secure mode for sudo
+ * @param pluginName Optional plugin name so that stdout and stderr can be piped
+ *
+ * @see promiseSpawn
+ * @see spawn
+ *
+ * @returns SpawnResult { status: SUCCESS | ERROR; data: string }
+ */
+async function sudoSpawn(
+  cmd: string,
+  opts: CodifySpawnOptions,
+): Promise<{ data: string, status: SpawnStatus }> {
+  return new Promise((resolve) => {
+    const output: string[] = [];
+
+    const _cmd = `sudo ${cmd}`;
+
+    // Source start up shells to emulate a users environment vs. a non-interactive non-login shell script
+    // Ignore all stdin
+    const _process = spawn(`source ~/.zshrc; ${_cmd}`, [], {
+      ...opts,
+      shell: 'zsh',
+      stdio: ['ignore', 'pipe', 'pipe'],
+    });
+
+    const { stderr, stdout } = _process
+    stdout.setEncoding('utf8');
+    stderr.setEncoding('utf8');
+
+    stdout.on('data', (data) => {
+      output.push(data.toString());
+    })
+
+    stderr.on('data', (data) => {
+      output.push(data.toString());
+    })
+
+    stdout.pipe(process.stdout);
+    stderr.pipe(process.stderr);
+
+    _process.on('close', (code) => {
+      resolve({
+        data: output.join(''),
+        status: code === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
+      })
+    })
+  })
+}

package/src/test-utils.test.ts

@@ -0,0 +1,79 @@
+import { EventEmitter } from 'node:events';
+import { ChildProcess } from 'node:child_process';
+import { Readable } from 'stream';
+import { CodifyTestUtils } from './test-utils.js';
+import { describe, expect, it, vi } from 'vitest';
+import { MessageStatus } from 'codify-schemas';
+
+describe('Test Utils tests', async () => {
+
+  const mockChildProcess = () => {
+    const process = new ChildProcess();
+    process.stdout = new EventEmitter() as Readable;
+    process.stderr = new EventEmitter() as Readable
+    process.send = () => true;
+
+    return process;
+  }
+
+  it('Sends the message that was passed in', async () => {
+    const process = mockChildProcess();
+    const sendMock = vi.spyOn(process, 'send');
+
+    CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' })
+
+    expect(sendMock.mock.calls.length).to.eq(1);
+    expect(sendMock.mock.calls[0][0]).to.deep.eq({ cmd: 'message', data: 'data' });
+  })
+
+  it('Send a message and receives a response from a plugin (success)', async () => {
+    const process = mockChildProcess();
+
+    const result = await Promise.all([
+      (async () => {
+        await sleep(30);
+        // Note that the response must end in _Response. In accordance to the message schema rules.
+        process.emit('message', { cmd: 'message_Response', status: MessageStatus.SUCCESS, data: 'data' })
+      })(),
+      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' }),
+    ]);
+
+    expect(result[1]).to.eq('data')
+  });
+
+  it('Send a message and can handle errors', async () => {
+    const process = mockChildProcess();
+
+    expect(async () => Promise.all([
+      (async () => {
+        await sleep(30);
+        // Note that the response must end in _Response. In accordance to the message schema rules.
+        process.emit('message', { cmd: 'message_Response', status: MessageStatus.ERROR, data: 'error message' })
+      })(),
+      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' }),
+    ])).rejects.toThrowError(new Error('error message'))
+  });
+
+  it('Ignores other IPC messages', async () => {
+    const process = mockChildProcess();
+
+    const result = await Promise.all([
+      (async () => {
+        await sleep(30);
+        process.emit('message', { cmd: 'randomMessage1', status: MessageStatus.SUCCESS, data: 'message1' })
+        process.emit('message', { cmd: 'randomMessage2', status: MessageStatus.SUCCESS, data: 'message2' })
+
+
+        process.emit('message', { cmd: 'message_Response', status: MessageStatus.SUCCESS, data: 'data' })
+      })(),
+      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' }),
+    ]);
+
+    // Only the final _Response message should be returned.
+    expect(result[1]).to.eq('data')
+  });
+});
+
+async function sleep(ms: number) {
+  return new Promise((resolve, reject) => setTimeout(resolve, ms))
+}

package/src/test-utils.ts

@@ -0,0 +1,33 @@
+import Ajv2020 from 'ajv/dist/2020.js';
+import { IpcMessage, IpcMessageSchema, MessageStatus } from 'codify-schemas';
+import { ChildProcess } from 'node:child_process';
+
+const ajv = new Ajv2020.default({
+  strict: true
+});
+const ipcMessageValidator = ajv.compile(IpcMessageSchema);
+
+export const CodifyTestUtils = {
+  sendMessageAndAwaitResponse(process: ChildProcess, message: IpcMessage): Promise<any> {
+    return new Promise((resolve, reject) => {
+      process.on('message', (response: IpcMessage) => {
+        if (!ipcMessageValidator(response)) {
+          throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
+        }
+
+        // Wait for the message response. Other messages such as sudoRequest may be sent before the response returns
+        if (response.cmd === message.cmd + '_Response') {
+          if (response.status === MessageStatus.SUCCESS) {
+            resolve(response.data)
+          } else {
+            reject(new Error(String(response.data)))
+          }
+        }
+      });
+
+      // Send message last to ensure listeners are all registered
+      process.send(message);
+    });
+  },
+
+};

package/test/plugin-tester.test.ts

@@ -0,0 +1,112 @@
+import { describe, expect, it } from 'vitest';
+import { PluginTester } from '../src/plugin-tester.js';
+import path from 'node:path';
+import { ResourceOperation } from 'codify-schemas/src/types/index.js';
+import { ParameterOperation } from 'codify-schemas';
+
+describe('Plugin tester integration tests', () => {
+  it('Can instantiate a plugin', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    expect(plugin.childProcess.pid).to.not.be.undefined;
+    expect(plugin.childProcess.stdout).to.not.be.undefined;
+    expect(plugin.childProcess.stderr).to.not.be.undefined;
+    expect(plugin.childProcess.channel).to.not.be.undefined;
+
+    await plugin.initialize({});
+  })
+
+  it('Can validate a config', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    const result = await plugin.validate({
+      configs: [{
+        type: 'test',
+        propA: 'a',
+        propB: 2,
+        propC: 'c',
+      }]
+    })
+
+    expect(result.validationResults).toMatchObject([{
+      isValid: true,
+    }])
+  })
+
+  it('Can generate a plan', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    const result = await plugin.plan({
+      type: 'test',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    })
+
+    expect(result).toMatchObject({
+      planId: expect.any(String),
+      operation: ResourceOperation.NOOP,
+      resourceType: 'test',
+    })
+  })
+
+  it('Can generate a plan', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    const result = await plugin.plan({
+      type: 'test',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    })
+
+    expect(result).toMatchObject({
+      planId: expect.any(String),
+      operation: ResourceOperation.NOOP,
+      resourceType: 'test',
+    })
+  })
+
+  it('Can apply a plan', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    const plan = await plugin.plan({
+      type: 'test',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    })
+
+    // No expect needed here. This passes if it doesn't throw.
+    await plugin.apply({ planId: plan.planId })
+  })
+
+  it('Handles errors that are thrown', async () => {
+    const plugin = new PluginTester(path.join(__dirname, './test-plugin.ts'));
+
+    expect(async () => plugin.plan({
+      type: 'test',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+      propD: 'any'
+    })).rejects.toThrowError(new Error('Prop D is included'));
+  })
+
+  it('Has helpers that can test 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.test([{
+      type: 'test',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    }, {
+      type: 'test',
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    }]);
+  })
+})

package/test/test-plugin.ts

@@ -0,0 +1,49 @@
+import { Plan, Plugin, Resource, ValidationResult, runPlugin } from 'codify-plugin-lib';
+import { StringIndexedObject } from 'codify-schemas';
+
+export interface TestConfig extends StringIndexedObject{
+  propA: string;
+  propB: number;
+  propC: string;
+}
+
+export class TestResource extends Resource<TestConfig> {
+  constructor() {
+    super({
+      type: 'test'
+    });
+  }
+
+  async applyCreate(plan: Plan<TestConfig>): Promise<void> {}
+
+  async applyDestroy(plan: Plan<TestConfig>): Promise<void> {}
+
+  async refresh(keys: Map<string, unknown>): Promise<Partial<TestConfig> | null> {
+    if (keys.has('propD')) {
+      throw new Error('Prop D is included');
+    }
+
+    return {
+      propA: 'a',
+      propB: 10,
+      propC: 'c',
+    };
+  }
+
+  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);
+
+  return new Plugin('test', resourceMap);
+}
+
+runPlugin(buildPlugin());

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "alwaysStrict": true,
+    "noImplicitAny": true,
+    "removeComments": true,
+    "strictNullChecks": true,
+    "declaration": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "rootDir": "src",
+    "outDir": "./dist"
+  },
+  "exclude": [
+    "node_modules",
+    "src/**/*.test.ts"
+  ],
+  "include": [
+    "src/**/*.ts"
+  ]
+}

package/tsconfig.test.json

@@ -0,0 +1,10 @@
+{
+  "extends": "tsconfig.json",
+  "compilerOptions": {
+    "strictNullChecks": false
+  },
+  "include": [
+    "src/**/*.test.ts",
+    "test/**/*.test.ts"
+  ]
+}