Merge pull request #83 from magiclabs/mushfichowdhury/sc49279/convertAllTestsToJest

Converted all Ava and Sinon testing to Jest

Author: smithki

.eslintignore

@@ -0,0 +1 @@
+jest.config.ts

jest.config.ts

@@ -0,0 +1,26 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+  maxWorkers: 2,
+  preset: 'ts-jest',
+  coverageReporters: ['text-summary', 'html'],
+  collectCoverageFrom: ['./src/**/*.{ts,tsx,}'],
+  collectCoverage: true,
+  testTimeout: 30000, // 30s
+  coverageThreshold: {
+    global: {
+      lines: 99,
+      statements: 99,
+      functions: 99,
+      branches: 99,
+    }
+  },
+  globals: {
+    'ts-jest': {
+      tsconfig: './test/tsconfig.json',
+      isolatedModules: true,
+    },
+  },
+};
+
+export default config;

package.json

@@ -16,7 +16,7 @@
     "test": "npm run clean:test-artifacts && ./scripts/test.sh",
     "lint": "eslint --fix src/**/*.ts",
     "clean": "npm-run-all -s clean:*",
-    "clean:test-artifacts": "rimraf coverage && rimraf .nyc_output",
+    "clean:test-artifacts": "rimraf coverage",
     "clean:build": "rimraf dist",
     "clean_node_modules": "rimraf node_modules"
   },
@@ -26,12 +26,11 @@
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@types/eth-sig-util": "^2.1.0",
     "@types/express": "^4.17.2",
+    "@types/jest": "^27.4.1",
     "@types/node": "^13.1.2",
     "@types/node-fetch": "^2.5.4",
-    "@types/sinon": "^7.5.2",
     "@typescript-eslint/eslint-plugin": "^2.15.0",
     "auto": "^9.60.1",
-    "ava": "^3.4.0",
     "boxen-cli": "^1.0.0",
     "eslint": "^6.7.2",
     "eslint-import-resolver-typescript": "^2.0.0",
@@ -41,15 +40,15 @@
     "eslint-plugin-react": "^7.15.1",
     "eslint-plugin-react-hooks": "^1.7.0",
     "husky": "^4.2.3",
+    "jest": "^27.5.1",
     "lint-staged": "^10.0.8",
     "npm-run-all": "~4.1.5",
-    "nyc": "^15.0.0",
     "prettier": "^1.19.1",
     "rimraf": "~3.0.0",
-    "sinon": "^9.0.0",
     "ts-node": "~8.5.2",
     "tslint": "~5.20.1",
-    "typescript": "~3.8.3"
+    "typescript": "~3.8.3",
+    "ts-jest": "^27.1.3"
   },
   "dependencies": {
     "eth-sig-util": "2.1.2",
@@ -70,31 +69,5 @@
       "npm",
       "released"
     ]
-  },
-  "ava": {
-    "require": [
-      "ts-node/register"
-    ],
-    "files": [
-      "test/**/*.spec.ts"
-    ],
-    "extensions": [
-      "ts"
-    ],
-    "verbose": true
-  },
-  "nyc": {
-    "extends": "@istanbuljs/nyc-config-typescript",
-    "all": false,
-    "check-coverage": true,
-    "per-file": true,
-    "lines": 99,
-    "statements": 99,
-    "functions": 99,
-    "branches": 99,
-    "reporter": [
-      "html",
-      "lcov"
-    ]
   }
 }

scripts/test.sh

@@ -10,4 +10,4 @@ export NODE_OPTIONS=--max_old_space_size=4096
 export NODE_ENV=test
 
 export TS_NODE_PROJECT="test/tsconfig.json"
-npx nyc --reporter=lcov --reporter=text-summary ava $input
+jest $input

test/spec/core/sdk-exceptions/error-factories.spec.ts

@@ -1,6 +1,4 @@
 /* eslint-disable no-underscore-dangle */
