当正文为列表时,Spring Cloud Contract会生成带有空白正文的契约

问题描述 投票:0回答:1

我正在尝试根据documentation所示的春季云合同生成合同。它只能在响应正文根是json时找到,但是当我尝试生成返回jsons数组的协定时,它将生成一个空的正文。我尝试使用具有字符串格式"""[{}...]"""的groovy dsl和DslProperty [value()...]。这是我的合同:

使用字符串格式

Contract.make {
description "should return a list of dummy object with dummy value. Generates pact with empty json"
request {
    method GET()
    url("/dummy")
}
response {
    body("""[{"value": "Hi! I'm a dummy object ;)"}]""")
    headers {
        contentType applicationJson()
    }
    status 200
}}

具有DslProperty

Contract.make {
description "should return a list of dummy object with dummy value. Generates pact with empty body list"
request {
    method GET()
    url("/dummy")
}
response {
    body([value(value: "Hi! I'm a dummy object ;)")])
    headers {
        contentType applicationJson()
    }
    status 200
}}

这就是在目标/位置生成的文件

{
"provider": {
    "name": "Provider"
},
"consumer": {
    "name": "Consumer"
},
"interactions": [
    {
        "description": "should return a list of dummy object with dummy value. Generates pact with empty body list",
        "request": {
            "method": "GET",
            "path": "/dummy"
        },
        "response": {
            "status": 200,
            "headers": {
                "Content-Type": "application/json"
            },
            "body": [

            ],
            "matchingRules": {
                "header": {
                    "Content-Type": {
                        "matchers": [
                            {
                                "match": "regex",
                                "regex": "application/json.*"
                            }
                        ],
                        "combine": "AND"
                    }
                }
            }
        }
    },
    {
        "description": "should return a list of dummy object with dummy value. Generates pact with empty json",
        "request": {
            "method": "GET",
            "path": "/dummy"
        },
        "response": {
            "status": 200,
            "headers": {
                "Content-Type": "application/json"
            },
            "body": {

            },
            "matchingRules": {
                "header": {
                    "Content-Type": {
                        "matchers": [
                            {
                                "match": "regex",
                                "regex": "application/json.*"
                            }
                        ],
                        "combine": "AND"
                    }
                }
            }
        }
    }
],
"metadata": {
    "pactSpecification": {
        "version": "3.0.0"
    },
    "pact-jvm": {
        "version": "3.5.23"
    }
}}

我正在使用以下版本

    <spring-cloud.version>Hoxton.BUILD-SNAPSHOT</spring-cloud.version>
    <spring-cloud-contract.version>2.0.1.RELEASE</spring-cloud-contract.version>
    <pact-jvm-provider-maven.version>3.5.23</pact-jvm-provider-maven.version>

这是我的插件配置

<!-- SCC to pact see https://cloud.spring.io/spring-cloud-contract/reference/html/howto.html#how-to-generate-pact-from-scc-->
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <version>1.6.0</version>
            <executions>
                <execution>
                    <id>convert-dsl-to-pact</id>
                    <phase>process-test-classes</phase>
                    <configuration>
                        <classpathScope>test</classpathScope>
                        <mainClass>
                            org.springframework.cloud.contract.verifier.util.ToFileContractsTransformer
                        </mainClass>
                        <arguments>
                            <argument>
                                org.springframework.cloud.contract.verifier.spec.pact.PactContractConverter
                            </argument>
                            <argument>${project.basedir}/target/pacts</argument>
                            <argument>
                                ${project.basedir}/src/test/resources/contracts
                            </argument>
                        </arguments>
                    </configuration>
                    <goals>
                        <goal>java</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>

通过插件调试时,我分别看到发生了什么:-将body声明为“”” [{...}] “””时,Pact转换器假定该body是String实例,因此它将通过org.springframework.cloud.contract.verifier.spec.pact.BodyConverter处的遍历方法。并且由于它以[开头,因此无法解析。

org.springframework.cloud.contract.verifier.spec.pact.BodyConverter

private static DslPart traverse(Object value, DslPart parent, Closure dslPropertyValueExtractor) {
    ...
    if (v instanceof String) {
        v = v.trim()
        if (v.startsWith("{") && v.endsWith("}")) {
            try {
                v = jsonSlurper.parseText(v as String)
            }
            catch (JsonException ex) { /*it wasn't a JSON string after all...*/
            }
        }
    }
    ...

另一方面,当使用DslProperty浏览插件代码时,我有一个像[DslProperty{clientValue=DslProperty}]的对象。正在提取第一个DslProperty,但是由于内容是另一个DslProperty,并且没有递归提取,所以我最终得到一个空的正文,因为v不是GstringStringNumberMap的实例],Collection。所以我又得到了一个空的身体。

org.springframework.cloud.contract.verifier.spec.pact.BodyConverter

    private static void processCollection(Collection values, PactDslJsonArray jsonArray, Closure dslPropertyValueExtractor) {
    values.forEach({
        Object v = it
        if (v instanceof DslProperty) {
            v = dslPropertyValueExtractor(v)
        }
        if (v instanceof GString) {
            v = ContentUtils.extractValue(v, dslPropertyValueExtractor)
        }
        if (v == null) {
            jsonArray.nullValue()
        }
        else if (v instanceof String) {
            jsonArray.string(v)
        }
        else if (v instanceof Number) {
            jsonArray.number(v)
        }
        else if (v instanceof Map) {
            PactDslJsonBody current = jsonArray.object()
            traverse(v, current, dslPropertyValueExtractor)
            current.closeObject()
        }
        else if (v instanceof Collection) {
            PactDslJsonArray current = jsonArray.array()
            traverse(v, current, dslPropertyValueExtractor)
            current.closeArray()
        }
    })
}

[我已经在https://github.com/brjt23/contract-to-pact/tree/master发布了一个示例,以防需要更多有关如何构建项目的信息。

在定义常规合同文件时我做错什么了吗?我想我误解了应如何定义响应主体。

pact spring-cloud-contract
1个回答
0
投票

您需要像这样在您的体内创建一个普通的对象数组:

body([ [value: "Object1"], [value: "Object2"] ])

这样,春季云合同将为您的合同生成正确的代码。

© www.soinside.com 2019 - 2024. All rights reserved.