feat: Add a pre-filled sudo password

Author: kevinwang5658

codify.json

@@ -12,9 +12,13 @@
       "$PYENV_ROOT/bin",
       "$BUN_INSTALL/bin",
       "$DENO_INSTALL/bin",
+      "~/.jenv/bin",
+      "~/a/random/path",
+      "$NVM_DIR/.bin/2",
       "$NVM_DIR/.bin/3"
     ],
-    "declarationsOnly": true
+    "declarationsOnly": true,
+    "name": "1"
   },
   {
     "type": "homebrew",
@@ -35,6 +39,11 @@
       "cirrus",
       "expect",
       "git-lfs",
+      "groff",
+      "hyperfine",
+      "jenv",
+      "jq",
+      "mas",
       "openjdk@11",
       "openjdk@17",
       "openjdk@21",
@@ -104,20 +113,20 @@
     "type": "aws-cli"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   },
   {
     "type": "vscode"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-plugin-lib",
     "repository": "git@github.com:kevinwang5658/codify-plugin-lib.git"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify",
     "repository": "git@github.com:kevinwang5658/codify.git"
   },
@@ -176,37 +185,37 @@
     "region": "us-east-1"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   },
   {
-    "type": "git-clone",
+    "type": "git-repository",
     "directory": "~/Projects/codify-homebrew-plugin",
     "repository": "git@github.com:kevinwang5658/codify-homebrew-plugin.git"
   }

src/commands/apply/index.ts src/commands/apply.tssrc/commands/apply/index.ts renamed to src/commands/apply.ts

@@ -1,11 +1,19 @@
 import { Flags } from '@oclif/core'
 
