feat: added export option to secrets env #342

src/secrets/CommandEnv.ts

@@ -24,6 +24,7 @@ class CommandEnv extends CommandPolykey {
     this.addOption(binOptions.envFormat);
     this.addOption(binOptions.envInvalid);
     this.addOption(binOptions.envDuplicate);
+    this.addOption(binOptions.envExport);
     this.addOption(binOptions.preserveNewline);
     this.argument(
       '<args...>',
@@ -280,45 +281,50 @@ class CommandEnv extends CommandPolykey {
           switch (format) {
             case 'unix':
               {
-                // Formatting as a .env file
                 let data = '';
                 for (const [key, value] of Object.entries(envp)) {
-                  data += `${key}='${value}'\n`;
+                  if (options.envExport) {
+                    data += `export ${key}='${value}'\n`;
+                  } else {
+                    data += `${key}='${value}'\n`;
+                  }
                 }
                 process.stdout.write(
                   binUtils.outputFormatter({
                     type: 'raw',
-                    data,
+                    data: data,
                   }),
                 );
               }
               break;
             case 'cmd':
               {
-                // Formatting as a .bat file for windows cmd
                 let data = '';
                 for (const [key, value] of Object.entries(envp)) {
                   data += `set "${key}=${value}"\n`;
                 }
                 process.stdout.write(
                   binUtils.outputFormatter({
                     type: 'raw',
-                    data,
+                    data: data,
                   }),
                 );
               }
               break;
             case 'powershell':
               {
-                // Formatting as a .bat file for windows cmd
                 let data = '';
                 for (const [key, value] of Object.entries(envp)) {
-                  data += `\$env:${key} = '${value}'\n`;
+                  if (options.envExport) {
+                    data += `$env:${key} = '${value}'\n`;
+                  } else {
+                    data += `$${key} = '${value}'\n`;
+                  }
                 }
                 process.stdout.write(
                   binUtils.outputFormatter({
                     type: 'raw',
-                    data,
+                    data: data,
                   }),
                 );
               }

src/utils/options.ts

@@ -246,6 +246,11 @@ const envDuplicate = new commander.Option(
   .choices(['keep', 'overwrite', 'warn', 'error'])
   .default('overwrite');
 
+const envExport = new commander.Option(
+  '-ee --env-export',
+  'If enabled, exports the set environment variables to child environments',
+).default(false);
+
 const discoveryMonitor = new commander.Option(
   '--monitor',
   'Enabling monitoring will cause discover to output discovery events as they happen and will exit once all children are processed',
@@ -363,6 +368,7 @@ export {
   envFormat,
   envInvalid,
   envDuplicate,
+  envExport,
   discoveryMonitor,
   seekStart,
   seekEnd,

tests/secrets/env.test.ts

@@ -416,10 +416,10 @@ describe('commandEnv', () => {
       env: { PK_PASSWORD: password },
     });
     expect(result.exitCode).toBe(0);
-    expect(result.stdout).toContain(`$env:SECRET1 = 'this is the secret1'`);
-    expect(result.stdout).toContain(`$env:SECRET2 = 'this is the secret2'`);
-    expect(result.stdout).toContain(`$env:SECRET3 = 'this is the secret3'`);
-    expect(result.stdout).toContain(`$env:SECRET4 = 'this is the secret4'`);
+    expect(result.stdout).toContain(`$SECRET1 = 'this is the secret1'`);
+    expect(result.stdout).toContain(`$SECRET2 = 'this is the secret2'`);
+    expect(result.stdout).toContain(`$SECRET3 = 'this is the secret3'`);
+    expect(result.stdout).toContain(`$SECRET4 = 'this is the secret4'`);
   });
   test('should output json format', async () => {
     const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
@@ -924,4 +924,33 @@ describe('commandEnv', () => {
     expect(result.stdout).toContain("SECRET3='this is the secret3'");
     expect(result.stdout).toContain("SECRET4='this is the secret4'");
   });
+  test.each(['unix', 'cmd', 'powershell'])(
+    'should export all secrets in %s format to child processes',
+    async (format) => {
+      const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
+      await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
+        await vaultOps.addSecret(vault, 'SECRET1', 'this is the secret1');
+      });
+      const command = [
+        'secrets',
+        'env',
+        '-np',
+        dataDir,
+        '--env-format',
+        format,
+        '--env-export',
+        `${vaultName}:SECRET1`,
+      ];
+      const result = await testUtils.pkExec(command, {
+        env: { PK_PASSWORD: password },
+      });
+      expect(result.exitCode).toBe(0);
+      const formatResult = {
+        unix: `export SECRET1='this is the secret1'\n`,
+        cmd: `set "SECRET1=this is the secret1"\n`,
+        powershell: `$env:SECRET1 = 'this is the secret1'\n`,
+      };
+      expect(result.stdout).toEqual(formatResult[format]);
+    },
+  );
 });