fix: Request query gets mangled/encoded when generating V2 pact file #1018

Author: Ronald Holshausen

consumer/pact-jvm-consumer/src/test/groovy/au/com/dius/pact/consumer/dsl/PactDslRequestWithPathSpec.groovy

@@ -39,6 +39,7 @@ class PactDslRequestWithPathSpec extends Specification {
     subject2.requestBody == OptionalBody.body('{"test":true}'.bytes)
   }
 
+  @Issue('#716')
   def 'set the content type header correctly (issue #716)'() {
     given:
     def builder = ConsumerPactBuilder.consumer('spec').hasPactWith('provider')
@@ -107,4 +108,29 @@ class PactDslRequestWithPathSpec extends Specification {
 
   }
 
+  @Issue('#1018')
+  def 'Request query gets mangled/encoded '() {
+    given:
+    def builder = ConsumerPactBuilder.consumer('spec').hasPactWith('provider')
+
+    when:
+    def pact = builder
+      .uponReceiving('a request with query parameters')
+      .path('/')
+      .query('include[]=term&include[]=total_scores&include[]=license&include[]=is_public&include[]=needs_' +
+        'grading_count&include[]=permissions&include[]=current_grading_period_scores&include[]=course_image&' +
+        'include[]=favorites')
+      .willRespondWith()
+      .status(200)
+      .toPact()
+
+    def request = pact.interactions[0].request
+
+    then:
+    request.query == [
+      'include[]': ['term', 'total_scores', 'license', 'is_public', 'needs_grading_count', 'permissions',
+                    'current_grading_period_scores', 'course_image', 'favorites']
+    ]
+  }
+
 }

core/model/src/main/kotlin/au/com/dius/pact/core/model/RequestResponseInteraction.kt

@@ -113,7 +113,7 @@ open class RequestResponseInteraction @JvmOverloads constructor(
 
     private fun mapToQueryStr(query: Map<String, List<String>>): String {
       return query.entries.joinToString("&") { (k, v) ->
-        v.joinToString { "$k=${URLEncoder.encode(it, "UTF-8")}" }
+        v.joinToString("&") { "$k=${URLEncoder.encode(it, "UTF-8")}" }
       }
     }
 

core/model/src/test/groovy/au/com/dius/pact/core/model/PactWriterSpec.groovy

@@ -212,4 +212,36 @@ class PactWriterSpec extends Specification {
     cleanup:
     pactFile.delete()
   }
+
+  @Issue('#1018')
+  def 'encode the query parameters correctly with V2 pact files'() {
+    given:
+    def request = new Request('GET', '/', [
+      'include[]': ['term', 'total_scores', 'license', 'is_public', 'needs_grading_count', 'permissions',
+                    'current_grading_period_scores', 'course_image', 'favorites']
+    ])
+    def response = new Response()
+    def interaction = new RequestResponseInteraction('test interaction with query parameters',
+      [], request, response)
+    def pact = new RequestResponsePact(new Provider('PactWriterSpecProvider'),
+      new Consumer('PactWriterSpecConsumer'), [interaction])
+    def sw = new StringWriter()
+    def sw2 = new StringWriter()
+
+    when:
+    DefaultPactWriter.INSTANCE.writePact(pact, new PrintWriter(sw), PactSpecVersion.V2)
+    DefaultPactWriter.INSTANCE.writePact(pact, new PrintWriter(sw2), PactSpecVersion.V3)
+    def json = Json.INSTANCE.toMap(JsonParser.parseString(sw.toString()))
+    def interactionJson = json.interactions.first()
+    def json2 = Json.INSTANCE.toMap(JsonParser.parseString(sw2.toString()))
+    def interactionJson2 = json2.interactions.first()
+
+    then:
+    interactionJson.request.query == 'include[]=term&include[]=total_scores&include[]=license&include[]=is_public' +
+      '&include[]=needs_grading_count&include[]=permissions&include[]=current_grading_period_scores&include[]' +
+      '=course_image&include[]=favorites'
+    interactionJson2.request.query == [
+      'include[]': ['term', 'total_scores', 'license', 'is_public', 'needs_grading_count', 'permissions',
+                    'current_grading_period_scores', 'course_image', 'favorites']]
+  }
 }

core/model/src/test/groovy/au/com/dius/pact/core/model/RequestResponseInteractionSpec.groovy

@@ -3,18 +3,22 @@ package au.com.dius.pact.core.model
 import au.com.dius.pact.core.model.generators.Category
 import au.com.dius.pact.core.model.generators.Generators
 import au.com.dius.pact.core.model.generators.RandomStringGenerator
+import spock.lang.Issue
 import spock.lang.Specification
 import spock.lang.Unroll
 
 class RequestResponseInteractionSpec extends Specification {
 
-  private interaction, generators
+  private RequestResponseInteraction interaction
+  private generators
+  private Request request
 
   def setup() {
     generators = new Generators([(Category.HEADER): [a: new RandomStringGenerator(4)]])
+    request = new Request(generators: generators)
     interaction = new RequestResponseInteraction('test interaction', [
       new ProviderState('state one'), new ProviderState('state two', [value: 'one', other: '2'])],
-      new Request(generators: generators), new Response(generators: generators))
+      request, new Response(generators: generators))
   }
 
   def 'creates a V3 map format if V3 spec'() {
@@ -97,4 +101,19 @@ class RequestResponseInteractionSpec extends Specification {
     [new ProviderState('state 1'), new ProviderState('state 2')] | 'state 1, state 2'
   }
 
+  @Issue('#1018')
+  def 'correctly encodes the query parameters when V2 format'() {
+    given:
+    request.query = ['include[]': ['term', 'total_scores', 'license', 'is_public', 'needs_grading_count', 'permissions',
+                                   'current_grading_period_scores', 'course_image', 'favorites']]
+
+    when:
+    def map = interaction.toMap(PactSpecVersion.V2)
+
+    then:
+    map.request.query == 'include[]=term&include[]=total_scores&include[]=license&include[]=is_public&' +
+      'include[]=needs_grading_count&include[]=permissions&include[]=current_grading_period_scores&' +
+      'include[]=course_image&include[]=favorites'
+  }
+
 }