docs: improve readme tests section #2380
Merged
Conversation
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
zepatrik
requested changes
Mar 5, 2021
README.md
Outdated
Comment on lines
442
to
450
| # quick tests | ||
| make quicktest | ||
|
|
||
| # regular tests | ||
| make test | ||
| test-resetdb | ||
|
|
||
| # end-to-end tests | ||
| make e2e |
There was a problem hiding this comment.
We usually use the fenced (backticks) codeblocks instead.
README.md
Outdated
Comment on lines
460
to
461
| Running quick tests will use the sqlite database | ||
| thus add `-tags sqlite` when building the binary. |
There was a problem hiding this comment.
Even the full tests run against sqlite and require the tag.
Suggested change
| Running quick tests will use the sqlite database | |
| thus add `-tags sqlite` when building the binary. | |
| All tests run against an sqlite in-memory database, | |
| thus it is required to use the `-tags sqlite` build tag. |
README.md
Outdated
| ``` | ||
|
|
||
| or test just a specific module: | ||
|
|
||
| ```shell script | ||
| cd client; go test -short . | ||
| cd client; go test -v -failfast -short -tags sqlite . |
There was a problem hiding this comment.
Suggested change
| cd client; go test -v -failfast -short -tags sqlite . | |
| go test -v -failfast -short -tags sqlite ./client |
aeneasr
approved these changes
Mar 8, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related issue
Proposed changes
Update the README.md file with the correct test commands as the previous ones were incomplete or out dated.
Checklist
vulnerability. If this pull request addresses a security. vulnerability, I
confirm that I got green light (please contact
security@ory.sh) from the maintainers to push
the changes.
works.
Further comments