Spring Cloud Contract генерирует пакты с пустым телом, когда тело является списком - PullRequest
0 голосов
/ 24 апреля 2020

Я пытаюсь сгенерировать пакты из весенних облачных контрактов, как показано в документации . Это работает просто найти, когда тело ответа root является 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
}}

И этот файл генерируется в target / pacts

{
"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>

Во время отладки через плагин я видел, что происходит соответственно: - Когда объявление тела как “”” [{...}] “”” Преобразователь Pact предполагает, что тело является экземпляром String, поэтому он проходит через метод обхода на org.springframework.cloud.contract.verifier.spec.pact.BodyConverter. И поскольку он начинается с [, он не анализируется.

org.springframework.cloud.contract.verifier.spe c .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 не является экземпляром Gstring, String, Number, Map, Collection. Так что я снова получаю пустое тело.

org.springframework.cloud.contract.verifier.spe c .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 в case требуется дополнительная информация о том, как я собрал проект.

Есть ли что-то, что я делаю неправильно при определении моих groovy файлов контракта? Думаю, я что-то не так понял, как определить тело ответа.

1 Ответ

1 голос
/ 27 апреля 2020

Вам необходимо создать массив из groovy объектов в вашем теле следующим образом:

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

Таким образом, весенние облачные контракты будут генерировать правильный код, необходимый для ваших контрактов.

...