codify-plugin-lib 1.0.181 → 1.0.182-beta2

package/src/resource/resource-settings.test.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it } from 'vitest';
 import { Plan } from '../plan/plan.js';
 import { spy } from 'sinon';
-import { ParameterOperation, ResourceOperation } from 'codify-schemas';
+import { OS, ParameterOperation, ResourceOperation } from 'codify-schemas';
 import {
   TestArrayStatefulParameter,
   TestConfig,
@@ -26,6 +26,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameter }
           },
@@ -71,6 +72,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy }
           },
@@ -105,6 +107,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy },
             propB: { canModify: true },
@@ -137,7 +140,8 @@ describe('Resource parameter tests', () => {
     const statefulParameter = spy(new class extends TestStatefulParameter {
       getSettings(): ParameterSetting {
         return {
-          default: 'abc'
+          default: 'abc',
+          operatingSystems: [OS.Darwin],
         };
       }
 
@@ -150,6 +154,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameter }
           },
@@ -191,6 +196,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy },
           },
@@ -225,6 +231,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy }
           },
@@ -251,6 +258,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             hosts: {
               type: 'array',
@@ -360,6 +368,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterSpy }
           },
@@ -416,6 +425,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterA, order: 3 },
             propB: { type: 'stateful', definition: statefulParameterB, order: 1 },
@@ -494,6 +504,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'stateful', definition: statefulParameterA, order: 3 },
             propB: { type: 'stateful', definition: statefulParameterB, order: 1 },
@@ -569,6 +580,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           transformation: {
             to: (desired) => ({
               propA: 'propA',
@@ -610,6 +622,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           transformation: {
             to: (desired) => ({
               propA: 'propA',
@@ -649,6 +662,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           importAndDestroy: {
             requiredParameters: [
               'propA',
@@ -668,6 +682,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'directory' }
           }
@@ -695,6 +710,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'string', setting: true },
             propB: { type: 'number' }
@@ -737,6 +753,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           importAndDestroy: {
             requiredParameters: ['propA'],
             refreshKeys: ['propB', 'propA'],
@@ -754,6 +771,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'string', isEqual: 'version' }
           }
@@ -780,6 +798,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: { type: 'object' }
           }
@@ -822,6 +841,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: { type: 'object' }
           }
@@ -863,6 +883,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: {
               type: 'array',
@@ -968,6 +989,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: { type: 'stateful', definition: sp }
           }
@@ -1007,6 +1029,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'version' }
           }
@@ -1036,6 +1059,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'directory' }
           }
@@ -1065,6 +1089,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'directory' }
           },
@@ -1101,6 +1126,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'array', itemType: 'directory' }
           },
@@ -1127,6 +1153,7 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'directory' }
           },

package/src/resource/resource-settings.ts

@@ -1,10 +1,16 @@
 import { JSONSchemaType } from 'ajv';
