feat: move to jest

Author: egor-romanov

.mocharc.yml

@@ -0,0 +1,23 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+  preset: 'ts-jest',
+  transform: {
+    '^.+\\.ts?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'js', 'cjs', 'json', 'node',],
+  setupFilesAfterEnv: [
+    './test/utils/jest-custom-reporter.ts',
+  ],
+  testEnvironment: 'jest-circus-allure-environment',
+  testTimeout: 60000,
+  coverageThreshold: {
+    global: {
+      branches: 0,
+      functions: 0,
+      lines: 0,
+      statements: 0,
+    },
+  },
+};
+export default config;

config.json

@@ -15,6 +15,7 @@
     "docs": "typedoc src/index.ts src/types.ts --excludePrivate --excludeProtected",
     "docs:json": "typedoc --json docs/spec.json --excludeExternals src/index.ts src/types.ts",
     "test": "mocha",
+    "test": "jest",
     "allure:generate": "rm -rf allure-report && node_modules/allure-commandline/bin/allure generate",
     "allure:serve": "node_modules/allure-commandline/bin/allure serve",
     "test:report": "npm run allure:generate && npm run allure:serve"
@@ -41,31 +42,26 @@
     "cross-fetch": "^3.1.5"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.0",
+    "@types/jest": "^27.4.1",
     "@types/jsonwebtoken": "^8.5.8",
-    "@types/mocha": "^9.1.0",
     "@types/node": "^17.0.23",
     "allure-commandline": "^2.17.2",
-    "chai": "^4.3.6",
     "genversion": "^3.0.2",
+    "jest": "^27.5.1",
+    "jest-circus-allure-environment": "^1.1.1",
     "jsonwebtoken": "^8.5.1",
-    "mocha": "^8.4.0",
-    "mocha-allure2-reporter": "^0.0.3",
-    "mocha-multi-reporters": "^1.5.1",
     "nanoid": "^3.3.1",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.6.0",
     "rimraf": "^3.0.2",
     "semantic-release": "^19.0.2",
     "semantic-release-plugin-update-version-in-files": "^1.1.0",
-<<<<<<< HEAD
     "typedoc": "^0.22.16",
-=======
     "testcontainers": "^8.5.1",
+    "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",
     "ts-test-decorators": "^0.0.6",
     "typedoc": "^0.22.13",
->>>>>>> b3a0615 (feat: add basic test and testing core)
     "typescript": "^4.6.2"
   },
   "publishConfig": {

jest.config.ts

@@ -4,9 +4,8 @@ import crossFetch from 'cross-fetch'
 import { sign } from 'jsonwebtoken'
 import { GenericContainer, Network, StartedTestContainer, Wait } from 'testcontainers'
 import { ExecResult } from 'testcontainers/dist/docker/types'
-import { ContentType } from 'allure2-js-commons'
-
-import { attach, log } from '../utils/allure'
+import { attach, log } from '../utils/jest-custom-reporter'
+import { ContentType } from 'allure-js-commons'
 
 /**
  * A Relay contains a running relay container that has a unique ID and two promises:

package.json

@@ -1,29 +1,31 @@
-import 'mocha'
-import { assert } from 'chai'
+import 'jest'
 import { nanoid } from 'nanoid'
 import { sign } from 'jsonwebtoken'
-import { ContentType } from 'allure2-js-commons'
+import { ContentType } from 'allure-js-commons'
 
 import { FunctionsClient } from '../../src/index'
 
 import { Relay, runRelay } from '../relay/container'
-import { attach, log } from '../utils/allure'
+import { attach, log } from '../utils/jest-custom-reporter'
 import { getCustomFetch } from '../utils/fetch'
 
 describe('basic tests (hello function)', () => {
   let relay: Relay
   const jwtSecret = nanoid(10)
   const apiKey = sign({ name: 'anon' }, jwtSecret)
 
-  before(async () => {
+  beforeAll(async () => {
     relay = await runRelay('hello', jwtSecret)
   })
 
-  after(async () => {
+  afterAll(async () => {
     relay && relay.container && (await relay.container.stop())
   })
 
-  it('invoke hello with auth header', async () => {
+  test('invoke hello with auth header', async () => {
+    /**
+     * @feature auth
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`, {
       Authorization: `Bearer ${apiKey}`,
@@ -33,12 +35,15 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('hello', { responseType: 'text' })
 
     log('assert no error')
-    assert.isNull(error)
+    expect(error).toBeNull()
     log(`assert ${data} is equal to 'Hello World'`)
-    assert.equal(data, 'Hello World')
+    expect(data).toEqual('Hello World')
   })
 
-  it('invoke hello with setAuth', async () => {
+  test('invoke hello with setAuth', async () => {
+    /**
+     * @feature auth
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`)
     attach('setAuth', apiKey, ContentType.TEXT)
@@ -48,12 +53,15 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('hello', { responseType: 'text' })
 
     log('assert no error')
-    assert.isNull(error)
+    expect(error).toBeNull()
     log(`assert ${data} is equal to 'Hello World'`)
-    assert.equal(data, 'Hello World')
+    expect(data).toEqual('Hello World')
   })
 
-  it('invoke hello with setAuth wrong key', async () => {
+  test('invoke hello with setAuth wrong key', async () => {
+    /**
+     * @feature errors
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`)
     const wrongKey = sign({ name: 'anon' }, 'wrong_jwt')
@@ -64,12 +72,15 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('hello', { responseType: 'text' })
 
     log('check error')
-    assert.isNotNull(error)
-    assert.equal(error?.message, 'Invalid JWT')
-    assert.isNull(data)
+    expect(error).not.toBeNull()
+    expect(error?.message).toEqual('Invalid JWT')
+    expect(data).toBeNull()
   })
 
-  it('invoke hello: auth override by setAuth wrong key', async () => {
+  test('invoke hello: auth override by setAuth wrong key', async () => {
+    /**
+     * @feature auth
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`, {
       Authorization: `Bearer ${apiKey}`,
@@ -82,12 +93,15 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('hello', { responseType: 'text' })
 
     log('check error')
-    assert.isNotNull(error)
-    assert.equal(error?.message, 'Invalid JWT')
-    assert.isNull(data)
+    expect(error).not.toBeNull()
+    expect(error?.message).toEqual('Invalid JWT')
+    expect(data).toBeNull()
   })
 
-  it('invoke hello: auth override by setAuth right key', async () => {
+  test('invoke hello: auth override by setAuth right key', async () => {
+    /**
+     * @feature auth
+     */
     const wrongKey = sign({ name: 'anon' }, 'wrong_jwt')
 
     log('create FunctionsClient with wrong jwt')
@@ -102,12 +116,15 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('hello', { responseType: 'text' })
 
     log('assert no error')
-    assert.isNull(error)
+    expect(error).toBeNull()
     log(`assert ${data} is equal to 'Hello World'`)
-    assert.equal(data, 'Hello World')
+    expect(data).toEqual('Hello World')
   })
 
