codify-plugin-lib 1.0.0

package/src/utils/test-utils.test.ts

@@ -0,0 +1,52 @@
+import { describe, it } from 'mocha';
+import { EventEmitter } from 'node:events';
+import { ChildProcess } from 'node:child_process';
+
+import { Readable } from 'stream';
+import { mock } from 'node:test';
+import { expect } from '@oclif/test';
+import { AssertionError } from 'chai';
+import { CodifyTestUtils } from './test-utils';
+import chai = require('chai');
+import chaiAsPromised = require('chai-as-promised');
+
+describe('Test Utils tests', async () => {
+
+  before(() => {
+    chai.use(chaiAsPromised);
+  })
+
+  const mockChildProcess = () => {
+    const process = new ChildProcess();
+    process.stdout = new EventEmitter() as Readable;
+    process.stderr = new EventEmitter() as Readable
+    process.send = () => true;
+
+    return process;
+  }
+
+  it('send a message', async () => {
+    const process = mockChildProcess();
+    const sendMock = mock.method(process, 'send');
+
+    CodifyTestUtils.sendMessageToProcessAwaitResponse(process, { cmd: 'message', data: 'data' })
+
+    expect(sendMock.mock.calls.length).to.eq(1);
+    expect(sendMock.mock.calls[0].arguments[0]).to.deep.eq({ cmd: 'message', data: 'data' });
+  })
+
+  it('send a message and receives the response', async () => {
+    const process = mockChildProcess();
+
+    try {
+      await Promise.all([
+        expect(CodifyTestUtils.sendMessageToProcessAwaitResponse(process, { cmd: 'message', data: 'data' }))
+          .to.eventually.deep.eq({ cmd: 'messageResult', data: 'data' }),
+        process.emit('message', { cmd: 'messageResult', data: 'data' }),
+      ]);
+    } catch (e) {
+      console.log(e);
+      throw new AssertionError('Failed to receive message');
+    }
+  });
+});

package/src/utils/test-utils.ts

@@ -0,0 +1,20 @@
+import { ChildProcess } from 'child_process';
+
+export class CodifyTestUtils {
+  static sendMessageToProcessAwaitResponse(process: ChildProcess, message: any): Promise<any> {
+    return new Promise((resolve, reject) => {
+      process.on('message', (response) => {
+        resolve(response)
+      });
+      process.on('error', (err) => reject(err))
+      process.on('exit', (code) => {
+        if (code != 0) {
+          reject('Exit code is not 0');
+        }
+        resolve(code);
+      })
+      process.send(message);
+    });
+  }
+
+}

package/src/utils/utils.ts

@@ -0,0 +1,33 @@
+import promiseSpawn from '@npmcli/promise-spawn';
+import { SpawnOptions } from 'child_process';
+
+export interface SpawnResult {
+  code: number;
+  signal: NodeJS.Signals | null;
+  stdout: string;
+  stderr: string;
+}
+
+type CodifySpawnOptions = {
+  cwd?: string;
+  stdioString?: boolean;
+} & SpawnOptions
+
+export async function codifySpawn(
+  cmd: string,
+  args: string[],
+  opts?: CodifySpawnOptions,
+  extras?: Record<any, any>,
+): Promise<SpawnResult> {
+  const stdio = isDebug() ? 'inherit' : 'pipe';
+  return promiseSpawn(
+    cmd,
+    args,
+    { ...opts, stdio, stdioString: true },
+    extras
+  );
+}
+
+export function isDebug(): boolean {
+  return process.env.DEBUG != null && process.env.DEBUG.includes('codify');
+}

package/tsconfig.json

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

package/tsconfig.test.json

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