@opra/testing 0.29.0 → 0.30.0

package/esm/api-expect/api-expect.js

@@ -1,109 +1,129 @@
 import '../jest-extend/index.js';
+import colors from 'ansi-colors';
+import { ApiExpectBase } from './api-expect-base.js';
 import { ApiExpectCollection } from './api-expect-collection.js';
 import { ApiExpectError } from './api-expect-error.js';
 import { ApiExpectObject } from './api-expect-object.js';
 import { ApiExpectOperationResult } from './api-expect-operation-result.js';
-export class ApiExpect {
-    constructor(response, _isNot = false) {
-        this.response = response;
-        this._isNot = _isNot;
-    }
-    get not() {
-        return new ApiExpect(this.response, !this._isNot);
-    }
-    toSuccess(status = 200) {
+export class ApiExpect extends ApiExpectBase {
+    /**
+     * Tests if request succeeded
+     * @param status Status code number between 200-299
+     */
+    toSuccess(status) {
         let msg = '';
         try {
-            msg = 'Unexpected "status" returned';
-            this._expect(this.response.status).toStrictEqual(status);
+            msg += `The response status isn't as expected.`;
+            if (status) {
+                expect(this.response.status).toEqual(status);
+            }
+            else {
+                expect(this.response.status).toBeGreaterThanOrEqual(200);
+                expect(this.response.status).toBeLessThan(400);
+            }
         }
         catch (e) {
+            e.message = 'Request didn\'t succeeded. ' + msg + '\n\n' + e.message;
             const issues = this.response.body?.errors;
             const issue = issues?.[0]?.message;
-            if (msg)
-                e.message = msg + '\n\n' + (issue || e.message);
+            if (issue) {
+                e.message += '\n\n' + colors.yellow('Server message: ') + issue;
+            }
             Error.captureStackTrace(e, this.toSuccess);
             throw e;
         }
         return this;
     }
-    toFail(status = 400) {
+    /**
+     * Tests if request failed
+     * @param status Status code number between 400-599
+     */
+    toFail(status) {
         let msg = '';
         try {
-            msg = 'Response "status" does not match';
+            msg += `The response status isn't as expected. `;
             if (status) {
-                expect(this.response.status).toStrictEqual(status);
+                expect(this.response.status).toEqual(status);
             }
             else {
                 expect(this.response.status).toBeGreaterThanOrEqual(400);
                 expect(this.response.status).toBeLessThanOrEqual(599);
             }
-            msg = 'Api did not returned "errors"';
-            expect(this.response.body.errors).toBeArray();
-            expect(this.response.body.errors.length).toBeGreaterThan(0);
         }
         catch (e) {
-            if (msg)
-                e.message = msg + '\n\n' + e.message;
-            Error.captureStackTrace(e, this.toFail);
+            e.message = 'Request didn\'t failed. ' + msg + '\n\n' + e.message;
+            Error.captureStackTrace(e, this.toSuccess);
             throw e;
         }
         return new ApiExpectError(this.response);
     }
-    toReturnOperationResult() {
+    /**
+     * Tests if API returns a Collection
+     */
+    toReturnCollection() {
         let msg = '';
         try {
-            msg = '"body" is empty';
-            expect(this.response.body).toBeDefined();
-            msg = '"operation" property is empty';
-            expect(this.response.body.context).toBeDefined();
+            msg = 'Content-Type header value is not valid. ';
+            expect(this.response.contentType).toEqual('application/opra+json');
+            msg = 'Type of response "body" is not valid. ';
+            expect(typeof this.response.body).toEqual('object');
+            msg = 'Type of "payload" is not an Array. ';
+            const payload = this.response.body.payload;
+            expect(Array.isArray(payload) ? 'array' : typeof payload).toEqual('array');
         }
         catch (e) {
+            e.message = 'Api didn\'t returned a Collection. ' + msg + '\n\n' + e.message;
             if (msg)
                 e.message = msg + '\n\n' + e.message;
-            Error.captureStackTrace(e, this.toReturnOperationResult);
+            Error.captureStackTrace(e, this.toReturnCollection);
             throw e;
         }
-        return new ApiExpectOperationResult(this.response);
+        return new ApiExpectCollection(this.response);
     }
+    /**
+     * Tests if API returns an Object
+     */
     toReturnObject() {
         let msg = '';
         try {
-            msg = '"body" is empty';
-            expect(this.response.body).toBeDefined();
-            expect(typeof this.response.body).toStrictEqual('object');
-            msg = `"body.payload" is ${typeof typeof this.response.body.payload}`;
-            expect(typeof this.response.body.payload).toStrictEqual('object');
+            msg = 'Content-Type header value is not valid. ';
+            expect(this.response.contentType).toEqual('application/opra+json');
+            msg = 'Type of response "body" is not valid. ';
+            expect(typeof this.response.body).toEqual('object');
+            msg = 'Type of "payload" is not an Object. ';
+            const payload = this.response.body.payload;
+            expect(typeof payload).toEqual('object');
         }
         catch (e) {
+            e.message = 'Api didn\'t returned an Object. ' + msg + '\n\n' + e.message;
             if (msg)
                 e.message = msg + '\n\n' + e.message;
-            Error.captureStackTrace(e, this.toReturnObject);
+            Error.captureStackTrace(e, this.toReturnCollection);
             throw e;
         }
         return new ApiExpectObject(this.response);
     }
-    toReturnCollection() {
+    /**
+     * Tests if API returns an OperationResult
+     */
+    toReturnOperationResult() {
         let msg = '';
         try {
-            msg = '"body" is empty';
-            expect(this.response.body).toBeDefined();
-            expect(this.response.body.payload).toBeDefined();
-            msg = '"body" is not an array';
-            expect(this.response.body.payload).toBeArray();
+            msg = 'Content-Type header value is not valid. ';
+            expect(this.response.contentType).toEqual('application/opra+json');
+            msg = 'Type of response "body" is not valid. ';
+            expect(typeof this.response.body).toEqual('object');
+            msg = 'The response has payload. ';
+            const payload = this.response.body.payload;
+            expect(typeof payload).toEqual('undefined');
         }
         catch (e) {
+            e.message = 'Api didn\'t returned a OperationResult. ' + msg + '\n\n' + e.message;
             if (msg)
                 e.message = msg + '\n\n' + e.message;
             Error.captureStackTrace(e, this.toReturnCollection);
             throw e;
         }
-        return new ApiExpectCollection(this.response);
-    }
-    _expect(expected) {
-        const out = expect(expected);
-        if (this._isNot)
-            return out.not;
-        return out;
+        return new ApiExpectOperationResult(this.response);
     }
 }

package/esm/jest-extend/common.extend.js

@@ -35,65 +35,6 @@ expect.extend({
             message: () => 'Value is not an array'
         };
     },
-    toBeSorted(received, compareFn) {
-        let pass = true;
-        let message;
-        if (pass) {
-            const sorted = [...(received || [])];
-            sorted.sort(compareFn);
-            try {
-                expect(received).toEqual(sorted);
-            }
-            catch (e) {
-                pass = false;
-                message = () => 'Array items is not sorted as expected';
-            }
-        }
-        return {
-            actual: received,
-            message,
-            pass
-        };
-    },
-    toBeSortedBy(received, properties) {
-        const fieldsMap = properties.map(x => x.split('.'));
-        const getValue = (obj, fieldMap) => {
-            let v = obj;
-            let i = 0;
-            while (v && i < fieldMap.length) {
-                v = v[fieldMap[i++]];
-            }
-            return v;
-        };
-        let pass = true;
-        let message;
-        if (pass) {
-            const sorted = [...(received || [])];
-            sorted.sort((a, b) => {
-                for (const sortField of fieldsMap) {
-                    const l = getValue(a, sortField);
-                    const r = getValue(b, sortField);
-                    if (l < r)
-                        return -1;
-                    if (l > r)
-                        return 1;
-                }
-                return 0;
-            });
-            try {
-                expect(received).toEqual(sorted);
-            }
-            catch (e) {
-                pass = false;
-                message = () => 'Array items is not sorted as expected';
-            }
-        }
-        return {
-            actual: received,
-            message,
-            pass
-        };
-    },
     toBeGreaterThanAny(received, expected) {
         return compare('toBeGreaterThan', {
             isNot: this.isNot,

package/esm/utils/object-matches.util.js

@@ -16,13 +16,15 @@ function _objectMatches(received, expected, path) {
                 throw new Error(`Property "${k}" does not match`);
             }
         }
-        if (ev && typeof ev === 'object')
+        else if (ev && typeof ev === 'object') {
             _objectMatches(rv, ev, path ? path + '.' + k : k);
-        try {
-            expect(rv).toStrictEqual(ev);
-        }
-        catch {
-            throw new Error(`Property "${k}" does not match`);
         }
+        else
+            try {
+                expect(rv).toEqual(ev);
+            }
+            catch {
+                throw new Error(`Property "${k}" does not match`);
+            }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/testing",
-  "version": "0.29.0",
+  "version": "0.30.0",
   "description": "Opra testing package",
   "author": "Panates",
   "license": "MIT",
@@ -25,8 +25,8 @@
     "clean:cover": "rimraf ../../coverage/testing"
   },
   "dependencies": {
-    "@opra/client": "^0.29.0",
-    "@opra/common": "^0.29.0",
+    "@opra/client": "^0.30.0",
+    "@opra/common": "^0.30.0",
     "ansi-colors": "^4.1.3",
     "lodash.isnil": "^4.0.0",
     "lodash.omitby": "^4.6.0",
@@ -56,4 +56,4 @@
     "opra",
     "testing"
   ]
-}
+}

package/types/api-expect/api-expect-base.d.ts

@@ -0,0 +1,8 @@
+import '../jest-extend/index.js';
+import { HttpResponse } from '@opra/client';
+export declare class ApiExpectBase {
+    readonly response: HttpResponse;
+    protected readonly isNot?: boolean;
+    constructor(response: HttpResponse, isNot?: boolean);
+    protected _expect(expected: any): jest.Matchers<any>;
+}

package/types/api-expect/api-expect-collection.d.ts

@@ -1,20 +1,38 @@
-import '../jest-extend/index.js';
-import { HttpResponse } from '@opra/client';
 import { OpraFilter } from '@opra/common';
-export declare class ApiExpectCollection {
-    readonly response: HttpResponse;
-    protected _isNot: boolean;
-    constructor(response: HttpResponse, _isNot?: boolean);
+import { ApiExpectBase } from './api-expect-base.js';
+export declare class ApiExpectCollection extends ApiExpectBase {
     get not(): ApiExpectCollection;
-    forEach(callbackfn: (v: any) => void): this;
+    /**
+     * Tests if Collection have number of items in payload
+     * @param min Minimum number of items. Default 1
+     * @param max Maximum number of items
+     */
+    toReturnItems(min?: number, max?: number): this;
+    toContainTotalMatches(min?: number, max?: number): this;
+    /**
+     * Tests if Collection items matches given object
+     * @param expected
+     */
     toMatch<T extends {}>(expected: T): this;
-    toHaveFields(keys: string[]): this;
-    toHaveFieldsOnly(keys: string[]): this;
-    toBeSortedBy(...fields: string[]): this;
+    /**
+     * Tests if Collection items has all of provided fields.
+     * @param fields
+     */
+    toContainFields(fields: string | string[]): this;
+    /**
+     * Tests if Collection items only contains all of provided fields.
+     * @param fields
+     */
+    toContainAllFields(fields: string | string[]): this;
+    /**
+     * Tests if Collection is sorted by given field(s).
+     * @param fields
+     */
+    toBeSortedBy(fields: string | string[]): this;
+    /**
+     * Tests if Collection is filtered by given condition.
+     * @param filter
+     */
     toBeFilteredBy(filter: string | OpraFilter.Expression): this;
-    toHaveExactItems(expected: number): this;
-    toHaveMaxItems(expected: number): this;
-    toHaveMinItems(expected: number): this;
-    protected _expect(expected: any): jest.Matchers<any>;
 }
 export declare function convertFilter(str: string | OpraFilter.Expression | undefined): any;

package/types/api-expect/api-expect-error.d.ts

@@ -1,15 +1,14 @@
 import '../jest-extend/index.js';
-import { HttpResponse } from '@opra/client';
-import { ApiExpectObject } from './api-expect-object.js';
-export declare class ApiExpectError extends ApiExpectObject {
-    readonly response: HttpResponse;
-    constructor(response: HttpResponse);
-    toContainDetail(...matching: any[]): void;
-}
-declare global {
-    namespace jest {
-        interface Matchers<R> {
-            apiErrorDetailToContain(...issue: any[]): any;
-        }
-    }
+import { ErrorIssue } from '@opra/common';
+import { ApiExpectBase } from './api-expect-base.js';
+export type MatchingErrorIssue = Partial<ErrorIssue> & {
+    message?: RegExp;
+    system?: RegExp;
+    code?: RegExp;
+    details?: RegExp;
+    diagnostics?: RegExp;
+    [index: string]: any;
+};
+export declare class ApiExpectError extends ApiExpectBase {
+    toMatch(expected: (string | RegExp | MatchingErrorIssue)): this;
 }

package/types/api-expect/api-expect-object.d.ts

@@ -1,12 +1,19 @@
-import '../jest-extend/index.js';
-import { HttpResponse } from '@opra/client';
-export declare class ApiExpectObject {
-    readonly response: HttpResponse;
-    protected _isNot: boolean;
-    constructor(response: HttpResponse, _isNot?: boolean);
+import { ApiExpectBase } from './api-expect-base.js';
+export declare class ApiExpectObject extends ApiExpectBase {
     get not(): ApiExpectObject;
+    /**
+     * Tests if Response payload matches given object
+     * @param expected
+     */
     toMatch<T extends {}>(expected: T): this;
-    toHaveFields(fields: string[]): this;
-    toHaveFieldsOnly(fields: string[]): this;
-    protected _expect(expected: any): jest.Matchers<any>;
+    /**
+     * Tests if Response payload has all of provided fields.
+     * @param fields
+     */
+    toContainFields(fields: string | string[]): this;
+    /**
+     * Tests if Response payload only contains all of provided fields.
+     * @param fields
+     */
+    toContainAllFields(fields: string | string[]): this;
 }

package/types/api-expect/api-expect-operation-result.d.ts

@@ -1,12 +1,6 @@
 import '../jest-extend/index.js';
-import { HttpResponse } from '@opra/client';
-export declare class ApiExpectOperationResult {
-    readonly response: HttpResponse;
-    protected _isNot: boolean;
-    constructor(response: HttpResponse, _isNot?: boolean);
+import { ApiExpectBase } from './api-expect-base.js';
+export declare class ApiExpectOperationResult extends ApiExpectBase {
     get not(): ApiExpectOperationResult;
-    toBeAffectedExact(expected: number): this;
-    toBeAffectedMin(expected: number): this;
-    toBeAffectedMax(expected: number): this;
-    protected _expect(expected: any): jest.Matchers<any>;
+    toBeAffected(min?: number, max?: number): this;
 }

package/types/api-expect/api-expect.d.ts

@@ -1,18 +1,30 @@
 import '../jest-extend/index.js';
-import { HttpResponse } from '@opra/client';
+import { ApiExpectBase } from './api-expect-base.js';
 import { ApiExpectCollection } from './api-expect-collection.js';
 import { ApiExpectError } from './api-expect-error.js';
 import { ApiExpectObject } from './api-expect-object.js';
 import { ApiExpectOperationResult } from './api-expect-operation-result.js';
-export declare class ApiExpect {
-    readonly response: HttpResponse;
-    protected _isNot: boolean;
-    constructor(response: HttpResponse, _isNot?: boolean);
-    get not(): ApiExpect;
+export declare class ApiExpect extends ApiExpectBase {
+    /**
+     * Tests if request succeeded
+     * @param status Status code number between 200-299
+     */
     toSuccess(status?: number): this;
+    /**
+     * Tests if request failed
+     * @param status Status code number between 400-599
+     */
     toFail(status?: number): ApiExpectError;
-    toReturnOperationResult(): ApiExpectOperationResult;
-    toReturnObject(): ApiExpectObject;
+    /**
+     * Tests if API returns a Collection
+     */
     toReturnCollection(): ApiExpectCollection;
-    protected _expect(expected: any): jest.Matchers<any>;
+    /**
+     * Tests if API returns an Object
+     */
+    toReturnObject(): ApiExpectObject;
+    /**
+     * Tests if API returns an OperationResult
+     */
+    toReturnOperationResult(): ApiExpectOperationResult;
 }

package/types/jest-extend/common.extend.d.ts

@@ -1,21 +1,13 @@
 declare global {
     namespace jest {
         interface Matchers<R> {
-            toHaveFields(expected: string[]): any;
-            toHaveFieldsOnly(expected: string[]): any;
             toBeArray(): any;
-            toBeSorted(compareFn?: (a: any, b: any) => number): any;
-            toBeSortedBy(properties: string[]): any;
             toBeGreaterThanAny(expected: number | bigint | string | Date): any;
             toBeGreaterThanOrEqualAny(expected: number | bigint | string | Date): any;
             toBeLessThanAny(expected: number | bigint | string | Date): any;
             toBeLessThanOrEqualAny(expected: number | bigint | string | Date): any;
         }
         interface InverseAsymmetricMatchers {
-            toContainKeys(expected: string[]): any;
-            toContainAllKeys(expected: string[]): any;
-            toBeSorted(compareFn?: (a: any, b: any) => number): any;
-            toBeSortedBy(properties: string[]): any;
             toBeGreaterThanAny(expected: number | bigint | string | Date): any;
             toBeGreaterThanOrEqualAny(expected: number | bigint | string | Date): any;
             toBeLessThanAny(expected: number | bigint | string | Date): any;