codechecker/codechecker-web

支持的标签和对应的Dockerfile链接

• https://github.com/Ericsson/codechecker/blob/v6.21.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.20.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.19.1/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.19.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.18.2/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.18.1/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.18.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.17.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.16.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.15.2/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.15.1/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.15.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.15.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.13.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.12.1/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.12.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.11.1/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.11.0/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/v6.10.1/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/master/web/docker/Dockerfile
• https://github.com/Ericsson/codechecker/blob/master/web/docker/Dockerfile
• 6.9.0
• 6.8.1
• 6.8.0
• 6.7.1
• 6.7.0

CodeChecker是什么

CodeChecker是一个分析工具、缺陷数据库和查看器扩展，适用于Clang静态分析器和Clang Tidy。

主要特性

• 可存储和可视化数千个分析报告，支持多种分析器，如Clang静态分析器（C/C++）、Clang Tidy（C/C++）、*** Infer（C/C++、Java）、Clang Sanitizers（C/C++）、Spotbugs（Java）、Pylint（Python）、Eslint（Javascript）等。完整列表参见https://github.com/Ericsson/codechecker/blob/master/docs/supported_code_analyzers.md
• Web应用程序，用于查看发现的代码缺陷，提供流畅、便捷的体验（支持PostgreSQL或SQLite后端）
• Gerrit和GitLab集成，将分析结果显示为https://github.com/Ericsson/codechecker/blob/master/docs/gitlab_integration.md或https://github.com/Ericsson/codechecker/blob/master/docs/jenkins_gerrit_integration.md代码审查
• 可过滤（按缺陷检查器名称、严重性、源路径等）和可比较（计算项目两次分析之间的差异，显示已修复和新引入的错误）的结果查看
• 差异模式：显示自上次分析器执行以来引入的错误列表
• 结果可与其他开发人员共享，评论和审查系统有助于代码缺陷的沟通
• 基于http://thrift.apache.org的服务器-客户端通信，用于存储和查询发现的缺陷，易于实现
• 支持多种错误可视化前端，如Web应用程序、https://github.com/Ericsson/codechecker/blob/master/docs/usage.md和http://github.com/Ericsson/CodeCheckerEclipsePlugin

使用方法

要运行CodeChecker服务器Docker容器，请使用以下命令：

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

部署

docker-compose.yml

https://docs.docker.com/compose/是用于定义和运行多容器Docker应用程序的工具。

通过在docker-compose.yml中定义组成应用的服务，可以轻松运行CodeChecker服务器，使它们在隔离环境中一起运行。

SQLite设置

要运行带有SQLite数据库的简单CodeChecker服务器，您需要编写类似于https://github.com/Ericsson/codechecker/blob/master/web/docker/services/docker-compose.sqlite.yml的compose文件。

PostgreSQL设置

无认证的PostgreSQL

要运行CodeChecker服务器和不需要认证的PostgreSQL数据库集群，您需要编写类似于https://github.com/Ericsson/codechecker/blob/master/web/docker/services/docker-compose.psql.yml的compose文件。

有认证的PostgreSQL

要运行CodeChecker服务器和需要认证的PostgreSQL数据库集群，您需要编写类似于https://github.com/Ericsson/codechecker/blob/master/web/docker/services/docker-compose.psql.auth.yml的compose文件。

可以使用https://docs.docker.com/engine/swarm/secrets/来定义PostgreSQL实例中的超级用户密码，并在CodeChecker服务器容器中定义`.pgpass`文件用于数据库连接：

• https://github.com/Ericsson/codechecker/blob/master/web/docker/services/secrets/postgres-passwd：此文件将包含在初始容器启动期间`initdb`脚本使用的超级用户密码。有关更多信息，请参见官方https://hub.docker.com/_/postgres的`Docker Secrets`部分。

• https://github.com/Ericsson/codechecker/blob/master/web/docker/services/secrets/pgpass：此文件可以包含连接所需的密码。此文件应包含以下格式的行：`hostname:port:database:username:password`。有关更多信息，请参见https://www.postgresql.org/docs/9.6/libpq-pgpass.html。

注意：在部署服务之前，请将示例pgpass和postgress-passwd文件中的密码更改为其他值。

运行应用

运行docker-compose -f web/docker/services/<service-yml-file> up -d，Compose将启动并运行整个应用。

在Docker Swarm中部署应用

• https://docs.docker.com/engine/reference/commandline/swarm_init/swarm节点：

  docker swarm init
  

• 如果需要，将多个节点https://docs.docker.com/engine/reference/commandline/swarm_join/swarm。

• 为节点https://docs.docker.com/engine/reference/commandline/node_update/：

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

  使用https://docs.docker.com/engine/reference/commandline/node_ls/命令列出swarm中的节点并获取它们的ID。

• 在管理节点上运行以下命令以https://docs.docker.com/engine/reference/commandline/stack_deploy/服务：

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

Kubernetes

当使用https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/时，CodeChecker支持为容器配置存活、就绪和启动探针。

如果您的服务器在8080端口上运行于my.company.org，则有两个URL端点可供使用：

• my.company.org:8080/live：表明服务器正在运行。成功时，它将返回200状态码和CODECHECKER_SERVER_IS_LIVE消息。
• my.company.org:8080/ready：它将在数据库上运行简单查询。成功时，它将返回200状态码和CODECHECKER_SERVER_IS_READY消息。出错时，它将返回500错误码和CODECHECKER_SERVER_IS_NOT_READY错误消息。

构建自己的Docker镜像

您可以在CodeChecker https://github.com/Ericsson/codechecker/的根目录中运行以下命令来创建Docker镜像：

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

可以指定多个构建时变量：

• CC_VERSION（默认：master）：将从Git克隆的分支或标签版本。如果要从最新的CodeChecker构建镜像，请使用master。
• CC_UID（默认：950）：在镜像构建期间创建的codechecker用户的ID，将用于启动CodeChecker服务器。
• CC_GID（默认：950）：在镜像构建期间创建的codechecker组的ID。
• INSTALL_AUTH（默认：no）：设置为yes以安装认证依赖项，如ldap。
• INSTALL_PG8000（默认：no）：设置为yes以安装pg8000要求。
• INSTALL_PSYCOPG2（默认：no）：设置为yes以安装psycopg2要求。

示例：

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

许可证

查看https://github.com/Ericsson/codechecker/blob/master/LICENSE.TXT的许可证信息。