Skip to content

Update the assertSucceed reference doc to the public doc #6366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 23, 2022
Merged

Update the assertSucceed reference doc to the public doc #6366

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
58ddf45
update the assertSucceed reference doc to the public doc
jbalidiong Jun 16, 2022
4b1b784
Merge branch 'firebase:master' into testing-doc
jbalidiong Jun 23, 2022
1895d5d
adjusted changes based from the comment
jbalidiong Jun 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/rules-unit-testing/src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ export function assertFails(pr: Promise<any>): Promise<any> {
}

/**
* Assert the promise to be rejected with a "permission denied" error.
* Assert the promise to be successful with no Security Rules error.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the additional part after "successful" is confusing and is explained in further detail below. "Assert the promise to be successful" should be good enough here. Thanks!

*
* This is a no-op function returning the passed promise as-is, but can be used for documentational
* purposes in test code to emphasize that a certain request should succeed (e.g. allowed by rules).
Expand Down