Coverity CodeXM

The Coverity CodeXM extension is a Visual Studio® Code extension that lets you author and test Coverity® checkers, before you share them with developers who will use them to analyze their own code. The checkers are currently compatible with Polaris, Code Sight, and Coverity Connect (available separately).

🎥 Quick Tour

Requirements

In order to use the extension you will need to have access to Coverity Analysis. The minimum supported version of Coverity Analysis is 2019.06

• if Coverity Analysis is already installed on your system, then you are ready to use the extension!
• if Coverity Analysis is not installed, ask your administrator where you can download the Coverity Analysis tools. Another way to do so is to download the Black Duck® Code Sight (Security) plug-in, which can download and install Coverity Analysis automatically. The IDEs that support Code Sight are Visual Studio Code, Visual Studio, Eclipse, and IntelliJ. Downloading Coverity Analysis through Code Sight requires authentication to a properly configured Coverity Connect or Polaris instance.

Quick Start

This is a pre-release for internal use only. If you would like to use it please contact us here or your Black Duck contact person.

In order to get you started right away, we have pre-configured the extension with a sample project checker and source file. This should allow you to see the extension working right out of the box. Moreover, you can also check out the interactive Quick Tour, which showcase an end-to-end workflow for writing, testing, and viewing the results of the sample project.

Supported Features

Syntax Highlighting + Snippet Completion

CodeXM syntax is highlighted.

Predefined snippets to accelerate development: checker, switch, function, pattern and debug

CodeXM Language Parse Errors

Parse/syntax error are denoted by a red squiggly underline. The errors are reported in the PROBLEMS view alongside those provided by other language support extensions.

Running CodeXM Against Source Files

The extension introduces a new type of run configuration, Sample CodeXM Checker Configuration. The new configuration provides a high level way to specify CodeXM checker to run against source file. The run configuration JSON schema specifies available configuration fields with description on hover support.

Logs/Diagnostics

Diagnostic logs can be found at the following locations in your system:

• On macOS/Linux: ~/.blackduck/cxm/logs/
• On Windows: C:/Users/<USERNAME>/AppData/Roaming/BlackDuck/cxm/logs/

What languages and IDEs are supported?

The Coverity CodeXM extension runs only in Microsoft® Visual Studio Code.

You can write CodeXM checkers to analyze source code written in C/C++, C#, Java®, or JavaScript®. The checkers in a particular .cxm file can analyze only one of the supported languages.

What if I have questions?

Feel free to ask questions, report issues, and give us feedback about the extension via the Coverity CodeXM extension site. Here you can find product documentation which is also available via the question-mark icon under EXTENSION STATUS.

For more general information on Black Duck products you can also visit Black Duck Community site.

License

By downloading and using the Coverity CodeXM extension, you agree to the product End User Software License and Maintenance Agreement.