feat(JUnit): allow pact loader to setup from the test class instead o…

…f just annotations
pact-foundation · Aug 2, 2022 · f54ee01 · f54ee01
1 parent afeca40
commit f54ee01
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 10 deletions.
diff --git a/docs/system-properties.md b/docs/system-properties.md
diff --git a/provider/gradle/build.gradle b/provider/gradle/build.gradle
@@ -13,7 +13,7 @@ dependencies {
   testImplementation "junit:junit:${project.junitVersion}"
   testImplementation 'org.mockito:mockito-core:2.28.2'
   testRuntimeOnly "org.junit.vintage:junit-vintage-engine:${project.junit5Version}"
-  testImplementation('org.spockframework:spock-core:2.0-groovy-3.0') {
+  testImplementation('org.spockframework:spock-core:2.0-groovy-2.5') {
     exclude group: 'org.codehaus.groovy'
   }
 }

diff --git a/provider/gradle/src/main/groovy/au/com/dius/pact/provider/gradle/PactVerificationTask.groovy b/provider/gradle/src/main/groovy/au/com/dius/pact/provider/gradle/PactVerificationTask.groovy
@@ -5,13 +5,16 @@ import au.com.dius.pact.provider.ProviderVerifier
 import org.gradle.api.GradleScriptException
 import org.gradle.api.Task
 import org.gradle.api.tasks.GradleBuild
+import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.TaskAction
 
 /**
  * Task to verify a pact against a provider
  */
 class PactVerificationTask extends PactVerificationBaseTask {
+  @Internal
   IProviderVerifier verifier = new ProviderVerifier()
+  @Internal
   GradleProviderInfo providerToVerify
 
   @TaskAction

diff --git a/provider/gradle/src/main/kotlin/au/com/dius/pact/provider/gradle/GradleProviderInfo.kt b/provider/gradle/src/main/kotlin/au/com/dius/pact/provider/gradle/GradleProviderInfo.kt
@@ -186,8 +186,8 @@ open class GradleProviderInfo(override var name: String, val project: Project) :
     return try {
       provider.hasPactsFromPactBrokerWithSelectorsV2(options, pactBrokerUrl, selectors)
     } catch (e: Exception) {
-      val verifyTaskName = PACT_VERIFY.lowercase()
-      if (project.gradle.startParameter.taskNames.any { it.lowercase().contains(verifyTaskName) }) {
+      val verifyTaskName = PACT_VERIFY.toLowerCase()
+      if (project.gradle.startParameter.taskNames.any { it.toLowerCase().contains(verifyTaskName) }) {
         logger.error(e) { "Failed to access Pact Broker" }
         throw e
       } else {

diff --git a/...junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactJUnit5VerificationProvider.kt b/...junit5/src/main/kotlin/au/com/dius/pact/provider/junit5/PactJUnit5VerificationProvider.kt
@@ -3,6 +3,7 @@ package au.com.dius.pact.provider.junit5
 import au.com.dius.pact.core.model.Interaction
 import au.com.dius.pact.core.model.Pact
 import au.com.dius.pact.core.pactbroker.NotFoundHalResponse
+import au.com.dius.pact.core.support.Utils
 import au.com.dius.pact.core.support.expressions.DataType
 import au.com.dius.pact.core.support.expressions.ExpressionParser.parseExpression
 import au.com.dius.pact.core.support.expressions.SystemPropertyResolver
@@ -55,7 +56,7 @@ open class PactVerificationInvocationContextProvider : TestTemplateInvocationCon
     val serviceName = if (providerInfo.isPresent && providerInfo.get().value.isNotEmpty()) {
       parseExpression(providerInfo.get().value, DataType.STRING)?.toString()
     } else {
-      System.getProperty("pact.provider.name")
+      Utils.lookupEnvironmentValue("pact.provider.name")
     }
     if (serviceName.isNullOrEmpty()) {
       throw UnsupportedOperationException("Provider name should be specified by using either " +

diff --git a/provider/src/main/java/au/com/dius/pact/provider/junitsupport/loader/PactBroker.java b/provider/src/main/java/au/com/dius/pact/provider/junitsupport/loader/PactBroker.java
@@ -50,15 +50,17 @@
    * Tags to use to fetch pacts for, defaults to `latest`
    * If you set the tags through the `pactbroker.tags` system property, separate the tags by commas
    *
-   * @deprecated Use {@link #consumerVersionSelectors} instead
+   * @deprecated Use consumerVersionSelectors method or pactbroker.consumerversionselectors property instead
    */
   @Deprecated
   String[] tags() default "${pactbroker.tags:}";
 
   /**
    * Consumer version selectors to fetch pacts for, defaults to latest version
    * If you set the version selector tags or latest fields through system properties, separate values by commas
+   * @deprecated Use consumerVersionSelectors method or pactbroker.consumerversionselectors property instead
    */
+  @Deprecated
   VersionSelector[] consumerVersionSelectors() default @VersionSelector(
     tag = "${pactbroker.consumerversionselectors.tags:}",
     latest = "${pactbroker.consumerversionselectors.latest:}",
@@ -69,7 +71,7 @@ VersionSelector[] consumerVersionSelectors() default @VersionSelector(
    * Consumers to fetch pacts for, defaults to all consumers
    * If you set the consumers through the `pactbroker.consumers` system property, separate the consumers by commas
    *
-   * @deprecated Use {@link #consumerVersionSelectors} instead
+   * @deprecated Use consumerVersionSelectors method or pactbroker.consumerversionselectors property instead
    */
   @Deprecated
   String[] consumers() default "${pactbroker.consumers:}";

diff --git a/provider/src/main/java/au/com/dius/pact/provider/junitsupport/loader/PactLoader.java b/provider/src/main/java/au/com/dius/pact/provider/junitsupport/loader/PactLoader.java
@@ -25,7 +25,7 @@ public interface PactLoader {
   PactSource getPactSource();
 
   /**
-   * Sets the value resolver to use to resolve property expressions. By default a system property resolver will be used.
+   * Sets the value resolver to use to resolve property expressions. By default, a system property resolver will be used.
    *
    * @param valueResolver Value Resolver
    */
@@ -40,4 +40,9 @@ default void setValueResolver(ValueResolver valueResolver) { }
    * Enables pending pact feature
    */
   default void enablePendingPacts(boolean flag) { };
+
+  /**
+   * Supports additional initialisation using the test class
+   */
+  default void initLoader(Class testClass) { };
 }
diff --git a/provider/src/main/kotlin/au/com/dius/pact/provider/ProviderUtils.kt b/provider/src/main/kotlin/au/com/dius/pact/provider/ProviderUtils.kt
@@ -134,13 +134,13 @@ object ProviderUtils : KLogging() {
     return result
   }
 
-  fun instantiatePactLoader(pactSource: PactSource, clazz: Class<*>, annotation: Annotation?): PactLoader {
+  fun instantiatePactLoader(pactSource: PactSource, testClass: Class<*>, annotation: Annotation?): PactLoader {
     val pactLoaderClass = pactSource.value
-    return try {
+    val pactLoader = try {
       // Checks if there is a constructor with one argument of type Class.
       val constructorWithClass = pactLoaderClass.java.getDeclaredConstructor(Class::class.java)
       constructorWithClass.isAccessible = true
-      constructorWithClass.newInstance(clazz)
+      constructorWithClass.newInstance(testClass)
     } catch (e: NoSuchMethodException) {
       logger.debug { "Pact source does not have a constructor with one argument of type Class" }
       if (annotation != null) {
@@ -169,5 +169,7 @@ object ProviderUtils : KLogging() {
         pactLoaderClass.createInstance()
       }
     }
+    pactLoader.initLoader(testClass)
+    return pactLoader
   }
 }