-
Notifications
You must be signed in to change notification settings - Fork 208
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add tests to check for V1CheckpointManager fixing dbGuid if mis-match. (
#1064) * Add tests to check for V1CheckpointManager fixing dbGuid if mis-match.
- Loading branch information
1 parent
b4da068
commit ebf11e0
Showing
9 changed files
with
182 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
common/changes/@bentley/imodeljs-backend/add-checkpoint-dbguid-test_2021-03-30-04-00.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "changes": [ | ||
| { | ||
| "packageName": "@bentley/imodeljs-backend", | ||
| "comment": "", | ||
| "type": "none" | ||
| } | ||
| ], | ||
| "packageName": "@bentley/imodeljs-backend", | ||
| "email": "31107829+calebmshafer@users.noreply.github.com" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
152 changes: 152 additions & 0 deletions
152
core/backend/src/test/standalone/CheckpointManager.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Bentley Systems, Incorporated. All rights reserved. | ||
| * See LICENSE.md in the project root for license terms and full copyright notice. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { assert } from "chai"; | ||
| import * as path from "path"; | ||
| import * as sinon from "sinon"; | ||
| import { ClientRequestContext, Guid } from "@bentley/bentleyjs-core"; | ||
| import { AccessToken, AuthorizedClientRequestContext } from "@bentley/itwin-client"; | ||
| import { CheckpointManager, V1CheckpointManager } from "../../CheckpointManager"; | ||
| import { IModelHost } from "../../imodeljs-backend"; | ||
| import { SnapshotDb } from "../../IModelDb"; | ||
| import { IModelJsFs } from "../../IModelJsFs"; | ||
| import { IModelTestUtils } from "../IModelTestUtils"; | ||
|
|
||
| describe("V1 Checkpoint Manager", () => { | ||
| it("empty props", async () => { | ||
| const props = { | ||
| contextId: "", | ||
| iModelId: "", | ||
| changeSetId: "", | ||
| requestContext: new AuthorizedClientRequestContext(new AccessToken()), | ||
| }; | ||
| assert.equal(V1CheckpointManager.getFileName(props), path.join(IModelHost.cacheDir, "imodels", "checkpoints", "first.bim")); | ||
| }); | ||
|
|
||
| it("changeset only props", async () => { | ||
| const props = { | ||
| contextId: "", | ||
| iModelId: "", | ||
| changeSetId: "1234", | ||
| requestContext: new AuthorizedClientRequestContext(new AccessToken()), | ||
| }; | ||
| assert.equal(V1CheckpointManager.getFileName(props), path.join(IModelHost.cacheDir, "imodels", "checkpoints", "1234.bim")); | ||
| }); | ||
|
|
||
| it("changeset+context props", async () => { | ||
| const props = { | ||
| contextId: "5678", | ||
| iModelId: "", | ||
| changeSetId: "1234", | ||
| requestContext: new AuthorizedClientRequestContext(new AccessToken()), | ||
| }; | ||
| assert.equal(V1CheckpointManager.getFileName(props), path.join(IModelHost.cacheDir, "imodels", "checkpoints", "1234.bim")); | ||
| }); | ||
|
|
||
| it("changeset+context+imodel props", async () => { | ||
| const props = { | ||
| contextId: "5678", | ||
| iModelId: "910", | ||
| changeSetId: "1234", | ||
| requestContext: new AuthorizedClientRequestContext(new AccessToken()), | ||
| }; | ||
| assert.equal(V1CheckpointManager.getFileName(props), path.join(IModelHost.cacheDir, "imodels", "910", "checkpoints", "1234.bim")); | ||
| }); | ||
|
|
||
| it("getFolder", async () => { | ||
| assert.equal(V1CheckpointManager.getFolder("1234"), path.join(IModelHost.cacheDir, "imodels", "1234", "checkpoints")); | ||
| assert.equal(V1CheckpointManager.getFolder(""), path.join(IModelHost.cacheDir, "imodels", "checkpoints")); | ||
| }); | ||
|
|
||
| it("should fix invalid dbGuid during download", async () => { | ||
| const dbPath = IModelTestUtils.prepareOutputFile("IModel", "TestCheckpoint.bim"); | ||
| const snapshot = SnapshotDb.createEmpty(dbPath, { rootSubject: { name: "test" } }); | ||
| const iModelId = Guid.createValue(); // This is wrong - it should be `snapshot.getGuid()`! | ||
| const contextId = Guid.createValue(); | ||
| const changeSetId = IModelTestUtils.generateChangeSetId(); | ||
| snapshot.nativeDb.saveProjectGuid(Guid.normalize(contextId)); | ||
| snapshot.nativeDb.saveLocalValue("ParentChangeSetId", changeSetId); | ||
| snapshot.saveChanges(); | ||
|
|
||
| assert.notEqual(iModelId, snapshot.nativeDb.getDbGuid()); // Ensure the Snapshot dbGuid and iModelId are different | ||
|
|
||
| snapshot.close(); | ||
|
|
||
| const mockCheckpoint = { | ||
| wsgId: "INVALID", | ||
| ecId: "INVALID", | ||
| changeSetId, | ||
| downloadUrl: `INVALID`, | ||
| mergedChangeSetId: changeSetId, | ||
| }; | ||
|
|
||
| const checkpointsHandler = IModelHost.iModelClient.checkpoints; | ||
| sinon.stub(checkpointsHandler, "get").callsFake(async () => [mockCheckpoint]); | ||
| sinon.stub(IModelHost.iModelClient, "checkpoints").get(() => checkpointsHandler); | ||
|
|
||
| const fileHandler = IModelHost.iModelClient.fileHandler!; | ||
| sinon.stub(fileHandler, "downloadFile").callsFake(async (_requestContext: AuthorizedClientRequestContext, _downloadUrl: string, downloadPath: string) => { | ||
| IModelJsFs.copySync(dbPath, downloadPath); | ||
| }); | ||
| sinon.stub(IModelHost.iModelClient, "fileHandler").get(() => fileHandler); | ||
|
|
||
| const ctx = ClientRequestContext.current as AuthorizedClientRequestContext; | ||
| const downloadedDbPath = IModelTestUtils.prepareOutputFile("IModel", "TestCheckpoint2.bim"); | ||
| await V1CheckpointManager.downloadCheckpoint({ localFile: downloadedDbPath, checkpoint: { requestContext: ctx, contextId, iModelId, changeSetId } }); | ||
| const db = SnapshotDb.openCheckpointV1(downloadedDbPath, { requestContext: ctx, contextId, iModelId, changeSetId }); | ||
| assert.equal(iModelId, db.nativeDb.getDbGuid(), "expected the V1 Checkpoint download to fix the improperly set dbGuid."); | ||
| }); | ||
| }); | ||
|
|
||
| describe("Checkpoint Manager", () => { | ||
|
|
||
| afterEach(() => { | ||
| sinon.restore(); | ||
| }); | ||
|
|
||
| it("open missing local file should return undefined", async () => { | ||
| const checkpoint = { | ||
| contextId: "5678", | ||
| iModelId: "910", | ||
| changeSetId: "1234", | ||
| requestContext: new AuthorizedClientRequestContext(new AccessToken()), // Why is this on CheckpointProps rather than DownloadRequest | ||
| }; | ||
| const request = { | ||
| localFile: V1CheckpointManager.getFileName(checkpoint), | ||
| checkpoint, | ||
| }; | ||
| const db = CheckpointManager.tryOpenLocalFile(request); | ||
| assert.isUndefined(db); | ||
| }); | ||
|
|
||
| it("open a bad bim file should return undefined", async () => { | ||
| const checkpoint = { | ||
| contextId: "5678", | ||
| iModelId: "910", | ||
| changeSetId: "1234", | ||
| requestContext: new AuthorizedClientRequestContext(new AccessToken()), // Why is this on CheckpointProps rather than DownloadRequest | ||
| }; | ||
|
|
||
| // Setup a local file | ||
| const folder = V1CheckpointManager.getFolder(checkpoint.iModelId); | ||
| if (!IModelJsFs.existsSync(folder)) | ||
| IModelJsFs.recursiveMkDirSync(folder); | ||
|
|
||
| const outputFile = V1CheckpointManager.getFileName(checkpoint); | ||
| if (IModelJsFs.existsSync(outputFile)) | ||
| IModelJsFs.unlinkSync(outputFile); | ||
|
|
||
| IModelJsFs.writeFileSync(outputFile, "Testing"); | ||
|
|
||
| // Attempt to open the file | ||
| const request = { | ||
| localFile: V1CheckpointManager.getFileName(checkpoint), | ||
| checkpoint, | ||
| }; | ||
| const db = CheckpointManager.tryOpenLocalFile(request); | ||
| assert.isUndefined(db); | ||
| }); | ||
|
|
||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters