@deenruv/testing 1.0.0

package/lib/simple-graphql-client.js

@@ -0,0 +1,229 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientError = exports.SimpleGraphQLClient = void 0;
+const shared_constants_1 = require("@deenruv/common/lib/shared-constants");
+const form_data_1 = __importDefault(require("form-data"));
+const fs_1 = __importDefault(require("fs"));
+const printer_1 = require("graphql/language/printer");
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const querystring_1 = require("querystring");
+const create_upload_post_data_1 = require("./utils/create-upload-post-data");
+const LOGIN = (0, graphql_tag_1.default) `
+  mutation ($username: String!, $password: String!) {
+    login(username: $username, password: $password) {
+      ... on CurrentUser {
+        id
+        identifier
+        channels {
+          token
+        }
+      }
+      ... on ErrorResult {
+        errorCode
+        message
+      }
+    }
+  }
+`;
+/**
+ * @description
+ * A minimalistic GraphQL client for populating and querying test data.
+ *
+ * @docsCategory testing
+ */
+class SimpleGraphQLClient {
+    constructor(deenruvConfig, apiUrl = "") {
+        this.deenruvConfig = deenruvConfig;
+        this.apiUrl = apiUrl;
+        this.channelToken = null;
+        this.headers = {
+            "Apollo-Require-Preflight": "true",
+        };
+    }
+    /**
+     * @description
+     * Sets the authToken to be used in each GraphQL request.
+     */
+    setAuthToken(token) {
+        this.authToken = token;
+        this.headers.Authorization = `Bearer ${this.authToken}`;
+    }
+    /**
+     * @description
+     * Sets the authToken to be used in each GraphQL request.
+     */
+    setChannelToken(token) {
+        this.channelToken = token;
+        if (this.deenruvConfig.apiOptions.channelTokenKey) {
+            this.headers[this.deenruvConfig.apiOptions.channelTokenKey] =
+                this.channelToken;
+        }
+    }
+    /**
+     * @description
+     * Returns the authToken currently being used.
+     */
+    getAuthToken() {
+        return this.authToken;
+    }
+    /**
+     * @description
+     * Performs both query and mutation operations.
+     */
+    async query(query, variables, queryParams) {
+        const response = await this.makeGraphQlRequest(query, variables, queryParams);
+        const result = await this.getResult(response);
+        if (response.ok && !result.errors && result.data) {
+            return result.data;
+        }
+        else {
+            const errorResult = typeof result === "string" ? { error: result } : result;
+            throw new ClientError(Object.assign(Object.assign({}, errorResult), { status: response.status }), { query: (0, printer_1.print)(query), variables });
+        }
+    }
+    /**
+     * @description
+     * Performs a raw HTTP request to the given URL, but also includes the authToken & channelToken
+     * headers if they have been set. Useful for testing non-GraphQL endpoints, e.g. for plugins
+     * which make use of REST controllers.
+     */
+    async fetch(url, options = {}) {
+        const headers = Object.assign(Object.assign({ "Content-Type": "application/json" }, this.headers), options.headers);
+        const response = await (0, node_fetch_1.default)(url, Object.assign(Object.assign({}, options), { headers }));
+        const authToken = response.headers.get(this.deenruvConfig.authOptions.authTokenHeaderKey || "");
+        if (authToken != null) {
+            this.setAuthToken(authToken);
+        }
+        return response;
+    }
+    /**
+     * @description
+     * Performs a query or mutation and returns the resulting status code.
+     */
+    async queryStatus(query, variables) {
+        const response = await this.makeGraphQlRequest(query, variables);
+        return response.status;
+    }
+    /**
+     * @description
+     * Attempts to log in with the specified credentials.
+     */
+    async asUserWithCredentials(username, password) {
+        var _a;
+        // first log out as the current user
+        if (this.authToken) {
+            await this.query((0, graphql_tag_1.default) `
+        mutation {
+          logout {
+            success
+          }
+        }
+      `);
+        }
+        const result = await this.query(LOGIN, { username, password });
+        if (((_a = result.login.channels) === null || _a === void 0 ? void 0 : _a.length) === 1) {
+            this.setChannelToken(result.login.channels[0].token);
+        }
+        return result.login;
+    }
+    /**
+     * @description
+     * Logs in as the SuperAdmin user.
+     */
+    async asSuperAdmin() {
+        var _a, _b;
+        const { superadminCredentials } = this.deenruvConfig.authOptions;
+        await this.asUserWithCredentials((_a = superadminCredentials === null || superadminCredentials === void 0 ? void 0 : superadminCredentials.identifier) !== null && _a !== void 0 ? _a : shared_constants_1.SUPER_ADMIN_USER_IDENTIFIER, (_b = superadminCredentials === null || superadminCredentials === void 0 ? void 0 : superadminCredentials.password) !== null && _b !== void 0 ? _b : shared_constants_1.SUPER_ADMIN_USER_PASSWORD);
+    }
+    /**
+     * @description
+     * Logs out so that the client is then treated as an anonymous user.
+     */
+    async asAnonymousUser() {
+        await this.query((0, graphql_tag_1.default) `
+      mutation {
+        logout {
+          success
+        }
+      }
+    `);
+    }
+    async makeGraphQlRequest(query, variables, queryParams) {
+        const queryString = (0, printer_1.print)(query);
+        const body = JSON.stringify({
+            query: queryString,
+            variables: variables ? variables : undefined,
+        });
+        const url = queryParams
+            ? this.apiUrl + `?${(0, querystring_1.stringify)(queryParams)}`
+            : this.apiUrl;
+        return this.fetch(url, {
+            method: "POST",
+            body,
+        });
+    }
+    async getResult(response) {
+        const contentType = response.headers.get("Content-Type");
+        if (contentType && contentType.startsWith("application/json")) {
+            return response.json();
+        }
+        else {
+            return response.text();
+        }
+    }
+    /**
+     * @description
+     * Perform a file upload mutation.
+     *
+     * Upload spec: https://github.com/jaydenseric/graphql-multipart-request-spec
+     * Discussion of issue: https://github.com/jaydenseric/apollo-upload-client/issues/32
+     */
+    async fileUploadMutation(options) {
+        const { mutation, filePaths, mapVariables } = options;
+        const postData = (0, create_upload_post_data_1.createUploadPostData)(mutation, filePaths, mapVariables);
+        const body = new form_data_1.default();
+        body.append("operations", JSON.stringify(postData.operations));
+        body.append("map", "{" +
+            Object.entries(postData.map)
+                .map(([i, path]) => `"${i}":["${path}"]`)
+                .join(",") +
+            "}");
+        for (const filePath of postData.filePaths) {
+            const file = fs_1.default.readFileSync(filePath.file);
+            body.append(filePath.name, file, { filename: filePath.file });
+        }
+        const result = await (0, node_fetch_1.default)(this.apiUrl, {
+            method: "POST",
+            body,
+            headers: Object.assign({}, this.headers),
+        });
+        const response = await result.json();
+        if (response.errors && response.errors.length) {
+            const error = response.errors[0];
+            throw new Error(error.message);
+        }
+        return response.data;
+    }
+}
+exports.SimpleGraphQLClient = SimpleGraphQLClient;
+class ClientError extends Error {
+    constructor(response, request) {
+        super(ClientError.extractMessage(response));
+        this.response = response;
+        this.request = request;
+    }
+    static extractMessage(response) {
+        if (response.errors) {
+            return response.errors[0].message;
+        }
+        else {
+            return `GraphQL Error (Code: ${response.status})`;
+        }
+    }
+}
+exports.ClientError = ClientError;
+//# sourceMappingURL=simple-graphql-client.js.map

