codify-plugin-test 0.0.53-beta2 → 0.0.53-beta20

package/dist/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,eAAe,CAC7B,MAA0B;IAE1B,MAAM,cAAc,GAAG;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7D,CAAC;IAGF,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;IAExD,OAAO;QACL,UAAU,EAAE,UAAe;QAC3B,cAAc;KACf,CAAC;AACJ,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,UAAU,EAAuB,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB,MAAM,UAAU,eAAe,CAC7B,MAA0B;IAE1B,MAAM,cAAc,GAAG;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5D,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACxC,CAAC;IAEF,6DAA6D;IAC7D,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC;IAE5D,OAAO;QACL,UAAU,EAAE,UAAe;QAC3B,cAAc;KACf,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,MAAM,MAAM,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAC7B,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,UAAU,CAAC,KAAK,CAAC;QAC1B,CAAC;QAED,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,UAAU,CAAC,KAAK,CAAC;QAC1B,CAAC;QAED,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,UAAU,CAAC,OAAO,CAAC;QAC5B,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-test",
-  "version": "0.0.53-beta2",
+  "version": "0.0.53-beta20",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -16,7 +16,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
-    "codify-schemas": "1.0.86-beta5",
+    "codify-schemas": "1.0.86-beta7",
     "lodash.matches": "^4.6.0",
     "lodash.differencewith": "4.5.0",
     "lodash.unionby": "^4.8.0",
@@ -37,7 +37,7 @@
     "eslint-config-oclif-typescript": "^3",
     "eslint-config-prettier": "^9.0.0",
     "tsx": "^4.7.3",
-    "typescript": "^5",
+    "typescript": "5.3.3",
     "vitest": "^1.4.0",
     "codify-plugin-lib": "1.0.182-beta9"
   },

package/src/index.ts

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

package/src/plugin-process.ts

@@ -21,7 +21,7 @@ import * as os from 'node:os';
 import path from 'node:path';
 
 import { spawnSafe } from './spawn.js';
