feat: add ssh resources

* Add ssh-key resource and tests

* Add ssh config resource and tests

* Added support for ssh configs with Match and fixed tests

* Add ssh add key resource and added dependencies for the other ssh resources.

* Added comment to failed ssh-add-key test

* Build fix and bug fix

* Fixed bugs from testing

Author: kevinwang5658

.cirrus.yml

@@ -20,7 +20,7 @@ integration_test_dev_task:
     fingerprint_script: cat package-lock.json
     populate_script: npm ci
   test_script:
-    - npm run test:integration -- --disable-console-intercept --inspect --no-file-parallelism
+    - npm run test:integration -- --disable-console-intercept $DEBUG --no-file-parallelism
 
 integration_individual_test_task:
   macos_instance:
@@ -31,4 +31,4 @@ integration_individual_test_task:
     populate_script: npm ci
   test_script:
     - echo $FILE_NAME
-    - npm run test -- $FILE_NAME --disable-console-intercept --inspect --no-file-parallelism
+    - npm run test -- $FILE_NAME --disable-console-intercept $DEBUG --no-file-parallelism

package-lock.json

@@ -22,11 +22,12 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "semver": "^7.6.0",
-    "codify-plugin-lib": "1.0.100",
+    "codify-plugin-lib": "1.0.106",
     "codify-schemas": "1.0.52",
     "chalk": "^5.3.0",
     "debug": "^4.3.4",
-    "plist": "^3.1.0"
+    "plist": "^3.1.0",
+    "lodash.isequal": "^4.5.0"
   },
   "devDependencies": {
     "rollup": "^4.12.0",
@@ -44,7 +45,8 @@
     "@types/commander": "^2.12.2",
     "@types/debug": "4.1.12",
     "@types/plist": "^3.0.5",
-    "codify-plugin-test": "0.0.13",
+    "@types/lodash.isequal": "^4.5.8",
+    "codify-plugin-test": "0.0.12",
     "commander": "^12.1.0",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",

package.json

@@ -43,7 +43,7 @@ const plugin = fork(
     // Use default true to test plugins in secure mode (un-able to request sudo directly)
     detached: true,
     env: { ...process.env },
-    execArgv: ['--import', 'tsx/esm', '--inspect=9221'],
+    execArgv: ['--import', 'tsx/esm'],
   },
 )
 

scripts/build.ts

@@ -45,6 +45,7 @@ async function launchSingleTest(test: string, debug: boolean) {
 async function run(cmd: string, debug: boolean, simple = true) {
   const messageBuffer: string[] = [];
 
+  cmd += (debug ? ' -e DEBUG="--inspect=9229"' : '');
   const cp = spawn(
     'source ~/.zshrc; ' + cmd,
     [],

scripts/run-tests.ts

@@ -2,9 +2,10 @@ import { Plugin, runPlugin } from 'codify-plugin-lib';
 
 import { AndroidStudioResource } from './resources/android/android-studio.js';
 import { AsdfResource } from './resources/asdf/asdf.js';
-import { AsdfPluginResource } from './resources/asdf/asdf-plugin.js';
 import { AsdfGlobalResource } from './resources/asdf/asdf-global.js';
+import { AsdfInstallResource } from './resources/asdf/asdf-install.js';
 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';
@@ -17,10 +18,12 @@ import { PgcliResource } from './resources/pgcli/pgcli.js';
 import { PyenvResource } from './resources/python/pyenv/pyenv.js';
 import { AliasResource } from './resources/shell/alias/alias-resource.js';
 import { PathResource } from './resources/shell/path/path-resource.js';
+import { SshAddKeyResource } from './resources/ssh/ssh-add-key.js';
+import { SshConfigFileResource } from './resources/ssh/ssh-config.js';
+import { SshKeyResource } from './resources/ssh/ssh-key.js';
 import { TerraformResource } from './resources/terraform/terraform.js';
 import { VscodeResource } from './resources/vscode/vscode.js';
 import { XcodeToolsResource } from './resources/xcode-tools/xcode-tools.js';
-import { AsdfInstallResource } from './resources/asdf/asdf-install.js';
 
 runPlugin(Plugin.create(
   'default',
@@ -45,6 +48,9 @@ runPlugin(Plugin.create(
     new AsdfPluginResource(),
     new AsdfGlobalResource(),
     new AsdfLocalResource(),
-    new AsdfInstallResource()
+    new AsdfInstallResource(),
+    new SshKeyResource(),
+    new SshConfigFileResource(),
+    new SshAddKeyResource()
   ])
 )

src/index.ts

@@ -27,7 +27,12 @@ export class GitCloneResource extends Resource<GitCloneConfig> {
       },
       import: {
         requiredParameters: ['directory']
-      }
+      },
+      dependencies: [
+        'ssh-key',
+        'ssh-add-key',
+        'ssh-config'
+      ]
     }
   }
 

src/resources/git/clone/git-clone.ts

@@ -58,7 +58,7 @@ export class HomebrewResource extends Resource<HomebrewConfig> {
       return this.installBrewInCustomDir(plan.desiredConfig.directory)
     }
 
-    await codifySpawn(`SUDO_ASKPASS=${SUDO_ASKPASS_PATH} NONINTERACTIVE=1 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`)
+    await codifySpawn(`SUDO_ASKPASS=${SUDO_ASKPASS_PATH} NONINTERACTIVE=1 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`, { requestsTTY: true })
     await codifySpawn('(echo; echo \'eval "$(/opt/homebrew/bin/brew shellenv)"\') >> /Users/$USER/.zshrc'); // TODO: may need to support non zsh shells here
 
     // TODO: Add a check here to see if homebrew is writable
@@ -72,7 +72,7 @@ export class HomebrewResource extends Resource<HomebrewConfig> {
     if (homebrewDirectory === '/opt/homebrew') {
       await codifySpawn(
         `SUDO_ASKPASS=${SUDO_ASKPASS_PATH} NONINTERACTIVE=1 /bin/bash -c "$(/usr/bin/curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/uninstall.sh)"`,
-        { throws: false }
+        { throws: false, requestsTTY: true }
       )
     }
 

src/resources/homebrew/homebrew.ts

@@ -10,7 +10,6 @@ import Schema from './nvm-schema.json';
 export interface NvmConfig extends ResourceConfig {
   global?: string,
   nodeVersions?: string[],
-  // TODO: Add option here to use homebrew to install instead. Default to true. Maybe add option to set default values to resource config.
 }
 
 export class NvmResource extends Resource<NvmConfig> {

src/resources/node/nvm/nvm.ts

@@ -0,0 +1,18 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://www.codifycli.com/ssh-key.json",
+  "title": "Ssh key resource",
+  "type": "object",
+  "properties": {
+    "path": {
+      "type": "string",
+      "description": "The path to the ssh-key to add"
+    },
+    "appleUseKeychain": {
+      "type": "boolean",
+      "description": "Corresponds to the --apple-use-keychain parameter. Controls whether the key should be loaded into the apple keychain. Only keys with a passphrase can be loaded"
+    }
+  },
+  "required": ["path"],
+  "additionalProperties": false
+}