Support bearer token with JUnit annotations - Fixes gh-925

Author: Kristine Jetzke

provider/pact-jvm-provider-junit/README.md

@@ -212,9 +212,10 @@ The following keys may be managed through the environment
 * `pactbroker.port`
 * `pactbroker.scheme`
 * `pactbroker.tags` (comma separated)
-* `pactbroker.auth.scheme`
-* `pactbroker.auth.username`
-* `pactbroker.auth.password`
+* `pactbroker.auth.scheme` (basic or bearer)
+* `pactbroker.auth.username` (for basic auth)
+* `pactbroker.auth.password` (for basic auth)
+* `pactbroker.auth.token` (for bearer auth)
 
 
 #### Using tags with the pact broker
@@ -231,7 +232,7 @@ For any other value the latest pact tagged with the specified tag is loaded.
 
 Specifying multiple tags is an OR operation. For example if you specify `tags = {"dev", "prod"}` then both the latest pact file tagged with `dev` and the latest pact file taggged with `prod` is loaded.
 
-#### Using basic auth with the with the pact broker
+#### Using authentication with the with the pact broker
 
 You can use basic authentication with the `@PactBroker` annotation by setting the `authentication` value to a `@PactBrokerAuth`
 annotation. For example:
@@ -241,7 +242,14 @@ annotation. For example:
   authentication = @PactBrokerAuth(username = "test", password = "test"))
 ```
 
-The `username` and `password` values also take Java system property expressions.
+Bearer tokens are also supported. For example:
+
+```java
+@PactBroker(host = "${pactbroker.url:localhost}", port = "1234", tags = {"latest", "prod", "dev"},
+  authentication = @PactBrokerAuth(scheme = "bearer", token = "test"))
+```
+
+The `scheme`, `token`, `username` and `password` values also take Java system property expressions.
 
 Preemptive Authentication can be enabled by setting the `pact.pactbroker.httpclient.usePreemptiveAuthentication` Java
 system property to `true`.

provider/pact-jvm-provider-junit/src/test/kotlin/au/com/dius/pact/provider/junit/PactBrokerAnnotationDefaultsTest.kt

@@ -132,6 +132,17 @@ class PactBrokerAnnotationDefaultsTest {
         assertThat(parseListExpression(annotation.authentication.password), contains("myPass"))
     }
 
+    @Test
+    fun `default auth token is empty`() {
+        assertThat(parseExpression(annotation.authentication.token), `is`(""))
+    }
+
+    @Test
+    fun `can set auth token`() {
+        props.setProperty("pactbroker.auth.token", "myToken")
+        assertThat(parseListExpression(annotation.authentication.token), contains("myToken"))
+    }
+
     @PactBroker
     class SampleBrokerClass
 }

provider/pact-jvm-provider/src/main/java/au/com/dius/pact/provider/junit/loader/PactBroker.java

@@ -51,7 +51,7 @@
    * Authentication to use with the pact broker, by default no authentication is used
    */
   PactBrokerAuth authentication() default @PactBrokerAuth(scheme = "${pactbroker.auth.scheme:basic}",
-    username = "${pactbroker.auth.username:}", password = "${pactbroker.auth.password:}");
+    username = "${pactbroker.auth.username:}", password = "${pactbroker.auth.password:}", token = "${pactbroker.auth.token:}");
 
   /**
    * Override the default value resolver for resolving the values in the expressions

provider/pact-jvm-provider/src/main/java/au/com/dius/pact/provider/junit/loader/PactBrokerAuth.java

@@ -15,17 +15,22 @@
 public @interface PactBrokerAuth {
 
   /**
-   * Authentication scheme to use. The default is basic.
+   * Authentication scheme to use. Currently bearer and basic are supported. The default is basic.
    */
   String scheme() default "Basic";
 
   /**
-   * Username to use for authentication
+   * Username to use for basic authentication
    */
   String username();
 
   /**
-   * Password to use for authentication
+   * Password to use for basic authentication
    */
   String password();
+
+  /**
+   * Token to use for bearer token authentication
+   */
+  String token() default "";
 }

provider/pact-jvm-provider/src/main/java/au/com/dius/pact/provider/junit/loader/PactBrokerLoader.java

@@ -183,7 +183,8 @@ PactBrokerClient newPactBrokerClient(URI url, ValueResolver resolver) {
     if (this.authentication != null && !this.authentication.scheme().equalsIgnoreCase("none")) {
       options.put("authentication", Arrays.asList(parseExpression(this.authentication.scheme(), resolver),
           parseExpression(this.authentication.username(), resolver),
-          parseExpression(this.authentication.password(), resolver)));
+          parseExpression(this.authentication.password(), resolver),
+          parseExpression(this.authentication.token(), resolver)));
     }
     return new PactBrokerClient(url.toString(), options);
   }