zation-assured 0.5.1 → 3.0.0-dev.1

package/dist/lib/helper/asserter/responseAsserter.js

@@ -1,260 +0,0 @@
-"use strict";
-/*
-Author: Luca Scaringella
-GitHub: LucaCode
-©Copyright by Luca Scaringella
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const zation_client_1 = require("zation-client");
-const when_1 = require("../../api/when");
-const logger_1 = require("../console/logger");
-const anyAsserter_1 = require("./anyAsserter");
-const backErrorFilterBuilder_1 = require("../backError/backErrorFilterBuilder");
-const clientAsserter_1 = require("./clientAsserter");
-const doUtils_1 = require("../do/doUtils");
-const assert = require('assert');
-class ResponseAsserter {
-    constructor(req, test, client) {
-        this.autoConnectedClient = false;
-        this._shouldThrowTimeoutError = false;
-        this._shouldThrowConnectionRequiredError = false;
-        this.req = req;
-        this._test = test;
-        this._client = client;
-        this._createTest();
-    }
-    _createTest() {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            if (!this._client.isConnected() && this.autoConnectedClient) {
-                yield this._client.connect();
-            }
-            try {
-                yield this.req.send(false);
-                if (this._shouldThrowTimeoutError) {
-                    assert.fail('Send should throw a timeout error.');
-                }
-                if (this._shouldThrowConnectionRequiredError) {
-                    assert.fail('Send should throw a connection required error.');
-                }
-            }
-            catch (e) {
-                if (e instanceof zation_client_1.TimeoutError) {
-                    if (!this._shouldThrowTimeoutError) {
-                        assert.fail('Send should not throw a timeout error.');
-                    }
-                }
-                else if (e instanceof zation_client_1.ConnectionRequiredError) {
-                    if (!this._shouldThrowConnectionRequiredError) {
-                        assert.fail('Send should not throw a connection required error.');
-                    }
-                }
-                else {
-                    throw e;
-                }
-            }
-        }), true);
-    }
-    // noinspection JSMethodCanBeStatic
-    _respInfo(res) {
-        return '\n   ' + res.toString();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that send the request should throw a timeout error.
-     * @param value
-     */
-    throwsTimeoutError(value = true) {
-        this._shouldThrowTimeoutError = value;
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that send the request should throw a connection required error.
-     * @param value
-     */
-    throwsConnectionRequiredError(value = true) {
-        this._shouldThrowConnectionRequiredError = value;
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the response is successful.
-     */
-    isSuccessful() {
-        this.req.onResponse((res) => {
-            assert(res.isSuccessful(), 'Response should be successful.' + this._respInfo(res));
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the response is not successful.
-     */
-    isNotSuccessful() {
-        this.req.onResponse((res) => {
-            assert(!res.isSuccessful(), 'Response should be not successful.' + this._respInfo(res));
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the response has a result.
-     */
-    hasResult() {
-        this.req.onResponse((res) => {
-            assert(res.hasResult(), `Response should have a result.`
-                + this._respInfo(res));
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert the result of the response.
-     */
-    assertResult() {
-        return new anyAsserter_1.AnyAsserter(this, 'Response Result', (test) => {
-            this.req.onResponse((res) => {
-                test(res.getResult());
-            });
-        });
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Print the complete response to the console.
-     */
-    print() {
-        this.req.onResponse((res) => {
-            logger_1.Logger.logInfo(res.toString());
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the response has a specific count of errors.
-     * @param count
-     * count of errors
-     * @param filter
-     * Filter to filter for specific errors.
-     */
-    hasErrorCount(count, ...filter) {
-        this.req.onResponse((res) => {
-            assert(ResponseAsserter._filterErrors(res, filter).length === count, `Response should have ${count} back errors.${filter.length === 0 ? '' : ` With filter: ${JSON.stringify(filter)}`}`
-                + this._respInfo(res));
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the response has count of specific errors
-     * with filter builder.
-     * @param count
-     * count of errors
-     */
-    buildHasErrorCount(count) {
-        return new backErrorFilterBuilder_1.BackErrorFilterBuilder(this, count);
-    }
-    hasError(...filter) {
-        if (filter.length > 0) {
-            this.req.onResponse((res) => {
-                assert(ResponseAsserter._filterErrors(res, filter).length > 0, `Response should have an error.${filter.length === 0 ? '' : ` With filter: ${JSON.stringify(filter)}`}`
-                    + this._respInfo(res));
-            });
-            return this;
-        }
-        else
-            return new backErrorFilterBuilder_1.BackErrorFilterBuilder(this);
-    }
-    static _filterErrors(res, filter) {
-        return zation_client_1.ErrorFilterEngine.filterErrors(res.getErrors(false), filter);
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * With this function you can create custom assertions for a response.
-     * @param assert
-     * The assert function with params:
-     * -res The response
-     */
-    assert(assert) {
-        this.req.onResponse((res) => __awaiter(this, void 0, void 0, function* () {
-            yield assert(res);
-        }));
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * With this function, you can do extra things in the test.
-     * Subscribe a channel, publish to a channel...
-     * @param func
-     * @param failMsg if not provided it throws the specific error.
-     */
-    do(func, failMsg) {
-        doUtils_1.default.do(this._test, func, failMsg);
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * With this function, you can do extra things in the test
-     * and assert that it should throw an error or a specific error.
-     * Subscribe a channel, publish to a channel...
-     * @param func
-     * @param failMsg
-     * @param errors
-     */
-    doShouldThrow(func, failMsg, ...errors) {
-        doUtils_1.default.doShouldThrow(this._test, func, failMsg, ...errors);
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Start with a new request and link them to one test.
-     */
-    and() {
-        this._test.newSubTest();
-        return new when_1.WhenBuilder(this._client, this._test);
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Run the test.
-     * @param autoConnect
-     * Will auto connect the client
-     * if the client is not connected to the server.
-     */
-    test(autoConnect = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.autoConnectedClient = autoConnect;
-            return this._test.execute();
-        });
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert zation clients after request.
-     */
-    client(...client) {
-        return new clientAsserter_1.ClientAsserter(client, this._test, this);
-    }
-}
-exports.ResponseAsserter = ResponseAsserter;

package/dist/lib/helper/asserter/rootSendAsserter.d.ts

@@ -1,89 +0,0 @@
-import { Channel, Databox, Client } from "zation-client";
-import { Test } from "../test/test";
-import { WhenBuilder } from "../../api/when";
-import { ClientAsserter } from "./client/clientAsserter";
-import { DataboxAsserter } from "./databox/databoxAsserter";
-import { ChannelAsserter } from "./channel/channelAsserter";
-export declare abstract class RootSendAsserter<T> {
-    protected readonly _test: Test;
-    protected readonly _client: Client;
-    private autoConnectedClient;
-    private _shouldThrowTimeoutError;
-    private _shouldThrowConnectionRequiredError;
-    protected constructor(test: Test, client: Client);
-    protected abstract _executeAction(): Promise<void>;
-    private _createTest;
-    /**
-     * @description
-     * Assert that send should throw a timeout error.
-     * @param value
-     */
-    throwsTimeoutError(value?: boolean): T;
-    /**
-     * @description
-     * Assert that send should throw a connection required error.
-     * @param value
-     */
-    throwsConnectionRequiredError(value?: boolean): T;
-    /**
-     * @description
-     * This function lets you do an extra action on the client and asserts that no error is thrown.
-     * When an error throws, it lets the test fail with the provided message or the concrete error.
-     * @param action
-     * @param message if not provided it throws the specific error.
-     */
-    action(action: (client: Client) => void | Promise<void>, message?: string): T;
-    /**
-     * @description
-     * This function lets you do an extra action on the client and
-     * asserts that an error or an error instance of a specific class is thrown.
-     * When no error is thrown, or the error does not match with the given classes
-     * (only if at least one class is given), it lets the test fail with the provided message.
-     * @param action
-     * @param message
-     * @param validErrorClasses
-     */
-    actionShouldThrow(action: (client: Client) => void | Promise<void>, message: string, ...validErrorClasses: any[]): T;
-    /**
-     * @description
-     * Start with a new when and link them to one test.
-     */
-    and(): WhenBuilder;
-    /**
-     * @description
-     * Assert client.
-     */
-    client(): ClientAsserter<T>;
-    /**
-     * @description
-     * Assert other clients.
-     * Notice that this method will not automatically connect the clients.
-     */
-    otherClients(...clients: Client[]): ClientAsserter<T>;
-    /**
-     * @description
-     * Assert other databoxes.
-     * Notice that this method will not automatically connect the databoxes.
-     */
-    otherDataboxes(...databoxes: Databox[]): DataboxAsserter<T>;
-    /**
-     * @description
-     * Assert other channels.
-     * Notice that this method will not automatically subscribe to the channels.
-     */
-    otherChannels(...channels: Channel[]): ChannelAsserter<T>;
-    /**
-     * @description
-     * Runs the test.
-     * @param autoConnect
-     * Will auto connect the client
-     * if the client is not connected to the server.
-     */
-    test(autoConnect?: boolean): Promise<void>;
-    /**
-     * @description
-     * Returns self.
-     * For fluent programing with inheritance.
-     */
-    protected abstract self(): T;
-}

package/dist/lib/helper/asserter/standaloneClientAsserter.d.ts

@@ -1,11 +0,0 @@
-import { ZationClient } from 'zation-client';
-import { AbstractClientAsserter } from "./abstractClientAsserter";
-export declare class StandaloneClientAsserter extends AbstractClientAsserter<StandaloneClientAsserter> {
-    constructor(client: ZationClient | ZationClient[], itTestDescription?: string);
-    /**
-     * @description
-     * Run the test.
-     */
-    test(): Promise<void>;
-    protected self(): StandaloneClientAsserter;
-}

package/dist/lib/helper/asserter/standaloneClientAsserter.js

@@ -1,38 +0,0 @@
-"use strict";
-/*
-Author: Luca Scaringella
-GitHub: LucaCode
-©Copyright by Luca Scaringella
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const abstractClientAsserter_1 = require("./abstractClientAsserter");
-const test_1 = require("../test/test");
-class StandaloneClientAsserter extends abstractClientAsserter_1.AbstractClientAsserter {
-    constructor(client, itTestDescription) {
-        let clients = Array.isArray(client) ? client : [client];
-        super(clients, new test_1.Test(itTestDescription));
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Run the test.
-     */
-    test() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this._test.execute();
-        });
-    }
-    self() {
-        return this;
-    }
-}
-exports.StandaloneClientAsserter = StandaloneClientAsserter;

package/dist/lib/helper/assured/clientAssured.d.ts

@@ -1,2 +0,0 @@
-export declare class ClientAssured {
-}

package/dist/lib/helper/assured/clientAssured.js

@@ -1,11 +0,0 @@
-"use strict";
-/*
-Author: Luca Scaringella
-GitHub: LucaCode
-©Copyright by Luca Scaringella
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const assert = require('assert');
-class ClientAssured {
-}
-exports.ClientAssured = ClientAssured;

package/dist/lib/helper/assured/responseAssured.d.ts

@@ -1,17 +0,0 @@
-import { AbstractRequestHelper, Zation as ZationClient } from "zation-client";
-import { Test } from "../data/test";
-import { WhenBuilder } from "../../api/when";
-export declare class ResponseAssured {
-    private req;
-    private readonly _test;
-    private readonly client;
-    constructor(req: AbstractRequestHelper<any>, test: Test, client: ZationClient);
-    private _respInfo;
-    isSuccessful(): ResponseAssured;
-    notSuccessful(): ResponseAssured;
-    hasError(): ResponseAssured;
-    print(): ResponseAssured;
-    hasErrorCount(count: number): ResponseAssured;
-    and(): WhenBuilder;
-    test(autoConnect?: boolean): void;
-}

package/dist/lib/helper/assured/responseAssured.js

@@ -1,72 +0,0 @@
-"use strict";
-/*
-Author: Luca Scaringella
-GitHub: LucaCode
-©Copyright by Luca Scaringella
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const when_1 = require("../../api/when");
-const logger_1 = require("../console/logger");
-const assert = require('assert');
-class ResponseAssured {
-    constructor(req, test, client) {
-        this.req = req;
-        this._test = test;
-        this.client = client;
-    }
-    // noinspection JSMethodCanBeStatic
-    _respInfo(res) {
-        return '\n   ' + res.toString();
-    }
-    isSuccessful() {
-        this.req.onResponse((res) => {
-            assert(res.isSuccessful(), 'Response should be successful.' + this._respInfo(res));
-        });
-        return this;
-    }
-    notSuccessful() {
-        this.req.onResponse((res) => {
-            assert(!res.isSuccessful(), 'Response should be not successful.' + this._respInfo(res));
-        });
-        return this;
-    }
-    hasError() {
-        this.req.onResponse((res) => {
-            assert(res.hasErrors(false), 'Response should have at least one error.' + this._respInfo(res));
-        });
-        return this;
-    }
-    print() {
-        this.req.onResponse((res) => {
-            logger_1.Logger.logInfo(res.toString());
-        });
-        return this;
-    }
-    hasErrorCount(count) {
-        this.req.onResponse((res) => {
-            assert(res.getErrors(false).length === count, `Response should have ${count} errors.` + this._respInfo(res));
-        });
-        return this;
-    }
-    and() {
-        return new when_1.WhenBuilder(this.client, this._test);
-    }
-    test(autoConnect = true) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            if (!this.client.isConnected() && autoConnect) {
-                yield this.client.connect();
-            }
-            yield this.req.send(false);
-        }));
-        this._test.execute();
-    }
-}
-exports.ResponseAssured = ResponseAssured;

package/dist/lib/helper/backError/backErrorFilterBuilder.d.ts

@@ -1,13 +0,0 @@
-import { AbstractBackErrorFilterBuilder } from "zation-client";
-import { ResponseAsserter } from "../asserter/controller/responseAsserter";
-export declare class BackErrorFilterBuilder<T extends ResponseAsserter> extends AbstractBackErrorFilterBuilder<BackErrorFilterBuilder<T>> {
-    private readonly respAsserter;
-    private readonly count;
-    constructor(respAsserter: T, count?: number);
-    /**
-     * @description
-     * End the filter builder.
-     */
-    end(): T;
-    protected self(): BackErrorFilterBuilder<T>;
-}

package/dist/lib/helper/backError/backErrorFilterBuilder.js

@@ -1,35 +0,0 @@
-"use strict";
-/*
-Author: Luca Scaringella
-GitHub: LucaCode
-©Copyright by Luca Scaringella
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BackErrorFilterBuilder = void 0;
-const zation_client_1 = require("zation-client");
-class BackErrorFilterBuilder extends zation_client_1.AbstractBackErrorFilterBuilder {
-    constructor(respAsserter, count) {
-        super();
-        this.respAsserter = respAsserter;
-        this.count = count;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * End the filter builder.
-     */
-    end() {
-        this._pushTmpFilter();
-        if (this.count) {
-            this.respAsserter.hasErrorCount(this.count, ...this.filter);
-        }
-        else {
-            this.respAsserter.hasError(...this.filter);
-        }
-        return this.respAsserter;
-    }
-    self() {
-        return this;
-    }
-}
-exports.BackErrorFilterBuilder = BackErrorFilterBuilder;

package/dist/lib/helper/builder/controller/abstractRequestBuilder.d.ts

@@ -1,53 +0,0 @@
-import { AbstractRequestBuilder as NativeAbstractRequestBuilder, Client } from "zation-client";
-import { Test } from "../../test/test";
-import { ResponseAsserter } from "../../asserter/controller/responseAsserter";
-import { ConnectTimeoutOption } from "zation-client/dist/lib/main/utils/connectionUtils";
-export declare abstract class AbstractRequestBuilder<T, RT> {
-    private readonly test;
-    private readonly client;
-    private readonly nativeBuilder;
-    protected constructor(test: Test, client: Client, nativeBuilder: NativeAbstractRequestBuilder<any>);
-    /**
-     * @description
-     * Set the apiLevel of the request.
-     * @param apiLevel.
-     * @default undefined.
-     */
-    apiLevel(apiLevel: number | undefined): T;
-    /**
-     * @description
-     * Set the timeout for the response of the request.
-     * Value can be null which means the timeout is disabled or
-     * undefined then it will use the default timeout of the client config,
-     * or it can be a number that indicates the milliseconds.
-     * @param timeout
-     */
-    responseTimeout(timeout: null | undefined | number): T;
-    /**
-     * With the ConnectTimeout option, you can activate that the socket is
-     * trying to connect when it is not connected. You have five possible choices:
-     * Undefined: It will use the value from the default options.
-     * False: The action will fail and throw a ConnectionRequiredError,
-     * when the socket is not connected.
-     * Null: The socket will try to connect (if it is not connected) and
-     * waits until the connection is made, then it continues the action.
-     * Number: Same as null, but now you can specify a timeout (in ms) of
-     * maximum waiting time for the connection. If the timeout is reached,
-     * it will throw a timeout error.
-     * AbortTrigger: Same as null, but now you have the possibility to abort the wait later.
-     * @param timeout
-     * @default undefined
-     */
-    connectTimeout(timeout: ConnectTimeoutOption): T;
-    /**
-     * @description
-     * Start the assertions.
-     */
-    assertThat(): ResponseAsserter;
-    /**
-     * @description
-     * Returns self.
-     * For fluent programing with inheritance.
-     */
-    protected abstract self(): T;
-}

package/dist/lib/helper/builder/controller/abstractRequestBuilder.js

@@ -1,69 +0,0 @@
-"use strict";
-/*
-Author: Luca Scaringella
-GitHub: LucaCode
-©Copyright by Luca Scaringella
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractRequestBuilder = void 0;
-const responseAsserter_1 = require("../../asserter/controller/responseAsserter");
-class AbstractRequestBuilder {
-    constructor(test, client, nativeBuilder) {
-        this.test = test;
-        this.client = client;
-        this.nativeBuilder = nativeBuilder;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Set the apiLevel of the request.
-     * @param apiLevel.
-     * @default undefined.
-     */
-    apiLevel(apiLevel) {
-        this.nativeBuilder.apiLevel(apiLevel);
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Set the timeout for the response of the request.
-     * Value can be null which means the timeout is disabled or
-     * undefined then it will use the default timeout of the client config,
-     * or it can be a number that indicates the milliseconds.
-     * @param timeout
-     */
-    responseTimeout(timeout) {
-        this.nativeBuilder.responseTimeout(timeout);
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * With the ConnectTimeout option, you can activate that the socket is
-     * trying to connect when it is not connected. You have five possible choices:
-     * Undefined: It will use the value from the default options.
-     * False: The action will fail and throw a ConnectionRequiredError,
-     * when the socket is not connected.
-     * Null: The socket will try to connect (if it is not connected) and
-     * waits until the connection is made, then it continues the action.
-     * Number: Same as null, but now you can specify a timeout (in ms) of
-     * maximum waiting time for the connection. If the timeout is reached,
-     * it will throw a timeout error.
-     * AbortTrigger: Same as null, but now you have the possibility to abort the wait later.
-     * @param timeout
-     * @default undefined
-     */
-    connectTimeout(timeout) {
-        this.nativeBuilder.connectTimeout(timeout);
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Start the assertions.
-     */
-    assertThat() {
-        return new responseAsserter_1.ResponseAsserter(this.nativeBuilder, this.test, this.client);
-    }
-}
-exports.AbstractRequestBuilder = AbstractRequestBuilder;