package/lib/simple-graphql-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-graphql-client.js","sourceRoot":"","sources":["../src/simple-graphql-client.ts"],"names":[],"mappings":";;;;;;AACA,2EAG8C;AAE9C,0DAAiC;AACjC,4CAAoB;AAEpB,sDAAiD;AACjD,8DAA8B;AAC9B,4DAA0D;AAC1D,6CAAwC;AAGxC,6EAAuE;AAEvE,MAAM,KAAK,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;;;CAgBhB,CAAC;AAEF;;;;;GAKG;AACH,MAAa,mBAAmB;IAO9B,YACU,aAAsC,EACtC,SAAiB,EAAE;QADnB,kBAAa,GAAb,aAAa,CAAyB;QACtC,WAAM,GAAN,MAAM,CAAa;QAPrB,iBAAY,GAAkB,IAAI,CAAC;QACnC,YAAO,GAA2B;YACxC,0BAA0B,EAAE,MAAM;SACnC,CAAC;IAKC,CAAC;IAEJ;;;OAGG;IACH,YAAY,CAAC,KAAa;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1D,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,KAAoB;QAClC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAClD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,eAAe,CAAC;gBACzD,IAAI,CAAC,YAAY,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CACT,KAA6C,EAC7C,SAAa,EACb,WAAyB;QAEzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC5C,KAAK,EACL,SAAS,EACT,WAAW,CACZ,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAE9C,IAAI,QAAQ,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YACjD,OAAO,MAAM,CAAC,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GACf,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;YAC1D,MAAM,IAAI,WAAW,iCACd,WAAW,KAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,KACzC,EAAE,KAAK,EAAE,IAAA,eAAK,EAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CACnC,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,GAAW,EAAE,UAAuB,EAAE;QAChD,MAAM,OAAO,iCACX,cAAc,EAAE,kBAAkB,IAC/B,IAAI,CAAC,OAAO,GACZ,OAAO,CAAC,OAAO,CACnB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,kCAC3B,OAAO,KACV,OAAO,IACP,CAAC;QACH,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CACpC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,kBAAkB,IAAI,EAAE,CACxD,CAAC;QACF,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAGf,KAAmB,EAAE,SAAa;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACjE,OAAO,QAAQ,CAAC,MAAM,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CAAC,QAAgB,EAAE,QAAgB;;QAC5D,oCAAoC;QACpC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAA,qBAAG,EAAA;;;;;;OAMnB,CAAC,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC/D,IAAI,CAAA,MAAA,MAAM,CAAC,KAAK,CAAC,QAAQ,0CAAE,MAAM,MAAK,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY;;QAChB,MAAM,EAAE,qBAAqB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;QACjE,MAAM,IAAI,CAAC,qBAAqB,CAC9B,MAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,UAAU,mCAAI,8CAA2B,EAChE,MAAA,qBAAqB,aAArB,qBAAqB,uBAArB,qBAAqB,CAAE,QAAQ,mCAAI,4CAAyB,CAC7D,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe;QACnB,MAAM,IAAI,CAAC,KAAK,CAAC,IAAA,qBAAG,EAAA;;;;;;KAMnB,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,KAAmB,EACnB,SAAkC,EAClC,WAAyB;QAEzB,MAAM,WAAW,GAAG,IAAA,eAAK,EAAC,KAAK,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;YAC1B,KAAK,EAAE,WAAW;YAClB,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;SAC7C,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,WAAW;YACrB,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,IAAA,uBAAS,EAAC,WAAW,CAAC,EAAE;YAC5C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAEhB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YACrB,MAAM,EAAE,MAAM;YACd,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,QAAkB;QACxC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACzD,IAAI,WAAW,IAAI,WAAW,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAC9D,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAIxB;QACC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QAEtD,MAAM,QAAQ,GAAG,IAAA,8CAAoB,EAAC,QAAQ,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;QACzE,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,CACT,KAAK,EACL,GAAG;YACD,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;iBACzB,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;iBACxC,IAAI,CAAC,GAAG,CAAC;YACZ,GAAG,CACN,CAAC;QACF,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;YAC1C,MAAM,IAAI,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC5C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAK,EAAC,IAAI,CAAC,MAAM,EAAE;YACtC,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO,oBACF,IAAI,CAAC,OAAO,CAChB;SACF,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;CACF;AArOD,kDAqOC;AAED,MAAa,WAAY,SAAQ,KAAK;IACpC,YACS,QAAa,EACb,OAAY;QAEnB,KAAK,CAAC,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;QAHrC,aAAQ,GAAR,QAAQ,CAAK;QACb,YAAO,GAAP,OAAO,CAAK;IAGrB,CAAC;IACO,MAAM,CAAC,cAAc,CAAC,QAAa;QACzC,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,OAAO,wBAAwB,QAAQ,CAAC,MAAgB,GAAG,CAAC;QAC9D,CAAC;IACH,CAAC;CACF;AAdD,kCAcC"}

package/lib/test-server.d.ts

@@ -0,0 +1,45 @@
+import { INestApplication } from "@nestjs/common";
+import { DeenruvConfig } from "@deenruv/core";
+import { TestServerOptions } from "./types";
+/**
+ * @description
+ * A real Deenruv server against which the e2e tests should be run.
+ *
+ * @docsCategory testing
+ */
+export declare class TestServer {
+    private deenruvConfig;
+    app: INestApplication;
+    constructor(deenruvConfig: Required<DeenruvConfig>);
+    /**
+     * @description
+     * Bootstraps an instance of Deenruv server and populates the database according to the options
+     * passed in. Should be called in the `beforeAll` function.
+     *
+     * The populated data is saved into an .sqlite file for each test file. On subsequent runs, this file
+     * is loaded so that the populate step can be skipped, which speeds up the tests significantly.
+     */
+    init(options: TestServerOptions): Promise<void>;
+    /**
+     * @description
+     * Bootstraps a Deenruv server instance. Generally the `.init()` method should be used, as that will also
+     * populate the test data. However, the `bootstrap()` method is sometimes useful in tests which need to
+     * start and stop a Deenruv instance multiple times without re-populating data.
+     */
+    bootstrap(): Promise<void>;
+    /**
+     * @description
+     * Destroy the Deenruv server instance and clean up all resources.
+     * Should be called after all tests have run, e.g. in an `afterAll` function.
+     */
+    destroy(): Promise<void>;
+    private getCallerFilename;
+    /**
+     * Populates an .sqlite database file based on the PopulateOptions.
+     */
+    private populateInitialData;
+    /**
+     * Bootstraps an instance of the Deenruv server for testing against.
+     */
+    private bootstrapForTesting;
+}

