feat: add support for request filters with MockMvcTarget #983

Author: Ronald Holshausen

provider/pact-jvm-provider-spring/src/main/kotlin/au/com/dius/pact/provider/spring/MvcProviderVerifier.kt

@@ -2,10 +2,15 @@ package au.com.dius.pact.provider.spring
 
 import au.com.dius.pact.core.model.Request
 import au.com.dius.pact.core.model.RequestResponseInteraction
+import au.com.dius.pact.provider.ProviderClient
 import au.com.dius.pact.provider.ProviderInfo
 import au.com.dius.pact.provider.ProviderVerifier
+import groovy.lang.Binding
+import groovy.lang.Closure
+import groovy.lang.GroovyShell
 import mu.KLogging
 import org.apache.commons.lang3.StringUtils
+import org.hamcrest.Matchers.anything
 import org.springframework.http.HttpHeaders
 import org.springframework.http.HttpMethod
 import org.springframework.http.MediaType
@@ -15,16 +20,20 @@ import org.springframework.test.web.servlet.MockMvc
 import org.springframework.test.web.servlet.MvcResult
 import org.springframework.test.web.servlet.RequestBuilder
 import org.springframework.test.web.servlet.ResultActions
+import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders.asyncDispatch
 import org.springframework.test.web.servlet.result.MockMvcResultHandlers
 import org.springframework.test.web.servlet.result.MockMvcResultMatchers.request
 import org.springframework.web.util.UriComponentsBuilder
+import scala.Function1
 import java.net.URI
+import java.util.concurrent.Callable
+import java.util.function.Consumer
+import java.util.function.Function
 import javax.mail.internet.ContentDisposition
 import javax.mail.internet.MimeMultipart
 import javax.mail.util.ByteArrayDataSource
