@itwin/core-backend 3.5.0-dev.12 → 3.5.0-dev.14

package/lib/cjs/HubMock.js

@@ -1,191 +1,191 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HubMock = void 0;
-const path_1 = require("path");
-const core_bentley_1 = require("@itwin/core-bentley");
-const IModelHost_1 = require("./IModelHost");
-const IModelJsFs_1 = require("./IModelJsFs");
-const LocalHub_1 = require("./LocalHub");
-function wasStarted(val) {
-    if (undefined === val)
-        throw new Error("Call HubMock.startup first");
-}
-/**
- * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.
- *
- * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:
- * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs
- * - waste network and data center resources (i.e. $$$s),
- * - interfere with other tests running on the same or other systems, and
- * - (far worse) are the source of test flakiness outside of the api being tested.
- *
- * This class can be used to create tests that do not require authentication, are synchronous,
- * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside
- * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.
- *
- * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests
- * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to
- * low level testing of the core apis only.
- *
- * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be
- * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean
- * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the
- * test against a "real" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your
- * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)
- *
- * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.
- * They use mock (aka "bogus") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current
- * computer.
- *
- * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests
- * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.
- *
- * @internal
- */
-class HubMock {
-    /** Determine whether a test us currently being run under HubMock */
-    static get isValid() { return undefined !== this.mockRoot; }
-    static get iTwinId() {
-        wasStarted(this._iTwinId);
-        return this._iTwinId;
-    }
-    /**
-     * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].
-     * @param mockName a unique name (e.g. "MyTest") for this HubMock to disambiguate tests when more than one is simultaneously active.
-     * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.
-     */
-    static startup(mockName, outputDir) {
-        if (this.isValid)
-            throw new Error("Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed");
-        this.hubs.clear();
-        this.mockRoot = (0, path_1.join)(outputDir, "HubMock", mockName);
-        IModelJsFs_1.IModelJsFs.recursiveMkDirSync(this.mockRoot);
-        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
-        this._saveHubAccess = IModelHost_1.IModelHost.getHubAccess();
-        IModelHost_1.IModelHost.setHubAccess(this);
-        HubMock._iTwinId = core_bentley_1.Guid.createValue(); // all iModels for this test get the same "iTwinId"
-    }
-    /** Stop a HubMock that was previously started with [[startup]]
-     * @note this function throws an exception if any of the iModels used during the tests are left open.
-     */
-    static shutdown() {
-        if (this.mockRoot === undefined)
-            return;
-        HubMock._iTwinId = undefined;
-        for (const hub of this.hubs)
-            hub[1].cleanup();
-        this.hubs.clear();
-        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
-        IModelJsFs_1.IModelJsFs.removeSync(this.mockRoot);
-        IModelHost_1.IModelHost.setHubAccess(this._saveHubAccess);
-        this.mockRoot = undefined;
-    }
-    static findLocalHub(iModelId) {
-        const hub = this.hubs.get(iModelId);
-        if (!hub)
-            throw new Error(`local hub for iModel ${iModelId} not created`);
-        return hub;
-    }
-    /** create a [[LocalHub]] for an iModel.  */
-    static async createNewIModel(arg) {
-        wasStarted(this.mockRoot);
-        const props = { ...arg, iModelId: core_bentley_1.Guid.createValue() };
-        const mock = new LocalHub_1.LocalHub((0, path_1.join)(this.mockRoot, props.iModelId), props);
-        this.hubs.set(props.iModelId, mock);
-        return props.iModelId;
-    }
-    /** remove the [[LocalHub]] for an iModel */
-    static destroy(iModelId) {
-        this.findLocalHub(iModelId).cleanup();
-        this.hubs.delete(iModelId);
-    }
-    /** All methods below are mocks of the [[BackendHubAccess]] interface */
-    static async getChangesetFromNamedVersion(arg) {
-        return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);
-    }
-    static changesetIndexFromArg(arg) {
-        return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);
-    }
-    static async getChangesetFromVersion(arg) {
-        const hub = this.findLocalHub(arg.iModelId);
-        const version = arg.version;
-        if (version.isFirst)
-            return hub.getChangesetByIndex(0);
-        const asOf = version.getAsOfChangeSet();
-        if (asOf)
-            return hub.getChangesetById(asOf);
-        const versionName = version.getName();
-        if (versionName)
-            return hub.findNamedVersion(versionName);
-        return hub.getLatestChangeset();
-    }
-    static async getLatestChangeset(arg) {
-        return this.findLocalHub(arg.iModelId).getLatestChangeset();
-    }
-    static async getAccessToken(arg) {
-        var _a;
-        return (_a = arg.accessToken) !== null && _a !== void 0 ? _a : await IModelHost_1.IModelHost.getAccessToken();
-    }
-    static async getMyBriefcaseIds(arg) {
-        const accessToken = await this.getAccessToken(arg);
-        return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);
-    }
-    static async acquireNewBriefcaseId(arg) {
-        const accessToken = await this.getAccessToken(arg);
-        return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);
-    }
-    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
-    static async releaseBriefcase(arg) {
-        return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);
-    }
-    static async downloadChangeset(arg) {
-        return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });
-    }
-    static async downloadChangesets(arg) {
-        return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });
-    }
-    static async queryChangeset(arg) {
-        return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));
-    }
-    static async queryChangesets(arg) {
-        return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);
-    }
-    static async pushChangeset(arg) {
-        return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);
-    }
-    static async queryV2Checkpoint(_arg) {
-        return undefined;
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    static async downloadV1Checkpoint(arg) {
-        return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });
-    }
-    static async releaseAllLocks(arg) {
-        const hub = this.findLocalHub(arg.iModelId);
-        hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });
-    }
-    static async queryAllLocks(_arg) {
-        return [];
-    }
-    static async acquireLocks(arg, locks) {
-        this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);
-    }
-    static async queryIModelByName(arg) {
-        for (const hub of this.hubs) {
-            const localHub = hub[1];
-            if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)
-                return localHub.iModelId;
-        }
-        return undefined;
-    }
-    static async deleteIModel(arg) {
-        return this.destroy(arg.iModelId);
-    }
-}
-exports.HubMock = HubMock;
-HubMock.hubs = new Map();
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HubMock = void 0;
+const path_1 = require("path");
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelHost_1 = require("./IModelHost");
+const IModelJsFs_1 = require("./IModelJsFs");
+const LocalHub_1 = require("./LocalHub");
+function wasStarted(val) {
+    if (undefined === val)
+        throw new Error("Call HubMock.startup first");
+}
+/**
+ * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.
+ *
+ * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:
+ * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs
+ * - waste network and data center resources (i.e. $$$s),
+ * - interfere with other tests running on the same or other systems, and
+ * - (far worse) are the source of test flakiness outside of the api being tested.
+ *
+ * This class can be used to create tests that do not require authentication, are synchronous,
+ * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside
+ * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.
+ *
+ * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests
+ * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to
+ * low level testing of the core apis only.
+ *
+ * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be
+ * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean
+ * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the
+ * test against a "real" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your
+ * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)
+ *
+ * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.
+ * They use mock (aka "bogus") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current
+ * computer.
+ *
+ * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests
+ * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.
+ *
+ * @internal
+ */
+class HubMock {
+    /** Determine whether a test us currently being run under HubMock */
+    static get isValid() { return undefined !== this.mockRoot; }
+    static get iTwinId() {
+        wasStarted(this._iTwinId);
+        return this._iTwinId;
+    }
+    /**
+     * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].
+     * @param mockName a unique name (e.g. "MyTest") for this HubMock to disambiguate tests when more than one is simultaneously active.
+     * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.
+     */
+    static startup(mockName, outputDir) {
+        if (this.isValid)
+            throw new Error("Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed");
+        this.hubs.clear();
+        this.mockRoot = (0, path_1.join)(outputDir, "HubMock", mockName);
+        IModelJsFs_1.IModelJsFs.recursiveMkDirSync(this.mockRoot);
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
+        this._saveHubAccess = IModelHost_1.IModelHost.getHubAccess();
+        IModelHost_1.IModelHost.setHubAccess(this);
+        HubMock._iTwinId = core_bentley_1.Guid.createValue(); // all iModels for this test get the same "iTwinId"
+    }
+    /** Stop a HubMock that was previously started with [[startup]]
+     * @note this function throws an exception if any of the iModels used during the tests are left open.
+     */
+    static shutdown() {
+        if (this.mockRoot === undefined)
+            return;
+        HubMock._iTwinId = undefined;
+        for (const hub of this.hubs)
+            hub[1].cleanup();
+        this.hubs.clear();
+        IModelJsFs_1.IModelJsFs.purgeDirSync(this.mockRoot);
+        IModelJsFs_1.IModelJsFs.removeSync(this.mockRoot);
+        IModelHost_1.IModelHost.setHubAccess(this._saveHubAccess);
+        this.mockRoot = undefined;
+    }
+    static findLocalHub(iModelId) {
+        const hub = this.hubs.get(iModelId);
+        if (!hub)
+            throw new Error(`local hub for iModel ${iModelId} not created`);
+        return hub;
+    }
+    /** create a [[LocalHub]] for an iModel.  */
+    static async createNewIModel(arg) {
+        wasStarted(this.mockRoot);
+        const props = { ...arg, iModelId: core_bentley_1.Guid.createValue() };
+        const mock = new LocalHub_1.LocalHub((0, path_1.join)(this.mockRoot, props.iModelId), props);
+        this.hubs.set(props.iModelId, mock);
+        return props.iModelId;
+    }
+    /** remove the [[LocalHub]] for an iModel */
+    static destroy(iModelId) {
+        this.findLocalHub(iModelId).cleanup();
+        this.hubs.delete(iModelId);
+    }
+    /** All methods below are mocks of the [[BackendHubAccess]] interface */
+    static async getChangesetFromNamedVersion(arg) {
+        return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);
+    }
+    static changesetIndexFromArg(arg) {
+        return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);
+    }
+    static async getChangesetFromVersion(arg) {
+        const hub = this.findLocalHub(arg.iModelId);
+        const version = arg.version;
+        if (version.isFirst)
+            return hub.getChangesetByIndex(0);
+        const asOf = version.getAsOfChangeSet();
+        if (asOf)
+            return hub.getChangesetById(asOf);
+        const versionName = version.getName();
+        if (versionName)
+            return hub.findNamedVersion(versionName);
+        return hub.getLatestChangeset();
+    }
+    static async getLatestChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).getLatestChangeset();
+    }
+    static async getAccessToken(arg) {
+        var _a;
+        return (_a = arg.accessToken) !== null && _a !== void 0 ? _a : await IModelHost_1.IModelHost.getAccessToken();
+    }
+    static async getMyBriefcaseIds(arg) {
+        const accessToken = await this.getAccessToken(arg);
+        return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);
+    }
+    static async acquireNewBriefcaseId(arg) {
+        const accessToken = await this.getAccessToken(arg);
+        return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);
+    }
+    /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */
+    static async releaseBriefcase(arg) {
+        return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);
+    }
+    static async downloadChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });
+    }
+    static async downloadChangesets(arg) {
+        return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });
+    }
+    static async queryChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));
+    }
+    static async queryChangesets(arg) {
+        return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);
+    }
+    static async pushChangeset(arg) {
+        return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);
+    }
+    static async queryV2Checkpoint(_arg) {
+        return undefined;
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    static async downloadV1Checkpoint(arg) {
+        return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });
+    }
+    static async releaseAllLocks(arg) {
+        const hub = this.findLocalHub(arg.iModelId);
+        hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });
+    }
+    static async queryAllLocks(_arg) {
+        return [];
+    }
+    static async acquireLocks(arg, locks) {
+        this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);
+    }
+    static async queryIModelByName(arg) {
+        for (const hub of this.hubs) {
+            const localHub = hub[1];
+            if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)
+                return localHub.iModelId;
+        }
+        return undefined;
+    }
+    static async deleteIModel(arg) {
+        return this.destroy(arg.iModelId);
+    }
+}
+exports.HubMock = HubMock;
+HubMock.hubs = new Map();
 //# sourceMappingURL=HubMock.js.map

