feat(REST): add header assertion

Author: coderbyheart

src/REST.spec.ts

@@ -47,6 +47,10 @@ void describe('REST', () => {
 				},
 			)
 
+		scope.get('/header-response').reply(200, undefined, {
+			'x-foo': 'bar',
+		})
+
 		const runner = await runFolder({
 			folder: path.join(__dirname, 'test-data', 'REST'),
 			name: 'REST',

src/REST.ts

@@ -107,6 +107,21 @@ export const steps: StepRunner<Record<string, any>>[] = [
 			)
 		},
 	),
+	regExpMatchedStep(
+		{
+			regExp:
+				/^the `(?<headerName>[^`]+)` header of the last response should be `(?<headerValue>[^`]+)`$/,
+			schema: Type.Object({
+				headerName: Type.String({ minLength: 1 }),
+				headerValue: Type.String({ minLength: 1 }),
+			}),
+		},
+		async ({ match: { headerName, headerValue } }) => {
+			await currentRequest.match(async ({ response }) =>
+				assert.equal(response.headers.get(headerName), headerValue),
+			)
+		},
+	),
 	regExpMatchedStep(
 		{
 			regExp:

src/test-data/REST/REST.feature.md

@@ -24,3 +24,9 @@ Then I should receive a
 `https://github.com/hello-nrfcloud/bdd-markdown-steps/tests` response
 
 And the status code of the last response should be `200`
+
+## Reading headers
+
+When I `GET` to `${endpoint}/header-response`
+
+Then the `x-foo` header of the last response should be `bar`