hotstaq 0.5.24

package/build/src/HotTester.d.ts

@@ -0,0 +1,188 @@
+import { HotStaq } from "./HotStaq";
+import { HotRouteMethod } from "./HotRouteMethod";
+import { HotTestDriver } from "./HotTestDriver";
+import { HotTestDestination, HotTestMap, HotTestPage, HotTestPath } from "./HotTestMap";
+/**
+ * The test stop that is executed as either a destination or
+ * a path.
+ */
+export interface HotTestStop {
+    /**
+     * A command to execute. Can be:
+     * * print(x)
+     *   * Print a message to the server's console.
+     * * println(x)
+     *   * Print a message with a new line to the server's console.
+     * * url(x)
+     *   * Open a url. Must be an absolute url.
+     * * waitForTesterAPIData
+     *   * This will wait for the tester API to receive data.
+     * * wait(x)
+     *   * This will wait for x number of milliseconds.
+     * * waitForTestObject(x)
+     *   * This will wait for a test object to be loaded.
+     */
+    cmd: string;
+    /**
+     * The destination to execute.
+     */
+    dest: string;
+    /**
+     * The path to execute.
+     */
+    path: string;
+}
+/**
+ * The destination for a test to take.
+ */
+export interface HotDestination {
+    /**
+     * The name of the map.
+     */
+    mapName: string;
+    /**
+     * The page to start at.
+     */
+    page: string;
+    /**
+     * The API route to start using.
+     */
+    api: string;
+    /**
+     * The paths to take on the page.
+     */
+    paths: HotTestStop[];
+}
+/**
+ * Executes tests.
+ */
+export declare abstract class HotTester {
+    /**
+     * The tester name.
+     */
+    name: string;
+    /**
+     * The base url that will construct future urls.
+     */
+    baseUrl: string;
+    /**
+     * The associated processor.
+     */
+    processor: HotStaq;
+    /**
+     * The test maps to test.
+     */
+    testMaps: {
+        [name: string]: HotTestMap;
+    };
+    /**
+     * The driver to use when running tests.
+     */
+    driver: HotTestDriver;
+    /**
+     * Has this tester finished loading?
+     */
+    finishedLoading: boolean;
+    /**
+     * Has this tester finished setting up?
+     */
+    hasBeenSetup: boolean;
+    /**
+     * Has this tester finished setting up?
+     */
+    hasBeenDestroyed: boolean;
+    constructor(processor: HotStaq, name: string, baseUrl: string, driver: HotTestDriver, testMaps?: {
+        [name: string]: HotTestMap;
+    });
+    /**
+     * Executed when setting up the tester.
+     */
+    abstract setup(isWebRoute: boolean, url: string, destinationKey?: string): Promise<void>;
+    /**
+     * Executed when destroying up the tester.
+     */
+    abstract destroy(): Promise<void>;
+    /**
+     * Executed when tests are started. If this returns true, it will
+     * continue and execute all test paths. If this returns it will
+     * skip all test paths and execute onTestEnd instead.
+     */
+    onTestStart?(destination: HotDestination, url: string, destinationKey?: string): Promise<boolean>;
+    /**
+     * Executed when an API test path has started. If this returns false,
+     * the testPath will not be immediately executed afterwards.
+     */
+    onTestAPIPathStart?(destination: HotDestination, method: HotRouteMethod, testName: string, continueWhenTestIsComplete?: boolean): Promise<boolean>;
+    /**
+     * Executed when an API test path has ended.
+     */
+    onTestAPIPathEnd?(destination: HotDestination, method: HotRouteMethod, testName: string, result: any, continueWhenTestIsComplete?: boolean): Promise<void>;
+    /**
+     * Executed when page tests are started. If this returns false, the testPath will not be
+     * immediately executed afterwards.
+     */
+    onTestPagePathStart?(destination: HotDestination, page: HotTestPage, stop: HotTestStop, continueWhenTestIsComplete?: boolean): Promise<boolean>;
+    /**
+     * Executed when a page test has ended.
+     */
+    onTestPagePathEnd?(destination: HotDestination, testPath: HotTestPath, result: any, continueWhenTestIsComplete?: boolean): Promise<void>;
+    /**
+     * Executed when a command is executed.
+     */
+    onCommand?(destination: HotDestination, page: HotTestPage, stop: HotTestStop, cmd: string, args: string[], cmdFunc: ((cmdArgs: string[]) => Promise<void>)): Promise<void>;
+    /**
+     * Executed when tests are finished.
+     */
+    onTestEnd?(destination: HotDestination): Promise<void>;
+    /**
+     * Executed when this tester has been executed from the API.
+     */
+    onExecute?(): Promise<void>;
+    /**
+     * Executed when this tester has finished loading all data from the API.
+     */
+    onFinishedLoading?(): Promise<void>;
+    /**
+     * Waits for the API to finish loading all data.
+     */
+    waitForData(): Promise<void>;
+    /**
+     * Get a test page.
+     */
+    getTestPage(destination: HotDestination): HotTestPage;
+    /**
+     * Get a test path.
+     */
+    getTestPath(destination: HotDestination, pathName: string): HotTestPath;
+    /**
+     * Get a destination JSON object to use.
+     */
+    static interpretDestination(mapName: string, testDest: HotTestDestination): HotDestination;
+    /**
+     * Execute an API's test path.
+     */
+    executeTestAPIPath(destination: HotDestination, method: HotRouteMethod, testName: string, skipEventCalls?: boolean, continueWhenTestIsComplete?: boolean): Promise<any>;
+    /**
+     * Execute all test paths in an API route.
+     *
+     * @fixme This needs a better implementation...
+     */
+    executeTestAPIPaths(destination: HotDestination): Promise<any[]>;
+    /**
+     * Execute a test page path.
+     */
+    executeTestPagePath(destination: HotDestination, stop: HotTestStop, skipEventCalls?: boolean, continueWhenTestIsComplete?: boolean): Promise<any>;
+    /**
+     * Execute a command.
+     */
+    executeCommand(destination: HotDestination, page: HotTestPage, stop: HotTestStop, cmd: string): Promise<void>;
+    /**
+     * Execute all test paths in a page.
+     */
+    executeTestPagePaths(destination: HotDestination, continueWhenTestIsComplete?: boolean): Promise<any[]>;
+    /**
+     * Execute the tests.
+     */
+    execute(mapName: string): Promise<void>;
+}
+//# sourceMappingURL=HotTester.d.ts.map

