linuxserver/ci

linuxserver/ci

联系方式

这是什么？

该容器是一个Docker镜像自动化测试工具，旨在发布前执行一系列检查，确保容器健康且功能正常。其主要功能如下：

1. 启动容器：使用指定标签运行目标Docker镜像。
2. 检查启动成功：跟踪容器日志，等待[services.d] done.消息，确认初始化系统完成且服务已运行。
3. 生成SBOM：使用syft创建软件物料清单，提供镜像内所有包的完整列表。
4. 测试Web UI（可选）：如果容器运行Web服务，尝试连接UI并截图，验证其可访问性和渲染正确性。
5. 生成报告：收集所有结果（容器日志、构建信息、SBOM、截图、测试状态），生成综合HTML报告。
6. 上传报告（仅CI环境）：在CI环境中，将最终报告上传至S3存储桶供审查。

开发模式（本地测试）

对于本地开发和调试，可使用CI_LOCAL_MODE。此模式运行所有测试但跳过S3上传，将报告直接保存到本地文件夹。这是无需云凭证即可测试容器的最简单方法。

示例运行命令

在终端中运行以下命令。它将测试linuxserver/plex:latest镜像，并将报告放在当前文件夹的output目录中。

docker run --rm -i \
 --shm-size=1gb \
 -v /var/run/docker.sock:/var/run/docker.sock \
 -v "$(pwd)/output:/ci/output" \
 -e CI_LOCAL_MODE=true \
 -e IMAGE="linuxserver/plex" \
 -e TAGS="latest" \
 -e BASE="ubuntu" \
 -e WEB_SCREENSHOT=true \
 -e PORT=32400 \
 -e SSL=false \
 -e WEB_PATH="/web/index.html" \
 -e WEB_AUTH="" \
 -e WEB_SCREENSHOT_TIMEOUT=60 \
 -e WEB_SCREENSHOT_DELAY=20 \
 -t lsiodev/ci:latest \
 python3 test_build.py

查看报告

脚本完成后，可使用以下命令查看详细HTML报告：

chromium output/linuxserver/plex/latest/index.html

注意：可使用任何现代网页浏览器（如Firefox、Chrome等）。

关键本地变量

高级用法（CI环境）

此容器不面向公众使用，因为它硬编码了LinuxServer的报告存储端点。

以下是CI系统（https://github.com/linuxserver/pipeline-triggers%EF%BC%89%E8%BF%90%E8%A1%8C%E5%AE%B9%E5%99%A8%E6%97%B6%E4%BD%BF%E7%94%A8%E7%9A%84%E5%AE%8C%E6%95%B4%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E5%88%97%E8%A1%A8%E3%80%82

sudo docker run --rm -i \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /host/path:/ci/output:rw `#可选，将包含容器创建的所有文件。` \
-e IMAGE="linuxserver/<dockerimage>" \
-e TAGS="<单个标签或用|分隔的标签数组>" \
-e META_TAG=<manifest主dockerhub标签> \
-e BASE=<alpine或debian基础发行版> \
-e SECRET_KEY=<S3密钥> \
-e ACCESS_KEY=<S3访问键> \
-e DOCKER_ENV="<可选，用|分隔的环境变量数组，如test=test|test2=test2或单个变量。默认为''>"\
-e WEB_AUTH="<可选，格式为user:password。默认为'user:password'>" \
-e WEB_PATH="<可选，格式为/yourpath。默认为''。" \
-e S3_REGION=<可选，自定义S3区域。默认为'us-east-1'> \
-e S3_BUCKET=<可选，自定义S3存储桶。默认为'ci-tests.linuxserver.io'> \
-e WEB_SCREENSHOT_TIMEOUT=<可选，截图超时时间（秒）。默认为'120'>
-e WEB_SCREENSHOT_DELAY=<可选，页面加载后延迟截图的秒数。默认为'10'> \
-e SBOM_TIMEOUT=<可选，生成SBOM的超时时间（秒）。默认为'900'>
-e WEB_SCREENSHOT=<可选，非Web应用设为false。默认为'false'> \
-e PORT=<可选，Web应用监听的内部Docker端口。默认为'80'> \
-e SSL=<可选，截图是否使用ssl，true/false。默认为'false'> \
-e CI_S6_VERBOSITY=<可选，更新S6_VERBOSITY环境变量。默认为'2'> \
-e CI_LOG_LEVEL=<可选，设置CI日志级别。默认为'INFO'> \
-e DOCKER_LOGS_TIMEOUT=<可选，跟踪容器日志的超时秒数。默认为'120'> \
-e DRY_RUN=<可选，测试时不想上传文件到S3则设为'true'> \
-e NODE_NAME=<可选，运行CI测试的构建器名称。> \
-e RELEASE_TAG=<可选，Docker镜像的发布标签。用于上传位置。默认为'latest'> \
-e SYFT_IMAGE_TAG=<可选，用于生成SBOM的syft Docker镜像标签。默认为'1.26.1'> \
-t lsiodev/ci:latest \
python3 test_build.py