协议-使用提供程序状态

Question

我正在尝试使用pact来验证spring boot微服务。我已经从consumer生成了pact文件，并在provider端使用pact Broker验证了它。

我有另一个用例，在根据实际的服务响应验证pact文件之前，我需要执行一些代码。我读过关于状态改变URL和状态改变与闭包来实现它，但没有得到一个如何实现这一点的例子。有人能帮忙吗？

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

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

Answer 1

state change URL是您在提供程序上创建的一个钩子，它允许Pact在测试开始时告诉提供程序它应该处于什么状态。在每次测试运行之前，模拟使用者点击提供程序上的状态更改URL，并告诉它测试所期望的状态的名称。

你需要做两件事：

1. 配置状态更改URL
2. 在提供程序上实现状态更改终结点

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

hasPactWith('consumer1') {
 stateChangeUrl = url('http://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引导错误--我不是一个Spring引导的人，但你可以看到一般的原理。

使用状态更改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页面。

你问：

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

你用两个测试来说明：

>

当我向客户记录提交更新时（处于客户存在时的状态），那么我期望X响应。

当我向客户记录提交更新时（在客户不存在的状态下），那么我期望Y响应。

这些测试是您的契约合同中的两个单独的项目。

其意图不是在合同中包含设置的细节。在消费者端，您的状态只是一个字符串，表示类似于“ID=1234的客户存在”。

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

使用者测试不应该知道如何设置提供者状态，他们应该只知道测试需要什么状态（仅通过名称）。类似地，提供者不需要知道正在测试什么，它只需要知道如何将状态名称转换为实际状态。