zation-assured 0.6.2 → 3.0.0-dev.3

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

@@ -1,293 +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 assert = require('assert');
-const zation_client_1 = require("zation-client");
-const objectAsserter_1 = require("./objectAsserter");
-const timeoutAssert_1 = require("../timeout/timeoutAssert");
-const doUtils_1 = require("../do/doUtils");
-const eventAsserter_1 = require("./eventAsserter");
-class AbstractClientAsserter {
-    constructor(clients, test) {
-        this._test = test;
-        this.clients = clients;
-    }
-    _forEachClient(func) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let promises = [];
-            this.clients.forEach((c, i) => {
-                promises.push(func(c, i));
-            });
-            yield Promise.all(promises);
-        });
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client is connected.
-     * @param timeout
-     * With this parameter, you can set a time limit in that the assertion must be successful.
-     */
-    isConnected(timeout = 0) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                if (c.isConnected()) {
-                    return;
-                }
-                const toa = new timeoutAssert_1.TimeoutAssert(`Client: ${i} should be connected.`, timeout);
-                c.eventReact().onceConnect(() => {
-                    toa.resolve();
-                });
-                yield toa.set();
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client is disconnected.
-     * @param timeout
-     * With this parameter, you can set a time limit in that the assertion must be successful.
-     */
-    isDisconnected(timeout = 0) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                if (!c.isConnected()) {
-                    return;
-                }
-                const toa = new timeoutAssert_1.TimeoutAssert(`Client: ${i} should be disconnected.`, timeout);
-                c.eventReact().onceDisconnect(() => {
-                    toa.resolve();
-                });
-                yield toa.set();
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client is authenticated.
-     * @param timeout
-     * With this parameter, you can set a time limit in that the assertion must be successful.
-     */
-    isAuthenticated(timeout = 0) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                if (c.isAuthenticated()) {
-                    return;
-                }
-                const toa = new timeoutAssert_1.TimeoutAssert(`Client: ${i} should be authenticated.`, timeout);
-                c.eventReact().onceAuthenticate(() => {
-                    toa.resolve();
-                });
-                yield toa.set();
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client is deauthenticated.
-     * @param timeout
-     * With this parameter, you can set a time limit in that the assertion must be successful.
-     */
-    isDeauthenticated(timeout = 0) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                if (!c.isAuthenticated()) {
-                    return;
-                }
-                const toa = new timeoutAssert_1.TimeoutAssert(`Client: ${i} should be deauthenticated.`, timeout);
-                c.eventReact().onceDeauthenticate(() => {
-                    toa.resolve();
-                });
-                yield toa.set();
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client has a user id.
-     * @param userId
-     * If it is not given it will assert that the client has any user id.
-     */
-    hasUserId(userId) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                const currentId = c.userId;
-                if (userId !== undefined) {
-                    assert.equal(currentId, userId, `Client: ${i} should have the userId: ${userId}`);
-                }
-                else if (currentId === undefined) {
-                    assert.fail(`Client: ${i} should have any user id.`);
-                }
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client has a authUserGroup.
-     * @param authUserGroup
-     * If it is not given it will assert that the client has any authUserGroup.
-     */
-    hasAuthUserGroup(authUserGroup) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                const currentGroup = c.authUserGroup;
-                if (authUserGroup !== undefined) {
-                    assert.equal(currentGroup, authUserGroup, `Client: ${i} should have the authUserGroup: ${authUserGroup}`);
-                }
-                else if (currentGroup === undefined) {
-                    assert.fail(`Client: ${i} should have any authUserGroup.`);
-                }
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client has a specific token id.
-     */
-    hasTokenId(tokenId) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                try {
-                    const currentTokenId = c.tokenId;
-                    assert.equal(currentTokenId, tokenId, `Client: ${i} should have the tokenId: ${tokenId}`);
-                }
-                catch (e) {
-                    if (e instanceof zation_client_1.AuthenticationRequiredError) {
-                        assert.fail(`Client: ${i} can not access the token for assert token id.`);
-                    }
-                    else {
-                        throw e;
-                    }
-                }
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client has panel access.
-     */
-    hasPanelAccess(access = true) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                try {
-                    const currentAccess = c.hasPanelAccess();
-                    assert.equal(currentAccess, access, `Client: ${i} should ${access ? '' : 'not'} have panel access`);
-                }
-                catch (e) {
-                    if (e instanceof zation_client_1.AuthenticationRequiredError) {
-                        assert.fail(`Client: ${i} can not access the token for assert panel access.`);
-                    }
-                    else {
-                        throw e;
-                    }
-                }
-            }));
-        }));
-        return this.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert the token payload of the client.
-     */
-    assertTokenPayload() {
-        return new objectAsserter_1.default(this.self(), 'Client:', (test) => {
-            this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-                yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        test(c.getTokenPayload(), ` ${i}  Token: `);
-                    }
-                    catch (e) {
-                        if (e instanceof zation_client_1.AuthenticationRequiredError) {
-                            assert.fail(`Client: ${i} can not access the token for assert token payload.`);
-                        }
-                        else {
-                            throw e;
-                        }
-                    }
-                }));
-            }));
-        });
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * With this function you can create custom assertions for a client.
-     * @param assert
-     * The assert function with params:
-     * -client the client
-     * -index the index of the client
-     */
-    assert(assert) {
-        this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-            yield this._forEachClient((c, i) => __awaiter(this, void 0, void 0, function* () {
-                yield assert(c, i);
-            }));
-        }));
-        return this.self();
-    }
-    // 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.self();
-    }
-    // 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.self();
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that the client should receive an emit-event from the server.
-     * It uses the custom zation event namespace
-     * (so you cannot have name conflicts with internal event names).
-     */
-    receiveEvent(event, responder) {
-        return new eventAsserter_1.EventAsserter(this.clients, event, this._test, this.self(), responder);
-    }
-}
-exports.AbstractClientAsserter = AbstractClientAsserter;

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

