feat: Add file and action resources

Author: kevinwang5658

src/index.ts

@@ -16,6 +16,8 @@ import { JenvResource } from './resources/java/jenv/jenv.js';
 import { NvmResource } from './resources/node/nvm/nvm.js';
 import { PgcliResource } from './resources/pgcli/pgcli.js';
 import { PyenvResource } from './resources/python/pyenv/pyenv.js';
+import { ActionResource } from './resources/scripting/action.js';
+import { FileResource } from './resources/scripting/file.js';
 import { AliasResource } from './resources/shell/alias/alias-resource.js';
 import { PathResource } from './resources/shell/path/path-resource.js';
 import { SshAddResource } from './resources/ssh/ssh-add.js';
@@ -51,6 +53,8 @@ runPlugin(Plugin.create(
     new AsdfInstallResource(),
     new SshKeyResource(),
     new SshConfigFileResource(),
-    new SshAddResource()
+    new SshAddResource(),
+    new ActionResource(),
+    new FileResource()
   ])
 )

src/resources/scripting/action-schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/action.json",
+  "title": "Action resource",
+  "type": "object",
+  "properties": {
+    "condition": {
+      "type": "string"
+    },
+    "action": {
+      "type": "string"
+    },
+    "cwd": {
+      "type": "string"
+    }
+  },
+  "required": ["action"],
+  "additionalProperties": false
+}

src/resources/scripting/action.ts

@@ -0,0 +1,49 @@
+import { CreatePlan, DestroyPlan, Resource, ResourceSettings } from 'codify-plugin-lib';
+import { StringIndexedObject } from 'codify-schemas';
+
+import { SpawnStatus, codifySpawn } from '../../utils/codify-spawn.js';
+import schema from './action-schema.json'
+
+export interface ActionConfig extends StringIndexedObject {
+  condition?: string;
+  action: string;
+  cwd?: string;
+}
+
+export class ActionResource extends Resource<ActionConfig> {
+  
+  getSettings(): ResourceSettings<ActionConfig> {
+    return {
+      id: 'action',
+      schema,
+      parameterSettings: {
+        cwd: { type: 'directory' },
+      }
+    }
+  }
+  
+  async refresh(parameters: Partial<ActionConfig>): Promise<Partial<ActionConfig> | Partial<ActionConfig>[] | null> {
+    // Always run if condition doesn't exist
+    // TODO: Remove hack. Right now we're returning null to simulate CREATE and a value for NO-OP
+    if (!parameters.condition) {
+      return null;
+    }
+    
+    const { condition, action, cwd } = parameters;
+    const { status } = await codifySpawn(condition, { throws: false, cwd: cwd ?? undefined });
+
+    return status === SpawnStatus.ERROR
+      ? null
+      : {
+        ...(condition ? { condition } : undefined),
+        ...(action ? { action } : undefined),
+        ...(cwd ? { cwd } : undefined),
+      };
+  }
+  
+  async create(plan: CreatePlan<ActionConfig>): Promise<void> {
+    await codifySpawn(plan.desiredConfig.action, { cwd: plan.desiredConfig.cwd ?? undefined });
+  }
+  
+  async destroy(plan: DestroyPlan<ActionConfig>): Promise<void> {}
+}

src/resources/scripting/file-schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/file.json",
+  "title": "File resource",
+  "type": "object",
+  "properties": {
+    "path": {
+      "type": "string"
+    },
+    "contents": {
+      "type": "string"
+    },
+    "onlyCreate": {
+      "type": "boolean"
+    }
+  },
+  "required": ["path", "contents"],
+  "additionalProperties": false
+}

src/resources/scripting/file.ts

@@ -0,0 +1,73 @@
+import { CreatePlan, DestroyPlan, ModifyPlan, ParameterChange, Resource, ResourceSettings } from 'codify-plugin-lib';
+import { StringIndexedObject } from 'codify-schemas';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+import { FileUtils } from '../../utils/file-utils.js';
+import schema from './file-schema.json'
+
+export interface FileConfig extends StringIndexedObject {
+  path: string;
+  contents: string;
+  onlyCreate: boolean;
+}
+
+export class FileResource extends Resource<FileConfig> {
+  getSettings(): ResourceSettings<FileConfig> {
+    return {
+      id: 'file',
+      schema,
+      parameterSettings: {
+        path: { type: 'directory' },
+        contents: { canModify: true },
+        onlyCreate: { type: 'boolean' }
+      },
+      import: {
+        requiredParameters: ['path']
+      }
+    }
+  }
+
+  async refresh(parameters: Partial<FileConfig>): Promise<Partial<FileConfig> | Partial<FileConfig>[] | null> {
+    const filePath  = parameters.path!;
+
+    if (!(await FileUtils.exists(filePath))) {
+      return null;
+    }
+
+    const isFile = (await fs.lstat(filePath)).isFile()
+    if (!isFile) {
+      throw new Error(`A directory exists at ${filePath}`)
+    }
+
+    // If we only care that the contents of the file is created then there's no point checking the contents
+    const { onlyCreate } = parameters;
+    if (onlyCreate) {
+      return parameters;
+    }
+
+    const contents = (await fs.readFile(filePath)).toString('utf8');
+    return {
+      path: parameters.path,
+      contents,
+      onlyCreate,
+    }
+  }
+
+  async create(plan: CreatePlan<FileConfig>): Promise<void> {
+    const { contents, path } = plan.desiredConfig;
+
+    await fs.writeFile(path, contents, 'utf8');
+  }
+
+  async modify(pc: ParameterChange<FileConfig>, plan: ModifyPlan<FileConfig>): Promise<void> {
+    const filePath = path.resolve(plan.desiredConfig.path!);
+    const { contents } = plan.desiredConfig;
+
+    await fs.writeFile(filePath, contents, 'utf8');
+  }
+
+  async destroy(plan: DestroyPlan<FileConfig>): Promise<void> {
+    await fs.rm(path.resolve(plan.currentConfig.path));
+  }
+}

