Merge branch 'v4.4.x' into v4.5.x

Author: rholshausen

CHANGELOG.md

@@ -1,5 +1,14 @@
 To generate the log, run `git log --pretty='* %h - %s (%an, %ad)'  TAGNAME..HEAD` replacing TAGNAME and HEAD as appropriate.
 
+# 4.4.7 - Maintenance Release
+
+* 5bc8bc683 - fix: PactVerificationExtension will fail when used with other extensions in a static context #1666 (Ronald Holshausen, Fri Feb 24 12:41:00 2023 +1100)
+* 3010a102b - feat: Add support for JSONObject with MessagePactBuilder #1669 (Ronald Holshausen, Fri Feb 24 11:59:17 2023 +1100)
+* 2a9ac69db - doc: add example using MessagePactBuilder with string content #1669 (Ronald Holshausen, Fri Feb 24 11:31:08 2023 +1100)
+* e297ef757 - chore: update versions in readme (Ronald Holshausen, Wed Feb 15 17:52:32 2023 +1100)
+* 8e125575f - chore: Update JUnit5 readme (Ronald Holshausen, Wed Feb 15 17:02:12 2023 +1100)
+* 0ca80c4b6 - bump version to 4.4.7 (Ronald Holshausen, Wed Feb 15 17:01:23 2023 +1100)
+
 # 4.5.0-beta.1 - Maintenance Release
 
 * 63559b887 - Merge branch 'master' into v4.5.x (Ronald Holshausen, Wed Feb 15 17:16:53 2023 +1100)

README.md

