Build-Info 项目技术文档

1. 安装指南

在开始使用 Build-Info 项目之前，请确保您的开发环境已经安装了以下依赖：

• JDK 8
• Gradle 5.6.2 或使用提供的 Gradle Wrapper

为了运行测试，还需要设置以下环境变量：

export BITESTS_PLATFORM_URL='http://localhost:8081'
export BITESTS_PLATFORM_USERNAME=admin
export BITESTS_PLATFORM_ADMIN_TOKEN=admin-access-token
export BITESTS_ARTIFACTORY_PIP_ENV=/Users/user/venv-test/bin

有关如何生成管理员令牌的详细信息，请参考JFrog文档。

2. 项目的使用说明

Build-Info 是 Artifactory 的开放集成层，用于 CI 服务器和构建工具。构建信息以 json 格式发送到 Artifactory。

3. 项目API使用文档

Build-Info 项目包括多个模块的测试，以下是如何针对不同构建工具运行测试的命令：

提取器测试 (Extractor tests)

./gradlew clean build-info-api:test build-info-client:test build-info-extractor:test build-info-vcs:test

Maven 测试

./gradlew clean build-info-extractor-maven3:test

Gradle 测试

./gradlew clean build-info-extractor-gradle:test

npm 测试

确保系统中已添加 npm 可执行文件的搜索路径（PATH 环境变量），并且版本为 7.7 或更高。

./gradlew clean build-info-extractor-npm:test

Go 测试

确保系统中已添加 Go 可执行文件的搜索路径（PATH 环境变量），并且版本为 v1.14 或更高。

./gradlew clean build-info-extractor-go:test

Pip 测试

确保系统中已添加 Python 和 pip 可执行文件的搜索路径（PATH 环境变量），并且在一个干净的 pip 环境中运行测试。创建一个虚拟环境并提供其路径到 'BITESTS_ARTIFACTORY_PIP_ENV' 变量。

python -m venv buildinfo-tests-env
export BITESTS_ARTIFACTORY_PIP_ENV=/Users/user/buildinfo-tests-env/bin
./gradlew clean build-info-extractor-pip:test

NuGet 测试

确保系统中已添加 Nuget 和 Dotnet 可执行文件的搜索路径（PATH 环境变量）。

./gradlew clean build-info-extractor-nuget:test

Docker 测试

Docker 测试仅在 Linux/mac 上运行。除了运行测试所需的一般环境变量外，还需要设置以下环境变量：

export BITESTS_PLATFORM_CONTAINER_REGISTRY=127.0.0.1:8081
export BITESTS_ARTIFACTORY_DOCKER_HOST=tcp://127.0.0.1:1234

对于 OSX 代理，请运行一个 Socat 容器：

docker run -d -v /var/run/docker.sock:/var/run/docker.sock -p 127.0.0.1:1234:1234 bobrik/socat TCP-LISTEN:1234,fork UNIX-CONNECT:/var/run/docker.sock

然后运行测试：

./gradlew clean build-info-extractor-docker:test

4. 项目安装方式

使用 Gradle Wrapper 构建 Build-Info 项目，可以在 Unix 和 Windows 系统上运行以下命令：

# Unix
./gradlew clean build

# Windows
gradlew clean build

如果不需要运行测试，可以添加 "-x test" 选项到 "clean build" 命令中：

./gradlew clean build -x test

以上就是 Build-Info 项目的详细技术文档，希望对您的使用有所帮助。