-import org.hamcrest.Matchers.anything
 
 /**
  * Verifies the providers against the defined consumers using Spring MockMvc
@@ -41,7 +50,7 @@ open class MvcProviderVerifier(private val debugRequestResponse: Boolean = false
     try {
       val request = interaction.request
 
-      val mvcResult = executeMockMvcRequest(mockMvc, request)
+      val mvcResult = executeMockMvcRequest(mockMvc, request, provider)
 
       val expectedResponse = interaction.response
       val actualResponse = handleResponse(mvcResult.response)
@@ -56,7 +65,7 @@ open class MvcProviderVerifier(private val debugRequestResponse: Boolean = false
     }
   }
 
-  fun executeMockMvcRequest(mockMvc: MockMvc, request: Request): MvcResult {
+  fun executeMockMvcRequest(mockMvc: MockMvc, request: Request, provider: ProviderInfo): MvcResult {
     val body = request.body
     val requestBuilder = if (body != null && body.isPresent()) {
       if (request.isMultipartFileUpload()) {
@@ -81,11 +90,46 @@ open class MvcProviderVerifier(private val debugRequestResponse: Boolean = false
       MockMvcRequestBuilders.request(HttpMethod.valueOf(request.method), requestUriString(request))
         .headers(mapHeaders(request, false))
     }
-      return performRequest(mockMvc, requestBuilder).andDo({
+
+    executeRequestFilter(requestBuilder, provider)
+
+    return performRequest(mockMvc, requestBuilder).andDo {
       if (debugRequestResponse) {
         MockMvcResultHandlers.print().handle(it)
       }
-    }).andReturn()
+    }.andReturn()
+  }
+
+  private fun executeRequestFilter(requestBuilder: MockHttpServletRequestBuilder, provider: ProviderInfo) {
+    val requestFilter = provider.requestFilter
+    if (requestFilter != null) {
+      when (requestFilter) {
+        is Closure<*> -> requestFilter.call(requestBuilder)
+        is Function1<*, *> -> (requestFilter as Function1<MockHttpServletRequestBuilder, *>).apply(requestBuilder)
+        is org.apache.commons.collections4.Closure<*> ->
+          (requestFilter as org.apache.commons.collections4.Closure<Any>).execute(requestBuilder)
+        else -> {
+          if (ProviderClient.isFunctionalInterface(requestFilter)) {
+            invokeJavaFunctionalInterface(requestFilter, requestBuilder)
+          } else {
+            val binding = Binding()
+            binding.setVariable(ProviderClient.REQUEST, requestBuilder)
+            val shell = GroovyShell(binding)
+            shell.evaluate(requestFilter as String)
+          }
+        }
+      }
+    }
+  }
+
+  private fun invokeJavaFunctionalInterface(functionalInterface: Any, requestBuilder: MockHttpServletRequestBuilder) {
+    when (functionalInterface) {
+      is Consumer<*> -> (functionalInterface as Consumer<MockHttpServletRequestBuilder>).accept(requestBuilder)
+      is Function<*, *> -> (functionalInterface as Function<MockHttpServletRequestBuilder, Any?>).apply(requestBuilder)
+      is Callable<*> -> (functionalInterface as Callable<MockHttpServletRequestBuilder>).call()
+      else -> throw IllegalArgumentException("Java request filters must be either a Consumer or Function that " +
+        "takes at least one MockHttpServletRequestBuilder parameter")
+    }
   }
 
   private fun performRequest(mockMvc: MockMvc, requestBuilder: RequestBuilder): ResultActions {

provider/pact-jvm-provider-spring/src/main/kotlin/au/com/dius/pact/provider/spring/target/MockMvcTarget.kt

@@ -12,9 +12,9 @@ import au.com.dius.pact.provider.junit.TargetRequestFilter
 import au.com.dius.pact.provider.junit.target.BaseTarget
 import au.com.dius.pact.provider.junit.target.Target
 import au.com.dius.pact.provider.spring.MvcProviderVerifier
-import org.apache.http.HttpRequest
 import org.springframework.http.converter.HttpMessageConverter
 import org.springframework.test.web.servlet.MockMvc
+import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders
 import org.springframework.test.web.servlet.setup.MockMvcBuilders.standaloneSetup
 import org.springframework.test.web.servlet.setup.StandaloneMockMvcBuilder
@@ -69,7 +69,7 @@ class MockMvcTarget @JvmOverloads constructor(
 
     val failures = HashMap<String, Any>()
 
-    1.rangeTo(runTimes).forEach {
+    repeat(1.rangeTo(runTimes).count()) {
       verifier.verifyResponseFromProvider(provider, interaction as RequestResponseInteraction, interaction.description,
         failures, mockMvc)
     }
@@ -131,7 +131,7 @@ class MockMvcTarget @JvmOverloads constructor(
 
     val methods = testClass.getAnnotatedMethods(TargetRequestFilter::class.java)
     if (methods.isNotEmpty()) {
-      providerInfo.requestFilter = Consumer<HttpRequest> { httpRequest ->
+      providerInfo.requestFilter = Consumer<MockHttpServletRequestBuilder> { httpRequest ->
         methods.forEach { method ->
           try {
             method.invokeExplosively(testTarget, httpRequest)

provider/pact-jvm-provider-spring/src/test/groovy/au/com/dius/pact/provider/spring/MvcProviderVerifierSpec.groovy

@@ -2,6 +2,7 @@ package au.com.dius.pact.provider.spring
 
 import au.com.dius.pact.core.model.OptionalBody
 import au.com.dius.pact.core.model.Request
+import au.com.dius.pact.provider.ProviderInfo
 import org.springframework.test.web.servlet.MockMvc
 import org.springframework.web.bind.annotation.RequestBody
 import org.springframework.web.bind.annotation.RequestMapping
@@ -41,7 +42,7 @@ class MvcProviderVerifierSpec extends Specification {
     def request = new Request(body: OptionalBody.body(body.bytes))
 
     when:
-    def response = verifier.executeMockMvcRequest(mockMvc, request)
+    def response = verifier.executeMockMvcRequest(mockMvc, request, new ProviderInfo())
 
     then:
     response.response.contentType == 'text/plain;charset=ISO-8859-1'
@@ -53,7 +54,7 @@ class MvcProviderVerifierSpec extends Specification {
     def request = new Request()
 
     when:
-    def response = verifier.executeMockMvcRequest(mockMvc, request)
+    def response = verifier.executeMockMvcRequest(mockMvc, request, new ProviderInfo())
 
     then:
     response.response.contentType == null
@@ -65,7 +66,7 @@ class MvcProviderVerifierSpec extends Specification {
     def request = new Request(path: '/upload').withMultipartFileUpload('file', 'filename', 'text/csv', 'file,contents')
 
     when:
-    def response = verifier.executeMockMvcRequest(mockMvc, request)
+    def response = verifier.executeMockMvcRequest(mockMvc, request, new ProviderInfo())
 
     then:
     response.response.contentType == 'text/plain;charset=ISO-8859-1'

provider/pact-jvm-provider-spring/src/test/groovy/au/com/dius/pact/provider/spring/target/MockMvcTargetSpec.groovy

@@ -3,7 +3,11 @@ package au.com.dius.pact.provider.spring.target
 import au.com.dius.pact.core.model.RequestResponseInteraction
 import au.com.dius.pact.core.model.UnknownPactSource
 import au.com.dius.pact.provider.junit.Provider
+import au.com.dius.pact.provider.junit.TargetRequestFilter
+import groovy.transform.CompileStatic
 import org.junit.runners.model.TestClass
+import org.springframework.http.MediaType
+import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder
 import org.springframework.web.bind.annotation.RequestMapping
 import org.springframework.web.bind.annotation.RestController
 import spock.lang.Specification
@@ -14,11 +18,20 @@ class MockMvcTargetSpec extends Specification {
   private MockMvcTarget mockMvcTarget
 
   @RestController
-  class TestController {
+  static class TestController {
     @RequestMapping('/')
     String test() { 'test' }
   }
 
+  @Provider('testProvider')
+  @CompileStatic
+  static class TestClassWithFilter {
+    @TargetRequestFilter
+    void requestFilter(MockHttpServletRequestBuilder request) {
+      request.header('X-Content-Type', MediaType.APPLICATION_ATOM_XML)
+    }
+  }
+
   def setup() {
     mockMvcTarget = new MockMvcTarget()
   }
@@ -38,4 +51,19 @@ class MockMvcTargetSpec extends Specification {
     1 * controller.test()
   }
 
+  def 'invokes any request filter'() {
+    given:
+    def testInstance = Spy(TestClassWithFilter)
+    mockMvcTarget.setTestClass(new TestClass(TestClassWithFilter), testInstance)
+    def interaction = new RequestResponseInteraction('Test Interaction')
+    def controller = Mock(TestController)
+    mockMvcTarget.controllers = [ controller ]
+
+    when:
+    mockMvcTarget.testInteraction('testConsumer', interaction, UnknownPactSource.INSTANCE, [:])
+
+    then:
+    1 * testInstance.requestFilter(_)
+  }
+
 }

provider/pact-jvm-provider/src/main/kotlin/au/com/dius/pact/provider/ProviderClient.kt

@@ -198,7 +198,7 @@ open class ProviderClient(
     fun urlEncodedFormPost(request: Request) = request.method.toLowerCase() == "post" &&
       request.mimeType() == ContentType.APPLICATION_FORM_URLENCODED.mimeType
 
-    private fun isFunctionalInterface(requestFilter: Any) =
+    fun isFunctionalInterface(requestFilter: Any) =
       requestFilter::class.java.interfaces.any { it.isAnnotationPresent(FunctionalInterface::class.java) }
 
     @JvmStatic