updated pact-feign example to Spring Boot 2 and JUnit 5

Spring boot testing

.idea/libraries/Gradle__org_projectlombok_lombok_1_16_20.xml

@@ -0,0 +1,11 @@
+<component name="libraryTable">
+  <library name="Gradle: org.projectlombok:lombok:1.16.20">
+    <CLASSES>
+      <root url="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/org.projectlombok/lombok/1.16.20/ac76d9b956045631d1561a09289cbf472e077c01/lombok-1.16.20.jar!/" />
+    </CLASSES>
+    <JAVADOC />
+    <SOURCES>
+      <root url="jar://$USER_HOME$/.gradle/caches/modules-2/files-2.1/org.projectlombok/lombok/1.16.20/69ebf81bb97bdb3c9581c171762bb4929cb5289c/lombok-1.16.20-sources.jar!/" />
+    </SOURCES>
+  </library>
+</component>

.idea/modules/spring-boot-testing.iml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module external.linked.project.id="spring-boot-testing" external.linked.project.path="$MODULE_DIR$/../../spring-boot/spring-boot-testing" external.root.project.path="$MODULE_DIR$/../../spring-boot/spring-boot-testing" external.system.id="GRADLE" external.system.module.group="reflectoring.io" external.system.module.version="0.0.1-SNAPSHOT" type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing">
+      <excludeFolder url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing/.gradle" />
+      <excludeFolder url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing/build" />
+      <excludeFolder url="file://$MODULE_DIR$/../../spring-boot/spring-boot-testing/out" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

.travis.yml

@@ -1,5 +1,11 @@
 before_install:
  - chmod +x gradlew
+ - |
+   if ! git diff --name-only $TRAVIS_COMMIT_RANGE | grep -qvE '(.md)|^(LICENSE)'
+   then
+     echo "Not running CI since only docs were changed."
+     exit
+   fi
 
 language: java
 

deprecated/pact-feign-consumer/gradle/wrapper/gradle-wrapper.properties

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-bin.zip

deprecated/pact-spring-data-rest-provider/gradle/wrapper/gradle-wrapper.properties

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-bin.zip

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.5.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-all.zip

junit/assumptions/README.md

@@ -0,0 +1,3 @@
+# Examples with JUnit 4 and JUnit 5
+
+Have a look at [the code](/src/test/java/com/example/demo/)

junit/assumptions/build.gradle

@@ -0,0 +1,25 @@
+buildscript {
+	repositories {
+		mavenCentral()
+	}
+}
+
+apply plugin: 'java'
+
+version = '0.0.1-SNAPSHOT'
+sourceCompatibility = 1.8
+
+repositories {
+	mavenLocal()
+	mavenCentral()
+}
+
+ext {
+	springCloudVersion = 'Dalston.SR2'
+}
+
+dependencies {
+	testCompile 'org.junit.jupiter:junit-jupiter-engine:5.0.1'
+	testCompile 'junit:junit:4.12'
+}
+

junit/assumptions/gradle/wrapper/gradle-wrapper.properties

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.2-bin.zip

junit/assumptions/src/test/java/com/example/demo/connectionchecking/ConnectionChecker.java

@@ -0,0 +1,15 @@
+package com.example.demo.connectionchecking;
+
+public class ConnectionChecker {
+
+  private String uri;
+
+  public ConnectionChecker(String uri) {
+    this.uri = uri;
+  }
+
+  public boolean connect() {
+    return false;
+  }
+
+}

junit/assumptions/src/test/java/com/example/demo/connectionchecking/junit4/AssumingConnection.java

@@ -0,0 +1,31 @@
+package com.example.demo.connectionchecking.junit4;
+
+import com.example.demo.connectionchecking.ConnectionChecker;
+import org.junit.AssumptionViolatedException;
+import org.junit.rules.TestRule;
+import org.junit.runner.Description;
+import org.junit.runners.model.Statement;
+
+public class AssumingConnection implements TestRule {
+
+  private ConnectionChecker checker;
+
+  public AssumingConnection(ConnectionChecker checker) {
+    this.checker = checker;
+  }
+
+  @Override
+  public Statement apply(Statement base, Description description) {
+    return new Statement() {
+      @Override
+      public void evaluate() throws Throwable {
+        if (!checker.connect()) {
+          throw new AssumptionViolatedException("Could not connect. Skipping test!");
+        } else {
+          base.evaluate();
+        }
+      }
+    };
+  }
+
+}

junit/assumptions/src/test/java/com/example/demo/connectionchecking/junit4/ConnectionCheckingJunit4Test.java

