chore: working on adding non-zero exit codes

[ci skip]

Author: aryanjassal

src/secrets/CommandMkdir.ts

@@ -4,8 +4,8 @@ import * as binUtils from '../utils';
 import * as binOptions from '../utils/options';
 import * as binParsers from '../utils/parsers';
 import * as binProcessors from '../utils/processors';
-import { ErrorMessage } from 'polykey/dist/client/types';
 import { ErrorPolykeyCLIUncaughtException } from '@/errors';
+import { utils } from '@';
 
 class CommandMkdir extends CommandPolykey {
   constructor(...args: ConstructorParameters<typeof CommandPolykey>) {
@@ -75,24 +75,27 @@ class CommandMkdir extends CommandPolykey {
         // As git does not track empty directories in version control, we need
         // to inform the user about this.
         process.stderr.write(
-          'WARNING: Empty directories will not be affected by modifications to the vault state (version change, sharing/cloning, etc.)',
+          'WARNING: Empty directories will not be affected by modifications to the vault state (version change, sharing/cloning, etc.)\n',
         );
 
         for await (const result of response.readable) {
           if (result.type === 'error') {
-            const error = result as ErrorMessage;
+            process.exitCode = 1;
             let message: string = '';
-            if (error.code === 'ENOENT') {
-              message = 'No such secret or directory';
-            } else if (error.code === 'EEXIST') {
-              message = 'Secret or directory exists';
-            } else {
-              throw new ErrorPolykeyCLIUncaughtException(
-                `Unexpected error code ${error.code}`,
-              );
+            switch (result.code) {
+              case 'ENOENT':
+                message = 'No such secret or directory';
+                break;
+              case 'EEXIST':
+                message = 'Secret or directory exists';
+                break;
+              default:
+                throw new ErrorPolykeyCLIUncaughtException(
+                  `Unexpected error code: ${result.code}`,
+                );
             }
             process.stderr.write(
-              `${error.code}: cannot create directory ${error.reason}: ${message}`,
+              `${result.code}: cannot create directory ${result.reason}: ${message}\n`,
             );
           }
         }

tests/secrets/mkdir.test.ts

@@ -6,7 +6,6 @@ import PolykeyAgent from 'polykey/dist/PolykeyAgent';
 import { vaultOps } from 'polykey/dist/vaults';
 import * as keysUtils from 'polykey/dist/keys/utils';
 import * as testUtils from '../utils';
-import { remoteErrorCause } from '@/utils';
 
 describe('commandMkdir', () => {
   const password = 'password';
@@ -46,21 +45,19 @@ describe('commandMkdir', () => {
     const vaultName = 'vault' as VaultName;
     const dirName = 'dir';
     const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
-
     command = [
       'secrets',
       'mkdir',
       '-np',
       dataDir,
       `${vaultName}:${dirName}`
     ];
-
     const result = await testUtils.pkStdio([...command], {
       env: { PK_PASSWORD: password },
       cwd: dataDir,
     });
     expect(result.exitCode).toBe(0);
-
+    expect(result.stderr).toInclude('WARNING');
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
       const stat = await vaultOps.statSecret(vault, dirName);
       expect(stat.isDirectory()).toBeTruthy();
@@ -72,7 +69,6 @@ describe('commandMkdir', () => {
     const dirName2 = 'dir2';
     const dirNameNested = `${dirName1}/${dirName2}`;
     const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
-
     command = [
       'secrets',
       'mkdir',
@@ -81,13 +77,11 @@ describe('commandMkdir', () => {
       `${vaultName}:${dirNameNested}`,
       '--recursive'
     ];
-
     const result = await testUtils.pkStdio([...command], {
       env: { PK_PASSWORD: password },
       cwd: dataDir,
     });
     expect(result.exitCode).toBe(0);
-
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
       const stat1 = await vaultOps.statSecret(vault, dirName1);
       expect(stat1.isDirectory()).toBeTruthy();
@@ -101,22 +95,19 @@ describe('commandMkdir', () => {
     const dirName2 = 'dir2';
     const dirNameNested = `${dirName1}/${dirName2}`;
     const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
-
     command = [
       'secrets',
       'mkdir',
       '-np',
       dataDir,
       `${vaultName}:${dirNameNested}`,
     ];
-
     const result = await testUtils.pkStdio([...command], {
       env: { PK_PASSWORD: password },
       cwd: dataDir,
     });
-    expect(result.exitCode).toBe(0);
-    expect(result.stderr).toBeDefined();
-
+    expect(result.exitCode).toBe(1);
+    expect(result.stderr).toInclude('ENOENT');
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
       await vault.readF(async (efs) => {
         const dirName1P = efs.readdir(dirName1);
@@ -130,28 +121,24 @@ describe('commandMkdir', () => {
     const vaultName = 'vault' as VaultName;
     const dirName = 'dir-exists';
     const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
-
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
       await vault.writeF(async (efs) => {
         await efs.mkdir(dirName);
       });
     });
-
     command = [
       'secrets',
       'mkdir',
       '-np',
       dataDir,
       `${vaultName}:${dirName}`,
     ];
-
     const result = await testUtils.pkStdio([...command], {
       env: { PK_PASSWORD: password },
       cwd: dataDir,
     });
-    expect(result.exitCode).toBe(0);
-    expect(result.stderr).toBeDefined();
-
+    expect(result.exitCode).toBe(1);
+    expect(result.stderr).toInclude('EEXIST');
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
       await vault.readF(async (efs) => {
         const dirP = efs.readdir(dirName);
@@ -164,28 +151,24 @@ describe('commandMkdir', () => {
     const secretName = 'secret-exists';
     const secretContent = 'secret-content';
     const vaultId = await polykeyAgent.vaultManager.createVault(vaultName);
-
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
       await vault.writeF(async (efs) => {
         await efs.writeFile(secretName, secretContent);
       });
     });
-
     command = [
       'secrets',
       'mkdir',
       '-np',
       dataDir,
       `${vaultName}:${secretName}`,
     ];
-
     const result = await testUtils.pkStdio([...command], {
       env: { PK_PASSWORD: password },
       cwd: dataDir,
     });
-    expect(result.exitCode).toBe(0);
-    expect(result.stderr).toBeDefined();
-
+    expect(result.exitCode).toBe(1);
+    expect(result.stderr).toInclude('EEXIST');
     await polykeyAgent.vaultManager.withVaults([vaultId], async (vault) => {
       await vault.readF(async (efs) => {
         const stat = await efs.stat(secretName);
@@ -203,7 +186,6 @@ describe('commandMkdir', () => {
     const dirName1 = 'dir1';
     const dirName2 = 'dir2';
     const dirName3 = 'dir3';
-
     command = [
       'secrets',
       'mkdir',
@@ -213,13 +195,11 @@ describe('commandMkdir', () => {
       `${vaultName2}:${dirName2}`,
       `${vaultName1}:${dirName3}`,
     ];
-
     const result = await testUtils.pkStdio([...command], {
       env: { PK_PASSWORD: password },
       cwd: dataDir,
     });
     expect(result.exitCode).toBe(0);
-
     await polykeyAgent.vaultManager.withVaults([vaultId1, vaultId2], async (vault1, vault2) => {
       const stat1 = await vaultOps.statSecret(vault1, dirName1);
       expect(stat1.isDirectory()).toBeTruthy();