Chore: Convert hubdb commands to TypeScript (#1372)

Author: kemmerle

commands/__tests__/hubdb.test.ts

@@ -0,0 +1,62 @@
+import yargs, { Argv } from 'yargs';
+import * as clear from '../hubdb/clear';
+import * as create from '../hubdb/create';
+import * as deleteCommand from '../hubdb/delete';
+import * as fetch from '../hubdb/fetch';
+
+jest.mock('yargs');
+jest.mock('../hubdb/clear');
+jest.mock('../hubdb/create');
+jest.mock('../hubdb/delete');
+jest.mock('../hubdb/fetch');
+jest.mock('../../lib/commonOpts');
+
+const commandSpy = jest
+  .spyOn(yargs as Argv, 'command')
+  .mockReturnValue(yargs as Argv);
+const demandCommandSpy = jest
+  .spyOn(yargs as Argv, 'demandCommand')
+  .mockReturnValue(yargs as Argv);
+
+// Import this last so mocks apply
+import * as hubdbCommands from '../hubdb';
+
+describe('commands/hubdb', () => {
+  describe('command', () => {
+    it('should have the correct command structure', () => {
+      expect(hubdbCommands.command).toEqual('hubdb');
+    });
+  });
+
+  describe('describe', () => {
+    it('should provide a description', () => {
+      expect(hubdbCommands.describe).toBeDefined();
+    });
+  });
+
+  describe('builder', () => {
+    beforeEach(() => {
+      commandSpy.mockClear();
+      demandCommandSpy.mockClear();
+    });
+
+    const subcommands = [clear, create, deleteCommand, fetch];
+
+    it('should demand the command takes one positional argument', () => {
+      hubdbCommands.builder(yargs as Argv);
+
+      expect(demandCommandSpy).toHaveBeenCalledTimes(1);
+      expect(demandCommandSpy).toHaveBeenCalledWith(1, '');
+    });
+
+    it('should add the correct number of sub commands', () => {
+      hubdbCommands.builder(yargs as Argv);
+      expect(commandSpy).toHaveBeenCalledTimes(subcommands.length);
+    });
+
+    it.each(subcommands)('should attach the %s subcommand', module => {
+      hubdbCommands.builder(yargs as Argv);
+      expect(commandSpy).toHaveBeenCalledWith(module);
+    });
+  });
+});

commands/__tests__/secret.test.ts

@@ -0,0 +1,62 @@
+import yargs, { Argv } from 'yargs';
+import * as addSecret from '../secret/addSecret';
+import * as deleteSecret from '../secret/deleteSecret';
+import * as listSecret from '../secret/listSecret';
+import * as updateSecret from '../secret/updateSecret';
+
+jest.mock('yargs');
+jest.mock('../secret/addSecret');
+jest.mock('../secret/deleteSecret');
+jest.mock('../secret/listSecret');
+jest.mock('../secret/updateSecret');
+jest.mock('../../lib/commonOpts');
+
+const commandSpy = jest
+  .spyOn(yargs as Argv, 'command')
+  .mockReturnValue(yargs as Argv);
+const demandCommandSpy = jest
+  .spyOn(yargs as Argv, 'demandCommand')
+  .mockReturnValue(yargs as Argv);
+
+// Import this last so mocks apply
+import * as secretCommands from '../secret';
+
+describe('commands/account', () => {
+  describe('command', () => {
+    it('should have the correct command structure', () => {
+      expect(secretCommands.command).toEqual(['secret', 'secrets']);
+    });
+  });
+
+  describe('describe', () => {
+    it('should provide a description', () => {
+      expect(secretCommands.describe).toBeDefined();
+    });
+  });
+
+  describe('builder', () => {
+    beforeEach(() => {
+      commandSpy.mockClear();
+      demandCommandSpy.mockClear();
+    });
+
+    const subcommands = [addSecret, deleteSecret, listSecret, updateSecret];
+
+    it('should demand the command takes one positional argument', () => {
+      secretCommands.builder(yargs as Argv);
+
+      expect(demandCommandSpy).toHaveBeenCalledTimes(1);
+      expect(demandCommandSpy).toHaveBeenCalledWith(1, '');
+    });
+
+    it('should add the correct number of sub commands', () => {
+      secretCommands.builder(yargs as Argv);
+      expect(commandSpy).toHaveBeenCalledTimes(subcommands.length);
+    });
+
+    it.each(subcommands)('should attach the %s subcommand', module => {
+      secretCommands.builder(yargs as Argv);
+      expect(commandSpy).toHaveBeenCalledWith(module);
+    });
+  });
+});

commands/hubdb.ts

@@ -1,17 +1,17 @@
-// @ts-nocheck
-const { addGlobalOptions } = require('../lib/commonOpts');
-const createCommand = require('./hubdb/create');
-const fetchCommand = require('./hubdb/fetch');
-const deleteCommand = require('./hubdb/delete');
-const clearCommand = require('./hubdb/clear');
-const { i18n } = require('../lib/lang');
+import { Argv } from 'yargs';
+import { addGlobalOptions } from '../lib/commonOpts';
+import * as createCommand from './hubdb/create';
+import * as fetchCommand from './hubdb/fetch';
+import * as deleteCommand from './hubdb/delete';
+import * as clearCommand from './hubdb/clear';
+import { i18n } from '../lib/lang';
 
 const i18nKey = 'commands.hubdb';
 
-exports.command = 'hubdb';
-exports.describe = i18n(`${i18nKey}.describe`);
+export const command = 'hubdb';
+export const describe = i18n(`${i18nKey}.describe`);
 
-exports.builder = yargs => {
+export function builder(yargs: Argv): Argv {
   addGlobalOptions(yargs);
 
   yargs
@@ -22,4 +22,4 @@ exports.builder = yargs => {
     .demandCommand(1, '');
 
   return yargs;
-};
+}

commands/hubdb/__tests__/clear.test.ts

@@ -0,0 +1,43 @@
+import yargs, { Argv } from 'yargs';
+import {
+  addAccountOptions,
+  addConfigOptions,
+  addUseEnvironmentOptions,
+} from '../../../lib/commonOpts';
+
+jest.mock('yargs');
+jest.mock('../../../lib/commonOpts');
+
+// Import this last so mocks apply
+import * as hubdbClearCommand from '../clear';
+
+describe('commands/account/clean', () => {
+  const yargsMock = yargs as Argv;
+
+  describe('command', () => {
+    it('should have the correct command structure', () => {
+      expect(hubdbClearCommand.command).toEqual('clear [table-id]');
+    });
+  });
+
+  describe('describe', () => {
+    it('should provide a description', () => {
+      expect(hubdbClearCommand.describe).toBeDefined();
+    });
+  });
+
+  describe('builder', () => {
+    it('should support the correct options', () => {
+      hubdbClearCommand.builder(yargsMock);
+
+      expect(addAccountOptions).toHaveBeenCalledTimes(1);
+      expect(addAccountOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addConfigOptions).toHaveBeenCalledTimes(1);
+      expect(addConfigOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
+      expect(addUseEnvironmentOptions).toHaveBeenCalledWith(yargsMock);
+    });
+  });
+});

commands/hubdb/__tests__/create.test.ts

@@ -0,0 +1,43 @@
+import yargs, { Argv } from 'yargs';
+import {
+  addAccountOptions,
+  addConfigOptions,
+  addUseEnvironmentOptions,
+} from '../../../lib/commonOpts';
+
+jest.mock('yargs');
+jest.mock('../../../lib/commonOpts');
+
+// Import this last so mocks apply
+import * as hubdbCreateCommand from '../create';
+
+describe('commands/account/clean', () => {
+  const yargsMock = yargs as Argv;
+
+  describe('command', () => {
+    it('should have the correct command structure', () => {
+      expect(hubdbCreateCommand.command).toEqual('create');
+    });
+  });
+
+  describe('describe', () => {
+    it('should provide a description', () => {
+      expect(hubdbCreateCommand.describe).toBeDefined();
+    });
+  });
+
+  describe('builder', () => {
+    it('should support the correct options', () => {
+      hubdbCreateCommand.builder(yargsMock);
+
+      expect(addAccountOptions).toHaveBeenCalledTimes(1);
+      expect(addAccountOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addConfigOptions).toHaveBeenCalledTimes(1);
+      expect(addConfigOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
+      expect(addUseEnvironmentOptions).toHaveBeenCalledWith(yargsMock);
+    });
+  });
+});

commands/hubdb/__tests__/delete.test.ts

@@ -0,0 +1,43 @@
+import yargs, { Argv } from 'yargs';
+import {
+  addAccountOptions,
+  addConfigOptions,
+  addUseEnvironmentOptions,
+} from '../../../lib/commonOpts';
+
+jest.mock('yargs');
+jest.mock('../../../lib/commonOpts');
+
+// Import this last so mocks apply
+import * as hubdbDeleteCommand from '../delete';
+
+describe('commands/account/clean', () => {
+  const yargsMock = yargs as Argv;
+
+  describe('command', () => {
+    it('should have the correct command structure', () => {
+      expect(hubdbDeleteCommand.command).toEqual('delete [table-id]');
+    });
+  });
+
+  describe('describe', () => {
+    it('should provide a description', () => {
+      expect(hubdbDeleteCommand.describe).toBeDefined();
+    });
+  });
+
+  describe('builder', () => {
+    it('should support the correct options', () => {
+      hubdbDeleteCommand.builder(yargsMock);
+
+      expect(addAccountOptions).toHaveBeenCalledTimes(1);
+      expect(addAccountOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addConfigOptions).toHaveBeenCalledTimes(1);
+      expect(addConfigOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
+      expect(addUseEnvironmentOptions).toHaveBeenCalledWith(yargsMock);
+    });
+  });
+});

commands/hubdb/__tests__/fetch.test.ts

@@ -0,0 +1,43 @@
+import yargs, { Argv } from 'yargs';
+import {
+  addAccountOptions,
+  addConfigOptions,
+  addUseEnvironmentOptions,
+} from '../../../lib/commonOpts';
+
+jest.mock('yargs');
+jest.mock('../../../lib/commonOpts');
+
+// Import this last so mocks apply
+import * as hubdbFetchCommand from '../fetch';
+
+describe('commands/account/clean', () => {
+  const yargsMock = yargs as Argv;
+
+  describe('command', () => {
+    it('should have the correct command structure', () => {
+      expect(hubdbFetchCommand.command).toEqual('fetch [table-id] [dest]');
+    });
+  });
+
+  describe('describe', () => {
+    it('should provide a description', () => {
+      expect(hubdbFetchCommand.describe).toBeDefined();
+    });
+  });
+
+  describe('builder', () => {
+    it('should support the correct options', () => {
+      hubdbFetchCommand.builder(yargsMock);
+
+      expect(addAccountOptions).toHaveBeenCalledTimes(1);
+      expect(addAccountOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addConfigOptions).toHaveBeenCalledTimes(1);
+      expect(addConfigOptions).toHaveBeenCalledWith(yargsMock);
+
+      expect(addUseEnvironmentOptions).toHaveBeenCalledTimes(1);
+      expect(addUseEnvironmentOptions).toHaveBeenCalledWith(yargsMock);
+    });
+  });
+});