@@ -0,0 +1,19 @@
+package com.example.demo.connectionchecking.junit4;
+
+
+import com.example.demo.connectionchecking.ConnectionChecker;
+import org.junit.ClassRule;
+import org.junit.Test;
+import static org.junit.Assert.fail;
+
+public class ConnectionCheckingJunit4Test {
+
+  @ClassRule
+  public static AssumingConnection assumingConnection = new AssumingConnection(new ConnectionChecker("http://my.integration.system"));
+
+  @Test
+  public void testOnlyWhenConnected() {
+    fail("Booh!");
+  }
+
+}

junit/assumptions/src/test/java/com/example/demo/connectionchecking/junit5/AssumeConnection.java

@@ -0,0 +1,14 @@
+package com.example.demo.connectionchecking.junit5;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+import org.junit.jupiter.api.extension.ExtendWith;
+
+@Retention(RetentionPolicy.RUNTIME)
+@ExtendWith(AssumeConnectionCondition.class)
+public @interface AssumeConnection {
+
+  String uri();
+
+}

junit/assumptions/src/test/java/com/example/demo/connectionchecking/junit5/AssumeConnectionCondition.java

@@ -0,0 +1,28 @@
+package com.example.demo.connectionchecking.junit5;
+
+import java.util.Optional;
+
+import com.example.demo.connectionchecking.ConnectionChecker;
+import org.junit.jupiter.api.extension.ConditionEvaluationResult;
+import org.junit.jupiter.api.extension.ExecutionCondition;
+import org.junit.jupiter.api.extension.ExtensionContext;
+import static org.junit.platform.commons.util.AnnotationUtils.findAnnotation;
+
+public class AssumeConnectionCondition implements ExecutionCondition {
+
+  @Override
+  public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) {
+    Optional<AssumeConnection> annotation = findAnnotation(context.getElement(), AssumeConnection.class);
+    if (annotation.isPresent()) {
+      String uri = annotation.get().uri();
+      ConnectionChecker checker = new ConnectionChecker(uri);
+      if (!checker.connect()) {
+        return ConditionEvaluationResult.disabled(String.format("Could not connect to '%s'. Skipping test!", uri));
+      } else {
+        return ConditionEvaluationResult.enabled(String.format("Successfully connected to '%s'. Continuing test!", uri));
+      }
+    }
+    return ConditionEvaluationResult.enabled("No AssumeConnection annotation found. Continuing test.");
+  }
+
+}

junit/assumptions/src/test/java/com/example/demo/connectionchecking/junit5/ConnectionCheckingJunit5Test.java

@@ -0,0 +1,14 @@
+package com.example.demo.connectionchecking.junit5;
+
+import org.junit.jupiter.api.Test;
+import static org.junit.jupiter.api.Assertions.fail;
+
+@AssumeConnection(uri = "http://my.integration.system")
+public class ConnectionCheckingJunit5Test {
+
+  @Test
+  public void testOnlyWhenConnected() {
+    fail("Booh!");
+  }
+
+}

junit/assumptions/target/pacts/addressClient-customerServiceProvider.json

@@ -0,0 +1,120 @@
+{
+    "provider": {
+        "name": "customerServiceProvider"
+    },
+    "consumer": {
+        "name": "addressClient"
+    },
+    "interactions": [
+        {
+            "description": "a request to the address collection resource",
+            "request": {
+                "method": "GET",
+                "path": "/addresses/"
+            },
+            "response": {
+                "status": 200,
+                "headers": {
+                    "Content-Type": "application/hal+json"
+                },
+                "body": {
+                    "_embedded": {
+                        "addresses": [
+                            {
+                                "street": "Elm Street",
+                                "_links": {
+                                    "self": {
+                                        "href": "http://localhost:8080/addresses/1"
+                                    },
+                                    "address": {
+                                        "href": "http://localhost:8080/addresses/1"
+                                    },
+                                    "customer": {
+                                        "href": "http://localhost:8080/addresses/1/customer"
+                                    }
+                                }
+                            },
+                            {
+                                "street": "High Street",
+                                "_links": {
+                                    "self": {
+                                        "href": "http://localhost:8080/addresses/2"
+                                    },
+                                    "address": {
+                                        "href": "http://localhost:8080/addresses/2"
+                                    },
+                                    "customer": {
+                                        "href": "http://localhost:8080/addresses/2/customer"
+                                    }
+                                }
+                            }
+                        ]
+                    },
+                    "_links": {
+                        "self": {
+                            "href": "http://localhost:8080/addresses{?page,size,sort}",
+                            "templated": true
+                        },
+                        "profile": {
+                            "href": "http://localhost:8080/profile/addresses"
+                        },
+                        "search": {
+                            "href": "http://localhost:8080/addresses/search"
+                        }
+                    },
+                    "page": {
+                        "size": 20,
+                        "totalElements": 2,
+                        "totalPages": 1,
+                        "number": 0
+                    }
+                }
+            },
+            "providerStates": [
+                {
+                    "name": "a collection of 2 addresses"
+                }
+            ]
+        },
+        {
+            "description": "a request to the address resource",
+            "request": {
+                "method": "GET",
+                "path": "/addresses/1"
+            },
+            "response": {
+                "status": 200,
+                "headers": {
+                    "Content-Type": "application/hal+json"
+                },
+                "body": {
+                    "street": "Elm Street",
+                    "_links": {
+                        "self": {
+                            "href": "http://localhost:8080/addresses/1"
+                        },
+                        "address": {
+                            "href": "http://localhost:8080/addresses/1"
+                        },
+                        "customer": {
+                            "href": "http://localhost:8080/addresses/1/customer"
+                        }
+                    }
+                }
+            },
+            "providerStates": [
+                {
+                    "name": "a single address"
+                }
+            ]
+        }
+    ],
+    "metadata": {
+        "pact-specification": {
+            "version": "3.0.0"
+        },
+        "pact-jvm": {
+            "version": "3.5.2"
+        }
+    }
+}

