COnverted ssh-add, homebrew, aws-cli, asdf to linux

Author: kevinwang5658

.cirrus.yml

@@ -48,7 +48,7 @@ integration_individual_test_task:
 
 integration_individual_test_linux_task:
   arm_container:
-    image: node:22
+    image: kevinwang5658/codify-test-linux:latest
 #  node_modules_cache:
 #    folder: node_modules
 #    fingerprint_script: cat package-lock.json

package-lock.json

@@ -26,8 +26,8 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "chalk": "^5.3.0",
-    "codify-plugin-lib": "1.0.182-beta21",
-    "codify-schemas": "1.0.86-beta5",
+    "codify-plugin-lib": "1.0.182-beta27",
+    "codify-schemas": "1.0.86-beta7",
     "debug": "^4.3.4",
     "lodash.isequal": "^4.5.0",
     "nanoid": "^5.0.9",
@@ -55,7 +55,7 @@
     "@types/node": "^18",
     "@types/plist": "^3.0.5",
     "@types/semver": "^7.5.4",
-    "codify-plugin-test": "0.0.53-beta7",
+    "codify-plugin-test": "0.0.53-beta11",
     "commander": "^12.1.0",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",

package.json

@@ -0,0 +1,14 @@
+FROM node:22
+
+USER root
+
+# Install system dependencies without sudo
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    curl \
+    git \
+    sudo \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN echo "node ALL=(ALL:ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/node
+

scripts/Dockerfile

