对于最新的稳定版本,请使用 spring-cloud-contract 4.3.0! |
消费者驱动的合同:每个消费者的存根
在某些情况下,同一终结点的两个使用者希望有两个不同的响应。
这种方法还可以让您立即知道哪个使用者使用了 API 的哪一部分。您可以删除 API 生成的部分响应,并查看自动生成的测试 失败。 如果没有失败,您可以安全地删除响应的该部分,因为没有人使用它。 |
考虑以下为生产者定义的名为producer
, 它有两个消费者 (foo-consumer
和bar-consumer
):
消费者
foo-service
request {
url '/foo'
method GET()
}
response {
status OK()
body(
foo: "foo"
}
}
消费者
bar-service
request {
url '/bar'
method GET()
}
response {
status OK()
body(
bar: "bar"
}
}
您不能为同一个请求生成两个不同的响应。这就是为什么您可以正确打包contracts,然后从stubsPerConsumer
特征。
在生产者端,消费者可以拥有一个文件夹,其中包含仅与他们相关的合同。通过将stubrunner.stubs-per-consumer
flag 到true
,我们不再注册所有存根,而只注册那些对应于消费者应用程序的名称。换句话说,我们扫描每个存根的路径,然后,如果它包含一个路径中包含消费者名称的子文件夹,则只有注册它。
在foo
生产者方合同将如下所示
.
└── contracts
├── bar-consumer
│ ├── bookReturnedForBar.groovy
│ └── shouldCallBar.groovy
└── foo-consumer
├── bookReturnedForFoo.groovy
└── shouldCallFoo.groovy
这bar-consumer
消费者可以将spring.application.name
或stubrunner.consumer-name
自bar-consumer
或者,您可以按如下方式设置测试:
@SpringBootTest(classes = Config, properties = ["spring.application.name=bar-consumer",
"stubrunner.jms.enabled=false"])
@AutoConfigureStubRunner(ids = "org.springframework.cloud.contract.verifier.stubs:producerWithMultipleConsumers",
repositoryRoot = "classpath:m2repo/repository/",
stubsMode = StubRunnerProperties.StubsMode.REMOTE,
stubsPerConsumer = true)
@ActiveProfiles("streamconsumer")
class StubRunnerStubsPerConsumerSpec {
...
}
然后,只有在包含以下内容的路径下注册的存根bar-consumer
在其名称中(即来自src/test/resources/contracts/bar-consumer/some/contracts/…
文件夹)被允许引用。
您还可以显式设置消费者名称,如下所示:
@SpringBootTest(classes = Config, properties = "stubrunner.jms.enabled=false")
@AutoConfigureStubRunner(ids = "org.springframework.cloud.contract.verifier.stubs:producerWithMultipleConsumers",
repositoryRoot = "classpath:m2repo/repository/",
consumerName = "foo-consumer",
stubsMode = StubRunnerProperties.StubsMode.REMOTE,
stubsPerConsumer = true)
@ActiveProfiles("streamconsumer")
class StubRunnerStubsPerConsumerWithConsumerNameSpec {
...
}
然后,只有在包含foo-consumer
在其名称中(即来自src/test/resources/contracts/foo-consumer/some/contracts/…
文件夹)被允许引用。
有关此更改背后原因的更多信息,请参阅问题 224。