chore: migrate from tap to native test runner (#172)

* chore: migrate from tap to native test runner * Merge branch 'master' into migrate-tap-to-native-test-runner * remove coverage npm script * fix test * fix windows * fix windows * fix windows --------- Signed-off-by: Aras Abbasi <aras.abbasi@googlemail.com>
fastify · Aug 20, 2024 · 3ac8496 · 3ac8496
1 parent a625094
commit 3ac8496
Show file tree

Hide file tree

Showing 14 changed files with 426 additions and 401 deletions.
diff --git a/e2e/custom.test.js → e2e/custom.spec.js b/e2e/custom.test.js → e2e/custom.spec.js
diff --git a/package.json b/package.json
@@ -6,20 +6,17 @@
   "type": "commonjs",
   "types": "types/index.d.ts",
   "scripts": {
-    "coverage": "npm run unit -- --coverage-report=lcovonly",
     "lint": "standard",
     "lint:fix": "npm run lint -- --fix",
     "prepare": "node scripts/prepare-swagger-ui",
     "prepublishOnly": "npm run prepare",
-    "test": "npm run prepare && npm run coverage && npm run typescript",
+    "test": "npm run prepare && npm run unit && npm run typescript",
     "test:dev": "npm run lint && npm run unit && npm run typescript",
     "test:e2e:command": "node ./examples/example-e2e.js",
     "test:e2e": "npx playwright test",
     "test:e2e:ui": "npx playwright test --ui",
     "typescript": "tsd",
-    "unit": "tap",
-    "unit:report": "npm run unit -- --coverage-report=html",
-    "unit:verbose": "npm run unit -- -Rspec"
+    "unit": "c8 --100 node --test"
   },
   "repository": {
     "type": "git",
@@ -52,15 +49,14 @@
     "@fastify/pre-commit": "^2.1.0",
     "@fastify/swagger": "^9.0.0-pre.fv5.1",
     "@playwright/test": "^1.43.1",
-    "@tapjs/snapshot": "^4.0.0",
     "@types/node": "^22.0.0",
     "ajv": "^8.12.0",
+    "c8": "^10.1.2",
     "fastify": "5.0.0-alpha.3",
     "fs-extra": "^11.2.0",
     "qs": "^6.12.1",
     "standard": "^17.1.0",
     "swagger-ui-dist": "5.17.14",
-    "tap": "^19.2.5",
     "tsd": "^0.31.0"
   },
   "dependencies": {

diff --git a/tap-snapshots/test/static.test.js.test.cjs b/tap-snapshots/test/static.test.js.test.cjs
diff --git a/test/csp.test.js b/test/csp.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { test } = require('tap')
+const { test } = require('node:test')
 const Fastify = require('fastify')
 const fastifyHelmet = require('@fastify/helmet')
 const fastifySwagger = require('@fastify/swagger')
@@ -33,9 +33,9 @@ test('staticCSP = undefined', async (t) => {
     method: 'GET',
     url: '/documentation'
   })
-  t.equal(res.statusCode, 200)
-  t.equal(typeof res.headers['content-security-policy'], 'undefined')
-  t.equal(typeof res.payload, 'string')
+  t.assert.deepStrictEqual(res.statusCode, 200)
+  t.assert.deepStrictEqual(typeof res.headers['content-security-policy'], 'undefined')
+  t.assert.deepStrictEqual(typeof res.payload, 'string')
 })
 
 test('staticCSP = true', async (t) => {
@@ -59,18 +59,18 @@ test('staticCSP = true', async (t) => {
       method: 'GET',
       url: '/documentation'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(res.headers['content-security-policy'], `default-src 'self'; base-uri 'self'; font-src 'self' https: data:; frame-ancestors 'self'; img-src 'self' data: validator.swagger.io; object-src 'none'; script-src 'self' ${csp.script.join(' ')}; script-src-attr 'none'; style-src 'self' https: ${csp.style.join(' ')}; upgrade-insecure-requests;`)
-    t.equal(typeof res.payload, 'string')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(res.headers['content-security-policy'], `default-src 'self'; base-uri 'self'; font-src 'self' https: data:; frame-ancestors 'self'; img-src 'self' data: validator.swagger.io; object-src 'none'; script-src 'self' ${csp.script.join(' ')}; script-src-attr 'none'; style-src 'self' https: ${csp.style.join(' ')}; upgrade-insecure-requests;`)
+    t.assert.deepStrictEqual(typeof res.payload, 'string')
   }
 
   {
     const res = await fastify.inject({
       method: 'GET',
       url: '/'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(typeof res.headers['content-security-policy'], 'undefined')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(typeof res.headers['content-security-policy'], 'undefined')
   }
 })
 
@@ -95,18 +95,18 @@ test('staticCSP = "default-src \'self\';"', async (t) => {
       method: 'GET',
       url: '/documentation'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(res.headers['content-security-policy'], "default-src 'self';")
-    t.equal(typeof res.payload, 'string')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(res.headers['content-security-policy'], "default-src 'self';")
+    t.assert.deepStrictEqual(typeof res.payload, 'string')
   }
 
   {
     const res = await fastify.inject({
       method: 'GET',
       url: '/'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(typeof res.headers['content-security-policy'], 'undefined')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(typeof res.headers['content-security-policy'], 'undefined')
   }
 })
 
@@ -134,18 +134,18 @@ test('staticCSP = object', async (t) => {
       method: 'GET',
       url: '/documentation'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(res.headers['content-security-policy'], "default-src 'self'; script-src 'self';")
-    t.equal(typeof res.payload, 'string')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(res.headers['content-security-policy'], "default-src 'self'; script-src 'self';")
+    t.assert.deepStrictEqual(typeof res.payload, 'string')
   }
 
   {
     const res = await fastify.inject({
       method: 'GET',
       url: '/'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(typeof res.headers['content-security-policy'], 'undefined')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(typeof res.headers['content-security-policy'], 'undefined')
   }
 })
 
@@ -157,7 +157,7 @@ test('transformStaticCSP = function', async (t) => {
   await fastify.register(fastifySwaggerUi, {
     staticCSP: "default-src 'self';",
     transformStaticCSP: function (header) {
-      t.equal(header, "default-src 'self';")
+      t.assert.deepStrictEqual(header, "default-src 'self';")
       return "default-src 'self'; script-src 'self';"
     }
   })
@@ -174,18 +174,18 @@ test('transformStaticCSP = function', async (t) => {
       method: 'GET',
       url: '/documentation'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(res.headers['content-security-policy'], "default-src 'self'; script-src 'self';")
-    t.equal(typeof res.payload, 'string')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(res.headers['content-security-policy'], "default-src 'self'; script-src 'self';")
+    t.assert.deepStrictEqual(typeof res.payload, 'string')
   }
 
   {
     const res = await fastify.inject({
       method: 'GET',
       url: '/'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(typeof res.headers['content-security-policy'], 'undefined')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(typeof res.headers['content-security-policy'], 'undefined')
   }
 })
 
@@ -197,7 +197,7 @@ test('transformStaticCSP = function, with @fastify/helmet', async (t) => {
   await fastify.register(fastifySwagger, swaggerOption)
   await fastify.register(fastifySwaggerUi, {
     transformStaticCSP: function (header) {
-      t.equal(header, "default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests")
+      t.assert.deepStrictEqual(header, "default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests")
       return "default-src 'self'; script-src 'self';"
     }
   })
@@ -214,17 +214,17 @@ test('transformStaticCSP = function, with @fastify/helmet', async (t) => {
       method: 'GET',
       url: '/documentation'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(res.headers['content-security-policy'], "default-src 'self'; script-src 'self';")
-    t.equal(typeof res.payload, 'string')
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(res.headers['content-security-policy'], "default-src 'self'; script-src 'self';")
+    t.assert.deepStrictEqual(typeof res.payload, 'string')
   }
 
   {
     const res = await fastify.inject({
       method: 'GET',
       url: '/'
     })
-    t.equal(res.statusCode, 200)
-    t.equal(res.headers['content-security-policy'], "default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests")
+    t.assert.deepStrictEqual(res.statusCode, 200)
+    t.assert.deepStrictEqual(res.headers['content-security-policy'], "default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests")
   }
 })
diff --git a/test/decorator.test.js b/test/decorator.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { test } = require('tap')
+const { test } = require('node:test')
 const Fastify = require('fastify')
 const fastifySwagger = require('@fastify/swagger')
 const fastifySwaggerUi = require('../index')
@@ -12,7 +12,7 @@ test('fastify.swaggerCSP should exist', async (t) => {
   await fastify.register(fastifySwagger)
   await fastify.register(fastifySwaggerUi)
 
-  t.ok(fastify.swaggerCSP)
-  t.ok(Array.isArray(fastify.swaggerCSP.script))
-  t.ok(Array.isArray(fastify.swaggerCSP.style))
+  t.assert.ok(fastify.swaggerCSP)
+  t.assert.ok(Array.isArray(fastify.swaggerCSP.script))
+  t.assert.ok(Array.isArray(fastify.swaggerCSP.style))
 })
diff --git a/test/hooks.test.js b/test/hooks.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { test } = require('tap')
+const { test } = require('node:test')
 const Fastify = require('fastify')
 const yaml = require('yaml')
 
@@ -39,36 +39,36 @@ test('hooks on static swagger', async t => {
   })
 
   let res = await fastify.inject('/documentation')
-  t.equal(res.statusCode, 401, 'root auth required')
+  t.assert.deepStrictEqual(res.statusCode, 401, 'root auth required')
 
   res = await fastify.inject('/documentation/yaml')
-  t.equal(res.statusCode, 401, 'auth required yaml')
+  t.assert.deepStrictEqual(res.statusCode, 401, 'auth required yaml')
   res = await fastify.inject({
     method: 'GET',
     url: '/documentation/yaml',
     headers: { authorization: basicAuthEncode('admin', 'admin') }
   })
-  t.equal(res.statusCode, 200)
-  t.equal(res.headers['content-type'], 'application/x-yaml')
+  t.assert.deepStrictEqual(res.statusCode, 200)
+  t.assert.deepStrictEqual(res.headers['content-type'], 'application/x-yaml')
   try {
     yaml.parse(res.payload)
-    t.pass('valid swagger yaml')
+    t.assert.ok(true, 'valid swagger yaml')
   } catch (err) {
-    t.fail(err)
+    t.assert.fail(err)
   }
 
   res = await fastify.inject('/documentation/json')
-  t.equal(res.statusCode, 401, 'auth required json')
+  t.assert.deepStrictEqual(res.statusCode, 401, 'auth required json')
   res = await fastify.inject({
     method: 'GET',
     url: '/documentation/json',
     headers: { authorization: basicAuthEncode('admin', 'admin') }
   })
-  t.equal(typeof res.payload, 'string')
-  t.equal(res.headers['content-type'], 'application/json; charset=utf-8')
+  t.assert.deepStrictEqual(typeof res.payload, 'string')
+  t.assert.deepStrictEqual(res.headers['content-type'], 'application/json; charset=utf-8')
   try {
     yaml.parse(res.payload)
-    t.pass('valid swagger json')
+    t.assert.ok(true, 'valid swagger json')
   } catch (err) {
     t.fail(err)
   }
@@ -91,24 +91,24 @@ test('hooks on dynamic swagger', async t => {
   fastify.post('/fooBar123', schemaBody, () => {})
 
   let res = await fastify.inject('/documentation')
-  t.equal(res.statusCode, 401, 'root auth required')
+  t.assert.deepStrictEqual(res.statusCode, 401, 'root auth required')
 
   res = await fastify.inject('/documentation/yaml')
-  t.equal(res.statusCode, 401, 'auth required yaml')
+  t.assert.deepStrictEqual(res.statusCode, 401, 'auth required yaml')
 
   res = await fastify.inject('/documentation/json')
-  t.equal(res.statusCode, 401, 'auth required json')
+  t.assert.deepStrictEqual(res.statusCode, 401, 'auth required json')
   res = await fastify.inject({
     method: 'GET',
     url: '/documentation/json',
     headers: { authorization: basicAuthEncode('admin', 'admin') }
   })
-  t.equal(typeof res.payload, 'string')
-  t.equal(res.headers['content-type'], 'application/json; charset=utf-8')
+  t.assert.deepStrictEqual(typeof res.payload, 'string')
+  t.assert.deepStrictEqual(res.headers['content-type'], 'application/json; charset=utf-8')
 
   const swaggerObject = res.json()
-  t.ok(swaggerObject.paths)
-  t.ok(swaggerObject.paths['/fooBar123'])
+  t.assert.ok(swaggerObject.paths)
+  t.assert.ok(swaggerObject.paths['/fooBar123'])
 })
 
 test('catch all added schema', async t => {
@@ -136,5 +136,5 @@ test('catch all added schema', async t => {
 
   await fastify.ready()
   const openapi = fastify.swagger()
-  t.same(Object.keys(openapi.components.schemas), ['Root', 'Instance', 'Sub-Instance'])
+  t.assert.deepStrictEqual(Object.keys(openapi.components.schemas), ['Root', 'Instance', 'Sub-Instance'])
 })
diff --git a/test/integration.test.js b/test/integration.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { test } = require('tap')
+const { test } = require('node:test')
 const Fastify = require('fastify')
 const fastifySwagger = require('@fastify/swagger')
 const fastifyHelmet = require('@fastify/helmet')
@@ -43,5 +43,5 @@ test('fastify will response swagger csp', async (t) => {
     method: 'GET',
     url: '/'
   })
-  t.same(res.headers['content-security-policy'], csp)
+  t.assert.deepStrictEqual(res.headers['content-security-policy'], csp)
 })