test/scripting/action.test.ts

@@ -0,0 +1,70 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+import { PluginTester } from 'codify-plugin-test';
+import path from 'node:path';
+import { ResourceOperation } from 'codify-schemas';
+import fs from 'node:fs';
+import os from 'node:os';
+
+describe('Action tests', () => {
+  let plugin: PluginTester;
+
+  beforeEach(() => {
+    plugin = new PluginTester(path.resolve('./src/index.ts'));
+  })
+
+  it('Can run an action if the condition returns as non-zero', { timeout: 300000 }, async () => {
+    await plugin.fullTest([
+      { type: 'action', condition: '[ -d ~/tmp ]', action: 'mkdir ~/tmp; touch ~/tmp/testFile' }
+    ], {
+      skipUninstall: true,
+      validateApply: (plans) => {
+        expect(plans[0]).toMatchObject({
+          operation: ResourceOperation.CREATE,
+        })
+
+        const dir = fs.readdirSync(path.resolve(os.homedir(), 'tmp'))
+        expect(dir[0]).to.eq('testFile')
+      }
+    })
+  })
+
+  it('It will return NO-OP when the return is 0', { timeout: 300000 }, async () => {
+    await plugin.fullTest([
+      { type: 'action', condition: 'exit 0;', action: 'mkdir ~/tmp; touch ~/tmp/testFile' }
+    ], {
+      skipUninstall: true,
+      validatePlan: (plans) => {
+        expect(plans[0]).toMatchObject({
+          operation: ResourceOperation.NOOP,
+        })
+      }
+    })
+  })
+
+  it('It can use the cwd parameter to run all commands from a specific directory', { timeout: 300000 }, async () => {
+    fs.mkdirSync(path.resolve(os.homedir(), 'tmp2'))
+    await plugin.fullTest([
+      { type: 'action', condition: '[ -e testFile ]', action: 'touch testFile', cwd: '~/tmp2' }
+    ], {
+      skipUninstall: true,
+      validatePlan: (plans) => {
+        expect(plans[0]).toMatchObject({
+          operation: ResourceOperation.CREATE,
+        })
+      }
+    })
+
+    expect(fs.existsSync(path.resolve(os.homedir(), 'tmp2', 'testFile'))).to.be.true;
+
+    await plugin.fullTest([
+      { type: 'action', condition: '[ -e testFile ]', action: 'touch testFile', cwd: '~/tmp2' }
+    ], {
+      skipUninstall: true,
+      validatePlan: (plans) => {
+        expect(plans[0]).toMatchObject({
+          operation: ResourceOperation.NOOP,
+        })
+      }
+    })
+  })
+})

test/scripting/file.test.ts

@@ -0,0 +1,78 @@
+import { beforeEach, describe, expect, it } from 'vitest';
+import { PluginTester } from 'codify-plugin-test';
+import path from 'node:path';
+import { ResourceOperation } from 'codify-schemas';
+import fs from 'node:fs';
+import os from 'node:os';
+
+describe('File resource tests', () => {
+  let plugin: PluginTester;
+
+  beforeEach(() => {
+    plugin = new PluginTester(path.resolve('./src/index.ts'));
+  })
+
+  it('Can create a file, modify the contents and delete it', { timeout: 300000 }, async () => {
+    const contents = 'AWS_ACCESS_KEY_ID=\n' +
+      'AWS_SECRET_ACCESS_KEY=\n' +
+      'AWS_S3_ENDPOINT=\n' +
+      'AWS_REGION=\n';
+
+    await plugin.fullTest([
+      { type: 'file',
+        path: '~/.env',
+        contents
+      }
+    ], {
+      validateApply: (plans) => {
+        expect(plans[0]).toMatchObject({
+          operation: ResourceOperation.CREATE,
+        })
+
+        expect(fs.readFileSync(path.resolve(os.homedir(), '.env'), 'utf-8')).to.eq(contents);
+      },
+      testModify: {
+        modifiedConfigs: [{
+          type: 'file',
+          path: '~/.env',
+          contents: 'testing\ntest',
+        }],
+        validateModify: (plans) => {
+          expect(plans[0]).toMatchObject({
+            operation: ResourceOperation.MODIFY,
+          })
+          expect(fs.readFileSync(path.resolve(os.homedir(), '.env'), 'utf-8')).to.eq('testing\ntest');
+        }
+      },
+      validateDestroy: () => {
+        expect(fs.existsSync(path.resolve(os.homedir(), '.env'))).to.be.false;
+      }
+    })
+  })
+
+  it('Will throw an error if the path given is a directory', { timeout: 300000 }, async () => {
+    fs.mkdirSync(path.resolve(os.homedir(), 'tmp'))
+
+    await expect(async () => plugin.fullTest([
+      { type: 'file', path: '~/tmp', contents: 'anything' }
+    ])).rejects.toThrow();
+  })
+
+  it('Will not modify a file if already created and onlyCreate is set to true', { timeout: 300000 }, async () => {
+    const filePath = path.resolve(os.homedir(), 'testFile');
+    fs.writeFileSync(filePath, 'this is the previous file', 'utf-8')
+
+    await plugin.fullTest([
+      { type: 'file', path: filePath, contents: 'anything', onlyCreate: true }
+    ], {
+      skipUninstall: true,
+      validatePlan(plans) {
+        expect(plans[0]).toMatchObject({
+          operation: ResourceOperation.NOOP,
+        })
+      }
+    })
+
+    expect(fs.readFileSync(filePath, 'utf-8')).to.eq('this is the previous file');
+  })
+})