pact/pact-angular/README.md

@@ -18,3 +18,13 @@ a consumer against the Pact.
 Run `npm install` to load the needed javascript libraries and then `npm run test` to
 run the tests. After the tests have successfully run the created pact file will be
 created in the folder `pacts`. 
+
+Then, you can call `npm run publish-pacts` to publish the pact files to a [Pact Broker](https://github.com/pact-foundation/pact_broker).
+You must set the following npm configs for the `publish-pacts` script to work:
+
+```
+npm config set angular-pact:brokerUrl <URL>
+npm config set angular-pact:brokerUsername <USER>
+npm config set angular-pact:brokerPassword <PASS>
+
+``` 

pact/pact-angular/package.json

@@ -8,7 +8,8 @@
     "build": "ng build",
     "test": "cross-env LOGLEVEL=DEBUG ng test",
     "lint": "ng lint",
-    "e2e": "ng e2e"
+    "e2e": "ng e2e",
+    "publish-pacts": "node publish-pacts.js"
   },
   "private": true,
   "dependencies": {
@@ -45,9 +46,9 @@
     "ts-node": "~3.2.0",
     "tslint": "~5.7.0",
     "typescript": "~2.3.3",
-    "@pact-foundation/pact-node": "~4.12",
-    "@pact-foundation/karma-pact": "~2.1.0",
-    "pact-web": "~3.0",
+    "@pact-foundation/pact-node": "6.5.0",
+    "@pact-foundation/karma-pact": "2.1.3",
+    "@pact-foundation/pact-web": "5.3.0",
     "cross-env": "^5.0.5"
   }
 }

pact/pact-angular/pacts/ui-userservice.json

@@ -0,0 +1,78 @@
+{
+  "consumer": {
+    "name": "ui"
+  },
+  "provider": {
+    "name": "userservice"
+  },
+  "interactions": [
+    {
+      "description": "a request to POST a person",
+      "providerState": "provider accepts a new person",
+      "request": {
+        "method": "POST",
+        "path": "/user-service/users",
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "firstName": "Arthur",
+          "lastName": "Dent"
+        }
+      },
+      "response": {
+        "status": 201,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "id": 42
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to PUT a person",
+      "providerState": "person 42 exists",
+      "request": {
+        "method": "PUT",
+        "path": "/user-service/users/42",
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "firstName": "Zaphod",
+          "lastName": "Beeblebrox"
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "firstName": "Zaphod",
+          "lastName": "Beeblebrox"
+        },
+        "matchingRules": {
+          "$.body": {
+            "match": "type"
+          }
+        }
+      }
+    }
+  ],
+  "metadata": {
+    "pactSpecification": {
+      "version": "2.0.0"
+    }
+  }
+}

pact/pact-angular/publish-pacts.js

@@ -0,0 +1,20 @@
+let projectFolder = __dirname;
+let pact = require('@pact-foundation/pact-node');
+let project = require('./package.json');
+let pactBrokerUrl = process.env.npm_package_config_brokerUrl;
+let pactBrokerUsername = process.env.npm_package_config_brokerUsername;
+let pactBrokerPassword = process.env.npm_package_config_brokerPassword;
+
+let options = {
+  pactFilesOrDirs: [projectFolder + '/pacts'],
+  pactBroker: pactBrokerUrl,
+  consumerVersion: project.version,
+  tags: ['latest'],
+  pactBrokerUsername: pactBrokerUsername,
+  pactBrokerPassword: pactBrokerPassword
+};
+
+
+pact.publishPacts(options).then(function () {
+  console.log("Pacts successfully published!");
+});

