feat: Updated to latest schema and library. Adds support for requestId and new pty

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-test",
-  "version": "0.0.26",
+  "version": "0.0.31",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -15,10 +15,11 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
-    "codify-schemas": "1.0.52",
+    "codify-schemas": "1.0.54",
     "lodash.matches": "^4.6.0",
     "lodash.differencewith": "4.5.0",
-    "lodash.unionby": "^4.8.0"
+    "lodash.unionby": "^4.8.0",
+    "nanoid": "^5.0.9"
   },
   "devDependencies": {
     "@oclif/prettier-config": "^0.2.1",
@@ -34,7 +35,7 @@
     "tsx": "^4.7.3",
     "typescript": "^5",
     "vitest": "^1.4.0",
-    "codify-plugin-lib": "1.0.106"
+    "codify-plugin-lib": "1.0.117"
   },
   "engines": {
     "node": ">=18.0.0"

src/plugin-tester.ts

@@ -5,6 +5,7 @@ import {
   ImportResponseData,
   InitializeResponseData,
   IpcMessageSchema,
+  IpcMessageV2,
   MessageCmd,
   PlanRequestData,
   PlanResponseData,
@@ -16,9 +17,10 @@ import {
   ValidateRequestData,
   ValidateResponseData
 } from 'codify-schemas';
+import unionBy from 'lodash.unionby';
+import { nanoid } from 'nanoid';
 import { ChildProcess, SpawnOptions, fork, spawn } from 'node:child_process';
 import path from 'node:path';
-import unionBy from 'lodash.unionby';
 
 import { CodifyTestUtils } from './test-utils.js';
 
@@ -108,23 +110,6 @@ export class PluginTester {
       });
     }
 
-    // Check that all applys were successful by re-planning
-    const validationPlans = [];
-    for (const config of configs) {
-      validationPlans.push(await this.plan({
-        desired: config,
-        isStateful: false,
-        state: undefined,
-      }));
-    }
-
-    const unsuccessfulPlans = validationPlans.filter((p) => p.operation !== ResourceOperation.NOOP);
-    if (unsuccessfulPlans.length > 0) {
-      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)}`
-      )
-    }
-
     if (options?.validateApply) {
       await options.validateApply(plans);
     }
@@ -211,21 +196,6 @@ ${JSON.stringify(modifyPlans, null, 2)}`)
       });
     }
 
-    // Validate that the destroy was successful
-    for (const config of configs) {
-      const validationPlan = await this.plan({
-        desired: config,
-        isStateful: true,
-        state: undefined
-      })
-      if (validationPlan.operation !== ResourceOperation.CREATE) {
-        throw new Error(`Resource was not successfully destroyed.
-Validation plan shows:
-${JSON.stringify(validationPlan, null, 2)}
-        `);
-      }
-    }
-
     if (options?.validateDestroy) {
       await options.validateDestroy(plans);
     }
@@ -235,34 +205,39 @@ ${JSON.stringify(validationPlan, null, 2)}
     return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'initialize',
       data: {},
+      requestId: nanoid(6),
     });
   }
 
   async validate(data: ValidateRequestData): Promise<ValidateResponseData> {
     return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'validate',
       data,
+      requestId: nanoid(6),
     });
   }
 
   async plan(data: PlanRequestData): Promise<PlanResponseData> {
     return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'plan',
       data,
+      requestId: nanoid(6),
     });
   }
 
   async apply(data: ApplyRequestData): Promise<void> {
     return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'apply',
       data,
+      requestId: nanoid(6),
     });
   }
 
   async import(data: ImportRequestData): Promise<ImportResponseData> {
     return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'import',
       data,
+      requestId: nanoid(6),
     });
   }
 
