@athenna/http 3.3.0 → 3.4.0

package/build/Testing/Plugins/Request/TestRequest.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Assert } from '@japa/assert';
+import { InjectOptions } from 'fastify';
+import { TestResponse } from '#src/Testing/Plugins/Request/TestResponse';
+export declare class TestRequest {
+    /**
+     * Japa assert class instance.
+     */
+    assert: Assert;
+    /**
+     * Instantiate TestResponse class from API response.
+     */
+    createResponse(response: any): TestResponse;
+    /**
+     * Make a GET request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.get('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    get(url: string, options?: InjectOptions): Promise<TestResponse>;
+    /**
+     * Make a HEAD request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.head('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    head(url: string, options?: InjectOptions): Promise<TestResponse>;
+    /**
+     * Make a OPTIONS request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.options('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    options(url: string, options?: InjectOptions): Promise<TestResponse>;
+    /**
+     * Make a POST request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.post('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    post(url: string, options?: InjectOptions): Promise<TestResponse>;
+    /**
+     * Make a PUT request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.put('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    put(url: string, options?: InjectOptions): Promise<TestResponse>;
+    /**
+     * Make a PATCH request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.patch('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    patch(url: string, options?: InjectOptions): Promise<TestResponse>;
+    /**
+     * Make a DELETE request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.delete('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    delete(url: string, options?: InjectOptions): Promise<TestResponse>;
+}

package/build/Testing/Plugins/Request/TestRequest.js

@@ -0,0 +1,114 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Server } from '#src';
+import { Assert } from '@japa/assert';
+import { TestResponse } from '#src/Testing/Plugins/Request/TestResponse';
+export class TestRequest {
+    /**
+     * Japa assert class instance.
+     */
+    assert = new Assert();
+    /**
+     * Instantiate TestResponse class from API response.
+     */
+    createResponse(response) {
+        return new TestResponse(this.assert, response);
+    }
+    /**
+     * Make a GET request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.get('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    async get(url, options = {}) {
+        return Server.request({ url, method: 'GET', ...options }).then(res => this.createResponse(res));
+    }
+    /**
+     * Make a HEAD request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.head('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    async head(url, options = {}) {
+        return Server.request({ url, method: 'HEAD', ...options }).then(res => this.createResponse(res));
+    }
+    /**
+     * Make a OPTIONS request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.options('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    async options(url, options = {}) {
+        return Server.request({ url, method: 'OPTIONS', ...options }).then(res => this.createResponse(res));
+    }
+    /**
+     * Make a POST request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.post('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    async post(url, options = {}) {
+        return Server.request({ url, method: 'POST', ...options }).then(res => this.createResponse(res));
+    }
+    /**
+     * Make a PUT request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.put('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    async put(url, options = {}) {
+        return Server.request({ url, method: 'PUT', ...options }).then(res => this.createResponse(res));
+    }
+    /**
+     * Make a PATCH request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.patch('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    async patch(url, options = {}) {
+        return Server.request({ url, method: 'PATCH', ...options }).then(res => this.createResponse(res));
+    }
+    /**
+     * Make a DELETE request to the given URL and options.
+     *
+     * @example
+     * ```js
+     * const response = await request.delete('/users')
+     *
+     * response.assertStatusCode(200)
+     * ```
+     */
+    async delete(url, options = {}) {
+        return Server.request({ url, method: 'DELETE', ...options }).then(res => this.createResponse(res));
+    }
+}

package/build/Testing/Plugins/Request/TestResponse.d.ts

