PACT - 使用提供者状态

Question

我正在尝试使用 pact 来验证 spring boot 微服务。我已经从消费者生成了协议(protocol)文件，并使用协议(protocol)代理在提供者端对其进行了验证。

我有另一个用例，在根据实际服务响应验证契约文件之前，我需要执行一些代码。我阅读了有关状态更改 URL 和关闭状态更改以实现它的信息，但无法获得如何实现此目的的示例。有人可以帮忙吗？

我的具体情况是:我创建了一个契约(Contract)来更新 ID 为 1234 的客户(名字:test 姓氏:user)。

如果这个客户不存在，那么我需要通过读取协议(protocol)文件中的更新请求中的名字、姓氏、id 以及通过状态更改的附加信息(城市、州、电话号码)来将此数据插入数据库代码。

所以我的问题是，我可以通过状态更改从 pact 文件中读取请求数据，而不是在验证端配置名字、姓氏和 ID 吗？

Answer 1

状态更改 URL 是您在提供者上创建的一个 Hook ，以允许 Pact 告诉提供者它在测试开始时应该处于什么状态。在每次测试运行之前，模拟消费者点击您提供者上的状态更改 URL，并告诉它测试期望的状态名称。

你需要做两件事:

1. 配置状态更改 URL
2. 在提供商上实现状态更改端点

配置状态更改 URL

您可以在提供商验证设置中配置状态更改 URL。例如，使用 the maven plugin :

<serviceProvider>
  <name>provider1</name>
  <stateChangeUrl>http://localhost:8080/tasks/pactStateChange</stateChangeUrl>
...

或者使用 Gradle provider plugin :

hasPactWith('consumer1') {
 stateChangeUrl = url('http://localhost:8080/tasks/pactStateChange')
...

这两者都告诉模拟消费者使用 localhost:8080/tasks/pactStateChange 在每次测试之前更改提供者的状态。

实现状态改变端点

上面链接的文档告诉我们，默认情况下，请求的格式是状态字符串和任何参数的 POST 请求:

{ "state" : "a provider state description", "params": { "a": "1", "b": "2" } }

要使用它，您需要在提供程序上实现类似以下未经测试的代码:

@RequestMapping(value = "tasks/pactStateChange", method = RequestMethod.POST)
ResponseEntity<?> stateChange(@RequestBody ProviderState state) {
   if (state.state == "no database") {
       // Set up state for the "no database" case here
   } else if state.state == "Some other state" {
       // Set up state here
   } else if  ...   // Other states go here
   ... 
   }

   return ResponseEntity.ok().build()
}

请原谅该示例中的任何 spring boot 错误 - 我不是 spring boot 的人，但你可以看到一般原则。

使用状态更改 URL，pact 不会告诉提供者任何设置细节。它只是告诉提供者您在测试中使用的预先商定的状态字符串。这可能类似于 "foo exists"。然后，在为状态更改 URL 实现处理程序时，您会检测到 “foo exists”，并在那里进行任何显式设置。

if (state.state == "foo exists") {
     // do whatever you need to set up so that foo exists
    repository.clear()
    repository.insert(new Foo("arguments that foo needs",12))
}

如果您想了解更多关于提供者状态的意图，请阅读 wiki page on provider states .

如何在您的特定情况下执行此操作

你问:

Can i read the request data from pact file through state change instead of configuring the first name,last name and id in the verification side?

您可能对契约(Contract)测试的意图感到困惑 - 每个测试都是状态和请求的组合。

因此，与其使用一个测试来说:

• 我的测试是请求客户更新。如果客户存在，那么我期望 X 响应，如果不存在，那么我期望 Y 响应

你用两个测试来说明:

• 当我提交对客户记录的更新时(在客户存在的状态下)，那么我期望 X 响应。

• 当我提交对客户记录的更新时(在客户不存在的状态下)，那么我期望 Y 响应。

这些测试是您的 Pact 契约(Contract)中的两个独立项目。

目的是不在契约(Contract)中包含设置的细节。在消费者方面，您的状态只是一个字符串，表示“存在 id=1234 的客户”。

在提供者端，您的状态更改端点会检测该 URL 并根据需要创建状态。这通常以硬编码的方式完成:

if (state == "Customer with id=1234 exists") {
  Database.Clear()
  Database.Insert(new Customer(1234, "John","Smith")) 
} else if (state == "No customers exist") { 
  Database.Clear()
}

您不想通过解析状态字符串以参数化的方式执行此操作，因为那样您将在测试消费者和提供者之间创建一个新的复杂契约(Contract)。

消费者测试不应该知道任何有关如何设置提供者状态的信息，他们应该只知道测试需要什么状态(仅按名称)。同样，提供者不需要知道正在测试什么，它只需要知道如何将状态名称转换为实际状态。