-
-import test, { ExecutionContext } from 'ava';
 import {
   MagicAdminSDKError,
   createTokenExpiredError,
@@ -12,86 +10,75 @@ import {
   createTokenCannotBeUsedYetError,
 } from '../../../../src/core/sdk-exceptions';
 
-function errorAssertions<T extends ExecutionContext<any>>(
-  t: T,
+function errorAssertions(
   error: MagicAdminSDKError,
   expectedCode: string,
   expectedMessage: string,
   expectedData: any[] = [],
 ) {
-  t.true(error instanceof MagicAdminSDKError);
-  t.is(error.code, expectedCode);
-  t.is(error.message, `Magic Admin SDK Error: [${expectedCode}] ${expectedMessage}`);
-  t.deepEqual(error.data, expectedData);
+  expect(error instanceof MagicAdminSDKError).toBe(true);
+  expect(error.code).toBe(expectedCode);
+  expect(error.message).toBe(`Magic Admin SDK Error: [${expectedCode}] ${expectedMessage}`);
+  expect(error.data).toEqual(expectedData);
 }
 
-test('#01: Creates `ERROR_DIDT_EXPIRED` error', async t => {
+test('#01: Creates `ERROR_DIDT_EXPIRED` error', async () => {
   const error = createTokenExpiredError();
-  errorAssertions(t, error, 'ERROR_DIDT_EXPIRED', 'DID Token has expired. Request failed authentication.');
+  errorAssertions(error, 'ERROR_DIDT_EXPIRED', 'DID Token has expired. Request failed authentication.');
 });
 
-test('#02: Creates `ERROR_DIDT_CANNOT_BE_USED_YET` error', async t => {
+test('#02: Creates `ERROR_DIDT_CANNOT_BE_USED_YET` error', async () => {
   const error = createTokenCannotBeUsedYetError();
   errorAssertions(
-    t,
     error,
     'ERROR_DIDT_CANNOT_BE_USED_YET',
     'Given DID Token cannot be used at this time. Please check the `nbf` field and regenerate a new token with a suitable value.',
   );
 });
 
-test('#03: Creates `ERROR_INCORRECT_SIGNER_ADDR` error', async t => {
+test('#03: Creates `ERROR_INCORRECT_SIGNER_ADDR` error', async () => {
   const error = createIncorrectSignerAddressError();
   errorAssertions(
-    t,
     error,
     'ERROR_INCORRECT_SIGNER_ADDR',
     'Incorrect signer address for DID Token. Request failed authentication.',
   );
 });
 
-test('#04: Creates `ERROR_FAILED_RECOVERING_PROOF` error', async t => {
+test('#04: Creates `ERROR_FAILED_RECOVERING_PROOF` error', async () => {
   const error = createFailedRecoveringProofError();
-  errorAssertions(t, error, 'ERROR_FAILED_RECOVERING_PROOF', 'Failed to recover proof. Request failed authentication.');
+  errorAssertions(error, 'ERROR_FAILED_RECOVERING_PROOF', 'Failed to recover proof. Request failed authentication.');
 });
 
-test('#05: Creates `ERROR_SECRET_API_KEY_MISSING` error', async t => {
+test('#05: Creates `ERROR_SECRET_API_KEY_MISSING` error', async () => {
   const error = createApiKeyMissingError();
   errorAssertions(
-    t,
     error,
     'ERROR_SECRET_API_KEY_MISSING',
     'Please provide a secret Fortmatic API key that you acquired from the developer dashboard.',
   );
 });
 
-test('#06: Creates `SERVICE_ERROR` error with empty `data` property', async t => {
+test('#06: Creates `SERVICE_ERROR` error with empty `data` property', async () => {
   const error = createServiceError();
   errorAssertions(
-    t,
     error,
     'SERVICE_ERROR',
     'A service error occurred while communicating with the Magic API. Check the `data` key of this error object to see nested errors with additional context.',
   );
 });
 
-test('#07: Creates `SERVICE_ERROR` error with non-empty `data` property', async t => {
+test('#07: Creates `SERVICE_ERROR` error with non-empty `data` property', async () => {
   const error = createServiceError('hello', 'world');
   errorAssertions(
-    t,
     error,
     'SERVICE_ERROR',
     'A service error occurred while communicating with the Magic API. Check the `data` key of this error object to see nested errors with additional context.',
     ['hello', 'world'],
   );
 });
 
-test('#08: Creates `EXPECTED_BEARER_STRING` error', async t => {
+test('#08: Creates `EXPECTED_BEARER_STRING` error', async () => {
   const error = createExpectedBearerStringError();
-  errorAssertions(
-    t,
-    error,
-    'EXPECTED_BEARER_STRING',
-    'Expected argument to be a string in the `Bearer {token}` format.',
-  );
+  errorAssertions(error, 'EXPECTED_BEARER_STRING', 'Expected argument to be a string in the `Bearer {token}` format.');
 });

test/spec/core/sdk-exceptions/magic-admin-sdk-error/constructor.spec.ts

@@ -1,18 +1,17 @@
-import test from 'ava';
 import { MagicAdminSDKError } from '../../../../../src/core/sdk-exceptions';
 
-test('#01: Instantiates `MagicAdminSDKError` with empty `data` property', t => {
+test('#01: Instantiates `MagicAdminSDKError` with empty `data` property', () => {
   const error = new MagicAdminSDKError('TEST_CODE' as any, 'test message');
-  t.true(error instanceof MagicAdminSDKError);
-  t.is(error.message, 'Magic Admin SDK Error: [TEST_CODE] test message');
-  t.is(error.code, 'TEST_CODE');
-  t.deepEqual(error.data, []);
+  expect(error instanceof MagicAdminSDKError).toBe(true);
+  expect(error.message).toBe('Magic Admin SDK Error: [TEST_CODE] test message');
+  expect(error.code).toBe('TEST_CODE');
+  expect(error.data).toEqual([]);
 });
 
-test('#01: Instantiates `MagicAdminSDKError` with non-empty `data` property', t => {
+test('#01: Instantiates `MagicAdminSDKError` with non-empty `data` property', () => {
   const error = new MagicAdminSDKError('TEST_CODE' as any, 'test message', ['hello world']);
-  t.true(error instanceof MagicAdminSDKError);
-  t.is(error.message, 'Magic Admin SDK Error: [TEST_CODE] test message');
-  t.is(error.code, 'TEST_CODE');
-  t.deepEqual(error.data, ['hello world']);
+  expect(error instanceof MagicAdminSDKError).toBe(true);
+  expect(error.message).toBe('Magic Admin SDK Error: [TEST_CODE] test message');
+  expect(error.code).toBe('TEST_CODE');
+  expect(error.data).toEqual(['hello world']);
 });

test/spec/core/sdk/constructor.spec.ts

@@ -1,37 +1,35 @@
 /* eslint-disable no-new */
-
-import test from 'ava';
-import { MagicAdminSDK } from '../../../../src/core/sdk';
+import { Magic } from '../../../../src/index';
 import { API_FULL_URL, API_KEY } from '../../../lib/constants';
 import { TokenModule } from '../../../../src/modules/token';
 import { UsersModule } from '../../../../src/modules/users';
 import { UtilsModule } from '../../../../src/modules/utils';
 
-test.serial('#01: Initialize `MagicAdminSDK`', t => {
-  const magic = new MagicAdminSDK(API_KEY);
+test('#01: Initialize `MagicAdminSDK`', () => {
+  const magic = new Magic(API_KEY);
 
-  t.is(magic.secretApiKey, API_KEY);
-  t.is(magic.apiBaseUrl, API_FULL_URL);
-  t.true(magic.token instanceof TokenModule);
-  t.true(magic.users instanceof UsersModule);
+  expect(magic.secretApiKey).toBe(API_KEY);
+  expect(magic.apiBaseUrl).toBe(API_FULL_URL);
+  expect(magic.token instanceof TokenModule).toBe(true);
+  expect(magic.users instanceof UsersModule).toBe(true);
 });
 
-test.serial('#02: Initialize `MagicAdminSDK` with custom endpoint', t => {
-  const magic = new MagicAdminSDK(API_KEY, { endpoint: 'https://example.com' });
+test('#02: Initialize `MagicAdminSDK` with custom endpoint', () => {
+  const magic = new Magic(API_KEY, { endpoint: 'https://example.com' });
 
-  t.is(magic.secretApiKey, API_KEY);
-  t.is(magic.apiBaseUrl, 'https://example.com');
-  t.true(magic.token instanceof TokenModule);
-  t.true(magic.users instanceof UsersModule);
-  t.true(magic.utils instanceof UtilsModule);
+  expect(magic.secretApiKey).toBe(API_KEY);
+  expect(magic.apiBaseUrl).toBe('https://example.com');
+  expect(magic.token instanceof TokenModule).toBe(true);
+  expect(magic.users instanceof UsersModule).toBe(true);
+  expect(magic.utils instanceof UtilsModule).toBe(true);
 });
 
-test.serial('#03: Strips trailing slash(es) from custom endpoint argument', t => {
-  const magicA = new MagicAdminSDK(API_KEY, { endpoint: 'https://example.com/' });
-  const magicB = new MagicAdminSDK(API_KEY, { endpoint: 'https://example.com//' });
-  const magicC = new MagicAdminSDK(API_KEY, { endpoint: 'https://example.com///' });
+test('#03: Strips trailing slash(es) from custom endpoint argument', () => {
+  const magicA = new Magic(API_KEY, { endpoint: 'https://example.com/' });
+  const magicB = new Magic(API_KEY, { endpoint: 'https://example.com//' });
+  const magicC = new Magic(API_KEY, { endpoint: 'https://example.com///' });
 
-  t.is(magicA.apiBaseUrl, 'https://example.com');
-  t.is(magicB.apiBaseUrl, 'https://example.com');
-  t.is(magicC.apiBaseUrl, 'https://example.com');
+  expect(magicA.apiBaseUrl).toBe('https://example.com');
+  expect(magicB.apiBaseUrl).toBe('https://example.com');
+  expect(magicC.apiBaseUrl).toBe('https://example.com');
 });

test/spec/modules/base-module/constructor.spec.ts

@@ -1,13 +1,12 @@
-import test from 'ava';
 import { MagicAdminSDK } from '../../../../src/core/sdk';
 import { BaseModule } from '../../../../src/modules/base-module';
 import { createMagicAdminSDK } from '../../../lib/factories';
 
-test.serial('#01: Initializes `BaseModule`', t => {
+test('#01: Initializes `BaseModule`', () => {
   const sdk = createMagicAdminSDK();
 
   const baseModule: any = new (BaseModule as any)(sdk);
 
-  t.true(baseModule instanceof BaseModule);
-  t.true(baseModule.sdk instanceof MagicAdminSDK);
+  expect(baseModule instanceof BaseModule).toBe(true);
+  expect(baseModule.sdk instanceof MagicAdminSDK).toBe(true);
 });

test/spec/modules/token/decode.spec.ts

@@ -1,18 +1,15 @@
-import test from 'ava';
 import { createMagicAdminSDK } from '../../../lib/factories';
 import { VALID_DIDT, VALID_DIDT_DECODED, INVALID_DIDT_MALFORMED_CLAIM } from '../../../lib/constants';
-import { MagicAdminSDKError, createMalformedTokenError } from '../../../../src/core/sdk-exceptions';
+import { createMalformedTokenError } from '../../../../src/core/sdk-exceptions';
 
-test('#01: Successfully decodes DIDT', async t => {
+test('#01: Successfully decodes DIDT', async () => {
   const sdk = createMagicAdminSDK();
   const result = sdk.token.decode(VALID_DIDT);
-  t.deepEqual(result, VALID_DIDT_DECODED);
+  expect(result).toEqual(VALID_DIDT_DECODED);
 });
 
-test('#02: Throws error if token is malformed', async t => {
+test('#02: Throws error if token is malformed', async () => {
   const sdk = createMagicAdminSDK();
   const expectedError = createMalformedTokenError();
-  const error: MagicAdminSDKError = t.throws(() => sdk.token.decode(INVALID_DIDT_MALFORMED_CLAIM));
-  t.is(error.code, expectedError.code);
-  t.is(error.message, expectedError.message);
+  expect(() => sdk.token.decode(INVALID_DIDT_MALFORMED_CLAIM)).toThrow(expectedError);
 });

test/spec/modules/token/getIssuer.spec.ts

@@ -1,10 +1,9 @@
-import test from 'ava';
 import { createMagicAdminSDK } from '../../../lib/factories';
 import { VALID_DIDT, VALID_DIDT_PARSED_CLAIMS } from '../../../lib/constants';
 
-test('#01: Successfully gets issuer from DIDT', t => {
+test('#01: Successfully gets issuer from DIDT', () => {
   const sdk = createMagicAdminSDK();
   const result = sdk.token.getIssuer(VALID_DIDT);
   const expected = VALID_DIDT_PARSED_CLAIMS.iss;
-  t.is(result, expected);
+  expect(result).toBe(expected);
 });

test/spec/modules/token/getPublicAddress.spec.ts

@@ -1,10 +1,9 @@
-import test from 'ava';
 import { createMagicAdminSDK } from '../../../lib/factories';
 import { VALID_DIDT, VALID_DIDT_PARSED_CLAIMS } from '../../../lib/constants';
 
-test('#01: Successfully gets public address from DIDT', t => {
+test('#01: Successfully gets public address from DIDT', () => {
   const sdk = createMagicAdminSDK();
   const result = sdk.token.getPublicAddress(VALID_DIDT);
   const expected = VALID_DIDT_PARSED_CLAIMS.iss.split(':')[2];
-  t.is(result, expected);
+  expect(result).toBe(expected);
 });