codechecker/codechecker-web repository overview

⁠Supported tags and respective Dockerfile links

• 6.21.0, latest (web/docker/Dockerfile)⁠
• 6.20.0 (web/docker/Dockerfile)⁠
• 6.19.1 (web/docker/Dockerfile)⁠
• 6.19.0 (web/docker/Dockerfile)⁠
• 6.18.2 (web/docker/Dockerfile)⁠
• 6.18.1 (web/docker/Dockerfile)⁠
• 6.18.0 (web/docker/Dockerfile)⁠
• 6.17.0 (web/docker/Dockerfile)⁠
• 6.16.0 (web/docker/Dockerfile)⁠
• 6.15.2 (web/docker/Dockerfile)⁠
• 6.15.1 (web/docker/Dockerfile)⁠
• 6.15.0 (web/docker/Dockerfile)⁠
• 6.14.0 (web/docker/Dockerfile)⁠
• 6.13.0 (web/docker/Dockerfile)⁠
• 6.12.1 (web/docker/Dockerfile)⁠
• 6.12.0 (web/docker/Dockerfile)⁠
• 6.11.1 (web/docker/Dockerfile)⁠
• 6.11.0 (web/docker/Dockerfile)⁠
• 6.10.1 (web/docker/Dockerfile)⁠
• 6.10.0 (web/docker/Dockerfile)⁠
• 6.9.1 (web/docker/Dockerfile)⁠
• 6.9.0
• 6.8.1
• 6.8.0
• 6.7.1
• 6.7.0

⁠What is CodeChecker

CodeChecker is an analyzer tooling, defect database and viewer extension for the Clang Static Analyzer and Clang Tidy.

⁠Main features

• You can store & visualize thousands of analysis reports of many analyzers like Clang Static Analyzer (C/C++), Clang Tidy (C/C++), Facebook Infer (C/C++, Java), Clang Sanitizers (C/C++), Spotbugs (Java), Pylint (Python), Eslint (Javascript) ...
  For a complete list see Supported Analyzers⁠
• Web application for viewing discovered code defects with a streamlined, easy experience (with PostgreSQL, or SQLite backend)
• Gerrit and GitLab integration Shows analysis results as Gitlab⁠ or Gerrit⁠ reviews
• Filterable (defect checker name, severity, source paths, ...) and comparable (calculates difference between two analyses of the project, showing which bugs have been fixed and which are newly introduced) result viewing
• Diff mode: Shows the list of bugs that have been introduced since your last analyzer execution
• Results can be shared with fellow developers, the comments and review system helps communication of code defects
• Easily implementable Thrift⁠-based server-client communication used for storing and querying of discovered defects
• Support for multiple bug visualisation frontends, such as the web application, a command-line tool⁠ and an Eclipse plugin⁠

⁠Usage

To run a CodeChecker server docker container use the following command:

docker run -d \
  -p 8001:8001 \
  -v /home/$USER/codechecker_workspace:/workspace \
  codechecker/codechecker-web:latest

⁠Deployment

⁠docker-compose.yml

Docker Compose⁠ is a tool for defining and running multi-container Docker applications.

CodeChecker server can be easily run by defining the services that make up your app in docker-compose.yml so they can be run together in an isolated environment.

⁠Sqlite setup

To run a simple CodeChecker server with SQLite database you have to write a compose file similar to this⁠.

⁠PostgreSQL setup

⁠PostgreSQL (no authentication)

To run a CodeChecker server and a PostgreSQL database cluster which does not require authentication you have to write a compose file similar to this⁠.

⁠PostgreSQL (authentication)

To run a CodeChecker server and a PostgreSQL database cluster which requires authentication you have write a compose file which should be similar to this⁠.

Docker secrets⁠ can be used to define the superuser password in the PostgreSQL instance and to define a .pgpass file in the CodeChecker server container for database connections:

• postgres-passwd⁠: this file will contain the superuser password which will be used in the initdb script during initial container startup. For more information see Docker Secrets section of the official readme⁠.

• pgpass⁠: this file can contain passwords to be used if the connection requires a password. This file should contain lines of the following format: hostname:port:database:username:password. For more information see⁠.

Note: please change the passwords in the example pgpass and postgress-passwd files to something else, before deploying the service.

⁠Running your app

Run docker-compose -f web/docker/services/<service-yml-file> up -d and Compose starts and runs your entire app.

⁠Deploy your app in docker swarm

• Init⁠ your swarm node:

  docker swarm init
  

  Copy

• Join⁠ multiple nodes to your swarm if you want.

• Add labels⁠ to your nodes:

  docker node update codechecker-db=true <node-id>
  docker node update codechecker-server=true <node-id>
  docker node update codechecker-nginx=true <node-id>
  

  Copy

  Use docker node ls⁠ command to list nodes in the swarm and to get there id's.

• Run the following command on the manager node to deploy⁠ the service:

  docker stack deploy -c web/docker/services/docker-compose.swarm.yml --with-registry-auth cc
  

  Copy

⁠Kubernetes

CodeChecker supports to configure liveness, readiness and startup probes for containers when using Kubernetes⁠.

If your server is running on my.company.org at 8080 port then two URL endpoints will be available for you:

• my.company.org:8080/live: simply say that the server is running. In case of succes it will response with 200 status code and a CODECHECKER_SERVER_IS_LIVE message.
• my.company.org:8080/ready: it will run a simple query on the database. In case of success it will response with 200 status code and a CODECHECKER_SERVER_IS_READY message. In case of error it will response with 500 error code and a CODECHECKER_SERVER_IS_NOT_READY error message.

⁠Build your own docker image

You can create a Docker image by running the following command in the root directory of the CodeChecker repository⁠:

docker build -t codechecker-web:latest web/docker

Multiple build-time variables can be specified:

• CC_VERSION (default: master): branch or tag version which will be cloned from Git. Use master if you would like to build an image from the latest CodeChecker.
• CC_UID (default: 950): id of the codechecker user which will be created during the image build and which will be used to start CodeChecker server.
• CC_GID (default: 950): id of the codechecker group which will be created during the image build.
• INSTALL_AUTH (default: no): set it to yes to install authentication dependencies like ldap.
• INSTALL_PG8000 (default: no): set it to yes to install pg8000 requirements.
• INSTALL_PSYCOPG2 (default: no): set it to yes to install psycopg2 requirements.

Example:

docker build \
  --build-arg INSTALL_AUTH=yes \
  --build-arg INSTALL_PSYCOPG2=yes \
  --tag codechecker-web:latest web/docker

⁠License

View license information here⁠.