package/build/src/HotTester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HotTester.d.ts","sourceRoot":"","sources":["../../src/HotTester.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,cAAc,EAAkB,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAExF;;;GAGG;AACH,MAAM,WAAW,WAAW;IAE3B;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAE9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,WAAW,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,8BAAsB,SAAS;IAE9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;KAAE,CAAC;IAC1C;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IACtB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;gBAEb,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAC7D,MAAM,EAAE,aAAa,EAAE,QAAQ,GAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;KAAO;IAYtE;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IACzF;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAK,OAAO,CAAC,IAAI,CAAC;IAElC;;;;OAIG;IACG,WAAW,CAAC,CAAE,WAAW,EAAE,cAAc,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IACxG;;;OAGG;IACG,kBAAkB,CAAC,CAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAC7E,QAAQ,EAAE,MAAM,EAAE,0BAA0B,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAC1E;;OAEG;IACG,gBAAgB,CAAC,CAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAC3E,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,0BAA0B,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IACpF;;;OAGG;IACG,mBAAmB,CAAC,CAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,EACzE,IAAI,EAAE,WAAW,EAAE,0BAA0B,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAC3E;;OAEG;IACG,iBAAiB,CAAC,CAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,EAAE,WAAW,EAC3E,MAAM,EAAE,GAAG,EAAE,0BAA0B,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAClE;;OAEG;IACG,SAAS,CAAC,CAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAClF,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAC7F;;OAEG;IACG,SAAS,CAAC,CAAE,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAE7D;;OAEG;IACG,SAAS,CAAC,IAAK,OAAO,CAAC,IAAI,CAAC;IAClC;;OAEG;IACG,iBAAiB,CAAC,IAAK,OAAO,CAAC,IAAI,CAAC;IAE1C;;OAEG;IACG,WAAW,IAAK,OAAO,CAAC,IAAI,CAAC;IAMnC;;OAEG;IACH,WAAW,CAAE,WAAW,EAAE,cAAc,GAAG,WAAW;IAOtD;;OAEG;IACH,WAAW,CAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,GAAG,WAAW;IAOxE;;OAEG;IACH,MAAM,CAAC,oBAAoB,CAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,GAAG,cAAc;IAoD3F;;OAEG;IACG,kBAAkB,CAAE,WAAW,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAC5E,QAAQ,EAAE,MAAM,EAAE,cAAc,GAAE,OAAe,EAAE,0BAA0B,GAAE,OAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAgC9G;;;;OAIG;IACG,mBAAmB,CAAE,WAAW,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAgCvE;;OAEG;IACG,mBAAmB,CAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,EACxE,cAAc,GAAE,OAAe,EAAE,0BAA0B,GAAE,OAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAgD5F;;OAEG;IACG,cAAc,CAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoIpH;;OAEG;IACG,oBAAoB,CAAE,WAAW,EAAE,cAAc,EAAE,0BAA0B,GAAE,OAAe,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IA2CrH;;OAEG;IACG,OAAO,CAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAuI9C"}