The Coverity on Polaris CLI runs the tools that analyze software to find quality and security issues. The Coverity on Polaris CLI itself is distinct from the analysis tools it can install and run.
The syntax of the command is:
polaris [common-options] command [command-options] [arguments]
The command that is passed will determine the phase to execute. The commands and phases have identical names. The options you pass in the command determine:
- The tools to install.
- The name of the project.
- Authentication of the current user.
- The build artifacts to be captured and processed.
- The build commands to be executed.
- The build artifacts to be cleaned after the build.
For more information on Coverity on Polaris CLI options, see Coverity on Polaris CLI Command Reference.
The polaris.yml configuration file also controls how analysis happens and enables customization based on your environment. For more information, refer to the configuration file help topics.
Note that Coverity on Polaris automatically generates the correct configuration in the default
configuration file for many project types, including Gradle. To upload a configuration file, pass
the --upload-local-config option with polaris analyze.
Finally, environment variables can also supply information to the command line tools.
Phases
The Coverity on Polaris CLI progresses through the following phases (see Coverity on Polaris CLI Phases).
- initialize
- setup
- configure
- install
- capture
- prepare
- analyze
When each CLI phase completes, the command line tells you how long it took, rounded to the nearest millisecond. For example:
[INFO] [y4wq7aho] Coverity - analyze phase took 1h 12m 36.543sFor tool-independent phases, such as setup, no tool name displays in the output.
Example 1
$ polaris analyze -w Use this command to run all phases, submit files, and wait for the Coverity on Polaris server to finish performing the analysis. If you have not previously run the Coverity on Polaris CLI, you might still be able to run this command, enter a server URL access token when prompted, and be able to complete a full analysis of your project without further configuration. Coverity on Polaris makes some educated guesses about the project configuration; for nonstandard project configurations, you must edit the YML configuration file and possibly the options you are using with the Coverity on Polaris CLI.
The CLI generates a clean command and a build command during configuration file creation (polaris.yml). You might need to change these to meet your needs.
At the conclusion of the analysis, the Coverity on Polaris CLI prints a brief summary of the issues, with counts reported by severity and with counts for new issues and closed issues:
Job issue summary
{
"IssuesBySeverity": {
"High": 0,
"Medium": 5,
"Low": 0
},
"Total": 5,
"NewIssues": 1,
"ClosedIssues": 0,
"SummaryUrl": "https://subdomain.cop.blackduck.com/projects/67d0f4df-12f2-4dbd-beb9-530a583fdb1c/branches/e8a22884-20a9-4571-a142-50fca02bf6eb"
}
To see more detailed results in the Coverity on Polaris UI, copy the project summary link at the end of the response and paste it into the address bar of your web browser.
Example 2
$ polaris --co project.branch='"different_branch"' analyzeThis example uses the --co option to change the name of the project branch,
temporarily overriding that setting in the configuration file. Use the --co
option to change your configurations quickly and from the command line when running analysis.
For more information, see Overriding the Configuration File from the Coverity on Polaris CLI.
Example 3
$ polaris -c other-configuration.yml prepare Proceeds through the life cycle through the prepare phase using a specific configuration file.
Example 4
$ polaris -i setupRemoves the locally stored access token, then runs up through the setup phase. You are prompted to enter an access token.