wip: current code

[ci skip]

Author: aryanjassal

src/secrets/CommandEdit.ts

@@ -118,11 +118,11 @@ class CommandEdit extends CommandPolykey {
             editorProc.removeListener('error', onError);
             editorProc.removeListener('close', onClose);
           };
-          const onError = (err: Error) => {
+          const onError = (e: Error) => {
             cleanup();
             const error = new errors.ErrorPolykeyCLIEditSecret(
               `Failed to run command ${process.env.EDITOR}`,
-              { cause: err },
+              { cause: e },
             );
             reject(error);
           };

src/secrets/CommandEnv.ts

@@ -1,11 +1,12 @@
 import type PolykeyClient from 'polykey/dist/PolykeyClient';
 import path from 'path';
 import os from 'os';
+import commander from 'commander';
 import * as utils from 'polykey/dist/utils';
+import CommandPolykey from '../CommandPolykey';
 import * as binProcessors from '../utils/processors';
 import * as binUtils from '../utils';
 import * as binErrors from '../errors';
-import CommandPolykey from '../CommandPolykey';
 import * as binOptions from '../utils/options';
 import * as binParsers from '../utils/parsers';
 
@@ -14,7 +15,7 @@ class CommandEnv extends CommandPolykey {
     super(...args);
     this.name('env');
     this.description(
-      `Run a command with the given secrets and env variables using process replacement. If no command is specified then the variables are printed to stdout in the format specified by env-format.`,
+      `Run a command with the given secrets and env variables. If no command is specified then the variables are printed to stdout in the format specified by env-format.`,
     );
     this.addOption(binOptions.nodeId);
     this.addOption(binOptions.clientHost);
@@ -37,11 +38,17 @@ class CommandEnv extends CommandPolykey {
         // The parser sets the default value for args. If no arguments are
         // provided, then args is an empty array []. This is different from the
         // expected structure. This block ensure that the structure is preserved.
+        // Do the same for options.preserveNewline.
         args = args[0] == null && args[1] == null ? [[], []] : args;
+        options.preserveNewline = options.preserveNewline ?? [];
 
-        // There needs to be at least one argument or preserved argument provided
+        // There needs to be at least one argument or preserved argument
+        // provided. Otherwise, print the help text and error out.
         if (args[0].length === 0 && options.preserveNewline.length === 0) {
-          this.help();
+          this.outputHelp()
+          throw new commander.InvalidArgumentError(
+            'You must provide at least one secret path.',
+          );
         }
         // Remove the -- from the command arguments
         args[1]?.shift();

src/utils/parsers.ts

@@ -208,6 +208,8 @@ function parseEnvArgs(
     [],
     [],
   ];
+  console.error('val', value)
+  console.error('cur', current)
   if (current[1].length === 0) {
     // Parse a secret path
     if (value !== '--') {
@@ -220,11 +222,6 @@ function parseEnvArgs(
     // Otherwise we just have the cmd args
     current[1].push(value);
   }
-  if (current[0].length === 0 && current[1].length > 0) {
-    throw new commander.InvalidArgumentError(
-      'You must provide at least 1 secret path',
-    );
-  }
   return current;
 }
 

tests/secrets/env.test.ts

@@ -669,12 +669,11 @@ describe('commandEnv', () => {
   });
   test('newlines in secrets are untouched', async () => {
     const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
+    const secretName = 'SECRET';
+    const secretContent =
+      'this is a secret\nit has multiple lines\n\nand some more lines';
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
-      await vaultOps.addSecret(
-        vault,
-        'SECRET',
-        'this is a secret\nit has multiple lines\n',
-      );
+      await vaultOps.addSecret(vault, secretName, secretContent);
     });
     const command = [
       'secrets',
@@ -683,7 +682,35 @@ describe('commandEnv', () => {
       dataDir,
       '--env-format',
       'unix',
-      `${vaultName}:SECRET`,
+      `${vaultName}:${secretName}`,
+      '--',
+      'node',
+      '-e',
+      'console.log(JSON.stringify(process.env))',
+    ];
+    const result = await testUtils.pkExec(command, {
+      env: { PK_PASSWORD: password },
+    });
+    expect(result.exitCode).toBe(0);
+    const jsonOut = JSON.parse(result.stdout);
+    expect(jsonOut[secretName]).toBe(secretContent);
+  });
+  // TODO: fastcheck
+  test('single trailing newline is automatically removed', async () => {
+    const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
+    const secretName = 'SECRET';
+    const secretContent = 'this is a secret\n'; // Simulating Unix file ending
+    await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
+      await vaultOps.addSecret(vault, secretName, secretContent);
+    });
+    const command = [
+      'secrets',
+      'env',
+      '-np',
+      dataDir,
+      '--env-format',
+      'unix',
+      `${vaultName}:${secretName}`,
       '--',
       'node',
       '-e',
@@ -694,7 +721,39 @@ describe('commandEnv', () => {
     });
     expect(result.exitCode).toBe(0);
     const jsonOut = JSON.parse(result.stdout);
-    expect(jsonOut['SECRET']).toBe('this is a secret\nit has multiple lines\n');
+    // Remove last character
+    expect(jsonOut[secretName]).toBe(secretContent.slice(0, -1));
+  });
+  // TODO: fastcheck
+  test('trailing newlines are preserved with option', async () => {
+    const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
+    const secretName = 'SECRET';
+    const secretContent = 'this is a secret\n';
+    await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
+      await vaultOps.addSecret(vault, secretName, secretContent);
+    });
+    const command = [
+      'secrets',
+      'env',
+      '-np',
+      dataDir,
+      '--env-format',
+      'unix',
+      '--preserve-newline',
+      `${vaultName}:${secretName}`,
+      '--',
+      'node',
+      '-e',
+      'console.log(JSON.stringify(process.env))',
+    ];
+    const result = await testUtils.pkExec(command, {
+      env: { PK_PASSWORD: password },
+    });
+    console.error(result.stderr)
+    expect(result.exitCode).toBe(0);
+    const jsonOut = JSON.parse(result.stdout);
+    // Remove last character
+    expect(jsonOut[secretName]).toBe(secretContent);
   });
   test.prop([
     testUtils.secretPathEnvArrayArb,
@@ -741,10 +800,10 @@ describe('commandEnv', () => {
       '--',
       'someCommand',
     ];
-    const result1 = await testUtils.pkExec(command, {
+    const result = await testUtils.pkExec(command, {
       env: { PK_PASSWORD: password },
     });
-    expect(result1.exitCode).toBe(64);
+    expect(result.exitCode).toBe(64);
   });
   test('should output all secrets without explicit secret path', async () => {
     const vaultId1 = await polykeyAgent.vaultManager.createVault(