package/lib/cjs/HubMock.js.map

@@ -1 +1 @@
-{"version":3,"file":"HubMock.js","sourceRoot":"","sources":["../../src/HubMock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,+BAA4B;AAC5B,sDAAuD;AAUvD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AAGtC,SAAS,UAAU,CAAC,GAAuB;IACzC,IAAI,SAAS,KAAK,GAAG;QACnB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,OAAO;IAMlB,oEAAoE;IAC7D,MAAM,KAAK,OAAO,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5D,MAAM,KAAK,OAAO;QACvB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,QAAsB,EAAE,SAAiB;QAC7D,IAAI,IAAI,CAAC,OAAO;YACd,MAAM,IAAI,KAAK,CAAC,0JAA0J,CAAC,CAAC;QAE9K,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrD,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,uBAAU,CAAC,YAAY,EAAE,CAAC;QAEhD,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,CAAC,QAAQ,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,mDAAmD;IAC5F,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAC7B,OAAO;QAET,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAEnB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrC,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,QAAoB;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,cAAc,CAAC,CAAC;QAClE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAyB;QAC3D,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1B,MAAM,KAAK,GAAG,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,mBAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,mBAAQ,CAAC,IAAA,WAAI,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,KAAK,CAAC,QAAQ,CAAC;IACxB,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,OAAO,CAAC,QAAoB;QACxC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED,wEAAwE;IAEjE,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,GAA0C;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,GAAiB;QACpD,OAAO,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACzI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAA6C;QACvF,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5B,IAAI,OAAO,CAAC,OAAO;YACjB,OAAO,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAEpC,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACxC,IAAI,IAAI;YACN,OAAO,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,WAAW;YACb,OAAO,GAAG,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAE3C,OAAO,GAAG,CAAC,kBAAkB,EAAE,CAAC;IAClC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAgB;QACrD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9D,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAa;;QAC/C,OAAO,MAAA,GAAG,CAAC,WAAW,mCAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;IAC9D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAgB;QACpD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAA6B;QACrE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IAChG,CAAC;IAED,gHAAgH;IACzG,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAmB;QACtD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAyB;QAC7D,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IACjI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAA8B;QACnE,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC5G,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAiB;QAClD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAA6C;QAC/E,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,GAAyD;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC1E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAqB;QACzD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAkB;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3I,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAmB;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,GAAG,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAClH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAoB;QACpD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAmB,EAAE,KAAc;QAClE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAkB;QACtD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,QAAQ,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU;gBAC5E,OAAO,QAAQ,CAAC,QAAQ,CAAC;SAC5B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAA0C;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;;AA/KH,0BAgLC;AA9KgB,YAAI,GAAG,IAAI,GAAG,EAAoB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { join } from \"path\";\r\nimport { Guid, GuidString } from \"@itwin/core-bentley\";\r\nimport {\r\n  ChangesetFileProps, ChangesetIndex, ChangesetIndexAndId, ChangesetProps, ChangesetRange, IModelVersion, LocalDirName,\r\n} from \"@itwin/core-common\";\r\nimport {\r\n  AcquireNewBriefcaseIdArg,\r\n  BackendHubAccess, BriefcaseDbArg, BriefcaseIdArg, ChangesetArg, CheckpointArg, CreateNewIModelProps, DownloadChangesetArg, DownloadChangesetRangeArg, IModelIdArg, IModelNameArg,\r\n  LockMap, LockProps, V2CheckpointAccessProps,\r\n} from \"./BackendHubAccess\";\r\nimport { CheckpointProps } from \"./CheckpointManager\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { LocalHub } from \"./LocalHub\";\r\nimport { TokenArg } from \"./IModelDb\";\r\n\r\nfunction wasStarted(val: string | undefined): asserts val is string {\r\n  if (undefined === val)\r\n    throw new Error(\"Call HubMock.startup first\");\r\n}\r\n\r\n/**\r\n * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.\r\n *\r\n * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:\r\n * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs\r\n * - waste network and data center resources (i.e. $$$s),\r\n * - interfere with other tests running on the same or other systems, and\r\n * - (far worse) are the source of test flakiness outside of the api being tested.\r\n *\r\n * This class can be used to create tests that do not require authentication, are synchronous,\r\n * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside\r\n * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.\r\n *\r\n * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests\r\n * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to\r\n * low level testing of the core apis only.\r\n *\r\n * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be\r\n * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean\r\n * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the\r\n * test against a \"real\" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your\r\n * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)\r\n *\r\n * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.\r\n * They use mock (aka \"bogus\") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current\r\n * computer.\r\n *\r\n * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests\r\n * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.\r\n *\r\n * @internal\r\n */\r\nexport class HubMock {\r\n  private static mockRoot: LocalDirName | undefined;\r\n  private static hubs = new Map<string, LocalHub>();\r\n  private static _saveHubAccess: BackendHubAccess | undefined;\r\n  private static _iTwinId: GuidString | undefined;\r\n\r\n  /** Determine whether a test us currently being run under HubMock */\r\n  public static get isValid() { return undefined !== this.mockRoot; }\r\n  public static get iTwinId() {\r\n    wasStarted(this._iTwinId);\r\n    return this._iTwinId;\r\n  }\r\n\r\n  /**\r\n   * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].\r\n   * @param mockName a unique name (e.g. \"MyTest\") for this HubMock to disambiguate tests when more than one is simultaneously active.\r\n   * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.\r\n   */\r\n  public static startup(mockName: LocalDirName, outputDir: string) {\r\n    if (this.isValid)\r\n      throw new Error(\"Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed\");\r\n\r\n    this.hubs.clear();\r\n    this.mockRoot = join(outputDir, \"HubMock\", mockName);\r\n    IModelJsFs.recursiveMkDirSync(this.mockRoot);\r\n    IModelJsFs.purgeDirSync(this.mockRoot);\r\n    this._saveHubAccess = IModelHost.getHubAccess();\r\n\r\n    IModelHost.setHubAccess(this);\r\n    HubMock._iTwinId = Guid.createValue(); // all iModels for this test get the same \"iTwinId\"\r\n  }\r\n\r\n  /** Stop a HubMock that was previously started with [[startup]]\r\n   * @note this function throws an exception if any of the iModels used during the tests are left open.\r\n   */\r\n  public static shutdown() {\r\n    if (this.mockRoot === undefined)\r\n      return;\r\n\r\n    HubMock._iTwinId = undefined;\r\n    for (const hub of this.hubs)\r\n      hub[1].cleanup();\r\n\r\n    this.hubs.clear();\r\n    IModelJsFs.purgeDirSync(this.mockRoot);\r\n    IModelJsFs.removeSync(this.mockRoot);\r\n    IModelHost.setHubAccess(this._saveHubAccess);\r\n    this.mockRoot = undefined;\r\n  }\r\n\r\n  public static findLocalHub(iModelId: GuidString): LocalHub {\r\n    const hub = this.hubs.get(iModelId);\r\n    if (!hub)\r\n      throw new Error(`local hub for iModel ${iModelId} not created`);\r\n    return hub;\r\n  }\r\n\r\n  /** create a [[LocalHub]] for an iModel.  */\r\n  public static async createNewIModel(arg: CreateNewIModelProps): Promise<GuidString> {\r\n    wasStarted(this.mockRoot);\r\n    const props = { ...arg, iModelId: Guid.createValue() };\r\n    const mock = new LocalHub(join(this.mockRoot, props.iModelId), props);\r\n    this.hubs.set(props.iModelId, mock);\r\n    return props.iModelId;\r\n  }\r\n\r\n  /** remove the [[LocalHub]] for an iModel */\r\n  public static destroy(iModelId: GuidString) {\r\n    this.findLocalHub(iModelId).cleanup();\r\n    this.hubs.delete(iModelId);\r\n  }\r\n\r\n  /** All methods below are mocks of the [[BackendHubAccess]] interface */\r\n\r\n  public static async getChangesetFromNamedVersion(arg: IModelIdArg & { versionName: string }): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);\r\n  }\r\n\r\n  private static changesetIndexFromArg(arg: ChangesetArg) {\r\n    return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);\r\n  }\r\n\r\n  public static async getChangesetFromVersion(arg: IModelIdArg & { version: IModelVersion }): Promise<ChangesetProps> {\r\n    const hub = this.findLocalHub(arg.iModelId);\r\n    const version = arg.version;\r\n    if (version.isFirst)\r\n      return hub.getChangesetByIndex(0);\r\n\r\n    const asOf = version.getAsOfChangeSet();\r\n    if (asOf)\r\n      return hub.getChangesetById(asOf);\r\n\r\n    const versionName = version.getName();\r\n    if (versionName)\r\n      return hub.findNamedVersion(versionName);\r\n\r\n    return hub.getLatestChangeset();\r\n  }\r\n\r\n  public static async getLatestChangeset(arg: IModelIdArg): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).getLatestChangeset();\r\n  }\r\n\r\n  private static async getAccessToken(arg: TokenArg) {\r\n    return arg.accessToken ?? await IModelHost.getAccessToken();\r\n  }\r\n\r\n  public static async getMyBriefcaseIds(arg: IModelIdArg): Promise<number[]> {\r\n    const accessToken = await this.getAccessToken(arg);\r\n    return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);\r\n  }\r\n\r\n  public static async acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<number> {\r\n    const accessToken = await this.getAccessToken(arg);\r\n    return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);\r\n  }\r\n\r\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\r\n  public static async releaseBriefcase(arg: BriefcaseIdArg): Promise<void> {\r\n    return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);\r\n  }\r\n\r\n  public static async downloadChangeset(arg: DownloadChangesetArg): Promise<ChangesetFileProps> {\r\n    return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });\r\n  }\r\n\r\n  public static async downloadChangesets(arg: DownloadChangesetRangeArg): Promise<ChangesetFileProps[]> {\r\n    return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });\r\n  }\r\n\r\n  public static async queryChangeset(arg: ChangesetArg): Promise<ChangesetProps> {\r\n    return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));\r\n  }\r\n\r\n  public static async queryChangesets(arg: IModelIdArg & { range?: ChangesetRange }): Promise<ChangesetProps[]> {\r\n    return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);\r\n  }\r\n\r\n  public static async pushChangeset(arg: IModelIdArg & { changesetProps: ChangesetFileProps }): Promise<ChangesetIndex> {\r\n    return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);\r\n  }\r\n\r\n  public static async queryV2Checkpoint(_arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined> {\r\n    return undefined;\r\n  }\r\n\r\n  // eslint-disable-next-line deprecation/deprecation\r\n  public static async downloadV1Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId> {\r\n    return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });\r\n  }\r\n\r\n  public static async releaseAllLocks(arg: BriefcaseDbArg) {\r\n    const hub = this.findLocalHub(arg.iModelId);\r\n    hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });\r\n  }\r\n\r\n  public static async queryAllLocks(_arg: BriefcaseDbArg): Promise<LockProps[]> {\r\n    return [];\r\n  }\r\n\r\n  public static async acquireLocks(arg: BriefcaseDbArg, locks: LockMap): Promise<void> {\r\n    this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);\r\n  }\r\n\r\n  public static async queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined> {\r\n    for (const hub of this.hubs) {\r\n      const localHub = hub[1];\r\n      if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)\r\n        return localHub.iModelId;\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public static async deleteIModel(arg: IModelIdArg & { iTwinId: GuidString }): Promise<void> {\r\n    return this.destroy(arg.iModelId);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"HubMock.js","sourceRoot":"","sources":["../../src/HubMock.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,+BAA4B;AAC5B,sDAAuD;AAUvD,6CAA0C;AAC1C,6CAA0C;AAC1C,yCAAsC;AAGtC,SAAS,UAAU,CAAC,GAAuB;IACzC,IAAI,SAAS,KAAK,GAAG;QACnB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;AAClD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAa,OAAO;IAMlB,oEAAoE;IAC7D,MAAM,KAAK,OAAO,KAAK,OAAO,SAAS,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC5D,MAAM,KAAK,OAAO;QACvB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,QAAsB,EAAE,SAAiB;QAC7D,IAAI,IAAI,CAAC,OAAO;YACd,MAAM,IAAI,KAAK,CAAC,0JAA0J,CAAC,CAAC;QAE9K,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QACrD,uBAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7C,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,cAAc,GAAG,uBAAU,CAAC,YAAY,EAAE,CAAC;QAEhD,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9B,OAAO,CAAC,QAAQ,GAAG,mBAAI,CAAC,WAAW,EAAE,CAAC,CAAC,mDAAmD;IAC5F,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAC7B,OAAO;QAET,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;QAC7B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI;YACzB,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QAEnB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClB,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrC,uBAAU,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;IAC5B,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,QAAoB;QAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,GAAG;YACN,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,cAAc,CAAC,CAAC;QAClE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAyB;QAC3D,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC1B,MAAM,KAAK,GAAG,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,mBAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,mBAAQ,CAAC,IAAA,WAAI,EAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACpC,OAAO,KAAK,CAAC,QAAQ,CAAC;IACxB,CAAC;IAED,4CAA4C;IACrC,MAAM,CAAC,OAAO,CAAC,QAAoB;QACxC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED,wEAAwE;IAEjE,MAAM,CAAC,KAAK,CAAC,4BAA4B,CAAC,GAA0C;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC3E,CAAC;IAEO,MAAM,CAAC,qBAAqB,CAAC,GAAiB;QACpD,OAAO,CAAC,SAAS,KAAK,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IACzI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAA6C;QACvF,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC5B,IAAI,OAAO,CAAC,OAAO;YACjB,OAAO,GAAG,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAEpC,MAAM,IAAI,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;QACxC,IAAI,IAAI;YACN,OAAO,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAEpC,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,IAAI,WAAW;YACb,OAAO,GAAG,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAE3C,OAAO,GAAG,CAAC,kBAAkB,EAAE,CAAC;IAClC,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAgB;QACrD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9D,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAa;;QAC/C,OAAO,MAAA,GAAG,CAAC,WAAW,mCAAI,MAAM,uBAAU,CAAC,cAAc,EAAE,CAAC;IAC9D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAgB;QACpD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IACtE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,GAA6B;QACrE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,WAAW,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC;IAChG,CAAC;IAED,gHAAgH;IACzG,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAmB;QACtD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAyB;QAC7D,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IACjI,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAA8B;QACnE,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC5G,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,GAAiB;QAClD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9F,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAA6C;QAC/E,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,GAAyD;QACzF,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC1E,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,IAAqB;QACzD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAkB;QACzD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,kBAAkB,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;IAC3I,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,GAAmB;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC5C,GAAG,CAAC,eAAe,CAAC,EAAE,WAAW,EAAE,GAAG,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAClH,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,IAAoB;QACpD,OAAO,EAAE,CAAC;IACZ,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAAmB,EAAE,KAAc;QAClE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,GAAkB;QACtD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,MAAM,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,QAAQ,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,QAAQ,CAAC,UAAU,KAAK,GAAG,CAAC,UAAU;gBAC5E,OAAO,QAAQ,CAAC,QAAQ,CAAC;SAC5B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,GAA0C;QACzE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;;AA/KH,0BAgLC;AA9KgB,YAAI,GAAG,IAAI,GAAG,EAAoB,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { join } from \"path\";\nimport { Guid, GuidString } from \"@itwin/core-bentley\";\nimport {\n  ChangesetFileProps, ChangesetIndex, ChangesetIndexAndId, ChangesetProps, ChangesetRange, IModelVersion, LocalDirName,\n} from \"@itwin/core-common\";\nimport {\n  AcquireNewBriefcaseIdArg,\n  BackendHubAccess, BriefcaseDbArg, BriefcaseIdArg, ChangesetArg, CheckpointArg, CreateNewIModelProps, DownloadChangesetArg, DownloadChangesetRangeArg, IModelIdArg, IModelNameArg,\n  LockMap, LockProps, V2CheckpointAccessProps,\n} from \"./BackendHubAccess\";\nimport { CheckpointProps } from \"./CheckpointManager\";\nimport { IModelHost } from \"./IModelHost\";\nimport { IModelJsFs } from \"./IModelJsFs\";\nimport { LocalHub } from \"./LocalHub\";\nimport { TokenArg } from \"./IModelDb\";\n\nfunction wasStarted(val: string | undefined): asserts val is string {\n  if (undefined === val)\n    throw new Error(\"Call HubMock.startup first\");\n}\n\n/**\n * Mocks iModelHub for testing creating Briefcases, downloading checkpoints, and simulating multiple users pushing and pulling changesets, etc.\n *\n * Generally, tests for apis that *create or modify* iModels can and should be mocked. Otherwise they:\n * - create tremendous load on the test servers when they run on programmer's desktops and in CI jobs\n * - waste network and data center resources (i.e. $$$s),\n * - interfere with other tests running on the same or other systems, and\n * - (far worse) are the source of test flakiness outside of the api being tested.\n *\n * This class can be used to create tests that do not require authentication, are synchronous,\n * are guaranteed to be self-contained (i.e. do not interfere with other tests running at the same time or later), and do not fail for reasons outside\n * of the control of the test itself. As a bonus, in addition to making tests more reliable, mocking IModelHub generally makes tests run *much* faster.\n *\n * On the other hand, tests that expect to find an existing iModels, checkpoints, changesets, etc. in IModelHub cannot be mocked. In that case, those tests\n * should be careful to NOT modify the data, since doing so causes interference with other tests running simultaneously. These tests should be limited to\n * low level testing of the core apis only.\n *\n * To initialize HubMock, call [[startup]] at the beginning of your test, usually in `describe.before`. Thereafter, all access to iModelHub for an iModel will be\n * directed to a [[LocalHub]] - your test code does not change. After the test(s) complete, call [[shutdown]] (usually in `describe.after`) to stop mocking IModelHub and clean\n * up any resources used by the test(s). If you want to mock a single test, call [[startup]] as the first line and [[shutdown]] as the last. If you wish to run the\n * test against a \"real\" IModelHub, you can simply comment off the call [[startup]], though in that case you should make sure the name of your\n * iModel is unique so your test won't collide with other tests (iModel name uniqueness is not necessary for mocked tests.)\n *\n * Mocked tests must always start by creating a new iModel via [[IModelHost.hubAccess.createNewIModel]] with a `version0` iModel.\n * They use mock (aka \"bogus\") credentials for `AccessTokens`, which is fine since [[HubMock]] never accesses resources outside the current\n * computer.\n *\n * @note Only one HubMock at a time, *running in a single process*, may be active. The comments above about multiple simultaneous tests refer to tests\n * running on different computers, or on a single computer in multiple processes. All of those scenarios are problematic without mocking.\n *\n * @internal\n */\nexport class HubMock {\n  private static mockRoot: LocalDirName | undefined;\n  private static hubs = new Map<string, LocalHub>();\n  private static _saveHubAccess: BackendHubAccess | undefined;\n  private static _iTwinId: GuidString | undefined;\n\n  /** Determine whether a test us currently being run under HubMock */\n  public static get isValid() { return undefined !== this.mockRoot; }\n  public static get iTwinId() {\n    wasStarted(this._iTwinId);\n    return this._iTwinId;\n  }\n\n  /**\n   * Begin mocking IModelHub access. After this call, all access to IModelHub will be directed to a [[LocalHub]].\n   * @param mockName a unique name (e.g. \"MyTest\") for this HubMock to disambiguate tests when more than one is simultaneously active.\n   * It is used to create a private directory used by the HubMock for a test. That directory is removed when [[shutdown]] is called.\n   */\n  public static startup(mockName: LocalDirName, outputDir: string) {\n    if (this.isValid)\n      throw new Error(\"Either a previous test did not call HubMock.shutdown() properly, or more than one test is simultaneously attempting to use HubMock, which is not allowed\");\n\n    this.hubs.clear();\n    this.mockRoot = join(outputDir, \"HubMock\", mockName);\n    IModelJsFs.recursiveMkDirSync(this.mockRoot);\n    IModelJsFs.purgeDirSync(this.mockRoot);\n    this._saveHubAccess = IModelHost.getHubAccess();\n\n    IModelHost.setHubAccess(this);\n    HubMock._iTwinId = Guid.createValue(); // all iModels for this test get the same \"iTwinId\"\n  }\n\n  /** Stop a HubMock that was previously started with [[startup]]\n   * @note this function throws an exception if any of the iModels used during the tests are left open.\n   */\n  public static shutdown() {\n    if (this.mockRoot === undefined)\n      return;\n\n    HubMock._iTwinId = undefined;\n    for (const hub of this.hubs)\n      hub[1].cleanup();\n\n    this.hubs.clear();\n    IModelJsFs.purgeDirSync(this.mockRoot);\n    IModelJsFs.removeSync(this.mockRoot);\n    IModelHost.setHubAccess(this._saveHubAccess);\n    this.mockRoot = undefined;\n  }\n\n  public static findLocalHub(iModelId: GuidString): LocalHub {\n    const hub = this.hubs.get(iModelId);\n    if (!hub)\n      throw new Error(`local hub for iModel ${iModelId} not created`);\n    return hub;\n  }\n\n  /** create a [[LocalHub]] for an iModel.  */\n  public static async createNewIModel(arg: CreateNewIModelProps): Promise<GuidString> {\n    wasStarted(this.mockRoot);\n    const props = { ...arg, iModelId: Guid.createValue() };\n    const mock = new LocalHub(join(this.mockRoot, props.iModelId), props);\n    this.hubs.set(props.iModelId, mock);\n    return props.iModelId;\n  }\n\n  /** remove the [[LocalHub]] for an iModel */\n  public static destroy(iModelId: GuidString) {\n    this.findLocalHub(iModelId).cleanup();\n    this.hubs.delete(iModelId);\n  }\n\n  /** All methods below are mocks of the [[BackendHubAccess]] interface */\n\n  public static async getChangesetFromNamedVersion(arg: IModelIdArg & { versionName: string }): Promise<ChangesetProps> {\n    return this.findLocalHub(arg.iModelId).findNamedVersion(arg.versionName);\n  }\n\n  private static changesetIndexFromArg(arg: ChangesetArg) {\n    return (undefined !== arg.changeset.index) ? arg.changeset.index : this.findLocalHub(arg.iModelId).getChangesetIndex(arg.changeset.id);\n  }\n\n  public static async getChangesetFromVersion(arg: IModelIdArg & { version: IModelVersion }): Promise<ChangesetProps> {\n    const hub = this.findLocalHub(arg.iModelId);\n    const version = arg.version;\n    if (version.isFirst)\n      return hub.getChangesetByIndex(0);\n\n    const asOf = version.getAsOfChangeSet();\n    if (asOf)\n      return hub.getChangesetById(asOf);\n\n    const versionName = version.getName();\n    if (versionName)\n      return hub.findNamedVersion(versionName);\n\n    return hub.getLatestChangeset();\n  }\n\n  public static async getLatestChangeset(arg: IModelIdArg): Promise<ChangesetProps> {\n    return this.findLocalHub(arg.iModelId).getLatestChangeset();\n  }\n\n  private static async getAccessToken(arg: TokenArg) {\n    return arg.accessToken ?? await IModelHost.getAccessToken();\n  }\n\n  public static async getMyBriefcaseIds(arg: IModelIdArg): Promise<number[]> {\n    const accessToken = await this.getAccessToken(arg);\n    return this.findLocalHub(arg.iModelId).getBriefcaseIds(accessToken);\n  }\n\n  public static async acquireNewBriefcaseId(arg: AcquireNewBriefcaseIdArg): Promise<number> {\n    const accessToken = await this.getAccessToken(arg);\n    return this.findLocalHub(arg.iModelId).acquireNewBriefcaseId(accessToken, arg.briefcaseAlias);\n  }\n\n  /** Release a briefcaseId. After this call it is illegal to generate changesets for the released briefcaseId. */\n  public static async releaseBriefcase(arg: BriefcaseIdArg): Promise<void> {\n    return this.findLocalHub(arg.iModelId).releaseBriefcaseId(arg.briefcaseId);\n  }\n\n  public static async downloadChangeset(arg: DownloadChangesetArg): Promise<ChangesetFileProps> {\n    return this.findLocalHub(arg.iModelId).downloadChangeset({ index: this.changesetIndexFromArg(arg), targetDir: arg.targetDir });\n  }\n\n  public static async downloadChangesets(arg: DownloadChangesetRangeArg): Promise<ChangesetFileProps[]> {\n    return this.findLocalHub(arg.iModelId).downloadChangesets({ range: arg.range, targetDir: arg.targetDir });\n  }\n\n  public static async queryChangeset(arg: ChangesetArg): Promise<ChangesetProps> {\n    return this.findLocalHub(arg.iModelId).getChangesetByIndex(this.changesetIndexFromArg(arg));\n  }\n\n  public static async queryChangesets(arg: IModelIdArg & { range?: ChangesetRange }): Promise<ChangesetProps[]> {\n    return this.findLocalHub(arg.iModelId).queryChangesets(arg.range);\n  }\n\n  public static async pushChangeset(arg: IModelIdArg & { changesetProps: ChangesetFileProps }): Promise<ChangesetIndex> {\n    return this.findLocalHub(arg.iModelId).addChangeset(arg.changesetProps);\n  }\n\n  public static async queryV2Checkpoint(_arg: CheckpointProps): Promise<V2CheckpointAccessProps | undefined> {\n    return undefined;\n  }\n\n  // eslint-disable-next-line deprecation/deprecation\n  public static async downloadV1Checkpoint(arg: CheckpointArg): Promise<ChangesetIndexAndId> {\n    return this.findLocalHub(arg.checkpoint.iModelId).downloadCheckpoint({ changeset: arg.checkpoint.changeset, targetFile: arg.localFile });\n  }\n\n  public static async releaseAllLocks(arg: BriefcaseDbArg) {\n    const hub = this.findLocalHub(arg.iModelId);\n    hub.releaseAllLocks({ briefcaseId: arg.briefcaseId, changesetIndex: hub.getIndexFromChangeset(arg.changeset) });\n  }\n\n  public static async queryAllLocks(_arg: BriefcaseDbArg): Promise<LockProps[]> {\n    return [];\n  }\n\n  public static async acquireLocks(arg: BriefcaseDbArg, locks: LockMap): Promise<void> {\n    this.findLocalHub(arg.iModelId).acquireLocks(locks, arg);\n  }\n\n  public static async queryIModelByName(arg: IModelNameArg): Promise<GuidString | undefined> {\n    for (const hub of this.hubs) {\n      const localHub = hub[1];\n      if (localHub.iTwinId === arg.iTwinId && localHub.iModelName === arg.iModelName)\n        return localHub.iModelId;\n    }\n    return undefined;\n  }\n\n  public static async deleteIModel(arg: IModelIdArg & { iTwinId: GuidString }): Promise<void> {\n    return this.destroy(arg.iModelId);\n  }\n}\n"]}