@@ -1,62 +0,0 @@
-import ObjectAsserter from "./objectAsserter";
-import { ForintQuery } from "forint";
-declare type AddTest = (test: (any: any, eStr?: string) => void) => void;
-export declare class AnyAsserter<T> {
-    protected readonly self: T;
-    private readonly addTest;
-    private readonly name;
-    constructor(self: T, name: string, addTest: AddTest);
-    /**
-     * @description
-     * Assert that any is undefined.
-     */
-    isUndefined(): AnyAsserter<T>;
-    /**
-     * @description
-     * Assert that any is from a specific type.
-     * @param type
-     */
-    typeOf(type: string): AnyAsserter<T>;
-    /**
-     * @description
-     * Assert that any is equal with...
-     * Is using the == operator to check.
-     * @param any
-     */
-    equal(any: any): AnyAsserter<T>;
-    /**
-     * @description
-     * Assert that any is strict equal with...
-     * Is using the === operator to check.
-     * @param any
-     */
-    strictEqual(any: any): AnyAsserter<T>;
-    /**
-     * @description
-     * Object assert any.
-     * This assertion will only invoked when any is from type object.
-     * @param addTypeOfAssertion
-     * Indicates if it should add a type of assertion for type object.
-     * Default value is true.
-     */
-    objectAssert(addTypeOfAssertion?: boolean): ObjectAsserter<AnyAsserter<T>>;
-    /**
-     * Asserts that any matches with a forint query.
-     */
-    matches(query: ForintQuery): AnyAsserter<T>;
-    /**
-     * @description
-     * With this function you can create custom assertions for any.
-     * @param assert
-     * function with params
-     * -any the input
-     * -name the name of this assertion.
-     */
-    assert(assert: (any: any, name: string) => void | Promise<void>): AnyAsserter<T>;
-    /**
-     * @description
-     * End the any asserter.
-     */
-    end(): T;
-}
-export {};

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

