首页 > 解决方案 > 如何使用 junit 5 spring boot 编写 pact-jvm 消费者驱动程序协议测试?

问题描述

我是编写 PACT 测试用例的新手。我有一个非常简单的场景,一个微服务在开发服务器上运行,它根据路径变量(它的一个 GET 调用)返回 true 或 false。如何编写生成 PACT 的测试用例?如何为协议设置代理服务器以进行发布?目前我只关心消费者端。

首先,我编写了以下代码?

OrderMsConsumerTest

@ExtendWith(PactConsumerTestExt.class)
@PactTestFor(providerName = "orderms-provider", port = "8888")
public class OrderMsConsumerTest {

    private static final String USER_SUBSCRIPTION_URL = "/api/order/order/subscription?userId=1&userSubscriptionId=1";
    private static final String SERVER_URL = "ACTUAL_SERVER_ADDRESS";

    @BeforeEach
    public void setUp(MockServer mockServer) {
        Assertions.assertTrue(mockServer != null);
    }

    @Pact(state = "user order subscription" , provider = "orderms-provider", consumer="orderms-consumer")
    public RequestResponsePact createPact(PactDslWithProvider builder) {
        Map headers = new HashMap<>();
        headers.put("Content-Type", "application/json;charset=UTF-8");
        return builder
                .given("Order User Subscription")
                .uponReceiving("user id and subscription id")
                .path("/api/order/order/subscription?userId=2968&userSubscriptionId=51230")
                .method("GET")
                .willRespondWith()
                .status(200)
                .headers(headers)
                .body("true")
                .toPact();
    }

    @Test
    @PactTestFor(pactMethod = "orderUserSubscription")
    void shouldPassResponseRecivedForGivenUserIdAndSubscriptionId() throws IOException {
        HttpResponse httpResponse = Request.Get(SERVER_URL + USER_SUBSCRIPTION_URL)
                .execute().returnResponse();
        Assertions.assertTrue(httpResponse.getStatusLine().getStatusCode() == 200);
    }
}

当我在 intellij 中编写 click 并运行测试时,我得到以下异常结果?

java.lang.UnsupportedOperationException: No method annotated with @Pact was found on test class OrderMsConsumerTest for provider 'orderms-provider'

    at au.com.dius.pact.consumer.junit5.PactConsumerTestExt.lookupPact(PactConsumerTestExt.kt:146)
    at au.com.dius.pact.consumer.junit5.PactConsumerTestExt.beforeEach(PactConsumerTestExt.kt:83)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeBeforeEachCallbacks$1(TestMethodTestDescriptor.java:151)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeBeforeMethodsOrCallbacksUntilExceptionOccurs$5(TestMethodTestDescriptor.java:187)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeBeforeMethodsOrCallbacksUntilExceptionOccurs(TestMethodTestDescriptor.java:187)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeBeforeEachCallbacks(TestMethodTestDescriptor.java:150)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:129)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:69)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:135)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$7(NodeTestTask.java:125)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:135)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:123)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:122)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:80)
    at java.util.ArrayList.forEach(ArrayList.java:1257)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:139)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$7(NodeTestTask.java:125)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:135)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:123)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:122)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:80)
    at java.util.ArrayList.forEach(ArrayList.java:1257)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$5(NodeTestTask.java:139)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$7(NodeTestTask.java:125)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:135)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively$8(NodeTestTask.java:123)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:122)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:80)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.submit(SameThreadHierarchicalTestExecutorService.java:32)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute(HierarchicalTestExecutor.java:57)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:51)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:229)
    at org.junit.platform.launcher.core.DefaultLauncher.lambda$execute$6(DefaultLauncher.java:197)
    at org.junit.platform.launcher.core.DefaultLauncher.withInterceptedStreams(DefaultLauncher.java:211)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:191)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:128)
    at com.intellij.junit5.JUnit5IdeaTestRunner.startRunnerWithArgs(JUnit5IdeaTestRunner.java:69)
    at com.intellij.rt.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:33)
    at com.intellij.rt.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:230)
    at com.intellij.rt.junit.JUnitStarter.main(JUnitStarter.java:58)
    Suppressed: kotlin.TypeCastException: null cannot be cast to non-null type au.com.dius.pact.consumer.junit5.JUnit5MockServerSupport
        at au.com.dius.pact.consumer.junit5.PactConsumerTestExt.afterEach(PactConsumerTestExt.kt:162)
        at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeAfterEachCallbacks$11(TestMethodTestDescriptor.java:245)
        at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeAllAfterMethodsOrCallbacks$12(TestMethodTestDescriptor.java:256)
        at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
        at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeAllAfterMethodsOrCallbacks$13(TestMethodTestDescriptor.java:256)
        at java.util.ArrayList.forEach(ArrayList.java:1257)
        at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeAllAfterMethodsOrCallbacks(TestMethodTestDescriptor.java:255)
        at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeAfterEachCallbacks(TestMethodTestDescriptor.java:244)
        at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:141)
        ... 41 more


我在这里有点困惑@PactTestFor(providerName = "orderms-provider", port = "8888")我现在没有设置代理,所以它会在端口 8888 自动运行一个提供者名称 orderms-provider 的模拟服务器?我是否需要在端口 8888 上运行应用程序并进行实际调用并通过测试?如何使测试用例作为我的 Maven 构建的一部分运行?

标签: spring-bootjunit5pactpact-broker

解决方案


@ExtendWith(PactConsumerTestExt.class)
@PactTestFor(providerName = "orderms-provider", port = "8888")
public class OrderMsConsumerTest {

    private static final String USER_SUBSCRIPTION_URL = "/api/order/order/subscription?userId=1&userSubscriptionId=1";
    private static final String SERVER_URL = "ACTUAL_SERVER_ADDRESS";

    @BeforeEach
    public void setUp(MockServer mockServer) {
        Assertions.assertTrue(mockServer != null);
    }

    @Pact(state = "user order subscription" , provider = "orderms-provider", consumer="orderms-consumer")
    public RequestResponsePact orderUserSubscription(PactDslWithProvider builder) {
        Map headers = new HashMap<>();
        headers.put("Content-Type", "application/json;charset=UTF-8");
        return builder
                .given("Order User Subscription")
                .uponReceiving("user id and subscription id")
                .path("/api/order/order/subscription?userId=2968&userSubscriptionId=51230")
                .method("GET")
                .willRespondWith()
                .status(200)
                .headers(headers)
                .body("true")
                .toPact();
    }

    @Test
    @PactTestFor(pactMethod = "orderUserSubscription")
    void shouldPassResponseRecivedForGivenUserIdAndSubscriptionId() throws IOException {
        HttpResponse httpResponse = Request.Get(SERVER_URL + USER_SUBSCRIPTION_URL)
                .execute().returnResponse();
        Assertions.assertTrue(httpResponse.getStatusLine().getStatusCode() == 200);
    }
}

推荐阅读