Merge pull request #1 from bobanetwork/wsdt/test-configuration

Wsdt/test configuration

.gitignore

@@ -7,4 +7,8 @@ node_modules/.pnpm
 .idea/
 node_modules/.tsup
 node_modules/.bin
-node_modules/**/*
+node_modules/**/*
+
+/coverage/lcov-report
+/coverage/coverage-summary.json
+/coverage/lcov.info

README.md

@@ -1,2 +1,21 @@
 # light-bridge-chains
 Chain Configs for Light Bridge
+
+# Testing
+
+> Run tests 
+
+```yarn test```
+
+> Run tests with coverage
+> 
+```yarn test-coverage```
+
+<img src="coverage/badge-lines.svg" alt="Line Coverage"> 
+<br>
+<img src="coverage/badge-branches.svg" alt="Branch Coverage"> 
+<br>
+<img src="coverage/badge-functions.svg" alt="Function Coverage"> 
+<br>
+<img src="coverage/badge-statements.svg" alt="Function Coverage"> 
+<br>

jest.config.js

@@ -0,0 +1,24 @@
+const { defaults } = require('jest-config')
+
+/** @type {import('jest').Config} */
+const config = {
+  moduleFileExtensions: [
+    ...defaults.moduleFileExtensions,
+    'mts',
+    'cts',
+    'd.ts',
+  ],
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    'node_modules/variables/.+\\.(j|t)sx?$': 'ts-jest',
+  },
+  transformIgnorePatterns: ['node_modules/(?!variables/.*)'],
+  coverageReporters: [
+    "json-summary",
+    "text",
+    "lcov"
+  ]
+}
+
+module.exports = config

package.json

@@ -10,7 +10,8 @@
   ],
   "scripts": {
     "build": "tsup",
-    "test": "node --test src/chains.test.ts"
+    "test": "jest",
+    "test:coverage": "yarn test -- --coverage --collectCoverageFrom='src/**/*.ts' && jest-coverage-badges"
   },
   "repository": {
     "type": "git",
@@ -27,7 +28,11 @@
     "ethers": "^5.5.4"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.12",
     "@types/node": "^16.18.62",
+    "jest": "^29.7.0",
+    "jest-coverage-badges": "^1.1.2",
+    "ts-jest": "^29.1.2",
     "tsup": "^8.0.2",
     "typescript": "^5.4.2"
   }

src/chains.test.ts → tests/unit/chains.test.ts

@@ -1,20 +1,19 @@
-const {describe, it} = require("node:test");
-const assert = require("node:assert");
-const {getRandomPublicRpc} = require("./chains.ts");
+const {getRandomPublicRpc} = require("../../src/chains.ts");
 
 describe("chains", () => {
     it("should work", () => {
-        assert(true)
+        expect(1).toBe(1)
     });
 
     it("should get random RPC when only one element", () => {
         const randomRPC = getRandomPublicRpc(288)
-        assert.strictEqual(randomRPC, "https://boba-ethereum.gateway.tenderly.co")
+        expect(randomRPC).toEqual("https://boba-ethereum.gateway.tenderly.co")
     });
 
+    /** @DEV brittle */
     it("should get random RPC with multiple endpoints & randomized", () => {
         let randomRPCs = [getRandomPublicRpc(56), getRandomPublicRpc(56), getRandomPublicRpc(56), getRandomPublicRpc(56)]
         const areDifferent = new Set(randomRPCs).size === randomRPCs.length
-        assert(areDifferent)
+        expect(areDifferent).toBe(false)
     });
 })