test: add REST steps tests

Author: coderbyheart

package-lock.json

@@ -39,6 +39,7 @@
     "@types/node": "20.12.7",
     "globstar": "1.0.0",
     "husky": "9.0.11",
+    "nock": "^14.0.0-beta.5",
     "tsx": "4.7.2"
   },
   "lint-staged": {

package.json

@@ -0,0 +1,44 @@
+import { describe, it, afterEach } from 'node:test'
+import assert from 'node:assert/strict'
+import { runFolder } from '@nordicsemiconductor/bdd-markdown'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { steps } from './REST.js'
+import nock from 'nock'
+const __dirname = fileURLToPath(new URL('.', import.meta.url))
+
+void describe('REST', () => {
+	void it('should implement a REST client', async () => {
+		const scope = nock(`https://api.example.com`)
+			.get('/foo', undefined, {
+				reqheaders: {
+					Accept: 'application/json',
+				},
+			})
+			.reply(
+				200,
+				{
+					'@context':
+						'https://github.com/hello-nrfcloud/bdd-markdown-steps/tests',
+					success: true,
+				},
+				{
+					'content-type': 'application/json; charset=utf-8',
+				},
+			)
+
+		const runner = await runFolder({
+			folder: path.join(__dirname, 'test-data', 'REST'),
+			name: 'REST',
+		})
+		runner.addStepRunners(...steps)
+		const ctx = {
+			endpoint: `https://api.example.com`,
+		}
+		const result = await runner.run(ctx)
+		assert.equal(result.ok, true)
+		assert.equal(scope.isDone(), true)
+	})
+
+	void afterEach(() => nock.cleanAll())
+})

src/REST.spec.ts

@@ -0,0 +1,31 @@
+import type { LogObserver } from '@nordicsemiconductor/bdd-markdown'
+
+const print = (arg: unknown) =>
+	typeof arg === 'object' ? JSON.stringify(arg) : arg
+
+export const logObserver: LogObserver = {
+	onDebug: (info, ...args) =>
+		console.error(
+			info.step.keyword,
+			info.step.title,
+			...args.map((arg) => print(arg)),
+		),
+	onError: (info, ...args) =>
+		console.error(
+			info.step.keyword,
+			info.step.title,
+			...args.map((arg) => print(arg)),
+		),
+	onInfo: (info, ...args) =>
+		console.error(
+			info.step.keyword,
+			info.step.title,
+			...args.map((arg) => print(arg)),
+		),
+	onProgress: (info, ...args) =>
+		console.error(
+			info.step.keyword,
+			info.step.title,
+			...args.map((arg) => print(arg)),
+		),
+}

src/lib/logObserver.ts

@@ -7,7 +7,7 @@ import { steps } from './random.js'
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 
 void describe('Random', () => {
-	void it('should store random in the context', async () => {
+	void it('should store random strings in the context', async () => {
 		const runner = await runFolder({
 			folder: path.join(__dirname, 'test-data', 'random'),
 			name: 'Random',

src/random.spec.ts

@@ -0,0 +1,13 @@
+---
+exampleContext:
+  endpoint: https://api.example.com/
+---
+
+# REST steps
+
+## Simple request
+
+When I `GET` `${endpoint}/foo`
+
+Then I should receive a
+`https://github.com/hello-nrfcloud/bdd-markdown-steps/tests` response