feat: Added ability to find all parameters for certain resources that allow multiple. General bug fixes and improvements

Author: kevinwang5658

package.json

@@ -23,7 +23,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "semver": "^7.6.0",
-    "codify-plugin-lib": "1.0.166",
+    "codify-plugin-lib": "1.0.170",
     "codify-schemas": "1.0.63",
     "chalk": "^5.3.0",
     "debug": "^4.3.4",

src/index.ts

@@ -8,7 +8,7 @@ import { AsdfLocalResource } from './resources/asdf/asdf-local.js';
 import { AsdfPluginResource } from './resources/asdf/asdf-plugin.js';
 import { AwsCliResource } from './resources/aws-cli/cli/aws-cli.js';
 import { AwsProfileResource } from './resources/aws-cli/profile/aws-profile.js';
-import { GitCloneResource } from './resources/git/clone/git-clone.js';
+import { GitCloneResource } from './resources/git/clone/git-repository.js';
 import { GitResource } from './resources/git/git/git-resource.js';
 import { GitLfsResource } from './resources/git/lfs/git-lfs.js';
 import { HomebrewResource } from './resources/homebrew/homebrew.js';

src/resources/aws-cli/profile/aws-profile-schema.json

@@ -40,8 +40,8 @@
     }
   },
   "oneOf": [
-    { "required": ["awsAccessKeyId", "awsSecretAccessKey", "region"]},
-    { "required": ["csvCredentials", "region"] }
+    { "required": ["awsAccessKeyId", "awsSecretAccessKey"]},
+    { "required": ["csvCredentials"] }
   ],
   "additionalProperties": false
 }

src/resources/aws-cli/profile/aws-profile.ts

@@ -40,16 +40,30 @@ export class AwsProfileResource extends Resource<AwsProfileConfig> {
         csvCredentials: { type: 'directory', setting: true }, // Type setting means it won't be included in the plan calculation
         output: { default: 'json', canModify: true },
         profile: { default: 'default', canModify: true },
-        metadataServiceNumAttempts: { canModify: true },
-        metadataServiceTimeout: { canModify: true },
+        metadataServiceNumAttempts: { canModify: true, setting: true },
+        metadataServiceTimeout: { canModify: true, setting: true },
       },
       transformation: CSVCredentialsTransformation,
       importAndDestroy:{
-        refreshKeys: ['output', 'profile', 'awsAccessKeyId', 'awsSecretAccessKey', 'region'],
         requiredParameters: ['profile']
       },
       allowMultiple: {
-        identifyingParameters: ['profile']
+        identifyingParameters: ['profile'],
+        findAllParameters: async () => {
+          const $ = getPty();
+          const { status } = await $.spawnSafe('which aws');
+          if (status === 'error') {
+            return [];
+          }
+
+          const { data } = await $.spawnSafe('aws configure list-profiles')
+
+          return data
+            ?.split(/\n/)
+            ?.filter(Boolean)
+            ?.map((profile) => ({ profile }))
+          ?? [];
+        }
       }
     };
   }

src/resources/git/clone/git-clone.ts src/resources/git/clone/git-repository.tssrc/resources/git/clone/git-clone.ts renamed to src/resources/git/clone/git-repository.ts

@@ -6,7 +6,6 @@ import { codifySpawn } from '../../../utils/codify-spawn.js';
 import { FileUtils } from '../../../utils/file-utils.js';
 import Schema from './git-clone-schema.json';
 