@@ -0,0 +1,355 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { Assert } from '@japa/assert';
+import { Response } from 'light-my-request';
+export declare class TestResponse {
+    /**
+     * Japa assert class instance.
+     */
+    assert: Assert;
+    /**
+     * Light my request response object.
+     */
+    response: Response;
+    constructor(assert: Assert, response: Response);
+    /**
+     * Assert the status code of the response.
+     *
+     * @example
+     * ```js
+     * response.assertStatusCode(200)
+     * ```
+     */
+    assertStatusCode(statusCode: number): void;
+    /**
+     * Assert the status code is not the same of the response.
+     *
+     * @example
+     * ```js
+     * response.assertIsNotStatusCode(200)
+     * ```
+     */
+    assertIsNotStatusCode(statusCode: number): void;
+    /**
+     * Assert body (array or object) to contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyContains({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyContains([{ id: 1 }, { id: 2 }]) // passes
+     * ```
+     */
+    assertBodyContains(values: any | any[]): void;
+    /**
+     * Assert body (array or object) to not contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContains({ id: 1 }) // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyNotContains([{ id: 3 }]) // passes
+     * ```
+     */
+    assertBodyNotContains(values: any | any[]): void;
+    /**
+     * Assert body to contain a key.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyContainsKey('id') // passes
+     * ```
+     */
+    assertBodyContainsKey(key: string): void;
+    /**
+     * Assert body to not contain a key.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsKey('id') // fails
+     * ```
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsKey('createdAt') // passes
+     * ```
+     */
+    assertBodyNotContainsKey(key: string): void;
+    /**
+     * Assert body to contain all keys.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyContainsAllKeys(['id', 'post']) // passes
+     * ```
+     */
+    assertBodyContainsAllKeys(keys: string[]): void;
+    /**
+     * Assert body to not contain all keys.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsAllKeys(['id']) // fails
+     * ```
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsAllKeys(['createdAt']) // passes
+     * ```
+     */
+    assertBodyNotContainsAllKeys(keys: string[]): void;
+    /**
+     * Assert body (array or object) to be deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyDeepEqual({ id: 1 }) // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // passes
+     * ```
+     */
+    assertBodyDeepEqual(values: any | any[]): void;
+    /**
+     * Assert body (array or object) to be not deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotDeepEqual({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyNotDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // fails
+     * ```
+     */
+    assertBodyNotDeepEqual(values: any | any[]): void;
+    /**
+     * Assert body to be an array.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsArray() // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsArray() // passes
+     * ```
+     */
+    assertBodyIsArray(): void;
+    /**
+     * Assert body to not be an array.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsNotArray() // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsNotArray() // fails
+     * ```
+     */
+    assertBodyIsNotArray(): void;
+    /**
+     * Assert body to be an object.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsObject() // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsObject() // fails
+     * ```
+     */
+    assertBodyIsObject(): void;
+    /**
+     * Assert body to not be an object.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsNotObject() // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsNotObject() // passes
+     * ```
+     */
+    assertBodyIsNotObject(): void;
+    /**
+     * Assert header (array or object) to contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContains({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     *  response.assertHeaderContains([{ id: 1 }, { id: 2 }]) // passes
+     * ```
+     */
+    assertHeaderContains(values: any | any[]): void;
+    /**
+     * Assert header (array or object) to not contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContains({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertHeaderContains([{ id: 1 }, { id: 2 }]) // passes
+     * ```
+     */
+    assertHeaderNotContains(values: any | any[]): void;
+    /**
+     * Assert header (array or object) to be deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderDeepEqual({ id: 1 }) // fails
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertHeaderDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // passes
+     * ```
+     */
+    assertHeaderDeepEqual(values: any | any[]): void;
+    /**
+     * Assert header (array or object) to be not deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotDeepEqual({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertHeaderNotDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // fails
+     * ```
+     */
+    assertHeaderNotDeepEqual(values: any | any[]): void;
+    /**
+     * Assert header to contain a key.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContainsKey('id') // passes
+     * ```
+     */
+    assertHeaderContainsKey(key: string): void;
+    /**
+     * Assert header to not contain a key.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsKey('id') // fails
+     * ```
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsKey('createdAt') // passes
+     * ```
+     */
+    assertHeaderNotContainsKey(key: string): void;
+    /**
+     * Assert header to contain all keys.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContainsAllKeys(['id', 'post']) // passes
+     * ```
+     */
+    assertHeaderContainsAllKeys(keys: string[]): void;
+    /**
+     * Assert header to not contain all keys.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsAllKeys(['id']) // fails
+     * ```
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsAllKeys(['createdAt']) // passes
+     * ```
+     */
+    assertHeaderNotContainsAllKeys(keys: string[]): void;
+}

