test: improve coverage for firestore deploy prepare #10356
+79
−142
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,160 +1,97 @@ | ||
| import { expect } from "chai"; | ||
| import * as sinon from "sinon"; | ||
| import prepare from "./prepare"; | ||
| import { RulesDeploy } from "../../rulesDeploy"; | ||
| import { FirestoreApi } from "../../firestore/api"; | ||
| import * as ensureApiEnabled from "../../ensureApiEnabled"; | ||
| import * as fsConfig from "../../firestore/fsConfig"; | ||
| import { FirebaseError } from "../../error"; | ||
|
|
||
| describe("deploy/firestore/prepare", () => { | ||
| let getFirestoreConfigStub: sinon.SinonStub; | ||
| let compileStub: sinon.SinonStub; | ||
| let getDatabaseStub: sinon.SinonStub; | ||
| let createDatabaseStub: sinon.SinonStub; | ||
|
|
||
| beforeEach(() => { | ||
| sinon.stub(ensureApiEnabled, "ensure").resolves(); | ||
| getFirestoreConfigStub = sinon.stub(fsConfig, "getFirestoreConfig").returns([]); | ||
| compileStub = sinon.stub(RulesDeploy.prototype, "compile").resolves(); | ||
| sinon.stub(RulesDeploy.prototype, "addFile").returns(); | ||
| getDatabaseStub = sinon.stub(FirestoreApi.prototype, "getDatabase").resolves(); | ||
| createDatabaseStub = sinon.stub(FirestoreApi.prototype, "createDatabase").resolves(); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| sinon.restore(); | ||
| }); | ||
|
|
||
| it("should exit early if no firestore configs are found", async () => { | ||
| const context: any = { projectId: "my-project" }; | ||
|
Contributor
There was a problem hiding this comment. The use of References
|
||
| const options: any = { only: "" }; | ||
|
|
||
| await prepare(context, options); | ||
|
|
||
| expect(context.firestore).to.be.undefined; | ||
| }); | ||
|
|
||
| it("should prepare filtering flags correctly for --only firestore", async () => { | ||
| getFirestoreConfigStub.returns([{ database: "(default)", rules: "firestore.rules" }]); | ||
| const context: any = { projectId: "my-project" }; | ||
| const options: any = { | ||
| only: "firestore", | ||
| config: { data: { firestore: {} }, path: () => "path" }, | ||
| projectId: "my-project", | ||
| }; | ||
|
|
||
| await prepare(context, options); | ||
|
|
||
| expect(context.firestoreRules).to.be.true; | ||
| expect(context.firestoreIndexes).to.be.true; | ||
| }); | ||
|
|
||
| it("should prepare filtering flags correctly for --only firestore:rules", async () => { | ||
| getFirestoreConfigStub.returns([{ database: "(default)", rules: "firestore.rules" }]); | ||
| const context: any = { projectId: "my-project" }; | ||
| const options: any = { | ||
| only: "firestore:rules", | ||
| config: { data: { firestore: {} }, path: () => "path" }, | ||
| projectId: "my-project", | ||
| }; | ||
|
|
||
| await prepare(context, options); | ||
|
|
||
| expect(context.firestoreRules).to.be.true; | ||
| expect(context.firestoreIndexes).to.be.false; | ||
| }); | ||
|
|
||
| it("should create a missing database on preparation", async () => { | ||
| getFirestoreConfigStub.returns([{ database: "(default)", rules: "firestore.rules" }]); | ||
| getDatabaseStub.rejects({ status: 404 } as unknown as Error); | ||
|
|
||
| const context: any = { projectId: "my-project" }; | ||
| const options: any = { | ||
| config: { data: { firestore: { database: "(default)" } }, path: () => "path" }, | ||
| projectId: "my-project", | ||
| }; | ||
|
|
||
| await prepare(context, options); | ||
|
|
||
| expect(createDatabaseStub).to.have.been.calledOnce; | ||
|
Contributor
There was a problem hiding this comment. This assertion only checks that the stub was called, but it doesn't verify the configuration passed to it. It is recommended to verify that |
||
| expect(compileStub).to.have.been.calledOnce; | ||
| }); | ||
|
|
||
| it("should throw if invalid edition is specified", async () => { | ||
| getFirestoreConfigStub.returns([{ database: "(default)" }]); | ||
| const context: any = { projectId: "my-project" }; | ||
| const options: any = { | ||
| config: { data: { firestore: { edition: "INVALID_EDITION" } }, path: () => "path" }, | ||
| projectId: "my-project", | ||
| }; | ||
|
|
||
| await expect(prepare(context, options)).to.be.rejectedWith( | ||
| FirebaseError, | ||
| /Invalid edition specified for database/, | ||
| ); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The refactoring of this test file has resulted in a significant loss of test coverage. Specifically, the following scenarios from the original file are no longer tested:\n- Default database creation settings.\n- Enterprise edition with
FIRESTORE_NATIVEdata access mode.\n- Enterprise edition withMONGODB_COMPATIBLEdata access mode.\n- Validation errors whendataAccessModeis used with the standard edition.\n\nWhile the new tests for filtering flags are valuable, they should not replace the existing logic tests forcreateDatabase. Please restore the missing test cases to ensure the robustness of the Firestore deployment preparation logic.