package/lib/test-server.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestServer = void 0;
+const core_1 = require("@nestjs/core");
+const core_2 = require("@deenruv/core");
+const bootstrap_1 = require("@deenruv/core/dist/bootstrap");
+const populate_for_testing_1 = require("./data-population/populate-for-testing");
+const initializers_1 = require("./initializers/initializers");
+/**
+ * @description
+ * A real Deenruv server against which the e2e tests should be run.
+ *
+ * @docsCategory testing
+ */
+class TestServer {
+    constructor(deenruvConfig) {
+        this.deenruvConfig = deenruvConfig;
+    }
+    /**
+     * @description
+     * Bootstraps an instance of Deenruv server and populates the database according to the options
+     * passed in. Should be called in the `beforeAll` function.
+     *
+     * The populated data is saved into an .sqlite file for each test file. On subsequent runs, this file
+     * is loaded so that the populate step can be skipped, which speeds up the tests significantly.
+     */
+    async init(options) {
+        const { type } = this.deenruvConfig.dbConnectionOptions;
+        const { dbConnectionOptions } = this.deenruvConfig;
+        const testFilename = this.getCallerFilename(1);
+        const initializer = (0, initializers_1.getInitializerFor)(type);
+        try {
+            await initializer.init(testFilename, dbConnectionOptions);
+            const populateFn = () => this.populateInitialData(this.deenruvConfig, options);
+            await initializer.populate(populateFn);
+            await initializer.destroy();
+        }
+        catch (e) {
+            throw e;
+        }
+        await this.bootstrap();
+    }
+    /**
+     * @description
+     * Bootstraps a Deenruv server instance. Generally the `.init()` method should be used, as that will also
+     * populate the test data. However, the `bootstrap()` method is sometimes useful in tests which need to
+     * start and stop a Deenruv instance multiple times without re-populating data.
+     */
+    async bootstrap() {
+        this.app = await this.bootstrapForTesting(this.deenruvConfig);
+    }
+    /**
+     * @description
+     * Destroy the Deenruv server instance and clean up all resources.
+     * Should be called after all tests have run, e.g. in an `afterAll` function.
+     */
+    async destroy() {
+        var _a;
+        // allow a grace period of any outstanding async tasks to complete
+        await new Promise((resolve) => global.setTimeout(resolve, 500));
+        await ((_a = this.app) === null || _a === void 0 ? void 0 : _a.close());
+    }
+    getCallerFilename(depth) {
+        let stack;
+        let file;
+        let frame;
+        const pst = Error.prepareStackTrace;
+        Error.prepareStackTrace = (_, _stack) => {
+            Error.prepareStackTrace = pst;
+            return _stack;
+        };
+        stack = new Error().stack;
+        stack = stack.slice(depth + 1);
+        do {
+            frame = stack.shift();
+            file = frame && frame.getFileName();
+        } while (stack.length && file === "module.js");
+        return file;
+    }
+    /**
+     * Populates an .sqlite database file based on the PopulateOptions.
+     */
+    async populateInitialData(testingConfig, options) {
+        const app = await (0, populate_for_testing_1.populateForTesting)(testingConfig, this.bootstrapForTesting, Object.assign({ logging: false }, options));
+        await app.close();
+    }
+    /**
+     * Bootstraps an instance of the Deenruv server for testing against.
+     */
+    async bootstrapForTesting(userConfig) {
+        const config = await (0, bootstrap_1.preBootstrapConfig)(userConfig);
+        core_2.Logger.useLogger(config.logger);
+        const appModule = await import("@deenruv/core/dist/app.module.js");
+        try {
+            core_2.DefaultLogger.hideNestBootstrapLogs();
+            const app = await core_1.NestFactory.create(appModule.AppModule, {
+                cors: config.apiOptions.cors,
+                logger: new core_2.Logger(),
+                abortOnError: false,
+            });
+            const { tokenMethod } = config.authOptions;
+            const usingCookie = tokenMethod === "cookie" ||
+                (Array.isArray(tokenMethod) && tokenMethod.includes("cookie"));
+            if (usingCookie) {
+                (0, bootstrap_1.configureSessionCookies)(app, config);
+            }
+            const earlyMiddlewares = config.apiOptions.middleware.filter((mid) => mid.beforeListen);
+            earlyMiddlewares.forEach((mid) => {
+                app.use(mid.route, mid.handler);
+            });
+            await app.listen(config.apiOptions.port);
+            await app.get(core_2.JobQueueService).start();
+            core_2.DefaultLogger.restoreOriginalLogLevel();
+            return app;
+        }
+        catch (e) {
+            console.log(e);
+            throw e;
+        }
+    }
+}
+exports.TestServer = TestServer;
+//# sourceMappingURL=test-server.js.map

