feat: Add support for JSONObject with MessagePactBuilder #1669

Author: rholshausen

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/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
    */