dius/pact-provider-verifier-docker

Pact提供者验证

注意：如果你是Pact新手并来到这里，这可能不是你想要的。如果你只需要一个验证器的Docker化版本，所有Pact库的官方Docker容器是：https://github.com/pact-foundation/pact-ruby-cli%E3%80%82

此设置通过在独立的Docker容器中运行Pact Rake任务，简化了任何语言下的Pact提供者https://github.com/realestate-com-au/pact#2-tell-your-provider-that-it-needs-to-honour-the-pact-file-you-made-earlier%E6%B5%81%E7%A8%8B%E3%80%82

核心功能

• 验证发布到https://github.com/bethesque/pact_broker%E7%9A%84Pact
• 验证本地*.json格式的Pact，用于开发环境测试
• 预配置的Docker镜像，已安装Ruby并包含合理的默认src/Rakefile，保持代码简洁
• 支持Pacthttps://github.com/realestate-com-au/pact/wiki/Provider-states（如果需要）

前提条件

• Docker
• Docker Compose
• 你的API对应的可用Dockerfile

使用场景与示例

简单API

步骤：

1. 创建API及其对应的Docker镜像
2. 将Pact发布到Pact Broker（或创建本地Pact）
3. 创建docker-compose.yml文件，将你的API与Pact验证器连接
4. 设置以下必填环境变量：
   • pact_urls - Pact文件URL的逗号分隔列表
   • provider_base_url - Pact提供者（即你的API）的基础URL
5. 运行docker-compose build，然后docker-compose up

Node API的示例docker-compose.yml文件（暴露4000端口）：

yaml
api:
  build: .
  command: npm start
  ports:
  - "4000:4000"

pactverifier:
  image: dius/pact-provider-verifier-docker
  links:
  - api:api
  volumes:
  - ./pact/pacts:/tmp/pacts                 # 如果你有本地Pact
  environment:
  - pact_urls=http://pact-host:9292/pacts/provider/MyAPI/consumer/MyConsumer/latest
  #- pact_urls=/tmp/pacts/foo-consumer.json # 如果你有本地Pact
  - provider_base_url=http://api:4000

带提供者状态的API

对实现以下功能的提供者执行Pact验证：

• 一个HTTP GET端点，按消费者返回Pact提供者状态：

  json
  {
    "myConsumer": [
      "customer is logged in",
      "customer has a million dollars"
    ]
  }
  

• 一个HTTP POST端点，设置活跃的Pact消费者和提供者状态： consumer=web&state=customer%20is%20logged%20in

必填环境变量：

• pact_urls - Pact文件URL的逗号分隔列表
• provider_base_url - Pact提供者的基础URL
• provider_states_url - 返回按消费者分类的提供者状态的端点完整URL
• provider_states_active_url - 设置活跃Pact消费者和提供者状态的端点完整URL

Docker Compose用法

示例docker-compose.yml文件：

yaml
api:
  build: .
  command: npm run-script pact-provider
  ports:
  - "4000"

pactverifier:
  image: dius/pact-provider-verifier-docker
  links:
  - api
  environment:
  - pact_urls=[***]
  - provider_base_url=[***]
  - provider_states_url=[***]
  - provider_states_active_url=[***]