@@ -1,130 +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 objectAsserter_1 = require("./objectAsserter");
-const forint_1 = require("forint");
-const cAssert = require('chai').assert;
-class AnyAsserter {
-    constructor(self, name, addTest) {
-        this.self = self;
-        this.addTest = addTest;
-        this.name = name;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that any is undefined.
-     */
-    isUndefined() {
-        this.addTest((any, eStr = '') => {
-            cAssert(any === undefined, `${this.name + eStr} should be undefined.`);
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that any is from a specific type.
-     * @param type
-     */
-    typeOf(type) {
-        this.addTest((any, eStr = '') => {
-            cAssert.typeOf(any, type, `${this.name + eStr} should from type ${type}`);
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that any is equal with...
-     * Is using the == operator to check.
-     * @param any
-     */
-    equal(any) {
-        this.addTest((inAny, eStr = '') => {
-            cAssert.equal(inAny, any, `${this.name + eStr} should equal with ${any}`);
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Assert that any is strict equal with...
-     * Is using the === operator to check.
-     * @param any
-     */
-    strictEqual(any) {
-        this.addTest((inAny, eStr = '') => {
-            cAssert.strictEqual(inAny, any, `${this.name + eStr} should strict equal with ${any}`);
-        });
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * Object assert any.
-     * This assertion will only invoked when any is from type object.
-     * @param addTypeOfAssertion
-     * Indicates if it should add a type of assertion for type object.
-     * Default value is true.
-     */
-    objectAssert(addTypeOfAssertion = true) {
-        if (addTypeOfAssertion) {
-            this.typeOf('object');
-        }
-        return new objectAsserter_1.default(this, this.name, (test) => {
-            this.addTest((any, eStr = '') => {
-                if (typeof any === 'object') {
-                    test(any, eStr);
-                }
-            });
-        });
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * Asserts that any matches with a forint query.
-     */
-    matches(query) {
-        this.addTest((inAny, eStr = '') => __awaiter(this, void 0, void 0, function* () {
-            yield cAssert(forint_1.default(query)(inAny), `${this.name + eStr} should match with the forint query.`);
-        }));
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * With this function you can create custom assertions for any.
-     * @param assert
-     * function with params
-     * -any the input
-     * -name the name of this assertion.
-     */
-    assert(assert) {
-        this.addTest((inAny, eStr = '') => __awaiter(this, void 0, void 0, function* () {
-            yield assert(inAny, this.name + eStr);
-        }));
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * End the any asserter.
-     */
-    end() {
-        return this.self;
-    }
-}
-exports.AnyAsserter = AnyAsserter;

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

@@ -1,34 +0,0 @@
-import { Test } from "../data/test";
-import { Zation as ZationClient } from 'zation-client';
-declare type AddReaction = (client: ZationClient, reaction: () => Promise<void>) => void;
-export declare class ChannelEventAsserter<T> {
-    protected readonly _test: Test;
-    protected readonly _addOnceReaction: AddReaction;
-    protected readonly _clients: ZationClient[];
-    protected readonly _source: T;
-    protected readonly _chName: string;
-    protected readonly _eventName: string;
-    private _timeout;
-    private _not;
-    constructor(addReaction: AddReaction, clients: ZationClient[], chName: string, eventName: string, test: Test, source: T);
-    /**
-     * @description
-     * With this function, you can set a time limit in that the channel event action must happen.
-     * @default
-     * The default value is 0.
-     */
-    timeout(timeout: number): ChannelEventAsserter<T>;
-    /**
-     * @description
-     * With this function, you can assert that the event should not be triggered.
-     * @default
-     * The default value is false.
-     */
-    not(): ChannelEventAsserter<T>;
-    /**
-     * @description
-     * End the channel event asserter.
-     */
-    end(): T;
-}
-export {};

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

@@ -1,84 +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 timeoutAssert_1 = require("../timeout/timeoutAssert");
-const assert = require('assert');
-class ChannelEventAsserter {
-    constructor(addReaction, clients, chName, eventName, test, source) {
-        this._timeout = 0;
-        this._not = false;
-        this._addOnceReaction = addReaction;
-        this._clients = clients;
-        this._chName = chName;
-        this._eventName = eventName;
-        this._test = test;
-        this._source = source;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * With this function, you can set a time limit in that the channel event action must happen.
-     * @default
-     * The default value is 0.
-     */
-    timeout(timeout) {
-        this._timeout = timeout;
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * With this function, you can assert that the event should not be triggered.
-     * @default
-     * The default value is false.
-     */
-    not() {
-        this._not = true;
-        return this;
-    }
-    // noinspection JSUnusedGlobalSymbols
-    /**
-     * @description
-     * End the channel event asserter.
-     */
-    end() {
-        this._clients.forEach((c, i) => {
-            let eventFired = false;
-            let resolve;
-            this._test.beforeTest(() => {
-                this._addOnceReaction(c, () => __awaiter(this, void 0, void 0, function* () {
-                    eventFired = true;
-                    if (typeof resolve === 'function') {
-                        resolve();
-                    }
-                }));
-            });
-            const failMsg = `Client: ${i} should ${this._not ? 'not' : ''} trigger the ${this._eventName} event in the channel: ${this._chName}.`;
-            this._test.test(() => __awaiter(this, void 0, void 0, function* () {
-                if (!eventFired) {
-                    const toa = new timeoutAssert_1.TimeoutAssert(failMsg, this._timeout, this._not);
-                    resolve = () => { toa.resolve(); };
-                    yield toa.set();
-                }
-                else if (this._not) {
-                    assert.fail(failMsg);
-                }
-            }));
-        });
-        return this._source;
-    }
-}
-exports.ChannelEventAsserter = ChannelEventAsserter;

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

@@ -1,53 +0,0 @@
-import { Test } from "../data/test";
-import { Zation as ZationClient } from 'zation-client';
-import { AnyAsserter } from "./anyAsserter";
-declare type AddReaction = (client: ZationClient, event: string | string[] | null, reaction: (data: any) => Promise<void>) => void;
-export declare class ChannelPubAsserter<T> {
-    protected readonly _test: Test;
-    protected readonly _addOnceReaction: AddReaction;
-    protected readonly _clients: ZationClient[];
-    protected readonly _source: T;
-    protected readonly _chName: string;
-    private readonly _pubDataChecker;
-    private _timeout;
-    private _event;
-    private _not;
-    constructor(addReaction: AddReaction, clients: ZationClient[], chName: string, test: Test, source: T);
-    /**
-     * @description
-     * With this function, you can set a time limit in that the publish action must happen.
-     * @default
-     * The default value is 0.
-     */
-    timeout(timeout: number): ChannelPubAsserter<T>;
-    /**
-     * @description
-     * With this function, you set that the client should not get a publish.
-     * @default
-     * The default value is false.
-     */
-    not(): ChannelPubAsserter<T>;
-    /**
-     * @description
-     * With this function, you can filter for a specific event.
-     * @param event
-     * You can also filter multiple events by giving an event array.
-     * Or to all events if you pass as parameter null.
-     * @default
-     * The default value is null.
-     */
-    event(event: string | string[] | null): ChannelPubAsserter<T>;
-    /**
-     * @description
-     * Assert the published data.
-     * Notice that the pub data will not checked in (get not) mode.
-     */
-    assertPubData(): AnyAsserter<ChannelPubAsserter<T>>;
-    private _checkPubData;
-    /**
-     * @description
-     * End the channel publish asserter.
-     */
-    end(): T;
-}
-export {};