Pact CLI

镜像概述和主要用途

Pact CLI Docker镜像整合了Pact Ruby实现中的所有CLI工具，功能上与pact-ruby-standalone一致，但打包为Docker容器形式，提供单一顶层入口点pact。该镜像主要用于发布和验证契约（pacts），以及与Pact Broker进行交互，简化契约测试流程的集成和执行。

核心功能和特性

• 统一入口点：通过单一命令pact访问所有Pact CLI功能
• 多平台支持：提供单平台（默认amd64）和多平台（amd64、arm、arm64）镜像
• 完整Pact功能：支持发布pacts到Pact Broker、验证pacts against提供者、与Pact Broker交互（如检查部署就绪性、创建版本标签等）
• 灵活认证：支持Pact Broker的用户名密码认证和Bearer Token认证（如PactFlow）

平台支持

单平台镜像

默认情况下，常规标签（如latest）仅构建amd64架构：

• --platform=linux/amd64

  docker run --rm -it pactfoundation/pact-cli:latest /bin/sh -c 'uname -sm'
  

多平台镜像

多平台镜像可通过在任何发布标签后添加-multi获取，支持以下架构：

• --platform=linux/amd64

• --platform=linux/arm

• --platform=linux/arm64

  docker run --rm -it pactfoundation/pact-cli:latest-multi /bin/sh -c 'uname -sm'
  

使用方法

环境准备

可使用公共测试Pact Broker进行示例操作，设置以下环境变量：

export PACT_BROKER_BASE_URL="[***]"
export PACT_BROKER_USERNAME="dXfltyFMgNOFZAxr8io9wJ37iUpY42M"
export PACT_BROKER_PASSWORD="O5AIZWxelWbLvqMd8PkAVycBJh2Psyg1"

示例中的$(date +%s)用于生成伪随机GIT_COMMIT。若使用Bearer Token认证的Pact Broker（如PactFlow），请设置PACT_BROKER_TOKEN而非用户名和密码。

Docker注意事项

• 发布pacts时：需使用-v标志将本地pacts文件挂载到容器中，示例见下文。
• 连接本地Pact Broker：若连接运行在localhost的Pact Broker，需添加--network="host"参数，使容器解析localhost为宿主机而非容器自身。

查看帮助

$ docker run --rm pactfoundation/pact-cli:latest help
Commands:
  pact-broker                     # 与Pact Broker交互
  publish PACT_DIRS_OR_FILES ...  # 将pacts发布到Pact Broker
  verify PACT_URL ...             # 针对提供者验证pact(s)
  version                         # 打印版本信息
  help [COMMAND]                  # 描述可用命令或特定命令的帮助

$ docker run --rm pactfoundation/pact-cli:latest pact-broker help
Commands:
  pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BRO...  # 检查是否可以部署
  pact-broker create-version-tag -a, --pacticipant=PACTICIPANT -b, --broker-base-u...  # 为版本创建标签
  pact-broker create-webhook URL -X, --request=REQUEST -b, --broker-base-url=BROKE...  # 创建Webhook
  pact-broker describe-version -a, --pacticipant=PACTICIPANT -b, --broker-base-url...  # 描述版本信息
  pact-broker help [COMMAND]                                                      ...  # 显示命令帮助
  pact-broker publish PACT_DIRS_OR_FILES ... -a, --consumer-app-version=CONSUMER_A...  # 发布pacts到Broker
  pact-broker version                                                             ...  # 显示版本

发布Pacts

可克隆仓库***:pact-foundation/pact-ruby-cli.git（[***]

docker run --rm \
 -w ${PWD} \
 -v ${PWD}:${PWD} \
 -e PACT_BROKER_BASE_URL \
 -e PACT_BROKER_USERNAME \
 -e PACT_BROKER_PASSWORD \
  pactfoundation/pact-cli:latest \
  publish \
  ${PWD}/example/pacts \
  --consumer-app-version fake-git-sha-for-demo-$(date +%s) \
  --tag-with-git-branch

所有发布选项详见官方文档。

演示：发布容器内置示例Pact

docker run --rm  \
  -e PACT_BROKER_BASE_URL  \
  -e PACT_BROKER_USERNAME  \
  -e PACT_BROKER_PASSWORD  \
  pactfoundation/pact-cli:latest \
  publish \
  /pact/example/pacts \
  --consumer-app-version fake-git-sha-for-demo-$(date +%s)

验证Pacts

参考示例docker-compose-verify.yml：

PACT_BROKER_PUBLISH_VERIFICATION_RESULTS=true GIT_COMMIT=fake-git-sha-for-demo$(date +%s) GIT_BRANCH=master \
  docker-compose -f docker-compose-verify.yml \
  up --build --abort-on-container-exit --exit-code-from pact_verifier

所有验证选项详见官方文档。

检查部署就绪性（Can I deploy）

docker run --rm \
 -e PACT_BROKER_BASE_URL \
 -e PACT_BROKER_USERNAME \
 -e PACT_BROKER_PASSWORD \
  pactfoundation/pact-cli:latest \
  pact-broker can-i-deploy \
  --pacticipant docker-example-consumer \
  --latest

所有选项详见官方文档。

为契约参与者版本创建标签

docker run --rm \
 -e PACT_BROKER_BASE_URL \
 -e PACT_BROKER_USERNAME \
 -e PACT_BROKER_PASSWORD \
  pactfoundation/pact-cli:latest \
  pact-broker create-version-tag \
  --pacticipant docker-example-consumer \
  --version fake-git-sha-for-demo-$(date +%s) \
  --tag prod

所有选项详见官方文档。

模拟服务（Mock Service）

docker run -dit \
  --rm \
  --name pact-mock-service \
  -p 1234:1234 \
  -v ${HOST_PACT_DIRECTORY}:/tmp/pacts \
  pactfoundation/pact-cli:latest \
  mock-service \
  -p 1234 \
  --host 0.0.0.0 \
  --pact-dir /tmp/pacts

-it参数用于支持通过ctl+c停止容器。使用docker stop时容器关闭可能较慢，这是已知问题。所有选项详见官方文档。

使用自定义证书

CA证书

docker run --rm \
 -v <宿主机证书文件路径>:/tmp/cacert.pem \
 -e SSL_CERT_FILE=/tmp/cacert.pem \
 pactfoundation/pact-cli:latest ...

也可设置SSL_CERT_DIR并挂载证书目录而非单个文件。

客户端证书认证（x509）

连接使用x509客户端证书认证的Pact Broker：

docker run --rm \
 -v <宿主机客户端证书文件路径>:/tmp/clientcert.pem \
 -v <宿主机客户端密钥文件路径>:/tmp/clientkey.pem \
 -e X509_CLIENT_CERT_FILE=/tmp/clientcert.pem \
 -e X509_CLIENT_KEY_FILE=/tmp/clientkey.pem \
 pactfoundation/pact-cli:latest ...

容器内Shell访问

为符合Docker一致性规则，容器提供sh访问（注意：容器内未安装bash）：

$ docker run --rm pactfoundation/pact-cli sh -c 'ls'
Gemfile
Gemfile.lock
bin
entrypoint.sh
example
lib
pact-cli.gemspec

$ docker run --rm pactfoundation/pact-cli ls
Gemfile
Gemfile.lock
bin
entrypoint.sh
example
lib
pact-cli.gemspec

贡献

欢迎在GitHub上提交bug报告和拉取请求：[***]

许可证

本镜像作为开源软件发布，遵循MIT许可证条款。