-  it('invoke hello with auth header in invoke', async () => {
+  test('invoke hello with auth header in invoke', async () => {
+    /**
+     * @feature auth
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`)
 
@@ -120,12 +137,15 @@ describe('basic tests (hello function)', () => {
     })
 
     log('assert no error')
-    assert.isNull(error)
+    expect(error).toBeNull()
     log(`assert ${data} is equal to 'Hello World'`)
-    assert.equal(data, 'Hello World')
+    expect(data).toEqual('Hello World')
   })
 
-  it('invoke hello with auth header override in invoke', async () => {
+  test('invoke hello with auth header override in invoke', async () => {
+    /**
+     * @feature auth
+     */
     log('create FunctionsClient with wrong jwt')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`)
 
@@ -142,12 +162,15 @@ describe('basic tests (hello function)', () => {
     })
 
     log('assert no error')
-    assert.isNull(error)
+    expect(error).toBeNull()
     log(`assert ${data} is equal to 'Hello World'`)
-    assert.equal(data, 'Hello World')
+    expect(data).toEqual('Hello World')
   })
 
-  it('invoke hello with wrong auth header overridden in invoke', async () => {
+  test('invoke hello with wrong auth header overridden in invoke', async () => {
+    /**
+     * @feature auth
+     */
     log('create FunctionsClient with wrong jwt')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`, {
       Authorization: `Bearer ${apiKey}`,
@@ -163,12 +186,15 @@ describe('basic tests (hello function)', () => {
     })
 
     log('check error')
-    assert.isNotNull(error)
-    assert.equal(error?.message, 'Invalid JWT')
-    assert.isNull(data)
+    expect(error).not.toBeNull()
+    expect(error?.message).toEqual('Invalid JWT')
+    expect(data).toBeNull()
   })
 
   it.skip('invoke missing function', async () => {
+    /**
+     * @feature errors
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`, {
       Authorization: `Bearer ${apiKey}`,
@@ -178,12 +204,15 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('missing', { responseType: 'text' })
 
     log('check error')
-    assert.isNotNull(error)
-    assert.equal(error?.message, 'Invalid JWT')
-    assert.isNull(data)
+    expect(error).not.toBeNull()
+    expect(error?.message).toEqual('Invalid JWT')
+    expect(data).toBeNull()
   })
 
-  it('invoke with custom fetch', async () => {
+  test('invoke with custom fetch', async () => {
+    /**
+     * @feature fetch
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(
       `http://localhost:${relay.container.getMappedPort(8081)}`,
@@ -200,12 +229,15 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('', { responseType: 'text' })
 
     log('assert no error')
-    assert.isNull(error)
+    expect(error).toBeNull()
     log(`assert ${data} is equal to 'Hello World'`)
-    assert.equal(data, 'Hello World')
+    expect(data).toEqual('Hello World')
   })
 
-  it('invoke with custom fetch wrong method', async () => {
+  test('invoke with custom fetch wrong method', async () => {
+    /**
+     * @feature fetch
+     */
     log('create FunctionsClient')
     const fclient = new FunctionsClient(
       `http://localhost:${relay.container.getMappedPort(8081)}`,
@@ -222,13 +254,16 @@ describe('basic tests (hello function)', () => {
     const { data, error } = await fclient.invoke<string>('', { responseType: 'text' })
 
     log('check error')
-    assert.isNotNull(error)
+    expect(error).not.toBeNull()
     log(`assert ${error?.message} is equal to 'Only POST and OPTIONS requests are supported'`)
-    assert.equal(error?.message, 'Only POST and OPTIONS requests are supported')
-    assert.isNull(data)
+    expect(error?.message).toEqual('Only POST and OPTIONS requests are supported')
+    expect(data).toBeNull()
   })
 
-  it('invoke hello with custom fetch override header', async () => {
+  test('invoke hello with custom fetch override header', async () => {
+    /**
+     * @feature fetch
+     */
     const wrongKey = sign({ name: 'anon' }, 'wrong_jwt')
     log('create FunctionsClient')
     const fclient = new FunctionsClient(
@@ -250,8 +285,8 @@ describe('basic tests (hello function)', () => {
     })
 
     log('assert no error')
-    assert.isNull(error)
+    expect(error).toBeNull()
     log(`assert ${data} is equal to 'Hello World'`)
-    assert.equal(data, 'Hello World')
+    expect(data).toEqual('Hello World')
   })
 })