refactor(account-api): split tests (#345)

Splitting the big `index.test.ts` into several test files.

Author: ccharly

packages/account-api/src/api/bip44.test.ts

@@ -0,0 +1,78 @@
+import type { KeyringAccountEntropyMnemonicOptions } from '@metamask/keyring-api';
+import { KeyringAccountEntropyTypeOption } from '@metamask/keyring-api';
+
+import { isBip44Account, assertIsBip44Account } from './bip44';
+import { MOCK_ENTROPY_SOURCE_1, MOCK_HD_ACCOUNT_1 } from '../mocks';
+
+describe('bip44', () => {
+  describe('isBip44Account', () => {
+    it('returns true if the account is BIP-44 compatible', () => {
+      expect(isBip44Account(MOCK_HD_ACCOUNT_1)).toBe(true);
+      expect(() => assertIsBip44Account(MOCK_HD_ACCOUNT_1)).not.toThrow();
+    });
+
+    it.each([
+      {
+        tc: 'missing type',
+        options: {
+          entropy: {
+            // Missing type.
+            id: MOCK_ENTROPY_SOURCE_1,
+            groupIndex: 0,
+            derivationPath: '',
+          },
+        },
+      },
+      {
+        tc: 'missing id',
+        options: {
+          entropy: {
+            type: KeyringAccountEntropyTypeOption.Mnemonic,
+            // Missing id.
+            groupIndex: 0,
+            derivationPath: '',
+          },
+        },
+      },
+      {
+        tc: 'missing groupIndex',
+        options: {
+          entropy: {
+            type: 'mnemonic',
+            id: MOCK_ENTROPY_SOURCE_1,
+            // Missing groupIndex.
+            derivationPath: '',
+          },
+        },
+      },
+      {
+        tc: 'missing derivationPath',
+        options: {
+          entropy: {
+            type: 'mnemonic',
+            id: MOCK_ENTROPY_SOURCE_1,
+            groupIndex: 0,
+            // Missing derivationPath.
+          },
+        },
+      },
+    ])(
+      'returns false if the account is not BIP-44 compatible with: $tc',
+      ({ options }) => {
+        const account = {
+          ...MOCK_HD_ACCOUNT_1,
+          options: {
+            entropy:
+              // Force the error case here.
+              options as unknown as KeyringAccountEntropyMnemonicOptions,
+          },
+        };
+
+        expect(isBip44Account(account)).toBe(false);
+        expect(() => assertIsBip44Account(account)).toThrow(
+          'Account is not BIP-44 compatible',
+        );
+      },
+    );
+  });
+});

packages/account-api/src/api/group.test.ts

@@ -0,0 +1,30 @@
+import {
+  DEFAULT_ACCOUNT_GROUP_UNIQUE_ID,
+  toAccountGroupId,
+  toDefaultAccountGroupId,
+} from './group';
+import { AccountWalletType, toAccountWalletId } from './wallet';
+
+describe('group', () => {
+  describe('toAccountGroupId', () => {
+    it('converts an account wallet id and a unique id to a group id', () => {
+      const walletId = toAccountWalletId(AccountWalletType.Keyring, 'test');
+      const groupId = toAccountGroupId(walletId, 'test');
+
+      expect(groupId.startsWith(walletId)).toBe(true);
+      expect(groupId.endsWith('/test')).toBe(true);
+    });
+  });
+
+  describe('toDefaultAccountGroupId', () => {
+    it('converts an account wallet id and to the default group id', () => {
+      const walletId = toAccountWalletId(AccountWalletType.Keyring, 'test');
+      const groupId = toDefaultAccountGroupId(walletId);
+
+      expect(groupId.startsWith(walletId)).toBe(true);
+      expect(groupId.endsWith(`/${DEFAULT_ACCOUNT_GROUP_UNIQUE_ID}`)).toBe(
+        true,
+      );
+    });
+  });
+});

packages/account-api/src/api/multichain/group.test.ts

@@ -0,0 +1,72 @@
+import type { MultichainAccountGroupId } from './group';
+import {
+  getGroupIndexFromMultichainAccountGroupId,
+  isMultichainAccountGroupId,
+  toMultichainAccountGroupId,
+} from './group';
+import { toMultichainAccountWalletId } from './wallet';
+import { MOCK_ENTROPY_SOURCE_1 } from '../../mocks';
+import { toAccountGroupId } from '../group';
+import { AccountWalletType, toAccountWalletId } from '../wallet';
+
+describe('multichain group', () => {
+  describe('toMultichainAccountGroupId', () => {
+    it('computes a multichain account group id with a group index', () => {
+      const groupIndex = 1;
+
+      const walletId = toMultichainAccountWalletId(MOCK_ENTROPY_SOURCE_1);
+      const groupId = toMultichainAccountGroupId(walletId, groupIndex);
+
+      expect(groupId.startsWith(walletId)).toBe(true);
+      expect(groupId.endsWith(`/${groupIndex}`)).toBe(true);
+    });
+  });
+
+  describe('isMultichainAccountGroupId', () => {
+    it('returns true if a group id is a multichain group id', () => {
+      const walletId = toMultichainAccountWalletId(MOCK_ENTROPY_SOURCE_1);
+      const groupId = toMultichainAccountGroupId(walletId, 0);
+
+      expect(isMultichainAccountGroupId(groupId)).toBe(true);
+    });
+
+    it('fails if a group id is not a multichain group id', () => {
+      const walletId = toAccountWalletId(
+        AccountWalletType.Keyring,
+        MOCK_ENTROPY_SOURCE_1,
+      );
+      const groupId = toAccountGroupId(walletId, 'test');
+
+      expect(isMultichainAccountGroupId(groupId)).toBe(false);
+    });
+  });
+
+  describe('getGroupIndexFromMultichainAccountGroupId', () => {
+    it('extracts the group index from its group id', () => {
+      const groupIndex = 2;
+
+      const walletId = toMultichainAccountWalletId(MOCK_ENTROPY_SOURCE_1);
+      const groupId = toMultichainAccountGroupId(walletId, groupIndex);
+
+      expect(getGroupIndexFromMultichainAccountGroupId(groupId)).toBe(
+        groupIndex,
+      );
+    });
+
+    it('throws if it cannot extract group index', () => {
+      const walletId = toAccountWalletId(
+        AccountWalletType.Keyring,
+        MOCK_ENTROPY_SOURCE_1,
+      );
+      const groupId = toAccountGroupId(walletId, 'test');
+
+      expect(() =>
+        getGroupIndexFromMultichainAccountGroupId(
+          // Force the error case even though, type wise, this should not
+          // be possible!
+          groupId as unknown as MultichainAccountGroupId,
+        ),
+      ).toThrow('Unable to extract group index');
+    });
+  });
+});

packages/account-api/src/api/multichain/wallet.test.ts

@@ -0,0 +1,12 @@
+import { toMultichainAccountWalletId } from './wallet';
+import { MOCK_ENTROPY_SOURCE_1 } from '../../mocks';
+
+describe('multichain wallet', () => {
+  describe('toMultichainAccountWalletId', () => {
+    it('computes a multichain account wallet id with an entropy source', () => {
+      const walletId = toMultichainAccountWalletId(MOCK_ENTROPY_SOURCE_1);
+
+      expect(walletId.endsWith(`:${MOCK_ENTROPY_SOURCE_1}`)).toBe(true);
+    });
+  });
+});

packages/account-api/src/api/wallet.test.ts

@@ -0,0 +1,15 @@
+import { AccountWalletType, toAccountWalletId } from './wallet';
+
+describe('wallet', () => {
+  describe('toAccountWalletId', () => {
+    it.each(Object.values(AccountWalletType))(
+      'computes a wallet id for: %s',
+      (type: AccountWalletType) => {
+        const walletId = toAccountWalletId(type, 'test');
+
+        expect(walletId.startsWith(type)).toBe(true);
+        expect(walletId.endsWith(':test')).toBe(true);
+      },
+    );
+  });
+});