@@ -278,7 +253,7 @@ ${JSON.stringify(validationPlan, null, 2)}
       }
 
       if (message.cmd === MessageCmd.SUDO_REQUEST) {
-        const { data } = message;
+        const { data, requestId } = message;
         if (!sudoRequestValidator(data)) {
           throw new Error(`Invalid sudo request from plugin. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
         }
@@ -288,9 +263,10 @@ ${JSON.stringify(validationPlan, null, 2)}
         console.log(`Running command with sudo: 'sudo ${command}'`)
         const result = await sudoSpawn(command, options);
 
-        process.send({
+        process.send(<IpcMessageV2>{
           cmd: MessageCmd.SUDO_REQUEST + '_Response',
           data: result,
+          requestId,
         })
       }
     })

src/test-utils.test.ts

@@ -4,6 +4,7 @@ import { Readable } from 'stream';
 import { CodifyTestUtils } from './test-utils.js';
 import { describe, expect, it, vi } from 'vitest';
 import { MessageStatus } from 'codify-schemas';
+import { nanoid } from 'nanoid';
 
 describe('Test Utils tests', async () => {
 
@@ -19,54 +20,57 @@ describe('Test Utils tests', async () => {
   it('Sends the message that was passed in', async () => {
     const process = mockChildProcess();
     const sendMock = vi.spyOn(process, 'send');
+    const requestId = nanoid(6);
 
-    CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' })
+    CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId })
 
     expect(sendMock.mock.calls.length).to.eq(1);
-    expect(sendMock.mock.calls[0][0]).to.deep.eq({ cmd: 'message', data: 'data' });
+    expect(sendMock.mock.calls[0][0]).to.deep.eq({ cmd: 'message', data: 'data', requestId });
   })
 
   it('Send a message and receives a response from a plugin (success)', async () => {
     const process = mockChildProcess();
+    const requestId = nanoid(6);
 
     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' })
+        process.emit('message', { cmd: 'message_Response', status: MessageStatus.SUCCESS, data: 'data', requestId })
       })(),
-      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' }),
+      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
     ]);
 
     expect(result[1]).to.eq('data')
   });
 
   it('Send a message and can handle errors', async () => {
     const process = mockChildProcess();
+    const requestId = nanoid(6);
 
     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' })
+        process.emit('message', { cmd: 'message_Response', status: MessageStatus.ERROR, data: 'error message', requestId })
       })(),
-      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' }),
+      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
     ])).rejects.toThrowError(new Error('error message'))
   });
 
   it('Ignores other IPC messages', async () => {
     const process = mockChildProcess();
 
+    const requestId = nanoid(6);
+
     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' })
+        process.emit('message', { cmd: 'randomMessage1', status: MessageStatus.SUCCESS, data: 'message1', requestId: nanoid(6) })
+        process.emit('message', { cmd: 'randomMessage2', status: MessageStatus.SUCCESS, data: 'message2', requestId: nanoid(6) })
+        process.emit('message', { cmd: 'message_Response', status: MessageStatus.SUCCESS, data: 'data', requestId  })
       })(),
-      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data' }),
+      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
     ]);
 
     // Only the final _Response message should be returned.

src/test-utils.ts

@@ -1,5 +1,5 @@
 import Ajv from 'ajv';
-import { IpcMessage, IpcMessageSchema, MessageStatus } from 'codify-schemas';
+import { IpcMessageSchema, IpcMessageV2, MessageStatus } from 'codify-schemas';
 import { ChildProcess } from 'node:child_process';
 
 const ajv = new Ajv.default({
@@ -8,15 +8,15 @@ const ajv = new Ajv.default({
 const ipcMessageValidator = ajv.compile(IpcMessageSchema);
 
 export const CodifyTestUtils = {
-  sendMessageAndAwaitResponse(process: ChildProcess, message: IpcMessage): Promise<any> {
+  sendMessageAndAwaitResponse(process: ChildProcess, message: IpcMessageV2): Promise<any> {
     return new Promise((resolve, reject) => {
-      process.on('message', (response: IpcMessage) => {
+      process.on('message', (response: IpcMessageV2) => {
         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.requestId === message.requestId) {
           if (response.status === MessageStatus.SUCCESS) {
             resolve(response.data)
           } else {