-import { StringIndexedObject } from 'codify-schemas';
+import { OS, StringIndexedObject } from 'codify-schemas';
 import isObjectsEqual from 'lodash.isequal'
 import path from 'node:path';
 
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
-import { addVariablesToPath, areArraysEqual, resolvePathWithVariables, tildify, untildify } from '../utils/utils.js';
+import {
+  addVariablesToPath,
+  areArraysEqual,
+  resolvePathWithVariables,
+  tildify,
+  untildify
+} from '../utils/internal-utils.js';
 import { RefreshContext } from './resource.js';
 
 export interface InputTransformation {
@@ -22,6 +28,11 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    */
   id: string;
 
+  /**
+   * List of supported operating systems
+   */
+  operatingSystems: Array<OS>;
+
   /**
    * Schema to validate user configs with. Must be in the format JSON Schema draft07
    */

package/src/utils/index.ts

@@ -0,0 +1,140 @@
+import { OS } from 'codify-schemas';
+import os from 'node:os';
+import path from 'node:path';
+
+export enum Shell {
+  ZSH = 'zsh',
+  BASH = 'bash',
+  SH = 'sh',
+  KSH = 'ksh',
+  CSH = 'csh',
+  FISH = 'fish',
+}
+
+export interface SystemInfo {
+  os: OS;
+  shell: Shell;
+}
+
+export const Utils = {
+  getUser(): string {
+    return os.userInfo().username;
+  },
+
+  getSystemInfo() {
+    return {
+      os: os.type(),
+      shell: this.getShell(),
+    }
+  },
+
+  isMacOS(): boolean {
+    return os.platform() === 'darwin';
+  },
+
+  isLinux(): boolean {
+    return os.platform() === 'linux';
+  },
+
+  getShell(): Shell | undefined {
+    const shell = process.env.SHELL || '';
+
+    if (shell.endsWith('bash')) {
+      return Shell.BASH
+    }
+
+    if (shell.endsWith('zsh')) {
+      return Shell.ZSH
+    }
+
+    if (shell.endsWith('sh')) {
+      return Shell.SH
+    }
+
+    if (shell.endsWith('csh')) {
+      return Shell.CSH
+    }
+
+    if (shell.endsWith('ksh')) {
+      return Shell.KSH
+    }
+
+    if (shell.endsWith('fish')) {
+      return Shell.FISH
+    }
+
+    return undefined;
+  },
+
+
+  getPrimaryShellRc(): string {
+    return this.getShellRcFiles()[0];
+  },
+
+  getShellRcFiles(): string[] {
+    const shell = process.env.SHELL || '';
+    const homeDir = os.homedir();
+
+    if (shell.endsWith('bash')) {
+      // Linux typically uses .bashrc, macOS uses .bash_profile
+      if (Utils.isLinux()) {
+        return [
+          path.join(homeDir, '.bashrc'),
+          path.join(homeDir, '.bash_profile'),
+          path.join(homeDir, '.profile'),
+        ];
+      }
+
+      return [
+        path.join(homeDir, '.bash_profile'),
+        path.join(homeDir, '.bashrc'),
+        path.join(homeDir, '.profile'),
+      ];
+    }
+
+    if (shell.endsWith('zsh')) {
+      return [
+        path.join(homeDir, '.zshrc'),
+        path.join(homeDir, '.zprofile'),
+        path.join(homeDir, '.zshenv'),
+      ];
+    }
+
+    if (shell.endsWith('sh')) {
+      return [
+        path.join(homeDir, '.profile'),
+      ]
+    }
+
+    if (shell.endsWith('ksh')) {
+      return [
+        path.join(homeDir, '.profile'),
+        path.join(homeDir, '.kshrc'),
+      ]
+    }
+
+    if (shell.endsWith('csh')) {
+      return [
+        path.join(homeDir, '.cshrc'),
+        path.join(homeDir, '.login'),
+        path.join(homeDir, '.logout'),
+      ]
+    }
+
+    if (shell.endsWith('fish')) {
+      return [
+        path.join(homeDir, '.config/fish/config.fish'),
+      ]
+    }
+
+    // Default to bash-style files
+    return [
+      path.join(homeDir, '.bashrc'),
+      path.join(homeDir, '.bash_profile'),
+      path.join(homeDir, '.profile'),
+    ];
+  },
+};
+
+
+

package/src/utils/{utils.test.ts → internal-utils.test.ts}

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { addVariablesToPath, resolvePathWithVariables, splitUserConfig } from './utils.js';
+import { addVariablesToPath, resolvePathWithVariables, splitUserConfig } from './internal-utils.js';
 import os from 'node:os';
 
 describe('Utils tests', () => {

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

@@ -1,4 +1,4 @@
-import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+import { OS, ResourceConfig, StringIndexedObject } from 'codify-schemas';
 import { ResourceSettings } from '../resource/resource-settings.js';
 import { Plan } from '../plan/plan.js';
 import { Resource } from '../resource/resource.js';
@@ -35,7 +35,10 @@ export interface TestConfig extends StringIndexedObject {
 
 export class TestResource extends Resource<TestConfig> {
   getSettings(): ResourceSettings<TestConfig> {
-    return { id: 'type' }
+    return {
+      id: 'type',
+      operatingSystems: [OS.Darwin]
+    }
   }
 
   create(plan: CreatePlan<TestConfig>): Promise<void> {