Migrate tests from tape to Jest

.eslintrc.js

@@ -6,6 +6,10 @@ module.exports = {
       files: ['*.ts'],
       extends: ['@metamask/eslint-config-typescript'],
     },
+    {
+      files: ['*.test.js'],
+      extends: ['@metamask/eslint-config-jest'],
+    },
   ],
   rules: {
     camelcase: [

.github/workflows/lint-test.yml

@@ -31,6 +31,7 @@ jobs:
           key: yarn-cache-${{ runner.os }}-${{ steps.yarn-version.outputs.YARN_VERSION }}-${{ hashFiles('yarn.lock') }}
       - run: yarn --frozen-lockfile
       - run: yarn allow-scripts
+      - run: yarn build
       - run: yarn lint
       - run: yarn test
       - name: Validate RC changelog

.gitignore

@@ -8,4 +8,9 @@ package-lock.json
 dist
 test/*.js
 
+# ESLint
 /.eslintcache
+
+# Jest
+/coverage
+

README.md

@@ -78,7 +78,7 @@ Returns a hex-encoded public key.
 
 ### Testing and Linting
 
-Run `yarn test` to run the tests.
+Run `yarn test` to run the tests once. To run tests on file changes, run `yarn test:watch`.
 
 Run `yarn lint` to run the linter, or run `yarn lint:fix` to run the linter and fix any automatically fixable issues.
 

jest.config.js

@@ -0,0 +1,27 @@
+module.exports = {
+  collectCoverage: true,
+  // Ensures that we collect coverage from all source files, not just tested
+  // ones.
+  collectCoverageFrom: ['./src/**.ts'],
+  coverageReporters: ['text', 'html'],
+  coverageThreshold: {
+    global: {
+      branches: 74,
+      functions: 100,
+      lines: 94,
+      statements: 94,
+    },
+  },
+  moduleFileExtensions: ['js', 'json', 'jsx', 'ts', 'tsx', 'node'],
+  preset: 'ts-jest',
+  // "resetMocks" resets all mocks, including mocked modules, to jest.fn(),
+  // between each test case.
+  resetMocks: true,
+  // "restoreMocks" restores all mocks created using jest.spyOn to their
+  // original implementations, between each test. It does not affect mocked
+  // modules.
+  restoreMocks: true,
+  testEnvironment: 'node',
+  testRegex: ['\\.test\\.(ts|js)$'],
+  testTimeout: 2500,
+};

package.json

@@ -22,12 +22,13 @@
   ],
   "scripts": {
     "setup": "yarn install && yarn allow-scripts",
-    "build": "tsc --project ./tsconfig.json && tsc --project ./tsconfig.test.json",
+    "build": "tsc --project .",
     "lint:eslint": "eslint . --cache --ext js,ts",
     "lint:json": "prettier '**/*.json' --ignore-path .gitignore",
     "lint": "yarn lint:eslint && yarn lint:json --check",
     "lint:fix": "yarn lint:eslint --fix && yarn lint:json --write",
-    "test": "yarn build && node test/index.js",
+    "test": "jest",
+    "test:watch": "jest --watch",
     "prepublishOnly": "yarn build"
   },
   "resolutions": {
@@ -43,19 +44,23 @@
     "@lavamoat/allow-scripts": "^1.0.6",
     "@metamask/auto-changelog": "^2.4.0",
     "@metamask/eslint-config": "^7.0.1",
+    "@metamask/eslint-config-jest": "^7.0.0",
     "@metamask/eslint-config-nodejs": "^7.0.0",
     "@metamask/eslint-config-typescript": "^7.0.1",
+    "@types/jest": "^26.0.24",
     "@types/node": "^14.14.25",
     "@typescript-eslint/eslint-plugin": "^4.28.2",
     "@typescript-eslint/parser": "^4.28.2",
     "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jest": "^24.3.6",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.0",
+    "jest": "^27.0.6",
     "prettier": "^2.3.2",
     "prettier-plugin-packagejson": "^2.2.11",
-    "tape": "^4.9.1",
+    "ts-jest": "^27.0.3",
     "typescript": "^4.1.3"
   },
   "engines": {