@@ -65,12 +65,8 @@ export class AsdfResource extends Resource<AsdfConfig> {
       // eslint-disable-next-line no-template-curly-in-string
       await FileUtils.addToShellRc('export PATH="${ASDF_DATA_DIR:-$HOME/.asdf}/shims:$PATH"')
 
-      // TODO: Add filtering to resources for operating systems
-      // os parameter
-      // TODO: Move all utils to codify-plugin-lib
       // TODO: Move OsUtils to a separate name space? All things that have to do with the os.
       // TODO: Add a way to run multiple commands in sequence
-      // TODO: Add a easier way to make sure path is on the path
       // TODO: Change all plugins to install to ~/.local/bin
 
       await $.spawnSafe('which asdf', { interactive: true });

src/resources/asdf/asdf.ts

@@ -1,8 +1,9 @@
-import { Resource, ResourceSettings, getPty, SpawnStatus } from 'codify-plugin-lib';
+import { Resource, ResourceSettings, getPty, SpawnStatus, Utils } from 'codify-plugin-lib';
 import { OS, StringIndexedObject } from 'codify-schemas';
 import fs from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
 
-import { Utils } from '../../../utils/index.js';
 import Schema from './aws-cli-schema.json';
 
 export interface AwsCliConfig extends StringIndexedObject {
@@ -16,7 +17,7 @@ export class AwsCliResource extends Resource<AwsCliConfig> {
   getSettings(): ResourceSettings<AwsCliConfig> {
     return {
       schema: Schema,
-      operatingSystems: [OS.Darwin],
+      operatingSystems: [OS.Darwin, OS.Linux],
       id: 'aws-cli',
     };
   }
@@ -41,22 +42,24 @@ export class AwsCliResource extends Resource<AwsCliConfig> {
     // Amazon has not released a standalone way to install arm aws-cli. See: https://github.com/aws/aws-cli/issues/7252
     // Prefer the homebrew version on M1
     const isArmArch = await Utils.isArmArch();
-    const isRosettaInstalled = await Utils.isRosetta2Installed()
-    const isHomebrewInstalled = await Utils.isHomebrewInstalled();
-
-    if (isArmArch && isHomebrewInstalled) {
-      console.log('Resource: \'aws-cli\'. Detected that mac is aarch64. Installing AWS-CLI via homebrew')
-      await $.spawn('HOMEBREW_NO_AUTO_UPDATE=1 brew install awscli', { interactive: true })
-
-    } else if (!isArmArch || isRosettaInstalled) {
-      console.log('Resource: \'aws-cli\'. Detected that mac is not ARM or Rosetta is installed. Installing AWS-CLI standalone version')
-      await $.spawn('curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg"');
-      await $.spawn('installer -pkg ./AWSCLIV2.pkg -target /', { requiresRoot: true })
-      await fs.rm('./AWSCLIV2.pkg', { recursive: true, force: true });
-
-    } else {
-      // This covers arm arch + Homebrew is not installed
-      throw new Error(`Resource: 'aws-cli'. This plugin prefers installing AWS-CLI via homebrew for M1 macs.
+
+    if (Utils.isMacOS()) {
+      const isRosettaInstalled = await Utils.isRosetta2Installed()
+      const isHomebrewInstalled = await Utils.isHomebrewInstalled();
+
+      if (isArmArch && isHomebrewInstalled) {
+        console.log('Resource: \'aws-cli\'. Detected that mac is aarch64. Installing AWS-CLI via homebrew')
+        await $.spawn('HOMEBREW_NO_AUTO_UPDATE=1 brew install awscli', { interactive: true })
+
+      } else if (!isArmArch || isRosettaInstalled) {
+        console.log('Resource: \'aws-cli\'. Detected that mac is not ARM or Rosetta is installed. Installing AWS-CLI standalone version')
+        await $.spawn('curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg"');
+        await $.spawn('installer -pkg ./AWSCLIV2.pkg -target /', { requiresRoot: true })
+        await fs.rm('./AWSCLIV2.pkg', { recursive: true, force: true });
+
+      } else {
+        // This covers arm arch + Homebrew is not installed
+        throw new Error(`Resource: 'aws-cli'. This plugin prefers installing AWS-CLI via homebrew for M1 macs.
 AWS has not updated the standalone installer to support M1 macs. See: https://github.com/aws/aws-cli/issues/7252. 
 
 Homebrew can be installed by adding: 
@@ -68,6 +71,14 @@ Or enable rosetta 2 using the below command and re-run:
 
 softwareupdate --install-rosetta
       `);
+      }
+    } else if (Utils.isLinux()) {
+      const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'codify-aws-cli'));
+
+      await $.spawn('curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"', { cwd: tmpDir });
+      await $.spawn('unzip -q awscliv2.zip', { cwd: tmpDir });
+      await $.spawn('./aws/install', { cwd: tmpDir, requiresRoot: true });
+      await fs.rm(tmpDir, { recursive: true, force: true });
     }
   }
 
@@ -78,17 +89,17 @@ softwareupdate --install-rosetta
     if (!installLocation) {
       return;
     }
-    
+
     if (installLocation.includes('homebrew')) {
       await $.spawn('brew uninstall awscli', { interactive: true, env: { HOMEBREW_NO_AUTO_UPDATE: 1 } });
       return;
     }
-    
+
     await $.spawn(`rm ${installLocation}`, { requiresRoot: true });
     await $.spawn(`rm ${installLocation}_completer`, { requiresRoot: true });
     await $.spawn('rm -rf $HOME/.aws/');
   }
-  
+
   private async findInstallLocation(): Promise<null | string> {
     const $ = getPty();
     const query = await $.spawnSafe('which aws', { interactive: true });

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

@@ -1,4 +1,4 @@
-import { ParameterSetting, Plan, SpawnStatus, StatefulParameter, getPty } from 'codify-plugin-lib';
+import { ParameterSetting, Plan, SpawnStatus, StatefulParameter, Utils, getPty } from 'codify-plugin-lib';
 import path from 'node:path';
 
 import { FileUtils } from '../../utils/file-utils.js';
@@ -42,7 +42,7 @@ export class CasksParameter extends StatefulParameter<HomebrewConfig, string[]>
 
       // This serves a secondary purpose as well. It checks that each cask to install is valid (alerting the user
       // in the plan instead of in the apply)
-      const casksWithConflicts = await this.findConflicts(notInstalledCasks);
+      const casksWithConflicts = await this.findConflictsOnMacOs(notInstalledCasks);
       if (casksWithConflicts.length > 0) {
         // To avoid errors, we pretend that those programs were already installed by homebrew (even though it was installed outside)
         if (config?.skipAlreadyInstalledCasks) {
@@ -82,7 +82,7 @@ export class CasksParameter extends StatefulParameter<HomebrewConfig, string[]>
     }
 
     const $ = getPty();
-    const conflicts = await this.findConflicts(casks);
+    const conflicts = await this.findConflictsOnMacOs(casks);
     const casksToInstall = casks.filter((c) => !conflicts.includes(c))
 
     if (conflicts.length > 0) {
@@ -132,9 +132,13 @@ export class CasksParameter extends StatefulParameter<HomebrewConfig, string[]>
     }
   }
 
-  private async findConflicts(casks: string[]): Promise<string[]> {
-    const $ = getPty();
+  private async findConflictsOnMacOs(casks: string[]): Promise<string[]> {
+    // if (!Utils.isMacOS()) {
+      return [];
+    // }
+
 
+    const $ = getPty();
     const result = (await $.spawn(
       `brew info -q --json=v2 ${casks.map((c) => `"${c}"`).join(' ')}`, {
         interactive: true,

src/resources/homebrew/casks-parameter.ts

@@ -73,7 +73,7 @@ export class HomebrewResource extends Resource<HomebrewConfig> {
     )
 
     const brewPath = Utils.isLinux() ? '/home/linuxbrew/.linuxbrew/bin/brew' : '/opt/homebrew/bin/brew';
-    await FileUtils.addToStartupFile(`eval "$(${brewPath} shellenv)"`);
+    await FileUtils.addToShellRc(`eval "$(${brewPath} shellenv)"`);
 
     // TODO: Add a check here to see if homebrew is writable
     //  Either add a warning or a parameter to edit the permissions on /opt/homebrew
@@ -94,7 +94,7 @@ export class HomebrewResource extends Resource<HomebrewConfig> {
     }
 
     // Delete eval from .zshrc
-    await FileUtils.removeLineFromPrimaryShellRc(`eval "$(${homebrewDirectory}/bin/brew shellenv)"`)
+    await FileUtils.removeLineFromShellRc(`eval "$(${homebrewDirectory}/bin/brew shellenv)"`)
   }
 
   private async installBrewInCustomDir(dir: string): Promise<void> {
@@ -119,7 +119,7 @@ export class HomebrewResource extends Resource<HomebrewConfig> {
       })
 
     // Update shell startup scripts
-    await FileUtils.addToStartupFile(`eval "$(${absoluteDir}/bin/brew shellenv)"`);
+    await FileUtils.addToShellRc(`eval "$(${absoluteDir}/bin/brew shellenv)"`);
   }
 
   // Ex:

src/resources/homebrew/homebrew.ts

@@ -1,4 +1,4 @@
-import { CreatePlan, DestroyPlan, getPty, Resource, ResourceSettings, SpawnStatus } from 'codify-plugin-lib';
+import { CreatePlan, DestroyPlan, getPty, Resource, ResourceSettings, SpawnStatus, Utils } from 'codify-plugin-lib';
 import { OS, StringIndexedObject } from 'codify-schemas';
 import path from 'node:path';
 
@@ -16,7 +16,7 @@ export class SshAddResource extends Resource<SshAddConfig> {
   getSettings(): ResourceSettings<SshAddConfig> {
     return {
       id: 'ssh-add',
-      operatingSystems: [OS.Darwin],
+      operatingSystems: [OS.Darwin, OS.Linux],
       schema: Schema,
       parameterSettings: {
         path: {
@@ -41,12 +41,12 @@ export class SshAddResource extends Resource<SshAddConfig> {
       return null;
     }
 
-    const { data: keyFingerprint, status: keygenStatus } = await $.spawnSafe(`eval "$(ssh-agent -s)"; ssh-keygen -lf ${sshPath}`);
+    const { data: keyFingerprint, status: keygenStatus } = await $.spawnSafe(`ssh-keygen -lf ${sshPath}`);
     if (keygenStatus === SpawnStatus.ERROR) {
       return null;
     }
 
-    const { data: loadedSshKeys, status: sshAddStatus } = await $.spawnSafe('eval "$(ssh-agent -s)"; /usr/bin/ssh-add -l');
+    const { data: loadedSshKeys, status: sshAddStatus } = await $.spawnSafe('/usr/bin/ssh-add -l');
     if (sshAddStatus === SpawnStatus.ERROR) {
       return null;
     }
@@ -63,7 +63,7 @@ export class SshAddResource extends Resource<SshAddConfig> {
 
     let appleUseKeychain: boolean | undefined;
     if (parameters.appleUseKeychain) {
-      appleUseKeychain = await this.isKeyLoadedInKeychain(sshPath);
+      appleUseKeychain = Utils.isMacOS() ? (await this.isKeyLoadedInKeychain(sshPath)) : parameters.appleUseKeychain;
     }
 
     return {
@@ -74,20 +74,43 @@ export class SshAddResource extends Resource<SshAddConfig> {
 
   async create(plan: CreatePlan<SshAddConfig>): Promise<void> {
     const { appleUseKeychain, path } = plan.desiredConfig;
-
     const $ = getPty();
-    await $.spawn(`eval "$(ssh-agent -s)"; /usr/bin/ssh-add ${appleUseKeychain ? '--apple-use-keychain ' : ''}${path}`, { interactive: true, stdin: true })
+
+    if (Utils.isLinux()) {
+      if ((await $.spawnSafe('ssh-agent -l')).status === SpawnStatus.ERROR) {
+        await FileUtils.addToStartupFile('eval "$(ssh-agent -s)"');
+      }
+
+      await FileUtils.addToStartupFile('ssh-add ' + path);
+    }
+
+    if (Utils.isMacOS()) {
+      await $.spawn(`/usr/bin/ssh-add ${appleUseKeychain && Utils.isMacOS() ? '--apple-use-keychain ' : ''}${path}`, {
+        interactive: true,
+        stdin: true
+      });
+    }
   }
 
   async destroy(plan: DestroyPlan<SshAddConfig>): Promise<void> {
     const { path } = plan.currentConfig;
 
+    if (Utils.isLinux()) {
+      await FileUtils.removeLineFromStartupFile('ssh-add ' + path);
+    }
+
+
     const $ = getPty();
-    await $.spawn(`eval "$(ssh-agent -s)"; /usr/bin/ssh-add -d ${path}`, { interactive: true })
+    await $.spawnSafe(`/usr/bin/ssh-add -d ${path}`, { interactive: true });
   }
 
   private async isKeyLoadedInKeychain(keyPath: string): Promise<boolean> {
-    const $ = getPty();
+    if (!Utils.isMacOS()) {
+      return false;
+    }
+
+
+   const $ = getPty();
     const { data: keychainKeys, status } = await $.spawnSafe('/usr/bin/ssh-add --apple-load-keychain', { interactive: true });
     if (status === SpawnStatus.ERROR) {
       return false;