-
 export interface GitCloneConfig extends ResourceConfig {
   autoVerifySSH: boolean
   directory?: string,
@@ -17,7 +16,7 @@ export interface GitCloneConfig extends ResourceConfig {
 export class GitCloneResource extends Resource<GitCloneConfig> {
   getSettings(): ResourceSettings<GitCloneConfig> {
     return {
-      id: 'git-clone',
+      id: 'git-repository',
       schema: Schema,
       parameterSettings: {
         parentDirectory: { type: 'directory' },
@@ -43,6 +42,16 @@ export class GitCloneResource extends Resource<GitCloneConfig> {
           }
 
           return desiredPath === currentPath;
+        },
+        findAllParameters: async () => {
+          const $ = getPty();
+          const { data } = await $.spawnSafe('find ~ -type d \\( -path $HOME/Library -o -path $HOME/Pictures -o -path $HOME/Utilities -o -path "$HOME/.*" \\) -prune -o -name .git -print')
+
+          return data
+              ?.split(/\n/)?.filter(Boolean)
+              ?.map((p) => path.dirname(p))
+              ?.map((directory) => ({ directory }))
+            ?? [];
         }
       },
       dependencies: [

src/resources/scripting/file.ts

@@ -19,10 +19,10 @@ export class FileResource extends Resource<FileConfig> {
       schema,
       parameterSettings: {
         path: { type: 'directory' },
-        contents: { canModify: true }
+        contents: { canModify: true },
+        onlyCreate: { type: 'boolean', setting: true },
       },
       importAndDestroy:{
-        refreshKeys: ['path', 'contents'],
         requiredParameters: ['path']
       },
       allowMultiple: {

src/resources/shell/alias/alias-resource.ts

@@ -31,8 +31,8 @@ export class AliasResource extends Resource<AliasConfig> {
         value: { canModify: true }
       },
       allowMultiple: {
-        identifyingParameters: ['alias']
-      }
+        identifyingParameters: ['alias'],
+      },
     }
   }
 

src/resources/ssh/ssh-key.ts

@@ -1,13 +1,14 @@
 import {
   CreatePlan,
   DestroyPlan,
-  getPty,
   ModifyPlan,
   ParameterChange,
   Resource,
-  ResourceSettings
+  ResourceSettings,
+  getPty
 } from 'codify-plugin-lib';
 import { StringIndexedObject } from 'codify-schemas';
+import fs from 'node:fs/promises';
 import os from 'node:os';
 import path from 'node:path';
 
@@ -60,6 +61,23 @@ export class SshKeyResource extends Resource<SshKeyConfig> {
       },
       allowMultiple: {
         identifyingParameters: ['fileName'],
+        async findAllParameters() {
+          try {
+            const sshPublicKeys = await fs.readdir(path.join(os.homedir(), '.ssh'));
+
+            return sshPublicKeys.filter((p) => {
+              if (!p.endsWith('.pub')) {
+                return false;
+              }
+
+              // We only want public / private pairs.
+              const name = p.slice(0, - 4);
+              return sshPublicKeys.includes(name)
+            }).map((p) => ({ fileName: p.slice(0, - 4) }))
+          } catch {
+            return [];
+          }
+        }
       }
     }
   }
@@ -142,7 +160,7 @@ export class SshKeyResource extends Resource<SshKeyConfig> {
     // Passphrase can't be called in stateless mode because we don't know what the previous password is
     if (pc.name === 'passphrase') {
       await codifySpawn(`ssh-keygen -f ${plan.desiredConfig.fileName} -N ${pc.newValue} -P ${pc.previousValue} -p`)
-      return;
+      
     }
   }
 

src/utils/codify-spawn.ts

@@ -1,15 +1,15 @@
 import { Ajv } from 'ajv';
-import { SudoError } from 'codify-plugin-lib';
+import { SudoError, VerbosityLevel } from 'codify-plugin-lib';
 import {
   IpcMessage,
   IpcMessageV2,
   MessageCmd,
   SudoRequestResponseData,
   SudoRequestResponseDataSchema
 } from 'codify-schemas';
+import { nanoid } from 'nanoid';
 import { SpawnOptions, spawn } from 'node:child_process';
 import stripAnsi from 'strip-ansi';
-import { nanoid } from 'nanoid';
 
 const ajv = new Ajv({
   strict: true,
@@ -139,7 +139,7 @@ async function internalSpawn(
     // please node that this is not a full replacement for 'inherit'
     // the child process can and will detect if stdout is a pty and change output based on it
     // the terminal context is lost & ansi information (coloring) etc will be lost
-    if (stdout && stderr) {
+    if (stdout && stderr && VerbosityLevel.get() > 0) {
       stdout.pipe(process.stdout)
       stderr.pipe(process.stderr)
     }

src/utils/index.ts

@@ -18,11 +18,9 @@ export const Utils = {
   },
 
   async findInFolder(dir: string, search: string): Promise<string[]> {
-    const { data } = await codifySpawn('ls -a', {
-      cwd: dir,
-    })
+    const data = await fs.readdir(dir);
 
-    return data.split(/\n/)
+    return data
       .filter((l) => l.includes(search))
       .map((l) => path.join(dir, l));
   },
@@ -58,7 +56,7 @@ export const Utils = {
       throw new Error(`Found file at ${path}. Cannot create a directory there`)
     }
 
-    await codifySpawn(`mkdir -p ${path}`)
+    await fs.mkdir(path, { recursive: true })
   },
 
   async findInstallLocation(name: string): Promise<null | string> {