pactfoundation/pact-cli

Pact CLI

镜像概述和主要用途

Pact CLI Docker镜像整合了Pact Ruby实现中的所有CLI工具，功能上与https://github.com/pact-foundation/pact-ruby-standalone%E4%B8%80%E8%87%B4%EF%BC%8C%E4%BD%86%E6%89%93%E5%8C%85%E4%B8%BADocker%E5%AE%B9%E5%99%A8%E5%BD%A2%E5%BC%8F%EF%BC%8C%E6%8F%90%E4%BE%9B%E5%8D%95%E4%B8%80%E9%A1%B6%E5%B1%82%E5%85%A5%E5%8F%A3%E7%82%B9%60pact%60%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E4%B8%BB%E8%A6%81%E7%94%A8%E4%BA%8E%E5%8F%91%E5%B8%83%E5%92%8C%E9%AA%8C%E8%AF%81%E5%A5%91%E7%BA%A6%EF%BC%88pacts%EF%BC%89%EF%BC%8C%E4%BB%A5%E5%8F%8A%E4%B8%8EPact 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

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

多平台镜像

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

• --platform=linux/amd64

• --platform=linux/arm

• --platform=linux/arm64

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

使用方法

环境准备

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

sh
export PACT_BROKER_BASE_URL="https://test.pactflow.io"
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为宿主机而非容器自身。

查看帮助

sh
$ 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

可克隆仓库git@github.com:pact-foundation/pact-ruby-cli.git（https://github.com/pact-foundation/pact-ruby-cli%EF%BC%89%EF%BC%8C%E5%B9%B6%E4%BB%8E%E6%A0%B9%E7%9B%AE%E5%BD%95%E8%BF%90%E8%A1%8C%E4%BB%A5%E4%B8%8B%E5%91%BD%E4%BB%A4%EF%BC%9A

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

所有发布选项详见https://github.com/pact-foundation/pact_broker-client#publish%E3%80%82

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

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

验证Pacts

参考示例https://github.com/pact-foundation/pact-ruby-cli/blob/master/docker-compose-verify.yml%EF%BC%9A

sh
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

所有验证选项详见https://github.com/pact-foundation/pact-provider-verifier/#usage%E3%80%82

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

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

所有选项详见https://github.com/pact-foundation/pact_broker-client#can-i-deploy%E3%80%82

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

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

所有选项详见https://github.com/pact-foundation/pact_broker-client#create-version-tag%E3%80%82

模拟服务（Mock Service）

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

-it参数用于支持通过ctl+c停止容器。使用docker stop时容器关闭可能较慢，这是已知问题。所有选项详见https://github.com/pact-foundation/pact-mock_service#mock-service-usage%E3%80%82

使用自定义证书

CA证书

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

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

客户端证书认证（x509）

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

sh
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 \
 docker.xuanyuan.run/pactfoundation/pact-cli:latest ...

容器内Shell访问

为符合https://github.com/docker-library/official-images#consistency%EF%BC%8C%E5%AE%B9%E5%99%A8%E6%8F%90%E4%BE%9B%60sh%60%E8%AE%BF%E9%97%AE%EF%BC%88**%E6%B3%A8%E6%84%8F%EF%BC%9A%E5%AE%B9%E5%99%A8%E5%86%85%E6%9C%AA%E5%AE%89%E8%A3%85bash**%EF%BC%89%EF%BC%9A

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

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

贡献

欢迎在GitHub上提交bug报告和拉取请求：https://github.com/pact-foundation/pact-ruby-cli%E3%80%82

许可证

本镜像作为开源软件发布，遵循https://opensource.org/licenses/MIT%E6%9D%A1%E6%AC%BE%E3%80%82