package/lib/test-server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-server.js","sourceRoot":"","sources":["../src/test-server.ts"],"names":[],"mappings":";;;AACA,uCAA2C;AAC3C,wCAKuB;AACvB,4DAGsC;AAEtC,iFAA4E;AAC5E,8DAAgE;AAGhE;;;;;GAKG;AACH,MAAa,UAAU;IAGrB,YAAoB,aAAsC;QAAtC,kBAAa,GAAb,aAAa,CAAyB;IAAG,CAAC;IAE9D;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CAAC,OAA0B;QACnC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,mBAAmB,CAAC;QACxD,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QACnD,MAAM,YAAY,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,IAAA,gCAAiB,EAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC;YACH,MAAM,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC;YAC1D,MAAM,UAAU,GAAG,GAAG,EAAE,CACtB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;YACxD,MAAM,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YACvC,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;QAC9B,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,CAAC,CAAC;QACV,CAAC;QACD,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS;QACb,IAAI,CAAC,GAAG,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO;;QACX,kEAAkE;QAClE,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QAChE,MAAM,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,KAAK,EAAE,CAAA,CAAC;IAC1B,CAAC;IAEO,iBAAiB,CAAC,KAAa;QACrC,IAAI,KAAU,CAAC;QACf,IAAI,IAAS,CAAC;QACd,IAAI,KAAU,CAAC;QAEf,MAAM,GAAG,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACpC,KAAK,CAAC,iBAAiB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;YACtC,KAAK,CAAC,iBAAiB,GAAG,GAAG,CAAC;YAC9B,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QAEF,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;QAC1B,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAE/B,GAAG,CAAC;YACF,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;YACtB,IAAI,GAAG,KAAK,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC,QAAQ,KAAK,CAAC,MAAM,IAAI,IAAI,KAAK,WAAW,EAAE;QAE/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,mBAAmB,CAC/B,aAAsC,EACtC,OAA0B;QAE1B,MAAM,GAAG,GAAG,MAAM,IAAA,yCAAkB,EAClC,aAAa,EACb,IAAI,CAAC,mBAAmB,kBAEtB,OAAO,EAAE,KAAK,IACX,OAAO,EAEb,CAAC;QACF,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,mBAAmB,CAE/B,UAAkC;QAElC,MAAM,MAAM,GAAG,MAAM,IAAA,8BAAkB,EAAC,UAAU,CAAC,CAAC;QACpD,aAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,kCAAkC,CAAC,CAAC;QACnE,IAAI,CAAC;YACH,oBAAa,CAAC,qBAAqB,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,MAAM,kBAAW,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE;gBACxD,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI;gBAC5B,MAAM,EAAE,IAAI,aAAM,EAAE;gBACpB,YAAY,EAAE,KAAK;aACpB,CAAC,CAAC;YACH,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC;YAC3C,MAAM,WAAW,GACf,WAAW,KAAK,QAAQ;gBACxB,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;YACjE,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAA,mCAAuB,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACvC,CAAC;YACD,MAAM,gBAAgB,GAAG,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAC1D,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,YAAY,CAC1B,CAAC;YACF,gBAAgB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC/B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;YAClC,CAAC,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,GAAG,CAAC,GAAG,CAAC,sBAAe,CAAC,CAAC,KAAK,EAAE,CAAC;YACvC,oBAAa,CAAC,uBAAuB,EAAE,CAAC;YACxC,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YACf,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;CACF;AAlID,gCAkIC"}