-import { BaseCommand } from '../../common/base-command.js';
-import { ApplyOrchestrator } from '../../orchestrators/apply.js';
+import { BaseCommand } from '../common/base-command.js';
+import { ApplyOrchestrator } from '../orchestrators/apply.js';
 
 export default class Apply extends BaseCommand {
   static description = 'Apply a codify file onto the system. A plan of the changes is first generated and a list of changes will be shown before proceeding'
 
+  static flags = {
+    'sudoPassword': Flags.string({
+      optional: true,
+      description: 'Pre-fill the sudo password to automatically use for any commands that require elevated permissions.',
+      char: 'S'
+    }),
+  }
+
   static examples = [
     '<%= config.bin %> <%= command.id %>',
     '<%= config.bin %> <%= command.id %> --path ~',
@@ -21,7 +29,7 @@ export default class Apply extends BaseCommand {
 
     await ApplyOrchestrator.run({
       path: flags.path,
-      secure: flags.secure,
+      // secure: flags.secure,
     }, this.reporter);
 
     process.exit(0);

src/commands/destroy.ts

@@ -1,3 +1,5 @@
+import { Flags } from '@oclif/core';
+
 import { BaseCommand } from '../common/base-command.js';
 import { DestroyOrchestrator } from '../orchestrators/destroy.js';
 
@@ -7,6 +9,15 @@ export default class Destroy extends BaseCommand {
   static examples = [
     '<%= config.bin %> <%= command.id %> homebrew nvm',
   ]
+
+  static flags = {
+    'sudoPassword': Flags.string({
+      optional: true,
+      description: 'Pre-fill the sudo password to automatically use for any commands that require elevated permissions.',
+      char: 'S',
+      helpValue: '<password>'
+    }),
+  }
 
   public async run(): Promise<void> {
     const { flags, raw } = await this.parse(Destroy)
@@ -26,7 +37,6 @@ export default class Destroy extends BaseCommand {
     await DestroyOrchestrator.run({
       ids: args,
       path: flags.path,
-      secureMode: flags.secure,
     }, this.reporter)
 
     process.exit(0);

src/commands/plan/index.ts src/commands/plan.tssrc/commands/plan/index.ts renamed to src/commands/plan.ts

@@ -1,8 +1,5 @@
-import { Args, Flags } from '@oclif/core'
-import * as path from 'node:path';
-
-import { PlanOrchestrator } from '../../orchestrators/plan.js';
-import { BaseCommand } from '../../common/base-command.js';
+import { BaseCommand } from '../common/base-command.js';
+import { PlanOrchestrator } from '../orchestrators/plan.js';
 
 export default class Plan extends BaseCommand {
   static description = 'Generate a plan based on a codify.json file. This plan will list ' +

src/common/base-command.ts

@@ -6,21 +6,21 @@ import createDebug from 'debug';
 
 import { Event, ctx } from '../events/context.js';
 import { Reporter, ReporterFactory, ReporterType } from '../ui/reporters/reporter.js';
+import { SudoUtils } from '../utils/sudo.js';
 import { prettyPrintError } from './errors.js';
 
 export abstract class BaseCommand extends Command {
   static baseFlags = {
-    'debug': Flags.boolean(),
+    'debug': Flags.boolean({
+      description: 'Add additional debug logs.'
+    }),
     'output': Flags.option({
       char: 'o',
       default: 'default',
       options: ['plain', 'default', 'json'],
+      description: 'Control the output format of Codify.',
     })(),
-    'secure': Flags.boolean({
-      char: 's',
-      default: false,
-    }),
-    path: Flags.string({ char: 'p', description: 'Path to codify.json file' }),
+    path: Flags.string({ char: 'p', description: 'Path to run Codify from.' }),
   }
 
   protected reporter!: Reporter;
@@ -29,6 +29,7 @@ export abstract class BaseCommand extends Command {
     await super.init();
 
     const { flags } = await this.parse({
+      flags: this.ctor.flags,
       baseFlags: (super.ctor as typeof BaseCommand).baseFlags,
       strict: false,
     });
@@ -42,7 +43,12 @@ export abstract class BaseCommand extends Command {
 
     ctx.on(Event.SUDO_REQUEST, async (pluginName: string, data: SudoRequestData) => {
       try {
-        const result = await this.reporter.promptSudo(pluginName, data, flags.secure);
+        const password = (flags.sudoPassword) ?? (await this.reporter.promptSudo(pluginName, data, flags.secure));
+        if (!password) {
+          throw new Error(`Unable to get sudo password to run command: ${data.command}`);
+        }
+
+        const result = await SudoUtils.runCommand(data.command, data.options, flags.secure, pluginName, password)
         ctx.sudoRequestGranted(pluginName, result);
 
         // This listener is outside of the base-command callstack. We have to manually catch the error.

src/ui/reporters/default-reporter.tsx

@@ -1,6 +1,6 @@
 import { FormProps, FormReturnValue } from '@codifycli/ink-form';
 import chalk from 'chalk';
-import { SudoRequestData, SudoRequestResponseData } from 'codify-schemas';
+import { SudoRequestData } from 'codify-schemas';
 import { render } from 'ink';
 import { EventEmitter } from 'node:events';
 import React from 'react';
@@ -138,7 +138,7 @@ export class DefaultReporter implements Reporter {
     this.updateRenderState(RenderStatus.DISPLAY_IMPORT_RESULT, { importResult, showConfigs });
   }
 
-  async promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<SudoRequestResponseData> {
+  async promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<string | undefined> {
     console.log(chalk.blue(`Plugin: "${pluginName}" requires root access to run command: "${data.command}"`));
 
     let password;
@@ -148,7 +148,7 @@ export class DefaultReporter implements Reporter {
       password = await this.getUserPassword();
     }
 
-    return SudoUtils.runCommand(data.command, data.options, secureMode, pluginName, password)
+    return password;
   }
 
   displayPlan(plan: Plan): void {

src/ui/reporters/reporter.ts

@@ -59,7 +59,7 @@ export interface Reporter {
 
   promptOptions(message: string, options: string[]): Promise<number>;
 
-  promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<SudoRequestResponseData>;
+  promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<string | undefined>;
 
   promptUserForValues(resources: Array<ResourceInfo>, promptType: PromptType): Promise<ResourceConfig[]>;