This repository was archived by the owner on Jan 5, 2023. It is now read-only.
Docs: Add building and testing to contributing guide#441
Merged
Conversation
sauyon
reviewed
Dec 23, 2020
Contributor
sauyon
left a comment
There was a problem hiding this comment.
Thanks, this will definitely be helpful for the future.
One comment, but otherwise looks great.
|
|
||
| 5. To run the full test suite, run `make test`. This will take approximately one hour. | ||
|
|
||
| 6. To run an individual test, run `codeql test run <directory>`, for example `codeql test run ql/test/query-tests/Security`. |
Contributor
There was a problem hiding this comment.
You can also run individual queries by passing the query file when there are multiple queries in a directory.
5fa9758 to
9da368e
Compare
sauyon
reviewed
Dec 28, 2020
|
|
||
| 6. To run all tests in a directory and its subdirectories, run `codeql test run <directory>`, for example `codeql test run ql/test/query-tests/Security`. | ||
|
|
||
| 7. To run an individual test, run `codeql test run <filename>`, where `<filename>` is a `.qlref` file, for example `codeql test run ql/test/query-tests/Security/CWE-020/MissingRegexpAnchor/MissingRegexpAnchor.qlref`. |
Contributor
There was a problem hiding this comment.
Tests can also be .ql files, so this needs a tiny modification:
Suggested change
| 7. To run an individual test, run `codeql test run <filename>`, where `<filename>` is a `.qlref` file, for example `codeql test run ql/test/query-tests/Security/CWE-020/MissingRegexpAnchor/MissingRegexpAnchor.qlref`. | |
| 7. To run an individual test, run `codeql test run <filename>`, where `<filename>` is a `.ql` or `.qlref` file, for example `codeql test run ql/test/query-tests/Security/CWE-020/MissingRegexpAnchor/MissingRegexpAnchor.qlref`. |
9da368e to
06721ce
Compare
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
This should help new contributors get started a little quicker.