package/lib/testing-logger.d.ts

@@ -0,0 +1,67 @@
+import { DeenruvLogger } from "@deenruv/core";
+/**
+ * @description
+ * The TestingLogger can be used in unit tests or e2e tests to make assertions on whether the various
+ * Logger methods have been called, and which arguments.
+ *
+ * Here's some examples of how to use it in e2e tests and unit tests. In both cases we are using
+ * the Jest testing framework, but the TestingLogger should work with other similar frameworks
+ * (e.g. replacing `jest.fn()` with `jasmine.createSpy()`).
+ *
+ * @example
+ * ```ts
+ * // e2e test example
+ * import { createTestEnvironment, TestingLogger } from '\@deenruv/testing';
+ *
+ * const testingLogger = new TestingLogger(() => jest.fn());
+ *
+ * const { server, adminClient, shopClient } = createTestEnvironment({
+ *   ...testConfig,
+ *   logger: testingLogger,
+ * });
+ *
+ * // e2e testing setup omitted
+ *
+ * it('should log an error', async () => {
+ *   // The `errorSpy` property exposes the Jest mock function
+ *   testingLogger.errorSpy.mockClear();
+ *
+ *   await doSomethingThatErrors();
+ *
+ *   expect(testingLogger.errorSpy).toHaveBeenCalled();
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // unit test example
+ * import { Test } from '\@nestjs/testing';
+ * import { Logger } from '\@deenruv/core';
+ * import { TestingLogger } from '\@deenruv/testing';
+ *
+ * beforeEach(async () => {
+ *   const moduleRef = await Test.createTestingModule({
+ *     // Nest testing setup omitted
+ *   }).compile();
+ *
+ *   Logger.useLogger(testingLogger);
+ *   moduleRef.useLogger(new Logger());
+ * }
+ * ```
+ *
+ * @docsCategory testing
+ */
+export declare class TestingLogger<Spy extends (...args: any[]) => any> implements DeenruvLogger {
+    private createSpyFn;
+    constructor(createSpyFn: () => Spy);
+    debugSpy: Spy;
+    errorSpy: Spy;
+    infoSpy: Spy;
+    verboseSpy: Spy;
+    warnSpy: Spy;
+    debug(message: string, context?: string): void;
+    error(message: string, context?: string, trace?: string): void;
+    info(message: string, context?: string): void;
+    verbose(message: string, context?: string): void;
+    warn(message: string, context?: string): void;
+}