package/build/Testing/Plugins/Request/TestResponse.js

@@ -0,0 +1,400 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export class TestResponse {
+    /**
+     * Japa assert class instance.
+     */
+    assert;
+    /**
+     * Light my request response object.
+     */
+    response;
+    constructor(assert, response) {
+        this.assert = assert;
+        this.response = response;
+    }
+    /**
+     * Assert the status code of the response.
+     *
+     * @example
+     * ```js
+     * response.assertStatusCode(200)
+     * ```
+     */
+    assertStatusCode(statusCode) {
+        this.assert.deepEqual(this.response.statusCode, statusCode);
+    }
+    /**
+     * Assert the status code is not the same of the response.
+     *
+     * @example
+     * ```js
+     * response.assertIsNotStatusCode(200)
+     * ```
+     */
+    assertIsNotStatusCode(statusCode) {
+        this.assert.notDeepEqual(this.response.statusCode, statusCode);
+    }
+    /**
+     * Assert body (array or object) to contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyContains({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyContains([{ id: 1 }, { id: 2 }]) // passes
+     * ```
+     */
+    assertBodyContains(values) {
+        this.assert.containsSubset(this.response.json(), values);
+    }
+    /**
+     * Assert body (array or object) to not contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContains({ id: 1 }) // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyNotContains([{ id: 3 }]) // passes
+     * ```
+     */
+    assertBodyNotContains(values) {
+        this.assert.notContainsSubset(this.response.json(), values);
+    }
+    /**
+     * Assert body to contain a key.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyContainsKey('id') // passes
+     * ```
+     */
+    assertBodyContainsKey(key) {
+        this.assert.property(this.response.json(), key);
+    }
+    /**
+     * Assert body to not contain a key.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsKey('id') // fails
+     * ```
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsKey('createdAt') // passes
+     * ```
+     */
+    assertBodyNotContainsKey(key) {
+        this.assert.notProperty(this.response.json(), key);
+    }
+    /**
+     * Assert body to contain all keys.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyContainsAllKeys(['id', 'post']) // passes
+     * ```
+     */
+    assertBodyContainsAllKeys(keys) {
+        this.assert.properties(this.response.json(), keys);
+    }
+    /**
+     * Assert body to not contain all keys.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsAllKeys(['id']) // fails
+     * ```
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotContainsAllKeys(['createdAt']) // passes
+     * ```
+     */
+    assertBodyNotContainsAllKeys(keys) {
+        this.assert.notAllProperties(this.response.json(), keys);
+    }
+    /**
+     * Assert body (array or object) to be deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyDeepEqual({ id: 1 }) // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // passes
+     * ```
+     */
+    assertBodyDeepEqual(values) {
+        this.assert.deepEqual(this.response.json(), values);
+    }
+    /**
+     * Assert body (array or object) to be not deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyNotDeepEqual({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyNotDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // fails
+     * ```
+     */
+    assertBodyNotDeepEqual(values) {
+        this.assert.notDeepEqual(this.response.json(), values);
+    }
+    /**
+     * Assert body to be an array.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsArray() // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsArray() // passes
+     * ```
+     */
+    assertBodyIsArray() {
+        this.assert.isArray(this.response.json());
+    }
+    /**
+     * Assert body to not be an array.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsNotArray() // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsNotArray() // fails
+     * ```
+     */
+    assertBodyIsNotArray() {
+        this.assert.isNotArray(this.response.json());
+    }
+    /**
+     * Assert body to be an object.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsObject() // passes
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsObject() // fails
+     * ```
+     */
+    assertBodyIsObject() {
+        this.assert.isObject(this.response.json());
+    }
+    /**
+     * Assert body to not be an object.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertBodyIsNotObject() // fails
+     * ```
+     * @example
+     * ```js
+     * const body = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertBodyIsNotObject() // passes
+     * ```
+     */
+    assertBodyIsNotObject() {
+        this.assert.isNotObject(this.response.json());
+    }
+    /**
+     * Assert header (array or object) to contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContains({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     *  response.assertHeaderContains([{ id: 1 }, { id: 2 }]) // passes
+     * ```
+     */
+    assertHeaderContains(values) {
+        this.assert.containsSubset(this.response.headers, values);
+    }
+    /**
+     * Assert header (array or object) to not contain a subset of the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContains({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertHeaderContains([{ id: 1 }, { id: 2 }]) // passes
+     * ```
+     */
+    assertHeaderNotContains(values) {
+        this.assert.notContainsSubset(this.response.headers, values);
+    }
+    /**
+     * Assert header (array or object) to be deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderDeepEqual({ id: 1 }) // fails
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertHeaderDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // passes
+     * ```
+     */
+    assertHeaderDeepEqual(values) {
+        this.assert.deepEqual(this.response.headers, values);
+    }
+    /**
+     * Assert header (array or object) to be not deep equal to the expected value.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotDeepEqual({ id: 1 }) // passes
+     * ```
+     * @example
+     * ```js
+     * const header = [{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]
+     *
+     * response.assertHeaderNotDeepEqual([{ id: 1, name: 'post 1' }, { id: 2, name: 'post 2'}]) // fails
+     * ```
+     */
+    assertHeaderNotDeepEqual(values) {
+        this.assert.notDeepEqual(this.response.headers, values);
+    }
+    /**
+     * Assert header to contain a key.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContainsKey('id') // passes
+     * ```
+     */
+    assertHeaderContainsKey(key) {
+        this.assert.property(this.response.headers, key);
+    }
+    /**
+     * Assert header to not contain a key.
+     *
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsKey('id') // fails
+     * ```
+     * @example
+     * ```js
+     * const body = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsKey('createdAt') // passes
+     * ```
+     */
+    assertHeaderNotContainsKey(key) {
+        this.assert.notProperty(this.response.headers, key);
+    }
+    /**
+     * Assert header to contain all keys.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderContainsAllKeys(['id', 'post']) // passes
+     * ```
+     */
+    assertHeaderContainsAllKeys(keys) {
+        this.assert.properties(this.response.headers, keys);
+    }
+    /**
+     * Assert header to not contain all keys.
+     *
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsAllKeys(['id']) // fails
+     * ```
+     * @example
+     * ```js
+     * const header = { id: 1, name: 'post 1' }
+     *
+     * response.assertHeaderNotContainsAllKeys(['createdAt']) // passes
+     * ```
+     */
+    assertHeaderNotContainsAllKeys(keys) {
+        this.assert.notAllProperties(this.response.headers, keys);
+    }
+}