-import { CodifyTestUtils } from './test-utils.js';
+import { TestUtils } from './test-utils.js';
 
 const ajv = new Ajv.default({
   strict: true
@@ -64,7 +64,7 @@ export class PluginProcess {
   }
 
   async initialize(): Promise<InitializeResponseData> {
-    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+    return TestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'initialize',
       data: { verbosityLevel: 3 },
       requestId: nanoid(6),
@@ -72,7 +72,7 @@ export class PluginProcess {
   }
 
   async validate(data: ValidateRequestData): Promise<ValidateResponseData> {
-    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+    return TestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'validate',
       data,
       requestId: nanoid(6),
@@ -80,7 +80,7 @@ export class PluginProcess {
   }
 
   async plan(data: PlanRequestData): Promise<PlanResponseData> {
-    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+    return TestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'plan',
       data,
       requestId: nanoid(6),
@@ -88,7 +88,7 @@ export class PluginProcess {
   }
 
   async apply(data: ApplyRequestData): Promise<void> {
-    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+    return TestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'apply',
       data,
       requestId: nanoid(6),
@@ -96,7 +96,7 @@ export class PluginProcess {
   }
 
   async import(data: ImportRequestData): Promise<ImportResponseData> {
-    return CodifyTestUtils.sendMessageAndAwaitResponse(this.childProcess, {
+    return TestUtils.sendMessageAndAwaitResponse(this.childProcess, {
       cmd: 'import',
       data,
       requestId: nanoid(6),
@@ -107,9 +107,9 @@ export class PluginProcess {
     this.childProcess.kill();
   }
 
-  private handleIncomingRequests(process: ChildProcess) {
+  private handleIncomingRequests(cp: ChildProcess) {
     // Listen for incoming sudo incoming sudo requests
-    process.on('message', async (message) => {
+    cp.on('message', async (message) => {
       if (!ipcMessageValidator(message)) {
         throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
       }
@@ -123,7 +123,7 @@ export class PluginProcess {
         const { command, options } = data as unknown as CommandRequestData;
         const result = await spawnSafe(command, options);
 
-        process.send(<IpcMessageV2>{
+        cp.send(<IpcMessageV2>{
           cmd: MessageCmd.COMMAND_REQUEST + '_Response',
           data: result,
           requestId,
@@ -136,7 +136,7 @@ export class PluginProcess {
           throw new Error(`Invalid sudo request from plugin. ${JSON.stringify(commandRequestValidator.errors, null, 2)}`);
         }
 
-        process.send(<IpcMessageV2>{
+        cp.send(<IpcMessageV2>{
           cmd: MessageCmd.PRESS_KEY_TO_CONTINUE_REQUEST + '_Response',
           data: {},
           requestId,
@@ -146,19 +146,14 @@ export class PluginProcess {
       if (message.cmd === MessageCmd.CODIFY_CREDENTIALS_REQUEST) {
         const { requestId } = message;
 
-        const loginJson = await fs.readFile(path.join(os.homedir(), '.codify', 'credentials.json'), 'utf8');
-        if (!loginJson) {
-          throw new Error('Unable to get login credentials')
+        const testJwt = process.env.VITE_CODIFY_TEST_JWT;
+        if (!testJwt) {
+          throw new Error('Unable to parse login credentials from VITE_CODIFY_TEST_JWT env var. Please set and try again');
         }
 
-        const login = JSON.parse(loginJson);
-        if (!login) {
-          throw new Error('Unable to parse login credentials')
-        }
-
-        process.send(<IpcMessageV2>{
+        cp.send(<IpcMessageV2>{
           cmd: MessageCmd.CODIFY_CREDENTIALS_REQUEST + '_Response',
-          data: login.accessToken,
+          data: testJwt,
           requestId,
         })
       }

package/src/plugin-tester.ts

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import {
-  ImportResponseData,
+  ImportResponseData, OS,
   PlanResponseData,
   ResourceConfig,
   ResourceOperation,
@@ -8,7 +8,8 @@ import {
 import unionBy from 'lodash.unionby';
 
 import { PluginProcess } from './plugin-process.js';
-import { splitUserConfig } from './utils.js';
+import { getPlatformOs, splitUserConfig } from './utils.js';
+import os from 'node:os';
 
 export class PluginTester {
   static async fullTest(
@@ -25,9 +26,13 @@ export class PluginTester {
         modifiedConfigs: ResourceConfig[],
         validateModify?: (plans: PlanResponseData[]) => Promise<void> | void,
       }
-  }): Promise<void> {
-    const ids = configs.map((c) => c.name ? `${c.type}.${c.name}` : c.type).join(', ')
-    console.info(chalk.cyan(`Starting full test of [ ${ids} ]...`))
+    }): Promise<void> {
+    configs = configs.filter((c) => !c.os || c.os.includes(getPlatformOs()));
+    const ids = configs
+      .map((c) => `${c.type}${c.name ? `.${c.name}` : ''}`)
+      .join(', ')
+    console.info(chalk.cyan(`Starting full test of [ ${ids} ]...`));
+
 
     const {
       skipUninstall = false,
@@ -46,11 +51,15 @@ 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)
-        return { core: coreParameters, parameters };
-      }) });
+      const validate = await plugin.validate({
+        configs: configs.map((c) => {
+          const { coreParameters, parameters } = splitUserConfig(c)
+          return { core: coreParameters, parameters };
+        })
+      });
 
       const invalidConfigs = validate.resourceValidations.filter((v) => !v.isValid)
       if (invalidConfigs.length > 0) {
@@ -61,7 +70,7 @@ export class PluginTester {
       const plans = [];
       for (const config of configs) {
         const { coreParameters, parameters } = splitUserConfig(config);
-        
+
         plans.push(await plugin.plan({
           core: coreParameters,
           desired: parameters,
@@ -91,7 +100,7 @@ export class PluginTester {
     if (!options?.skipImport) {
       const importPlugin = new PluginProcess(pluginPath);
       try {
-        await plugin.initialize();
+        await importPlugin.initialize();
         console.info(chalk.cyan('Testing import...'))
 
         const importResults = [];
@@ -114,13 +123,13 @@ export class PluginTester {
       const modifyPlugin = new PluginProcess(pluginPath);
 
       try {
-        await plugin.initialize();
+        await modifyPlugin.initialize();
         console.info(chalk.cyan('Testing modify...'))
 
         const modifyPlans = [];
         for (const config of options.testModify.modifiedConfigs) {
           const { coreParameters, parameters } = splitUserConfig(config);
-          
+
           modifyPlans.push(await modifyPlugin.plan({
             core: coreParameters,
             desired: parameters,
@@ -160,6 +169,59 @@ ${JSON.stringify(modifyPlans, null, 2)}`)
     }
   }
 
+  static async install(pluginPath: string, configs: ResourceConfig[]) {
+    const plugin = new PluginProcess(pluginPath);
+
+    try {
+      console.info(chalk.cyan('Testing initialization...'))
+      const initializeResult = await plugin.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)}`)
+      }
+
+      // 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)
+          return { core: coreParameters, parameters };
+        })
+      });
+
+      const invalidConfigs = validate.resourceValidations.filter((v) => !v.isValid)
+      if (invalidConfigs.length > 0) {
+        throw new Error(`The following configs did not validate:\n ${JSON.stringify(invalidConfigs, null, 2)}`)
+      }
+
+      console.info(chalk.cyan('Testing plan...'))
+      const plans = [];
+      for (const config of configs) {
+        const { coreParameters, parameters } = splitUserConfig(config);
+
+        plans.push(await plugin.plan({
+          core: coreParameters,
+          desired: parameters,
+          isStateful: false,
+          state: undefined,
+        }));
+      }
+
+      console.info(chalk.cyan('Testing apply...'))
+      for (const plan of plans) {
+        await plugin.apply({
+          planId: plan.planId
+        });
+      }
+    } finally {
+      plugin.kill();
+    }
+  }
+
   static async uninstall(pluginPath: string, configs: ResourceConfig[], options?: {
     validateDestroy?: (plans: PlanResponseData[]) => Promise<void> | void
   }) {
@@ -172,7 +234,7 @@ ${JSON.stringify(modifyPlans, null, 2)}`)
       const plans = [];
       for (const config of configs) {
         const { coreParameters, parameters } = splitUserConfig(config);
-        
+
         plans.push(await destroyPlugin.plan({
           core: coreParameters,
           isStateful: true,
@@ -206,7 +268,9 @@ ${JSON.stringify(modifyPlans, null, 2)}`)
     for (const type of typeSet) {
       const sameTypeConfigs = configs.filter((c) => c.type === type);
       if (sameTypeConfigs.length > 1) {
-        sameTypeConfigs.forEach((c, idx) => { c.name = c.name ?? idx.toString() });
+        sameTypeConfigs.forEach((c, idx) => {
+          c.name = c.name ?? idx.toString()
+        });
       }
 
       configsWithNames.push(...sameTypeConfigs);

package/src/spawn.ts

@@ -18,12 +18,16 @@ 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')
   }
 
-  process.stdout.write(`Running command: ${options?.requiresRoot ? 'sudo' : ''} ${cmd}` + (options?.cwd ? `(${options?.cwd})` : ''))
+  console.log(`Running command: ${options?.requiresRoot ? 'sudo' : ''} ${cmd}` + (options?.cwd ? `(${options?.cwd})` : ''))
 
   return new Promise((resolve) => {
     const output: string[] = [];
@@ -40,7 +44,7 @@ export function spawnSafe(cmd: string, options?: SpawnOptions): Promise<SpawnRes
     }
 
     // Initial terminal dimensions
-    const initialCols = process.stdout.columns ?? 80;
+    const initialCols = process.stdout.columns ?? 2000;
     const initialRows = process.stdout.rows ?? 24;
 
     const command = options?.requiresRoot ? `sudo ${cmd}` : cmd;

package/src/test-utils.test.ts

@@ -1,7 +1,7 @@
 import { EventEmitter } from 'node:events';
 import { ChildProcess } from 'node:child_process';
 import { Readable } from 'stream';
-import { CodifyTestUtils } from './test-utils.js';
+import { TestUtils } from './test-utils.js';
 import { describe, expect, it, vi } from 'vitest';
 import { MessageStatus } from 'codify-schemas';
 import { nanoid } from 'nanoid';
@@ -22,7 +22,7 @@ describe('Test Utils tests', async () => {
     const sendMock = vi.spyOn(process, 'send');
     const requestId = nanoid(6);
 
-    CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId })
+    TestUtils.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', requestId });
@@ -38,7 +38,7 @@ describe('Test Utils tests', async () => {
         // 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', requestId })
       })(),
-      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
+      TestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
     ]);
 
     expect(result[1]).to.eq('data')
@@ -54,7 +54,7 @@ describe('Test Utils tests', async () => {
         // 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', requestId })
       })(),
-      CodifyTestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
+      TestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
     ])).rejects.toThrowError(new Error('error message'))
   });
 
@@ -70,7 +70,7 @@ describe('Test Utils tests', async () => {
         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', requestId }),
+      TestUtils.sendMessageAndAwaitResponse(process, { cmd: 'message', data: 'data', requestId }),
     ]);
 
     // Only the final _Response message should be returned.

package/src/test-utils.ts

@@ -1,13 +1,18 @@
 import Ajv from 'ajv';
-import { IpcMessageSchema, IpcMessageV2, MessageStatus } from 'codify-schemas';
+import { IpcMessageSchema, IpcMessageV2, MessageStatus, ResourceOs, SpawnStatus } from 'codify-schemas';
 import { ChildProcess } from 'node:child_process';
+import os from 'node:os';
+import path from 'node:path';
+
+import { PluginTester } from './plugin-tester.js';
+import { testSpawn } from './spawn.js';
 
 const ajv = new Ajv.default({
   strict: true
 });
 const ipcMessageValidator = ajv.compile(IpcMessageSchema);
 
-export const CodifyTestUtils = {
+export const TestUtils = {
   sendMessageAndAwaitResponse(process: ChildProcess, message: IpcMessageV2): Promise<any> {
     return new Promise((resolve, reject) => {
       process.on('message', (response: IpcMessageV2) => {
@@ -30,4 +35,113 @@ export const CodifyTestUtils = {
     });
   },
 
+  async ensureHomebrewInstalledOnMacOs(pluginPath: string) {
+    const homebrewQuery = await testSpawn('which homebrew');
+    if (homebrewQuery.status !== SpawnStatus.SUCCESS) {
+      await PluginTester.install(pluginPath, [{ type: 'homebrew', os: [ResourceOs.MACOS] }])
+    }
+  },
+
+  async ensureXcodeInstalledOnMacOs(pluginPath: string) {
+    const xcodeQuery = await testSpawn('xcodebuild -version');
+    if (xcodeQuery.status !== SpawnStatus.SUCCESS) {
+      await PluginTester.install(pluginPath, [{ type: 'xcode-tools', os: [ResourceOs.MACOS] }])
+    }
+  },
+
+
+  getShell(): 'bash' | 'zsh' {
+    const shell = process.env.SHELL || '';
+
+    if (shell.includes('bash')) {
+      return 'bash';
+    }
+
+    if (shell.includes('zsh')) {
+      return 'zsh';
+    }
+
+    // Default to bash for tests
+    return 'bash';
+  },
+
+  /**
+   * Get the primary shell rc file path
+   */
+  getPrimaryShellRc(): string {
+    const shell = TestUtils.getShell();
+    const homeDir = os.homedir();
+
+    if (shell === 'bash') {
+      return path.join(homeDir, '.bashrc')
+    }
+
+    if (shell === 'zsh') {
+      return path.join(homeDir, '.zshrc');
+    }
+
+    throw new Error('Unsupported shell')
+  },
+
+  /**
+   * Get the source command for the shell rc file
+   * Usage: execSync(TestUtils.getSourceCommand())
+   */
+  getSourceCommand(): string {
+    return `source ${TestUtils.getPrimaryShellRc()}`;
+  },
+
+  /**
+   * Get shell-specific command to run with sourced environment
+   * Usage: execSync(TestUtils.getShellCommand('which brew'))
+   */
+  getShellCommand(command: string): string {
+    return `${TestUtils.getSourceCommand()}; ${command}`;
+  },
+
+  /**
+   * Get shell name for execSync shell option
+   */
+  getShellName(): string {
+    return TestUtils.getShell();
+  },
+
+  /**
+   * Get interactive shell command
+   * Usage: execSync(TestUtils.getInteractiveCommand('my-alias'))
+   */
+  getInteractiveCommand(command: string): string {
+    const shell = TestUtils.getShell();
+
+    return shell === 'bash'
+      ? `bash -i -c "${command}"`
+      : `zsh -i -c "${command}"`;
+  },
+
+  /**
+   * Get which command output format based on shell
+   */
+  getAliasWhichCommand(aliasName: string): string {
+    const shell = TestUtils.getShell();
+
+    // zsh outputs: "alias_name: aliased to command"
+    // bash outputs: "alias alias_name='command'"
+    return shell === 'bash'
+      ? `${TestUtils.getShellCommand(`alias ${aliasName}`)}`
+      : `${TestUtils.getShellCommand(`which ${aliasName}`)}`;
+  },
+
+  /**
+   * Check if running on macOS
+   */
+  isMacOS(): boolean {
+    return os.platform() === 'darwin';
+  },
+
+  /**
+   * Check if running on Linux
+   */
+  isLinux(): boolean {
+    return os.platform() === 'linux';
+  },
 };

package/src/utils.ts

@@ -1,4 +1,5 @@
-import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+import { ResourceConfig, ResourceOs, StringIndexedObject } from 'codify-schemas';
+import os from 'node:os';
 
 export function splitUserConfig<T extends StringIndexedObject>(
   config: ResourceConfig & T
@@ -7,13 +8,35 @@ export function splitUserConfig<T extends StringIndexedObject>(
     type: config.type,
     ...(config.name ? { name: config.name } : {}),
     ...(config.dependsOn ? { dependsOn: config.dependsOn } : {}),
+    ...(config.os ? { os: config.os } : {}),
   };
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  const { type, name, dependsOn, ...parameters } = config;
+  const { type, name, dependsOn, os, ...parameters } = config;
 
   return {
     parameters: parameters as T,
     coreParameters,
   };
 }
+
+export function getPlatformOs(): ResourceOs{
+  const currOs = os.platform();
+  switch (currOs) {
+    case 'darwin': {
+      return ResourceOs.MACOS;
+    }
+
+    case 'linux': {
+      return ResourceOs.LINUX;
+    }
+
+    case 'win32': {
+      return ResourceOs.WINDOWS;
+    }
+
+    default: {
+      throw new Error(`Unsupported OS: ${currOs}`);
+    }
+  }
+}

package/test/plugin-tester.test.ts

@@ -27,14 +27,14 @@ describe('Plugin tester integration tests', () => {
 
     const result = await plugin.initialize();
     expect(result).toMatchObject({
-      resourceDefinitions: [
-        { dependencies: [], type: 'test' },
-        { dependencies: [], type: 'test2' },
-        { dependencies: [], type: 'test-uninstall' },
-        { dependencies: [], type: 'test-modify' },
-        { dependencies: [], type: 'test-destroy' },
-        { dependencies: [], type: 'test-destroy-2' }
-      ]
+      resourceDefinitions: expect.arrayContaining([
+        expect.objectContaining({ dependencies: [], type: 'test' }),
+        expect.objectContaining({ dependencies: [], type: 'test2' }),
+        expect.objectContaining({ dependencies: [], type: 'test-uninstall' }),
+        expect.objectContaining({ dependencies: [], type: 'test-modify' }),
+        expect.objectContaining({ dependencies: [], type: 'test-destroy' }),
+        expect.objectContaining({ dependencies: [], type: 'test-destroy-2' }),
+      ])
     })
   })
 
@@ -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([{