feat: Added testSpawn and filter tests by OS

Author: kevinwang5658

package.json

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

src/index.ts

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

src/plugin-tester.ts

@@ -1,14 +1,15 @@
 import chalk from 'chalk';
 import {
-  ImportResponseData,
+  ImportResponseData, OS,
   PlanResponseData,
   ResourceConfig,
   ResourceOperation,
 } from 'codify-schemas';
 import unionBy from 'lodash.unionby';
 
 import { PluginProcess } from './plugin-process.js';
-import { getResourceOs, splitUserConfig } from './utils.js';
+import { getPlatformOs, splitUserConfig } from './utils.js';
+import os from 'node:os';
 
 export class PluginTester {
   static async fullTest(
@@ -26,7 +27,7 @@ export class PluginTester {
         validateModify?: (plans: PlanResponseData[]) => Promise<void> | void,
       }
   }): Promise<void> {
-    configs = configs.filter((c) => !c.os || c.os.includes(getResourceOs()));
+    configs = configs.filter((c) => !c.os || c.os.includes(getPlatformOs()));
     const ids = configs
       .map((c) => `${c.type}${c.name ? `.${c.name}` : ''}`)
       .join(', ')
@@ -50,6 +51,8 @@ export class PluginTester {
         throw new Error(`The plugin does not support the following configs supplied:\n ${JSON.stringify(unsupportedConfigs, null, 2)}\n Initialize result: ${JSON.stringify(initializeResult)}`)
       }
 
+      configs = configs.filter((c) => initializeResult.resourceDefinitions.find((rd) => rd.type === c.type)?.operatingSystems?.includes(os.platform() as OS));
+
       console.info(chalk.cyan('Testing validate...'))
       const validate = await plugin.validate({ configs: configs.map((c) => {
         const { coreParameters, parameters } = splitUserConfig(c)

src/spawn.ts

@@ -18,6 +18,10 @@ export interface SpawnOptions {
   stdin?: boolean,
 }
 
+export function testSpawn(cmd: string, options?: SpawnOptions): Promise<SpawnResult> {
+  return spawnSafe(cmd, { interactive: true, ...options,  });
+}
+
 export function spawnSafe(cmd: string, options?: SpawnOptions): Promise<SpawnResult> {
   if (cmd.toLowerCase().includes('sudo')) {
     throw new Error('Command must not include sudo')

src/utils.ts

@@ -20,7 +20,7 @@ export function splitUserConfig<T extends StringIndexedObject>(
   };
 }
 
-export function getResourceOs(): ResourceOs{
+export function getPlatformOs(): ResourceOs{
   const currOs = os.platform();
   switch (currOs) {
     case 'darwin': {

test/plugin-tester.test.ts

@@ -313,6 +313,17 @@ describe('Plugin tester integration tests', () => {
     }
   })
 
+  it('Can filter out unsupported configs based on OS', { timeout: 300000 }, async () => {
+      await PluginTester.fullTest(pluginPath, [{
+        type: 'windows-only',
+      }], {
+        validatePlan(plan) {
+          expect(plan.length).to.eq(0);
+        }
+      });
+  });
+
+
 
   // it('Can uninstall two resources with the same type', async () => {
   //   await plugin.fullTest([{

test/test-plugin.ts

@@ -1,14 +1,14 @@
 import {
   CreatePlan,
-  DestroyPlan, ModifyPlan,
+  DestroyPlan,
+  ModifyPlan,
   ParameterChange,
   Plugin,
   Resource,
   ResourceSettings,
   runPlugin
 } from 'codify-plugin-lib';
-import { StringIndexedObject } from 'codify-schemas';
-import { b } from 'vitest/dist/reporters-yx5ZTtEV';
+import { OS, StringIndexedObject } from 'codify-schemas';
 import * as fs from 'node:fs';
 
 export interface TestConfig extends StringIndexedObject {
@@ -27,6 +27,7 @@ export class TestResource extends Resource<TestConfig> {
   getSettings(): ResourceSettings<TestConfig> {
     return {
       id: 'test',
+      operatingSystems: [OS.Linux, OS.Darwin],
       allowMultiple: true,
     };
   }
@@ -54,6 +55,7 @@ export class TestResource2 extends Resource<TestConfig2> {
   getSettings(): ResourceSettings<TestConfig2> {
     return {
       id: 'test2',
+      operatingSystems: [OS.Linux, OS.Darwin],
       parameterSettings: {
         propB: { type: 'array' }
       }
@@ -82,7 +84,8 @@ export class TestUninstallResource extends Resource<TestConfig> {
   first = true;
   getSettings(): ResourceSettings<TestConfig> {
     return {
-      id: 'test-uninstall'
+      id: 'test-uninstall',
+      operatingSystems: [OS.Linux, OS.Darwin],
     }
   }
 
@@ -106,6 +109,7 @@ export class TestModifyResource extends Resource<TestConfig> {
   getSettings(): ResourceSettings<TestConfig> {
     return {
       id: 'test-modify',
+      operatingSystems: [OS.Linux, OS.Darwin],
       parameterSettings: {
         propA: { type: 'string', canModify: true },
         propB: { type: 'string', canModify: true },
@@ -141,6 +145,7 @@ export class TestDestroyResource extends Resource<TestConfig> {
   getSettings(): ResourceSettings<TestConfig> {
     return {
       id: 'test-destroy',
+      operatingSystems: [OS.Linux, OS.Darwin],
     }
   }
 
@@ -165,6 +170,29 @@ export class TestDestroyResource extends Resource<TestConfig> {
   }
 }
 
+export class WindowsOnlyResource extends Resource<TestConfig> {
+  private name: string;
+
+  getSettings(): ResourceSettings<TestConfig> {
+    return {
+      id: 'windows-only',
+      operatingSystems: [OS.Windows],
+    }
+  }
+
+  async refresh(parameters: Partial<TestConfig>): Promise<Array<Partial<TestConfig>> | Partial<TestConfig> | null> {
+    return {};
+  }
+
+  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> {}
+}
+
 export class TestDestroyResource2 extends TestDestroyResource {
   getSettings(): ResourceSettings<TestConfig> {
     return {
@@ -181,6 +209,7 @@ runPlugin(Plugin.create(
     new TestUninstallResource(),
     new TestModifyResource(),
     new TestDestroyResource(),
-    new TestDestroyResource2()
+    new TestDestroyResource2(),
+    new WindowsOnlyResource(),
   ]
 ));