package/build/Testing/Plugins/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { TestRequest } from './Request/TestRequest.js';
+declare module '@japa/runner' {
+    interface TestContext {
+        request: TestRequest;
+    }
+}
+export * from './Request/TestRequest.js';
+export * from './Request/TestResponse.js';
+/**
+ * Request plugin register the request macro to the test context.
+ */
+export declare function request(): (_config: any, _runner: any, classes: any) => Promise<void>;

package/build/Testing/Plugins/index.js

@@ -0,0 +1,19 @@
+/**
+ * @athenna/http
+ *
+ * (c) João Lenon <lenon@athenna.io>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { TestRequest } from './Request/TestRequest.js';
+export * from './Request/TestRequest.js';
+export * from './Request/TestResponse.js';
+/**
+ * Request plugin register the request macro to the test context.
+ */
+export function request() {
+    return async function (_config, _runner, classes) {
+        classes.TestContext.macro('request', new TestRequest());
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -45,6 +45,7 @@
   "types": "./build/index.d.ts",
   "exports": {
     ".": "./build/index.js",
+    "./testing/plugins": "./build/Testing/Plugins/index.js",
     "./providers/HttpRouteProvider": "./build/Providers/HttpRouteProvider.js",
     "./providers/HttpServerProvider": "./build/Providers/HttpServerProvider.js",
     "./commands/RouteListCommand": "./build/Commands/RouteListCommand.js",