pact/pact-angular/src/app/user.service.pact.spec.ts

@@ -2,20 +2,18 @@ import {TestBed} from '@angular/core/testing';
 import {HttpClientModule} from '@angular/common/http';
 import {UserService} from './user.service';
 import {User} from './user';
-import * as Pact from 'pact-web';
+import {PactWeb, Matchers} from '@pact-foundation/pact-web';
 
 describe('UserService', () => {
 
   let provider;
 
   beforeAll(function (done) {
-    provider = Pact({
+    provider = new PactWeb({
       consumer: 'ui',
       provider: 'userservice',
-      web: true,
       port: 1234,
       host: '127.0.0.1',
-      logLevel: 'DEBUG'
     });
 
     // required for slower CI environments
@@ -72,7 +70,7 @@ describe('UserService', () => {
         },
         willRespondWith: {
           status: 201,
-          body: Pact.Matchers.somethingLike({
+          body: Matchers.somethingLike({
               id: createdUserId
           }),
           headers: {
@@ -94,4 +92,41 @@ describe('UserService', () => {
 
   });
 
+  describe('update()', () => {
+
+    const expectedUser: User = {
+      firstName: 'Zaphod',
+      lastName: 'Beeblebrox'
+    };
+
+    beforeAll((done) => {
+      provider.addInteraction({
+        state: `person 42 exists`,
+        uponReceiving: 'a request to PUT a person',
+        withRequest: {
+          method: 'PUT',
+          path: '/user-service/users/42',
+          body: Matchers.somethingLike(expectedUser),
+          headers: {
+            'Content-Type': 'application/json'
+          }
+        },
+        willRespondWith: {
+          status: 200,
+          body: Matchers.somethingLike(expectedUser)
+        }
+      }).then(done, error => done.fail(error));
+    });
+
+    it('should update a Person', (done) => {
+      const userService: UserService = TestBed.get(UserService);
+      userService.update(expectedUser, 42).subscribe(response => {
+        done();
+      }, error => {
+        done.fail(error);
+      });
+    });
+
+  });
+
 });

pact/pact-feign-consumer/README.md

@@ -0,0 +1,11 @@
+# Testing a Spring Boot REST API Consumer against a Contract with Pact
+
+## Companion Blog Article
+Read the [companion blog article](http://localhost:4000/consumer-driven-contract-feign-pact/) to this repository.
+
+## Getting Started
+
+* have a look at the [feign client](src/main/java/io/reflectoring/UserClient.java)
+* have a look at the [consumer test](src/test/java/io/reflectoring/UserServiceConsumerTest.java)
+* run `./gradlew build` in this project to create a pact and run the consumer test
+* afterwards, find the pact contract file in the folder `target/pacts` 

pact/pact-feign-consumer/application.yml

@@ -0,0 +1,5 @@
+userservice:
+  ribbon:
+    eureka:
+      enabled: false
+    listOfServers: localhost:8080

pact/pact-feign-consumer/build.gradle

@@ -0,0 +1,50 @@
+buildscript {
+    repositories {
+        mavenLocal()
+        jcenter()
+    }
+    dependencies {
+        classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}"
+    }
+}
+
+plugins {
+    id "au.com.dius.pact" version "3.5.20"
+}
+
+apply plugin: 'java'
+apply plugin: 'org.springframework.boot'
+apply plugin: 'io.spring.dependency-management'
+
+version '1.0.0.SNAPSHOT'
+
+repositories {
+    mavenLocal()
+    jcenter()
+}
+
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springcloud_version}"
+    }
+}
+
+dependencies {
+    compile('org.springframework.boot:spring-boot-starter-data-jpa')
+    compile('org.springframework.boot:spring-boot-starter-web')
+    compile('org.springframework.cloud:spring-cloud-starter-openfeign')
+    compile('org.springframework.cloud:spring-cloud-starter-netflix-ribbon')
+    compile('com.h2database:h2:1.4.196')
+    testCompile('org.codehaus.groovy:groovy-all:2.4.6')
+    testCompile("au.com.dius:pact-jvm-consumer-junit5_2.12:${pact_version}")
+    testCompile('org.springframework.boot:spring-boot-starter-test')
+}
+
+pact {
+    publish {
+        pactDirectory = 'target/pacts'
+        pactBrokerUrl = 'URL'
+        pactBrokerUsername = 'USERNAME'
+        pactBrokerPassword = 'PASSWORD'
+    }
+}

pact/pact-feign-consumer/gradle.properties

@@ -0,0 +1,3 @@
+springboot_version=2.0.4.RELEASE
+springcloud_version=Finchley.SR1
+pact_version=3.5.20