I think the current layout is too flat, since once a jar is unpacked or inserted on a classpath there is no way to tell the origin of the contracts and mappings. My proposal is /META-INF/[mappings,contracts]/<groupId>/<artifactId>/<version>/* instead of /[mappings,contracts]/*. Note that WireMock already knows natively how to register stubs from a directory containing /mappings/** (that's why we want that at the top of the path).

P.S. I know we don't add stubs to any classpath in the stub runner, but it's a jar file in a Maven repo, so it's easy to do, and could be used to run Wiremock "manually" without the stub runner.

Moved from Codearte/accurest#205

For the case where the consumer wants to prototype the API it would be good for them to immediately install and run stubs from the contracts.

E.g. installing

spring cloud contract install /Users/path/to/contracts/ 'groupid.a.b.c' 'artifactid.d.e.f' '1.0.0.BUILD-SNAPSHOT'

E.g. running

spring cloud contract run /Users/path/to/contracts/ 'groupid.a.b.c' 'artifactid.d.e.f' '1.0.0.BUILD-SNAPSHOT'

https://cloud.spring.io/spring-cloud-contract/spring-cloud-contract.html#_dynamic_properties

There is a potentially confusing portion in the first example under the regular expressions heading.

                surname: $(
                        consumer('Kowalsky'),
                        producer('Lewandowski')
                ),

The producer value should probably be an alpha regex instead of a concrete value.

current groupid is inconsistent

From @making on May 4, 2016 6:44

I'd like to test plain text response but it does not support regex, optional, execute and so on.

For example,

io.codearte.accurest.dsl.GroovyDsl.make {
    request {
        method 'GET'
        urlPath '/'
    }
    response {
        status 200
        body(value(
                client('123'),
                server(regex('[0-9]+'))
        ))
        headers {
            header('Content-Type': 'text/plain;charset=ISO-8859-1')
        }
    }
}

generates

    @Test
    public void validate_shouldSayHello() throws Exception {
        // given:
            MockMvcRequestSpecification request = given();

        // when:
            ResponseOptions response = given().spec(request)
                    .get("/");

        // then:
            assertThat(response.statusCode()).isEqualTo(200);
            assertThat(response.header("Content-Type")).isEqualTo("text/plain;charset=ISO-8859-1");
        // and:
            Object responseBody = (response.getBody().asString());
            assertThat(responseBody).isEqualTo("[0-9]+"); // .matches(...) is expected 😩 
    }

Of course, JSON response works well

io.codearte.accurest.dsl.GroovyDsl.make {
    request {
        method 'GET'
        urlPath '/'
    }
    response {
        status 200
        body(id : value(
                client('123'),
                server(regex('[0-9]+'))
        ))
        headers {
            header('Content-Type': 'application/json;charset=UTF-8')
        }
    }
}

generates

    @Test
    public void validate_shouldSayHello() throws Exception {
        // given:
            MockMvcRequestSpecification request = given();

        // when:
            ResponseOptions response = given().spec(request)
                    .get("/");

        // then:
            assertThat(response.statusCode()).isEqualTo(200);
            assertThat(response.header("Content-Type")).isEqualTo("application/json;charset=UTF-8");
        // and:
            DocumentContext parsedJson = JsonPath.parse(response.getBody().asString());
            assertThatJson(parsedJson).field("id").matches("[0-9]+"); // 😀
    }

Copied from original issue: Codearte/accurest#263

From @marcingrzejszczak on February 1, 2015 9:6

Let's add possibility for people to add transformations to other things than Wiremock stubs or test code. There are other Http stub servers like Moco Mountback (don't remember if spelled it correctly) etc.

Copied from original issue: Codearte/accurest#8

Currently it is possible only in configuration level (Maven or Gradle) and it'll be good to have it as a particular contract property

When we're skipping tests we don't want to generate and compile any test classes

From @marcingrzejszczak on July 6, 2016 9:54

Check this out: spring-attic/spring-integration-java-dsl#91 (comment)

Copied from original issue: Codearte/accurest#294

From @marcingrzejszczak on June 27, 2016 20:59

Copied from original issue: Codearte/accurest#291

Some common combinations of dependencies can be supported via starters, in the usual Spring Boot way. In particular the wiremock and stub runner combos. See #39.

Currently we're producing WireMock snippets. It would be nice to produce also the Groovy DSL.

For example you can do value(consumer(regex('[2-9][0-9]'))) but not $(consumer(regex('[2-9][0-9]')))

From @marcingrzejszczak on June 22, 2016 14:34

Copied from original issue: Codearte/accurest#290

From @jkubrynski on May 12, 2015 11:13

Copied from original issue: Codearte/accurest#65

Feedback from @fitzoh:

So you’re introduced to those blocks, then you scroll down a page or two, then they’re referenced again
It says they’re injected, so the first thing I do is look for a variable containing them which has been injected
So I scroll back and forth a couple times (across a lot of real estate), then realize that it’s value is included in the strings
But you need to look closely to see what maps to what
As there’s no example in the block that says “This thing is from the consumer block referenced earlier"
It could use some annotated lines to more clearly specify that “this thing is a result of that thing"
Here’s an example of what I have in mind from some internal pact documentation I wrote

https://files.gitter.im/spring-cloud/spring-cloud-contract/Screen-Shot-2016-07-25-at-1.23.57-PM.png

if only client or server is passed in request / response then some data can be generated

Consumers could publish their expectations (contracts to a repo). If a consumer (let's call him barClient) wants a server (groupid : a.b.c, artifactid: fooServer) to behave in a certain manner he could push the contract to some Git repository (e.g. under the folder /a/b/c/fooServer/barClient-expectations) or publish the jar (e.g. a.b.c:barClient:fooServer-expectations-stubs).

Then the server side could provide the URL of the repo or switch to JAR based approach to download the contracts / find the proper folder (e.g. groupId/artifactId) and generate the tests for those expectations. Only after the tests pass can the server publish its stubs. Also if your tests fail you will know ultimately which consumer you break.

cc @olivergierke

You could provide in the annotation on the tests which stubs you would like to have downloaded

From @jkubrynski on December 4, 2015 8:56

Setup embedded wiremock instance in unit tests based on Accurest DSL contracts

Copied from original issue: Codearte/accurest#184

From @mchmielarz on February 24, 2016 20:42

It would be quite useful to have possibility to do regular expression on whole response body returning for server side. Here is my case:

io.codearte.accurest.dsl.GroovyDsl.make {
    request {
        method('POST')
        url(PATH)
        headers {
            header("Content-Type": FORM_CONTENT_TYPE)
        }
        body(
                """field=${value(client("something"), server("else"))}"""
        )
    }
    response {
        status 400
        body (value(client("Processing failed with 400 status."), server(regex(".*400.*"))))
    }
}

I want to return 400 in a body of the client stub. And that's ok actually. On the other hand for server tests I'm able to generate such status by sending malformed request. In this case body will contain some standard HTML with 400 added somewhere in between. Regex in such case will free me from pasting whole HTML in stub definition.

Copied from original issue: Codearte/accurest#199

http://cloud.spring.io/spring-cloud-contract/

[] - Change client / server to consumer / producer
[] - Change the intro snippets to use consumer / producer

We're doing the hacks to convert regex from GString into a placeholder and then we try to convert them back as JSONs. Everything works fine if we have string values with regex. The problem occurs when using ints and creating stubs.

Example

org.springframework.cloud.contract.spec.Contract.make {
        request {
          method 'POST'
          url '/check'
          body("""
          {
          "name":"${value(consumer(regex('[a-zA-Z]+')))}",
          "age": ${value(consumer(regex('[3-9][0-9]|2[2-9]')))}
        }
        """
          )
        }
        response {
          status 200
          body( """{
              "status": "OK"
            }"""
          )
          headers {
            header 'Content-Type', 'application/json'
          }
        }
      }

gets temporarily converted to:

          {
          "name":"REGEXP>>[a-zA-Z]+<<",
          "age": REGEXP>>[3-9][0-9]|2[2-9]<<
        }

This part can't be parsed as JSON.

Things to look at:

• org.springframework.cloud.contract.verifier.util.ContentUtils#extractValueForJSON
• https://github.com/spring-cloud/spring-cloud-contract/tree/issues_50_regex_gstring_int

From @jkubrynski on May 12, 2015 11:13

Copied from original issue: Codearte/accurest#64

Make all messaging / http related stuff conditional

From @mzielinski on April 10, 2016 11:1

Assume that we have below response from server

{
   "exp": 2459982033,
   "user_name": "admin",
   "authorities": [
       "ROLE_ADMIN"
   ],
   "client_id": "ui",
   "scope": [
       "read",
       "write"
   ]
}

I would like to check wheather scope array is not empty. I do not care about specific values. Currently I am not able to do it. For sure we should improve support for arrays in body, maybe this task will be a good place to think about it.

Copied from original issue: Codearte/accurest#217

Atom Feed - https://github.com/marcingrzejszczak/atom-feed
Github analytics - https://github.com/dsyer/github-analytics/

From @hator on July 5, 2016 15:14

For input:

response {
    status 200
    body( content: [
        value(
            id: 'article_accurest::1',
            tags: ['tag1', 'tag2', 'tag3']
        ), value (
            id: 'article_accurest::2',
            tags: ['tag1', 'tag2', 'tag3']
        )
])}

Generated:

DocumentContext parsedJson = JsonPath.parse(response.body.asString())
assertThatJson(parsedJson).array("content").array("tags").hasSize(3)

The problem is that using Json path <$.content[*].tags[*]> all elements of all tags arrays are counted giving total of 6 instead of 3. This of course causes tests to fail.

Copied from original issue: Codearte/accurest#293

I think it will lead to problems at some point if we use regular autoconfig to install features in tests (they might leak into the app at runtime in an IDE for instance). It's better to use a custom annotation or something (e.g. see @ImportAutoConfiguration etc. in Spring Boot 1.4).

From @marcingrzejszczak on May 13, 2015 19:33

Copied from original issue: Codearte/accurest#69

From @cbuleandra on March 21, 2015 21:32

It is not currently possible to use the Groovy DSL for creating stub definitions with request bodies that accept optional parameters. It would be nice if something like this could be defined using the Groovy DSL:

${$(client(~/('loanNumber': '[0-9]+')?/), server('"loanNumber": 321'))}

This should then result in the following stub definition:

"bodyPatterns": [
    { "matches": "\\{(\"loanNumber\":\"[0-9]+\")?\\}" }
]

I guess nothing should have to change on the acceptance tests generation part.

What do you think? If you're ok with this idea, I could start working on a pull request in the following days.

Copied from original issue: Codearte/accurest#42

From @jakubnabrdalik on July 5, 2016 13:21

In my contract I do "get" on a resource, but I have no hard-coded id. I need to have a generated id (object created before test and saved to mongo) so I can run tests concurrently without interference. During runtime the id is available in the base class, but I cannot hardcode it in the contract Groovy. So in other words, I need to execute a method, in URL part, like this:

org.springframework.cloud.contract.spec.Contract.make {
    request {
        method 'GET'
        url $(client(regex('/api/articles/.*')), server(execute('getArticleId()')))
        headers {
            header 'Content-Type': 'application/json;charset=UTF-8'
        }
    }

But instead of creating a call to getArticleId() this snippet generates a toString on ExecutionProperty, like so:

def validate_shouldFetchArticle() throws Exception {
        given:
            def request = given()
                    .header('Content-Type', 'application/json;charset=UTF-8')

        when:
            def response = given().spec(request)
            .get("org.springframework.cloud.contract.spec.internal.ExecutionProperty@26d445e9")

Can you make it possible to use "execute" in url as well? The documentation doesn't give that example but also suggests it should be possible.

Copied from original issue: Codearte/accurest#292

I can't see any implementations of this interface or any calls to its method. Also no uses of MessageNotMatchingException.