test accept
Accept results of failing unit tests.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://github.com/github/codeql-cli-binaries/releases.
To see details of the options available for this command in an earlier release, run the command with the--help option in your terminal.
Synopsis
codeql test accept <options>... -- <test|dir>...
codeql test accept <options>... -- <test|dir>...Description
Accept results of failing unit tests.
This is a convenience command that renames the.actual files left bycodeql test run for failing tests into.expected, such that future runs on the tests that give thesame output will be considered to pass. What it does can also beachieved by ordinary file manipulation, but you may find its syntax moreuseful for this special case.
The command-line arguments specify one or moretests -- that is,.ql(ref) files -- and the command automatically derives the names ofthe.actual files from them. Any test that doesn't have an.actualfile will be silently ignored, which makes it easy to accept just theresults offailing tests from a previous run.
Options
Primary Options
<test|dir>...
Each argument is one of:
- A
.qlor.qlreffile that defines a test to run. - A directory which will be searched recursively for tests to run.
--slice=<N/M>
[Advanced] Divide the test cases intoM roughly equal-sized slicesand process only theNth of them. This can be used for manualparallelization of the testing process.
--[no-]strict-test-discovery
[Advanced] Only use queries that can be strongly identified as tests.This mode tries to distinguish between.ql files that define unittests and.ql files that are meant to be useful queries. This optionis used by tools, such as IDEs, that need to identify all unit tests ina directory tree without depending on previous knowledge of how thefiles in it are arranged.
Within a QL pack whoseqlpack.yml declares atests directory, all.ql files in that directory are considered tests, and.ql filesoutside it are ignored. In a QL pack that doesn't declare atestsdirectory, a.ql file is identified as a test only if it has acorresponding.expected file.
For consistency,.qlref files are limited by the same rules as.qlfiles even though a.qlref file cannot really be a non-test.
Common options
-h, --help
Show this help text.
-J=<opt>
[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the number of progress messages printed.
-q, --quiet
Incrementally decrease the number of progress messages printed.
--verbosity=<level>
[Advanced] Explicitly set the verbosity level to one of errors,warnings, progress, progress+, progress++, progress+++. Overrides-vand-q.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.
(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)
--common-caches=<dir>
[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.
Available sincev2.15.2.