@@ -46,12 +46,15 @@ and in the [Pact-JVM wiki](https://github.com/DiUS/pact-jvm/wiki). [Stack Overfl
 
 ## Supported JDK and specification versions:
 
-| Branch                                                                 | Specification | JDK  | Kotlin Version | Latest Version | Notes                                  |
-|------------------------------------------------------------------------|---------------|------|----------------|----------------|----------------------------------------|
-| [4.5.x](https://github.com/DiUS/pact-jvm/blob/v4.5.x/README.md)        | V4 + plugins  | 11+  | 1.7.20         | 4.5.0-beta.0   |                                        |
-| [4.4.x](https://github.com/DiUS/pact-jvm/blob/v4.4.x/README.md) master | V4 + plugins  | 11+  | 1.6.21         | 4.4.3          |                                        |
-| [4.3.x](https://github.com/DiUS/pact-jvm/blob/v4.3.x/README.md)        | V4            | 11+  | 1.6.21         | 4.3.19         | [Upgrade notes](./upgrade-to-4.3.x.md) |
-| [4.1.x](https://github.com/DiUS/pact-jvm/blob/v4.1.x/README.md)        | V3            | 8-12 | 1.3.72         | 4.1.41         |                                        |
+| Branch                                                                 | Specification | JDK        | Kotlin Version | Latest Version | Notes                                  |
+|------------------------------------------------------------------------|---------------|------------|----------------|----------------|----------------------------------------|
+| [4.5.x](https://github.com/DiUS/pact-jvm/blob/v4.5.x/README.md)        | V4 + plugins  | 11+/17+(1) | 1.7.20         | 4.5.0-beta.1   |                                        |
+| [4.4.x](https://github.com/DiUS/pact-jvm/blob/v4.4.x/README.md) master | V4 + plugins  | 11+        | 1.6.21         | 4.4.6          |                                        |
+| [4.3.x](https://github.com/DiUS/pact-jvm/blob/v4.3.x/README.md)        | V4            | 11+        | 1.6.21         | 4.3.19         | [Upgrade notes](./upgrade-to-4.3.x.md) |
+| [4.1.x](https://github.com/DiUS/pact-jvm/blob/v4.1.x/README.md)        | V3            | 8-12       | 1.3.72         | 4.1.41         |                                        |
+
+**Notes:**
+* **1:** Spring6 support library requires JDK 17+. The rest of Pact-JVM libs require 11+.
 
 ### Previous versions (not actively supported)
 

consumer/README.md

@@ -14,7 +14,7 @@ The library is available on maven central using:
 
 * group-id = `au.com.dius.pact`
 * artifact-id = `consumer`
-* version-id = `4.2.x`
+* version-id = `4.4.x`
 
 ## DSL Usage
 
@@ -506,14 +506,14 @@ When you come accross the `body()` method of `PactDslWithProvider` builder start
 The call to `LambdaDsl` replaces the call to instance `new PactDslJsonArray()` and `new PactDslJsonBody()` of the pact library.
 
 ```java
-io.pactfoundation.consumer.dsl.LambdaDsl.*
+au.com.dius.pact.consumer.dsl.LambdaDsl.*
 ```
 
 ### Response body as json array
 
 ```java
 
-import static io.pactfoundation.consumer.dsl.LambdaDsl.newJsonArray;
+import static au.com.dius.pact.consumer.dsl.LambdaDsl.newJsonArray;
 
 ...
 
@@ -534,7 +534,7 @@ builder.given("some state")
 
 ```java
 
-import static io.pactfoundation.consumer.dsl.LambdaDsl.newJsonBody;
+import static au.com.dius.pact.consumer.dsl.LambdaDsl.newJsonBody;
 
 ...
 

consumer/junit/src/test/groovy/au/com/dius/pact/consumer/junit/MessagePactBuilderSpec.groovy

@@ -9,6 +9,7 @@ import au.com.dius.pact.core.model.generators.DateTimeGenerator
 import au.com.dius.pact.core.model.messaging.Message
 import groovy.json.JsonSlurper
 import groovy.xml.XmlParser
+import org.json.JSONObject
 import spock.lang.Issue
 import spock.lang.Specification
 import spock.lang.Unroll
@@ -218,4 +219,22 @@ class MessagePactBuilderSpec extends Specification {
     message.contents.valueAsString() == 'a=b&c=d'
     message.contents.contentType.toString() == 'application/x-www-form-urlencoded'
   }
+
+  @Issue('#1669')
+  def 'support content with JSONObject'() {
+    given:
+    JSONObject jsonObject = new JSONObject().put('JSON', 'Hello, World!')
+
+    when:
+    def pact = new MessagePactBuilder()
+      .consumer('MessagePactBuilderSpec')
+      .expectsToReceive('a message with text contents')
+      .withContent(jsonObject)
+      .toPact()
+    Message message = pact.interactions.first()
+
+    then:
+    message.contents.valueAsString() == '{"JSON":"Hello, World!"}'
+    message.contents.contentType.toString() == 'application/json'
+  }
 }

consumer/junit5/README.md

@@ -9,7 +9,7 @@ The library is available on maven central using:
 
 * group-id = `au.com.dius.pact.consumer`
 * artifact-id = `junit5`
-* version-id = `4.2.X`
+* version-id = `4.4.X`
 
 ## Usage
 
@@ -234,6 +234,26 @@ message queue or topic as a notification or event. With Pact tests, we will be t
 works with the messages setup as the expectations in test. This should be the message handler code that processes the
 actual messages that come off the message queue in production.
 
+For example:
+
+```java
+builder.given("Some Provider State")
+    .expectsToReceive("a test message")
+    .withContent("{\"value\": \"test\"}")
+    .toPact();
+```
+
+or using a Dsl object:
+
+```java
+builder.given("Some Provider State")
+    .expectsToReceive("a test message")
+    .withContent(new PactDslJsonBody()
+      .stringValue("testParam1", "value1")
+      .stringValue("testParam2", "value2"))
+    .toPact();
+```
+
 You can use either the V3 Message Pact or the V4 Asynchronous Message interaction to test these types of interactions.
 
 For a V3 message pact example, see [AsyncMessageTest](https://github.com/pact-foundation/pact-jvm/blob/ac6a0eae0b18183f6f453eafddb89b90741ace42/consumer/junit5/src/test/java/au/com/dius/pact/consumer/junit5/AsyncMessageTest.java).
@@ -256,7 +276,7 @@ builder.given("SomeProviderState")
         md.add("metadata3", 10L);
         md.matchRegex("partitionKey", "[A-Z]{3}\\d{2}", "ABC01");
     })
-    .withContent(body)
+    .withContent("{\"value\": \"test\"}")
     .toPact();
 ```
 

consumer/src/main/kotlin/au/com/dius/pact/consumer/MessagePactBuilder.kt

@@ -18,6 +18,7 @@ import au.com.dius.pact.core.model.generators.Category
 import au.com.dius.pact.core.model.messaging.Message
 import au.com.dius.pact.core.model.messaging.MessagePact
 import au.com.dius.pact.core.model.v4.MessageContents
+import org.json.JSONObject
 import java.util.Locale
 
 /**
@@ -163,7 +164,7 @@ class MessagePactBuilder @JvmOverloads constructor(
    */
   fun withContent(body: DslPart): MessagePactBuilder {
     if (messages.isEmpty()) {
-      throw InvalidPactException("expectsToReceive is required before withMetaData")
+      throw InvalidPactException("expectsToReceive is required before withContent")
     }
 
     val message = messages.last()
@@ -197,7 +198,7 @@ class MessagePactBuilder @JvmOverloads constructor(
    */
   fun withContent(xmlBuilder: PactXmlBuilder): MessagePactBuilder {
     if (messages.isEmpty()) {
-      throw InvalidPactException("expectsToReceive is required before withMetaData")
+      throw InvalidPactException("expectsToReceive is required before withContent")
     }
 
     val message = messages.last()
@@ -231,7 +232,7 @@ class MessagePactBuilder @JvmOverloads constructor(
   @JvmOverloads
   fun withContent(contents: String, contentType: String = "text/plain"): MessagePactBuilder {
     if (messages.isEmpty()) {
-      throw InvalidPactException("expectsToReceive is required before withMetaData")
+      throw InvalidPactException("expectsToReceive is required before withContent")
     }
 
     val message = messages.last()
@@ -247,6 +248,35 @@ class MessagePactBuilder @JvmOverloads constructor(
     return this
   }
 
+  /**
+   * Adds the JSON body as the message content
+   */
+  fun withContent(json: JSONObject): MessagePactBuilder {
+    if (messages.isEmpty()) {
+      throw InvalidPactException("expectsToReceive is required before withContent")
+    }
+
+    val message = messages.last()
+    val metadata = message.contents.metadata.toMutableMap()
+    val contentTypeEntry = metadata.entries.find {
+      it.key.lowercase() == "contenttype" || it.key.lowercase() == "content-type"
+    }
+
+    var contentType = ContentType.JSON
+    if (contentTypeEntry == null) {
+      metadata["contentType"] = contentType.toString()
+    } else {
+      contentType = ContentType(contentTypeEntry.value.toString())
+    }
+
+    message.contents = message.contents.copy(
+      contents = OptionalBody.body(json.toString().toByteArray(contentType.asCharset()), contentType),
+      metadata = metadata
+    )
+
+    return this
+  }
+
   /**
    * Terminates the DSL and builds a pact to represent the interactions
    */

provider/junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactVerificationExtension.kt

@@ -73,14 +73,14 @@ open class PactVerificationExtension(
 
   override fun supportsParameter(parameterContext: ParameterContext, extensionContext: ExtensionContext): Boolean {
     val store = extensionContext.getStore(ExtensionContext.Namespace.create("pact-jvm"))
-    val testContext = store.get("interactionContext") as PactVerificationContext
+    val testContext = store.get("interactionContext") as PactVerificationContext?
     return when (parameterContext.parameter.type) {
       Pact::class.java -> true
       Interaction::class.java -> true
-      ClassicHttpRequest::class.java, HttpRequest::class.java -> testContext.target is HttpTestTarget
+      ClassicHttpRequest::class.java, HttpRequest::class.java -> testContext?.target is HttpTestTarget
       PactVerificationContext::class.java -> true
       ProviderVerifier::class.java -> true
-      RequestData::class.java -> testContext.target is PluginTestTarget
+      RequestData::class.java -> testContext?.target is PluginTestTarget
       else -> false
     }
   }

provider/junit5/src/test/java/au/com/dius/pact/provider/junit5/WithRegisteredExtensionTest.java

@@ -0,0 +1,63 @@
+package au.com.dius.pact.provider.junit5;
+
+import au.com.dius.pact.provider.junitsupport.Provider;
+import au.com.dius.pact.provider.junitsupport.State;
+import au.com.dius.pact.provider.junitsupport.loader.PactFolder;
+import org.junit.jupiter.api.extension.Extension;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import org.junit.jupiter.api.extension.ParameterContext;
+import org.junit.jupiter.api.extension.ParameterResolutionException;
+import org.junit.jupiter.api.extension.ParameterResolver;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.junit.jupiter.api.TestTemplate;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static org.hamcrest.Matchers.notNullValue;
+
+@Provider("myAwesomeService")
+@PactFolder("pacts")
+public class WithRegisteredExtensionTest {
+  private static final Logger LOGGER = LoggerFactory.getLogger(WithRegisteredExtensionTest.class);
+
+  @RegisterExtension
+  static final TestDependencyResolver resolverExt = new TestDependencyResolver(/*...*/);
+
+  private final TestDependency dependency;
+
+  public WithRegisteredExtensionTest(TestDependency dependency) {
+    this.dependency = dependency;
+  }
+
+  @TestTemplate
+  @ExtendWith(PactVerificationInvocationContextProvider.class)
+  void test() {
+    assertThat(dependency, is(notNullValue()));
+  }
+
+  @State("state 2")
+  void state2() {
+  }
+
+  @State("default")
+  void stateDefault() {
+  }
+
+  static class TestDependencyResolver implements Extension, ParameterResolver {
+    @Override
+    public boolean supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) throws ParameterResolutionException {
+      return parameterContext.getParameter().getType().isAssignableFrom(TestDependency.class);
+    }
+
+    @Override
+    public Object resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext) throws ParameterResolutionException {
+      return new TestDependency();
+    }
+  }
+
+  static class TestDependency {
+  }
+}