@opra/testing 0.29.0 → 0.30.0

package/cjs/api-expect/api-expect-base.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExpectBase = void 0;
+require("../jest-extend/index.js");
+class ApiExpectBase {
+    constructor(response, isNot) {
+        this.response = response;
+        this.isNot = isNot;
+    }
+    _expect(expected) {
+        const out = expect(expected);
+        if (this.isNot)
+            return out.not;
+        return out;
+    }
+}
+exports.ApiExpectBase = ApiExpectBase;

package/cjs/api-expect/api-expect-collection.js

@@ -2,31 +2,64 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertFilter = exports.ApiExpectCollection = void 0;
 const tslib_1 = require("tslib");
-require("../jest-extend/index.js");
 const lodash_isnil_1 = tslib_1.__importDefault(require("lodash.isnil"));
 const lodash_omitby_1 = tslib_1.__importDefault(require("lodash.omitby"));
 const rule_judgment_1 = tslib_1.__importDefault(require("rule-judgment"));
 const common_1 = require("@opra/common");
+const api_expect_base_js_1 = require("./api-expect-base.js");
 // @ts-ignore
 const ruleJudgment = typeof rule_judgment_1.default === 'object' ? rule_judgment_1.default.default : rule_judgment_1.default;
-class ApiExpectCollection {
-    constructor(response, _isNot = false) {
-        this.response = response;
-        this._isNot = _isNot;
-    }
+class ApiExpectCollection extends api_expect_base_js_1.ApiExpectBase {
     get not() {
-        return new ApiExpectCollection(this.response, !this._isNot);
+        return new ApiExpectCollection(this.response, !this.isNot);
+    }
+    /**
+     * 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, max) {
+        let msg = '';
+        try {
+            msg += `The length of payload array do not match. `;
+            const l = this.response.body.payload.length;
+            this._expect(l).toBeGreaterThanOrEqual(min || 1);
+            if (max)
+                this._expect(l).toBeLessThanOrEqual(max);
+        }
+        catch (e) {
+            if (msg)
+                e.message = msg + '\n\n' + e.message;
+            Error.captureStackTrace(e, this.toReturnItems);
+            throw e;
+        }
+        return this;
     }
-    forEach(callbackfn) {
-        this.response.body.forEach(callbackfn);
+    toContainTotalMatches(min, max) {
+        let msg = '';
+        try {
+            msg += `The value of "totalMatches" do not match. `;
+            const l = this.response.body.totalMatches;
+            this._expect(l).toBeGreaterThanOrEqual(min || 1);
+            if (max)
+                this._expect(l).toBeLessThanOrEqual(max);
+        }
+        catch (e) {
+            if (msg)
+                e.message = msg + '\n\n' + e.message;
+            Error.captureStackTrace(e, this.toReturnItems);
+            throw e;
+        }
         return this;
     }
+    /**
+     * Tests if Collection items matches given object
+     * @param expected
+     */
     toMatch(expected) {
         try {
-            const v = (0, lodash_omitby_1.default)(expected, lodash_isnil_1.default);
-            for (const item of this.response.body.payload) {
-                this._expect(item).toMatchObject(v);
-            }
+            expected = (0, lodash_omitby_1.default)(expected, lodash_isnil_1.default);
+            this._expect(this.response.body.payload).toEqual(expect.arrayContaining([expect.objectContaining(expected)]));
         }
         catch (e) {
             Error.captureStackTrace(e, this.toMatch);
@@ -34,46 +67,49 @@ class ApiExpectCollection {
         }
         return this;
     }
-    toHaveFields(keys) {
+    /**
+     * Tests if Collection items has all of provided fields.
+     * @param fields
+     */
+    toContainFields(fields) {
         try {
+            fields = Array.isArray(fields) ? fields : [fields];
             for (const item of this.response.body.payload) {
-                this._expect(item).toHaveFields(keys);
+                this._expect(Object.keys(item)).toEqual(expect.arrayContaining(fields));
             }
         }
         catch (e) {
-            Error.captureStackTrace(e, this.toHaveFields);
+            Error.captureStackTrace(e, this.toContainFields);
             throw e;
         }
         return this;
     }
-    toHaveFieldsOnly(keys) {
+    /**
+     * Tests if Collection items only contains all of provided fields.
+     * @param fields
+     */
+    toContainAllFields(fields) {
         try {
+            fields = Array.isArray(fields) ? fields : [fields];
             for (const item of this.response.body.payload) {
-                this._expect(item).toHaveFieldsOnly(keys);
+                this._expect(Object.keys(item)).toEqual(fields);
             }
         }
         catch (e) {
-            Error.captureStackTrace(e, this.toHaveFieldsOnly);
+            Error.captureStackTrace(e, this.toContainAllFields);
             throw e;
         }
         return this;
     }
-    //
-    // toHaveProperty(keyPath, value?): this {
-    //   try {
-    //     for (const item of this.response.payload) {
-    //       this._expect(item).toHaveProperty(keyPath, value);
-    //     }
-    //
-    //   } catch (e: any) {
-    //     Error.captureStackTrace(e, this.toHaveProperty);
-    //     throw e;
-    //   }
-    //   return this;
-    // }
-    toBeSortedBy(...fields) {
+    /**
+     * Tests if Collection is sorted by given field(s).
+     * @param fields
+     */
+    toBeSortedBy(fields) {
         try {
-            this._expect(this.response.body.payload).toBeSortedBy(fields);
+            fields = Array.isArray(fields) ? fields : [fields];
+            this._expect(this.response.body.payload)
+                .opraCollectionToBeSortedBy(fields);
         }
         catch (e) {
             Error.captureStackTrace(e, this.toBeSortedBy);
@@ -81,6 +117,10 @@ class ApiExpectCollection {
         }
         return this;
     }
+    /**
+     * Tests if Collection is filtered by given condition.
+     * @param filter
+     */
     toBeFilteredBy(filter) {
         const f = convertFilter(filter);
         if (f) {
@@ -96,44 +136,49 @@ class ApiExpectCollection {
         }
         return this;
     }
-    toHaveExactItems(expected) {
-        try {
-            this._expect(this.response.body.dapayloadta).toHaveLength(expected);
-        }
-        catch (e) {
-            Error.captureStackTrace(e, this.toHaveExactItems);
-            throw e;
-        }
-        return this;
-    }
-    toHaveMaxItems(expected) {
-        try {
-            this._expect(this.response.body.payload.length).toBeLessThanOrEqual(expected);
-        }
-        catch (e) {
-            Error.captureStackTrace(e, this.toHaveMaxItems);
-            throw e;
-        }
-        return this;
-    }
-    toHaveMinItems(expected) {
-        try {
-            this._expect(this.response.body.payload.length).toBeGreaterThanOrEqual(expected);
-        }
-        catch (e) {
-            Error.captureStackTrace(e, this.toHaveMinItems);
-            throw e;
-        }
-        return this;
-    }
-    _expect(expected) {
-        const out = expect(expected);
-        if (this._isNot)
-            return out.not;
-        return out;
-    }
 }
 exports.ApiExpectCollection = ApiExpectCollection;
+expect.extend({
+    opraCollectionToBeSortedBy(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 = () => 'Items are not sorted as expected';
+            }
+        }
+        return {
+            actual: received,
+            message,
+            pass
+        };
+    },
+});
 function convertFilter(str) {
     const ast = typeof str === 'string' ? common_1.OpraFilter.parse(str) : str;
     if (!ast)

package/cjs/api-expect/api-expect-error.js

@@ -3,60 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiExpectError = void 0;
 const tslib_1 = require("tslib");
 require("../jest-extend/index.js");
-const jest_matcher_utils_1 = tslib_1.__importDefault(require("jest-matcher-utils"));
-const object_matches_util_js_1 = require("../utils/object-matches.util.js");
-const api_expect_object_js_1 = require("./api-expect-object.js");
-class ApiExpectError extends api_expect_object_js_1.ApiExpectObject {
-    constructor(response) {
-        super(response);
-        this.response = response;
-    }
-    toContainDetail(...matching) {
+const lodash_isnil_1 = tslib_1.__importDefault(require("lodash.isnil"));
+const lodash_omitby_1 = tslib_1.__importDefault(require("lodash.omitby"));
+const api_expect_base_js_1 = require("./api-expect-base.js");
+class ApiExpectError extends api_expect_base_js_1.ApiExpectBase {
+    toMatch(expected) {
         try {
-            expect(this.response.body).toBeDefined();
-            expect(this.response.body.issues).toBeDefined();
-            expect(this.response.body.issues).apiErrorDetailToContain(matching);
+            if (typeof expected === 'string')
+                expected = { message: expected };
+            else if (expected instanceof RegExp)
+                expected = { message: expect.stringMatching(expected) };
+            expected = (0, lodash_omitby_1.default)(expected, lodash_isnil_1.default);
+            this._expect(this.response.body.errors).toEqual(expect.arrayContaining([expect.objectContaining(expected)]));
         }
         catch (e) {
-            Error.captureStackTrace(e, this.toContainDetail);
+            Error.captureStackTrace(e, this.toMatch);
             throw e;
         }
+        return this;
     }
 }
 exports.ApiExpectError = ApiExpectError;
-expect.extend({
-    apiErrorDetailToContain(received, issues) {
-        try {
-            expect(typeof received).toStrictEqual('object');
-            expect(Array.isArray(received)).toStrictEqual(true);
-        }
-        catch (e) {
-            return {
-                pass: false,
-                message: () => e.message
-            };
-        }
-        for (const m of issues) {
-            let matched = false;
-            for (const detail of received) {
-                if (typeof m === 'object') {
-                    try {
-                        (0, object_matches_util_js_1.objectMatches)(detail, m);
-                        matched = true;
-                        break;
-                    }
-                    catch {
-                        //
-                    }
-                }
-            }
-            if (!matched) {
-                return {
-                    pass: false,
-                    message: () => `Object does not match: \n` + jest_matcher_utils_1.default.stringify(m)
-                };
-            }
-        }
-        return { actual: true, pass: true, message: () => '' };
-    },
-});

package/cjs/api-expect/api-expect-object.js

@@ -2,21 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiExpectObject = void 0;
 const tslib_1 = require("tslib");
-require("../jest-extend/index.js");
 const lodash_isnil_1 = tslib_1.__importDefault(require("lodash.isnil"));
 const lodash_omitby_1 = tslib_1.__importDefault(require("lodash.omitby"));
-class ApiExpectObject {
-    constructor(response, _isNot = false) {
-        this.response = response;
-        this._isNot = _isNot;
-    }
+const api_expect_base_js_1 = require("./api-expect-base.js");
+class ApiExpectObject extends api_expect_base_js_1.ApiExpectBase {
     get not() {
-        return new ApiExpectObject(this.response, !this._isNot);
+        return new ApiExpectObject(this.response, !this.isNot);
     }
+    /**
+     * Tests if Response payload matches given object
+     * @param expected
+     */
     toMatch(expected) {
         try {
-            const v = (0, lodash_omitby_1.default)(expected, lodash_isnil_1.default);
-            this._expect(this.response.body.payload).toMatchObject(v);
+            expected = (0, lodash_omitby_1.default)(expected, lodash_isnil_1.default);
+            this._expect(this.response.body.payload).toEqual(expect.objectContaining(expected));
         }
         catch (e) {
             Error.captureStackTrace(e, this.toMatch);
@@ -24,31 +24,37 @@ class ApiExpectObject {
         }
         return this;
     }
-    toHaveFields(fields) {
+    /**
+     * Tests if Response payload has all of provided fields.
+     * @param fields
+     */
+    toContainFields(fields) {
         try {
-            this._expect(this.response.body.payload).toHaveFields(fields);
+            fields = Array.isArray(fields) ? fields : [fields];
+            this._expect(Object.keys(this.response.body.payload))
+                .toEqual(expect.arrayContaining(fields));
         }
         catch (e) {
-            Error.captureStackTrace(e, this.toHaveFields);
+            Error.captureStackTrace(e, this.toContainFields);
             throw e;
         }
         return this;
     }
-    toHaveFieldsOnly(fields) {
+    /**
+     * Tests if Response payload only contains all of provided fields.
+     * @param fields
+     */
+    toContainAllFields(fields) {
         try {
-            this._expect(this.response.body.payload).toHaveFieldsOnly(fields);
+            fields = Array.isArray(fields) ? fields : [fields];
+            this._expect(Object.keys(this.response.body.payload))
+                .toEqual(fields);
         }
         catch (e) {
-            Error.captureStackTrace(e, this.toHaveFieldsOnly);
+            Error.captureStackTrace(e, this.toContainAllFields);
             throw e;
         }
         return this;
     }
-    _expect(expected) {
-        const out = expect(expected);
-        if (this._isNot)
-            return out.not;
-        return out;
-    }
 }
 exports.ApiExpectObject = ApiExpectObject;

package/cjs/api-expect/api-expect-operation-result.js

@@ -2,49 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiExpectOperationResult = void 0;
 require("../jest-extend/index.js");
-class ApiExpectOperationResult {
-    constructor(response, _isNot = false) {
-        this.response = response;
-        this._isNot = _isNot;
-    }
+const api_expect_base_js_1 = require("./api-expect-base.js");
+class ApiExpectOperationResult extends api_expect_base_js_1.ApiExpectBase {
     get not() {
-        return new ApiExpectOperationResult(this.response, !this._isNot);
-    }
-    toBeAffectedExact(expected) {
-        try {
-            this._expect(this.response.body.affected).toStrictEqual(expected);
-        }
-        catch (e) {
-            Error.captureStackTrace(e, this.toBeAffectedExact);
-            throw e;
-        }
-        return this;
+        return new ApiExpectOperationResult(this.response, !this.isNot);
     }
-    toBeAffectedMin(expected) {
+    toBeAffected(min, max) {
+        let msg = '';
         try {
-            this._expect(this.response.body.affected).toBeGreaterThanOrEqual(expected);
+            msg += `The value of "affected" do not match. `;
+            const l = this.response.body.affected;
+            this._expect(l).toBeGreaterThanOrEqual(min || 1);
+            if (max)
+                this._expect(l).toBeLessThanOrEqual(max);
         }
         catch (e) {
-            Error.captureStackTrace(e, this.toBeAffectedMin);
+            if (msg)
+                e.message = msg + '\n\n' + e.message;
+            Error.captureStackTrace(e, this.toBeAffected);
             throw e;
         }
         return this;
     }
-    toBeAffectedMax(expected) {
-        try {
-            this._expect(this.response.body.affected).toBeLessThanOrEqual(expected);
-        }
-        catch (e) {
-            Error.captureStackTrace(e, this.toBeAffectedMax);
-            throw e;
-        }
-        return this;
-    }
-    _expect(expected) {
-        const out = expect(expected);
-        if (this._isNot)
-            return out.not;
-        return out;
-    }
 }
 exports.ApiExpectOperationResult = ApiExpectOperationResult;

package/cjs/api-expect/api-expect.js

@@ -1,113 +1,134 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiExpect = void 0;
+const tslib_1 = require("tslib");
 require("../jest-extend/index.js");
+const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
+const api_expect_base_js_1 = require("./api-expect-base.js");
 const api_expect_collection_js_1 = require("./api-expect-collection.js");
 const api_expect_error_js_1 = require("./api-expect-error.js");
 const api_expect_object_js_1 = require("./api-expect-object.js");
 const api_expect_operation_result_js_1 = require("./api-expect-operation-result.js");
-class ApiExpect {
-    constructor(response, _isNot = false) {
-        this.response = response;
-        this._isNot = _isNot;
-    }
-    get not() {
-        return new ApiExpect(this.response, !this._isNot);
-    }
-    toSuccess(status = 200) {
+class ApiExpect extends api_expect_base_js_1.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' + ansi_colors_1.default.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 api_expect_error_js_1.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 api_expect_operation_result_js_1.ApiExpectOperationResult(this.response);
+        return new api_expect_collection_js_1.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 api_expect_object_js_1.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 api_expect_collection_js_1.ApiExpectCollection(this.response);
-    }
-    _expect(expected) {
-        const out = expect(expected);
-        if (this._isNot)
-            return out.not;
-        return out;
+        return new api_expect_operation_result_js_1.ApiExpectOperationResult(this.response);
     }
 }
 exports.ApiExpect = ApiExpect;