package/lib/testing-logger.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestingLogger = void 0;
+/**
+ * @description
+ * The TestingLogger can be used in unit tests or e2e tests to make assertions on whether the various
+ * Logger methods have been called, and which arguments.
+ *
+ * Here's some examples of how to use it in e2e tests and unit tests. In both cases we are using
+ * the Jest testing framework, but the TestingLogger should work with other similar frameworks
+ * (e.g. replacing `jest.fn()` with `jasmine.createSpy()`).
+ *
+ * @example
+ * ```ts
+ * // e2e test example
+ * import { createTestEnvironment, TestingLogger } from '\@deenruv/testing';
+ *
+ * const testingLogger = new TestingLogger(() => jest.fn());
+ *
+ * const { server, adminClient, shopClient } = createTestEnvironment({
+ *   ...testConfig,
+ *   logger: testingLogger,
+ * });
+ *
+ * // e2e testing setup omitted
+ *
+ * it('should log an error', async () => {
+ *   // The `errorSpy` property exposes the Jest mock function
+ *   testingLogger.errorSpy.mockClear();
+ *
+ *   await doSomethingThatErrors();
+ *
+ *   expect(testingLogger.errorSpy).toHaveBeenCalled();
+ * });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // unit test example
+ * import { Test } from '\@nestjs/testing';
+ * import { Logger } from '\@deenruv/core';
+ * import { TestingLogger } from '\@deenruv/testing';
+ *
+ * beforeEach(async () => {
+ *   const moduleRef = await Test.createTestingModule({
+ *     // Nest testing setup omitted
+ *   }).compile();
+ *
+ *   Logger.useLogger(testingLogger);
+ *   moduleRef.useLogger(new Logger());
+ * }
+ * ```
+ *
+ * @docsCategory testing
+ */
+class TestingLogger {
+    constructor(createSpyFn) {
+        this.createSpyFn = createSpyFn;
+        this.debugSpy = createSpyFn();
+        this.errorSpy = createSpyFn();
+        this.infoSpy = createSpyFn();
+        this.verboseSpy = createSpyFn();
+        this.warnSpy = createSpyFn();
+    }
+    debug(message, context) {
+        this.debugSpy(message, context);
+    }
+    error(message, context, trace) {
+        this.errorSpy(message, context, trace);
+    }
+    info(message, context) {
+        this.infoSpy(message, context);
+    }
+    verbose(message, context) {
+        this.verboseSpy(message, context);
+    }
+    warn(message, context) {
+        this.warnSpy(message, context);
+    }
+}
+exports.TestingLogger = TestingLogger;
+//# sourceMappingURL=testing-logger.js.map

package/lib/testing-logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing-logger.js","sourceRoot":"","sources":["../src/testing-logger.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAa,aAAa;IAGxB,YAAoB,WAAsB;QAAtB,gBAAW,GAAX,WAAW,CAAW;QACxC,IAAI,CAAC,QAAQ,GAAG,WAAW,EAAE,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,WAAW,EAAE,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,WAAW,EAAE,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,WAAW,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,WAAW,EAAE,CAAC;IAC/B,CAAC;IAQD,KAAK,CAAC,OAAe,EAAE,OAAgB;QACrC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,OAAgB,EAAE,KAAc;QACrD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,OAAgB;QACpC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,CAAC,OAAe,EAAE,OAAgB;QACvC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,OAAgB;QACpC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;CACF;AApCD,sCAoCC"}

package/lib/types.d.ts

@@ -0,0 +1,42 @@
+import { InitialData } from "@deenruv/core";
+/**
+ * Creates a mutable version of a type with readonly properties.
+ */
+export type Mutable<T> = {
+    -readonly [K in keyof T]: T[K];
+};
+/**
+ * @description
+ * Configuration options used to initialize an instance of the {@link TestServer}.
+ *
+ * @docsCategory testing
+ */
+export interface TestServerOptions {
+    /**
+     * @description
+     * The path to an optional CSV file containing product data to import.
+     */
+    productsCsvPath?: string;
+    /**
+     * @description
+     * An object containing non-product data which is used to populate the database.
+     */
+    initialData: InitialData;
+    /**
+     * @description
+     * The number of fake Customers to populate into the database.
+     *
+     * @default 10
+     */
+    customerCount?: number;
+    /**
+     * @description
+     * Set this to `true` to log some information about the database population process.
+     *
+     * @default false
+     */
+    logging?: boolean;
+}
+export type QueryParams = {
+    [key: string]: string | number;
+};

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/lib/utils/create-upload-post-data.d.ts

@@ -0,0 +1,23 @@
+import { DocumentNode } from "graphql";
+export interface FilePlaceholder {
+    file: null;
+}
+export interface UploadPostData<V = any> {
+    operations: {
+        operationName: string;
+        variables: V;
+        query: string;
+    };
+    map: {
+        [index: number]: string;
+    };
+    filePaths: Array<{
+        name: string;
+        file: string;
+    }>;
+}
+/**
+ * Creates a data structure which can be used to mae a curl request to upload files to a mutation using
+ * the Upload type.
+ */
+export declare function createUploadPostData<P extends string[] | string, V>(mutation: DocumentNode, filePaths: P, mapVariables: (filePaths: P) => V): UploadPostData<V>;