CodeChecker Documentation

CodeChecker provides a command-line interface to perform static code analysis and store the resulting reports in a web-based storage.

Key analysis-related workflows include:

• Integrating analysis with your build system using log.
• Executing static analysis using analyze.
• Viewing analysis results in the command line using parse.
• Applying code fixes using fixit.
• Suppressing false positives using source-code comments.

Note: Analysis workflows can be completed entirely without a web-server.

The CodeChecker CLI is divided into two main categories of sub-commands:

1. Analysis sub-commands: Used for executing analyzers and performing local analysis (e.g., analyze, check, checkers, analyzers, log, parse).
2. Web sub-commands: Used for interacting with a running CodeChecker web server (e.g., server, store, cmd, version).

The CodeChecker client communicates with the server exclusively via the HTTP(S) protocol.

CodeChecker --help

The CodeChecker VSCode extension allows you to integrate static analysis directly into your editor workflow.

Key Features:

• Run CodeChecker analysis from the editor and view results automatically.
• Re-analyze the current file upon saving.
• Use commands and build tasks to run CodeChecker as part of a build system.
• Browse reports and view reproduction steps directly within the code.
• Navigate between different reproduction steps.

The store and cmd commands require a PRODUCT_URL to identify which server and Product to target.

Format: [http[s]://]host:port/ProductEndpoint

• Protocol: http (default) or https.
• Host/Port: The server's address and listening port.
• ProductEndpoint: The case-sensitive unique endpoint for the product (configured by administrators).

Defaults: If no URL is provided, it defaults to http://localhost:8001/Default.

Example: https://codechecker.example.org:9999/SampleProduct connects to codechecker.example.org on port 9999 via HTTPS using the SampleProduct endpoint.

A partial function is one that only works on a specific subset of input values. If the analyzer doesn't know these preconditions, it may report errors for the 'missing' cases.

To fix this, you can:

1. Use a default case in a switch statement with an assert(false).
2. Use an Immediately-Invoked Function Expression (IIFE) with a lambda (C++11 or later) to ensure variables are assigned valid values immediately.

// Option 1: Using default assert
int f(MyEnum Val) {
  int x = 0;
  switch (Val) {
    case MyEnumA: x = 1; break;
    case MyEnumB: x = 5; break;
    default: assert(false); break;
  }
  return 5/x;
}

// Option 2: Using IIFE (C++11+)
int f(MyEnum Val) {
  const int x = [&] {
    switch (Val) {
      case MyEnumA: return 1;
      case MyEnumB: return 5;
      default: assert(false); return 0;
    }
  } ();
  return 5/x;
}

The Report Storage and Viewer server manages the lifecycle of analysis results. Key features include:

• Thrift API: Used to store and query analysis results.
• Deduplication: Automatically detects duplicate results (e.g., a result in a header file detected by multiple analyzer runs) so each source file is stored only once.
• Database Management: Uses SQLAlchemy to connect to backends. It manages multiple Products, where each product can reside in a separate database.
• Authentication: Supports user authentication (e.g., LDAP).
• Web Interface: Provides an HTTPS webserver for viewing reports.