removed deprecated examples

added logging example

.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:spring-boot-testing" external.linked.project.path="$MODULE_DIR$/../../spring-boot/spring-boot-testing" external.root.project.path="$MODULE_DIR$/../.." 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
 

logging/README.md

@@ -0,0 +1,7 @@
+# Logging Code Examples
+ 
+## Related Blog Articles
+
+* [Use Logging Levels Consistently](https://reflectoring.io/logging-levels/)
+* [Use a Human-Readable Logging Format](https://reflectoring.io/logging-format/)
+* [Configuring a Human-Readable Logging Format with Logback and Descriptive Logger](https://reflectoring.io/logging-format-logback/)

logging/build.gradle

@@ -0,0 +1,20 @@
+apply plugin: 'java'
+
+buildscript {
+    repositories {
+        mavenLocal()
+        jcenter()
+    }
+}
+
+
+repositories {
+    mavenLocal()
+    jcenter()
+}
+
+dependencies {
+    compile("ch.qos.logback:logback-classic:1.2.3")
+    compile("io.reflectoring:descriptive-logger:1.0")
+    testCompile("org.junit.jupiter:junit-jupiter-engine:5.0.1")
+}

logging/src/test/java/io/reflectoring/logging/LoggingFormatTest.java

@@ -0,0 +1,18 @@
+package io.reflectoring.logging;
+
+import io.reflectoring.descriptivelogger.LoggerFactory;
+import org.junit.jupiter.api.Test;
+
+public class LoggingFormatTest {
+
+	private MyLogger logger = LoggerFactory.getLogger(MyLogger.class, LoggingFormatTest.class);
+
+	@Test
+	public void testLogPattern(){
+		Thread.currentThread().setName("very-long-thread-name");
+		logger.logDebugMessage();
+		Thread.currentThread().setName("short");
+		logger.logInfoMessage();
+		logger.logMessageWithLongId();
+	}
+}

logging/src/test/java/io/reflectoring/logging/MyLogger.java

@@ -0,0 +1,19 @@
+package io.reflectoring.logging;
+
+import io.reflectoring.descriptivelogger.DescriptiveLogger;
+import io.reflectoring.descriptivelogger.LogMessage;
+import org.slf4j.event.Level;
+
+@DescriptiveLogger
+public interface MyLogger {
+
+	@LogMessage(level=Level.DEBUG, message="This is a DEBUG message.", id=14556)
+	void logDebugMessage();
+
+	@LogMessage(level=Level.INFO, message="This is an INFO message.", id=5456)
+	void logInfoMessage();
+
+	@LogMessage(level=Level.ERROR, message="This is an ERROR message with a very long ID.", id=1548654)
+	void logMessageWithLongId();
+
+}

logging/src/test/java/io/reflectoring/logging/TruncatedLoggerConverter.java

@@ -0,0 +1,27 @@
+package io.reflectoring.logging;
+
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import ch.qos.logback.classic.pattern.LoggerConverter;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+
+public class TruncatedLoggerConverter extends LoggerConverter {
+
+	@Override
+	public String convert(ILoggingEvent event) {
+		String maxLengthString = getFirstOption();
+		int maxLength = Integer.parseInt(maxLengthString);
+		String loggerName = super.convert(event);
+		if (loggerName.length() <= maxLength) {
+			return loggerName + generateSpaces(maxLength - loggerName.length());
+		} else {
+			return "..." + loggerName.substring(loggerName.length() - maxLength + 3);
+		}
+	}
+
+	private String generateSpaces(int count) {
+		return Stream.generate(() -> " ").limit(count).collect(Collectors.joining());
+	}
+
+}

logging/src/test/java/io/reflectoring/logging/TruncatedThreadConverter.java

@@ -0,0 +1,28 @@
+package io.reflectoring.logging;
+
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import ch.qos.logback.classic.pattern.ClassicConverter;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+
+public class TruncatedThreadConverter extends ClassicConverter {
+
+	@Override
+	public String convert(ILoggingEvent event) {
+		String maxLengthString = getFirstOption();
+		int maxLength = Integer.parseInt(maxLengthString);
+		String threadName = event.getThreadName();
+
+		if (threadName.length() <= maxLength) {
+			return threadName + generateSpaces(maxLength - threadName.length());
+		} else {
+			return "..." + threadName.substring(threadName.length() - maxLength + 3);
+		}
+	}
+
+	private String generateSpaces(int count) {
+		return Stream.generate(() -> " ").limit(count).collect(Collectors.joining());
+	}
+
+}

logging/src/test/resources/logback.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+    <conversionRule conversionWord="truncatedThread"
+                    converterClass="io.reflectoring.logging.TruncatedThreadConverter" />
+
+    <conversionRule conversionWord="truncatedLogger"
+                    converterClass="io.reflectoring.logging.TruncatedLoggerConverter" />
+    ​
+    <!-- Appender to log to console -->
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{yyyy-MM-dd} | %d{HH:mm:ss.SSS} | %truncatedThread{20} | %5p | %truncatedLogger{25} | %12(ID: %8mdc{id}) | %m%n</pattern>
+            <charset>utf8</charset>
+        </encoder>
+    </appender>
+
+    <root level="DEBUG">
+        <appender-ref ref="CONSOLE"/>
+    </root>
+</configuration>

pact-feign-consumer/README.md

@@ -1,15 +0,0 @@
-# Consumer-Driven-Contract Test for a Feign Consumer
- 
-This repo contains an example of consumer-driven-contract testing for a Feign client
-that consumes a REST API provided by the module `pact-spring-data-rest-provider`.
-
-The contract is created and verified with [Pact](https://docs.pact.io/).
-
-## Companion Blog Post
-
-The Companion Blog Post to this project can be found [here](https://reflectoring.io/consumer-driven-contracts-with-pact-feign-spring-data-rest/).
-
-## Running the application
-
-The interesting part in this code base is the class `ConsumerPactVerificationTest`.
-You can run the tests with `gradlew test` on Windows or `./gradlew test` on Unix.

pact-feign-consumer/build.gradle

@@ -1,46 +0,0 @@
-buildscript {
-	ext {
-		springBootVersion = '1.5.4.RELEASE'
-	}
-	repositories {
-		mavenCentral()
-	}
-	dependencies {
-		classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
-	}
-}
-
-apply plugin: 'java'
-apply plugin: 'eclipse'
-apply plugin: 'org.springframework.boot'
-
-version = '0.0.1-SNAPSHOT'
-sourceCompatibility = 1.8
-
-repositories {
-	mavenLocal()
-	mavenCentral()
-}
-
-ext {
-	springCloudVersion = 'Dalston.SR2'
-}
-
-dependencies {
-	compile('org.springframework.cloud:spring-cloud-starter-feign')
-	// locking transitive guava version to work around "java.lang.IllegalAccessError: tried to access method com.google.common.collect.Lists.cartesianProduct"
-	compile('com.google.guava:guava:22.0')
-	compile('org.springframework.boot:spring-boot-starter-hateoas')
-	testCompile group: 'au.com.dius', name: 'pact-jvm-consumer-junit_2.11', version: '3.5.2'
-	testCompile('org.springframework.boot:spring-boot-starter-test')
-}
-
-dependencyManagement {
-	imports {
-		mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
-	}
-}
-
-bootRun{
-	jvmArgs = ["-Xdebug", "-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5006"]
-}

pact-feign-consumer/src/main/java/com/example/demo/AddressClient.java

@@ -1,19 +0,0 @@
-package com.example.demo;
-
-import org.springframework.cloud.netflix.feign.FeignClient;
-import org.springframework.hateoas.Resource;
-import org.springframework.hateoas.Resources;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestMethod;
-
-@FeignClient(value = "addresses", path = "/addresses")
-public interface AddressClient {
-
-  @RequestMapping(method = RequestMethod.GET, path = "/")
-  Resources<Address> getAddresses();
-
-  @RequestMapping(method = RequestMethod.GET, path = "/{id}")
-  Resource<Address> getAddress(@PathVariable("id") long id);
-
-}

pact-feign-consumer/src/main/java/com/example/demo/CustomerClient.java

@@ -1,19 +0,0 @@
-package com.example.demo;
-
-import org.springframework.cloud.netflix.feign.FeignClient;
-import org.springframework.hateoas.Resource;
-import org.springframework.hateoas.Resources;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestMethod;
-
-@FeignClient(value = "customers", path = "/customers_mto")
-public interface CustomerClient {
-
-	@RequestMapping(method = RequestMethod.GET, value = "/")
-	Resources<Customer> getCustomers();
-
-	@RequestMapping(method = RequestMethod.GET, value = "/{id}")
-	Resource<Customer> getCustomer(@PathVariable("id") long id);
-
-}

pact-feign-consumer/src/main/java/com/example/demo/DemoApplication.java

@@ -1,16 +0,0 @@
-package com.example.demo;
-
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.cloud.netflix.feign.EnableFeignClients;
-import org.springframework.hateoas.config.EnableHypermediaSupport;
-
-@SpringBootApplication
-@EnableFeignClients
-@EnableHypermediaSupport(type = EnableHypermediaSupport.HypermediaType.HAL)
-public class DemoApplication {
-
-  public static void main(String[] args) {
-    SpringApplication.run(DemoApplication.class, args);
-  }
-}

pact-feign-consumer/src/main/resources/application.yml

@@ -1,17 +0,0 @@
-server.port: 8081
-
-logging.level.com.example.demo.CustomerClient: DEBUG
-logging.level.com.example.demo.AddressClient: DEBUG
-logging.level.org.hibernate.SQL: DEBUG
-
-customers:
-  ribbon:
-    eureka:
-      enabled: false
-    listOfServers: localhost:8080
-
-addresses:
-  ribbon:
-    eureka:
-      enabled: false
-    listOfServers: localhost:8080

pact-feign-consumer/src/test/java/com/example/demo/ConsumerPactVerificationTest.java

@@ -1,137 +0,0 @@
-package com.example.demo;
-
-import au.com.dius.pact.consumer.Pact;
-import au.com.dius.pact.consumer.PactProviderRuleMk2;
-import au.com.dius.pact.consumer.PactVerification;
-import au.com.dius.pact.consumer.dsl.PactDslWithProvider;
-import au.com.dius.pact.model.RequestResponsePact;
-import org.apache.http.entity.ContentType;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.hateoas.Resource;
-import org.springframework.hateoas.Resources;
-import org.springframework.test.context.junit4.SpringRunner;
-
-import static org.assertj.core.api.Assertions.assertThat;
-
-@RunWith(SpringRunner.class)
-@SpringBootTest(properties = {
-        // overriding provider address
-        "addresses.ribbon.listOfServers: localhost:8888"
-})
-public class ConsumerPactVerificationTest {
-
-  @Rule
-  public PactProviderRuleMk2 stubProvider = new PactProviderRuleMk2("customerServiceProvider", "localhost", 8888, this);
-
-  @Autowired
-  private AddressClient addressClient;
-
-  @Pact(state = "a collection of 2 addresses", provider = "customerServiceProvider", consumer = "addressClient")
-  public RequestResponsePact createAddressCollectionResourcePact(PactDslWithProvider builder) {
-    return builder
-            .given("a collection of 2 addresses")
-            .uponReceiving("a request to the address collection resource")
-            .path("/addresses/")
-            .method("GET")
-            .willRespondWith()
-            .status(200)
-            .body("{\n" +
-                    "  \"_embedded\": {\n" +
-                    "    \"addresses\": [\n" +
-                    "      {\n" +
-                    "        \"street\": \"Elm Street\",\n" +
-                    "        \"_links\": {\n" +
-                    "          \"self\": {\n" +
-                    "            \"href\": \"http://localhost:8080/addresses/1\"\n" +
-                    "          },\n" +
-                    "          \"address\": {\n" +
-                    "            \"href\": \"http://localhost:8080/addresses/1\"\n" +
-                    "          },\n" +
-                    "          \"customer\": {\n" +
-                    "            \"href\": \"http://localhost:8080/addresses/1/customer\"\n" +
-                    "          }\n" +
-                    "        }\n" +
-                    "      },\n" +
-                    "      {\n" +
-                    "        \"street\": \"High Street\",\n" +
-                    "        \"_links\": {\n" +
-                    "          \"self\": {\n" +
-                    "            \"href\": \"http://localhost:8080/addresses/2\"\n" +
-                    "          },\n" +
-                    "          \"address\": {\n" +
-                    "            \"href\": \"http://localhost:8080/addresses/2\"\n" +
-                    "          },\n" +
-                    "          \"customer\": {\n" +
-                    "            \"href\": \"http://localhost:8080/addresses/2/customer\"\n" +
-                    "          }\n" +
-                    "        }\n" +
-                    "      }\n" +
-                    "    ]\n" +
-                    "  },\n" +
-                    "  \"_links\": {\n" +
-                    "    \"self\": {\n" +
-                    "      \"href\": \"http://localhost:8080/addresses{?page,size,sort}\",\n" +
-                    "      \"templated\": true\n" +
-                    "    },\n" +
-                    "    \"profile\": {\n" +
-                    "      \"href\": \"http://localhost:8080/profile/addresses\"\n" +
-                    "    },\n" +
-                    "    \"search\": {\n" +
-                    "      \"href\": \"http://localhost:8080/addresses/search\"\n" +
-                    "    }\n" +
-                    "  },\n" +
-                    "  \"page\": {\n" +
-                    "    \"size\": 20,\n" +
-                    "    \"totalElements\": 2,\n" +
-                    "    \"totalPages\": 1,\n" +
-                    "    \"number\": 0\n" +
-                    "  }\n" +
-                    "}", "application/hal+json")
-            .toPact();
-  }
-
-  @Pact(state = "a single address", provider = "customerServiceProvider", consumer = "addressClient")
-  public RequestResponsePact createAddressResourcePact(PactDslWithProvider builder) {
-    return builder
-            .given("a single address")
-            .uponReceiving("a request to the address resource")
-            .path("/addresses/1")
-            .method("GET")
-            .willRespondWith()
-            .status(200)
-            .body("{\n" +
-                    "  \"street\": \"Elm Street\",\n" +
-                    "  \"_links\": {\n" +
-                    "    \"self\": {\n" +
-                    "      \"href\": \"http://localhost:8080/addresses/1\"\n" +
-                    "    },\n" +
-                    "    \"address\": {\n" +
-                    "      \"href\": \"http://localhost:8080/addresses/1\"\n" +
-                    "    },\n" +
-                    "    \"customer\": {\n" +
-                    "      \"href\": \"http://localhost:8080/addresses/1/customer\"\n" +
-                    "    }\n" +
-                    "  }\n" +
-                    "}", "application/hal+json")
-            .toPact();
-  }
-
-  @Test
-  @PactVerification(fragment = "createAddressCollectionResourcePact")
-  public void verifyAddressCollectionPact() {
-    Resources<Address> addresses = addressClient.getAddresses();
-    assertThat(addresses).hasSize(2);
-  }
-
-  @Test
-  @PactVerification(fragment = "createAddressResourcePact")
-  public void verifyAddressPact() {
-    Resource<Address> address = addressClient.getAddress(1L);
-    assertThat(address).isNotNull();
-  }
-
-}

pact-spring-data-rest-provider/README.md

@@ -1,16 +0,0 @@
-# Consumer-Driven-Contract Test for a Spring Data Rest Provider
- 
-This repo contains an example of consumer-driven-contract testing for a Spring
-Data REST API provider. The corresponding consumer to the contract is
-implemented in the module `pact-feign-consumer`.
-
-The contract is created and verified with [Pact](https://docs.pact.io/).
-
-## Companion Blog Post
-
-The Companion Blog Post to this project can be found [here](https://reflectoring.io/consumer-driven-contracts-with-pact-feign-spring-data-rest/).
-
-## Running the application
-
-The interesting part in this code base is the class `ProviderPactVerificationTest`.
-You can run the tests with `gradlew test` on Windows or `./gradlew test` on Unix.

pact-spring-data-rest-provider/src/main/java/com/example/demo/Address.java

@@ -1,43 +0,0 @@
-package com.example.demo;
-
-import javax.persistence.*;
-
-@Entity
-public class Address {
-
-  @GeneratedValue
-  @Id
-  private Long id;
-
-  @Column
-  private String street;
-
-  @ManyToOne
-  private Customer customer;
-
-  public Long getId() {
-    return id;
-  }
-
-  public void setId(Long id) {
-    this.id = id;
-  }
-
-  public String getStreet() {
-    return street;
-  }
-
-  public void setStreet(String street) {
-    this.street = street;
-  }
-
-  public Customer getCustomer() {
-    return customer;
-  }
-
-  public void setCustomer(Customer customer) {
-    this.customer = customer;
-  }
-}
-
-

pact-spring-data-rest-provider/src/main/java/com/example/demo/AddressRepository.java

@@ -1,14 +0,0 @@
-package com.example.demo;
-
-import org.springframework.data.repository.PagingAndSortingRepository;
-import org.springframework.data.rest.core.annotation.RepositoryRestResource;
-import org.springframework.hateoas.Resources;
-
-import java.util.List;
-
-@RepositoryRestResource(path = "addresses")
-public interface AddressRepository extends PagingAndSortingRepository<Address, Long> {
-
-  List<Address> findByCustomerId(long customerId);
-
-}

pact-spring-data-rest-provider/src/main/java/com/example/demo/Customer.java

@@ -1,30 +0,0 @@
-package com.example.demo;
-
-import javax.persistence.Column;
-import javax.persistence.Entity;
-import javax.persistence.GeneratedValue;
-import javax.persistence.Id;
-
-@Entity
-public class Customer {
-
-  @Id
-  @GeneratedValue
-  private long id;
-
-  @Column
-  private String name;
-
-  public void setId(long id) {
-    this.id = id;
-  }
-
-  public String getName() {
-    return name;
-  }
-
-  public void setName(String name) {
-    this.name = name;
-  }
-
-}

pact-spring-data-rest-provider/src/main/resources/application.properties

@@ -1,7 +0,0 @@
-spring.datasource.url=jdbc:h2:mem:AZ;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
-spring.datasource.driverClassName=org.h2.Driver
-spring.datasource.username=sa
-spring.datasource.password=
-spring.h2.console.enabled=true
-
-logging.level.org.hibernate.SQL=OFF

pact-spring-data-rest-provider/src/test/java/com/example/demo/ProviderPactVerificationTest.java

@@ -1,41 +0,0 @@
-package com.example.demo;
-
-import au.com.dius.pact.provider.junit.PactRunner;
-import au.com.dius.pact.provider.junit.Provider;
-import au.com.dius.pact.provider.junit.State;
-import au.com.dius.pact.provider.junit.loader.PactFolder;
-import au.com.dius.pact.provider.junit.target.HttpTarget;
-import au.com.dius.pact.provider.junit.target.Target;
-import au.com.dius.pact.provider.junit.target.TestTarget;
-import com.example.framework.DatabaseStateHolder;
-import com.example.framework.SpringBootStarter;
-import org.junit.ClassRule;
-import org.junit.runner.RunWith;
-
-@RunWith(PactRunner.class)
-@Provider("customerServiceProvider")
-@PactFolder("../pact-feign-consumer/target/pacts")
-public class ProviderPactVerificationTest {
-
-  @ClassRule
-  public static SpringBootStarter appStarter = SpringBootStarter.builder()
-          .withApplicationClass(DemoApplication.class)
-          .withArgument("--spring.config.location=classpath:/application-pact.properties")
-          .withDatabaseState("single-address", "/initial-schema.sql", "/single-address.sql")
-          .withDatabaseState("address-collection", "/initial-schema.sql", "/address-collection.sql")
-          .build();
-
-  @State("a single address")
-  public void toSingleAddressState() {
-    DatabaseStateHolder.setCurrentDatabaseState("single-address");
-  }
-
-  @State("a collection of 2 addresses")
-  public void toAddressCollectionState() {
-    DatabaseStateHolder.setCurrentDatabaseState("address-collection");
-  }
-
-  @TestTarget
-  public final Target target = new HttpTarget(8080);
-
-}

pact-spring-data-rest-provider/src/test/java/com/example/framework/DatabaseState.java

@@ -1,32 +0,0 @@
-package com.example.framework;
-
-/**
- * Defines a state of the database, which is defined by a set of SQL scripts.
- */
-public class DatabaseState {
-
-  private final String stateName;
-
-  private final String[] sqlscripts;
-
-  /**
-   * Constructor.
-   *
-   * @param stateName  unique name of this database state.
-   * @param sqlscripts paths to SQL scripts within the classpath. These scripts will be executed to put the
-   *                   database into the database state described by this object.
-   */
-  public DatabaseState(String stateName, String... sqlscripts) {
-    this.stateName = stateName;
-    this.sqlscripts = sqlscripts;
-  }
-
-  public String getStateName() {
-    return stateName;
-  }
-
-  public String[] getSqlscripts() {
-    return sqlscripts;
-  }
-
-}

pact-spring-data-rest-provider/src/test/java/com/example/framework/DatabaseStateHolder.java

@@ -1,36 +0,0 @@
-package com.example.framework;
-
-/**
- * Holds the current database state.
- * <p/>
- * TODO: replace the static state variable with a thread-safe alternative. Potentially use a special HTTP header
- * that is intercepted by a Bean defined in {@link PactDatabaseStatesAutoConfiguration} and sets the database
- * state in a {@link ThreadLocal} variable.
- */
-public class DatabaseStateHolder {
-
-  private static String currentDatabaseState;
-
-  /**
-   * Sets the database to the state with the specified name.
-   * <p/>
-   * <strong>WARNING:</strong> the database state is not thread safe. If there are multiple threads accessing
-   * the database in different states at the same time, apocalypse will come!
-   *
-   * @param databaseStateName the name of the {@link DatabaseState} to put the database in.
-   */
-  public static void setCurrentDatabaseState(String databaseStateName) {
-    currentDatabaseState = databaseStateName;
-  }
-
-  /**
-   * Returns the name of the current {@link DatabaseState}.
-   * <p/>
-   * <strong>WARNING:</strong> the database state is not thread safe. If there are multiple threads accessing
-   * the database in different states at the same time, apocalypse will come!
-   */
-  public static String getCurrentDatabaseState() {
-    return currentDatabaseState;
-  }
-
-}

pact-spring-data-rest-provider/src/test/java/com/example/framework/DatabaseStatesInitializer.java

@@ -1,50 +0,0 @@
-package com.example.framework;
-
-import org.springframework.core.io.ClassPathResource;
-import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator;
-
-import javax.annotation.PostConstruct;
-import javax.sql.DataSource;
-import java.util.List;
-
-/**
- * Initializes a {@link DataSource} to a specified List of {@link DatabaseState}s. It is assumed that the {@link DataSource}
- * can switch between several states.
- */
-public class DatabaseStatesInitializer {
-
-  private final DataSource dataSource;
-
-  private final List<DatabaseState> databaseStates;
-
-  /**
-   * Constructor.
-   *
-   * @param dataSource     the {@link DataSource} to execute SQL scripts against.
-   * @param databaseStates the {@link DatabaseState}s to create within the {@link DataSource}.
-   */
-  public DatabaseStatesInitializer(DataSource dataSource, List<DatabaseState> databaseStates) {
-    this.dataSource = dataSource;
-    this.databaseStates = databaseStates;
-  }
-
-  /**
-   * Executes SQL scripts to initialize the {@link DataSource} with several states.
-   * <p/>
-   * For each {@link DatabaseState}, the {@link DatabaseStateHolder} will be called to set the {@link DataSource}
-   * into that state. Then, the SQL scripts of that {@link DatabaseState} are executed against the {@link DataSource}
-   * to initialize that state.
-   */
-  @PostConstruct
-  public void initialize() {
-    for (DatabaseState databaseState : this.databaseStates) {
-      DatabaseStateHolder.setCurrentDatabaseState(databaseState.getStateName());
-      ResourceDatabasePopulator populator = new ResourceDatabasePopulator();
-      for (String script : databaseState.getSqlscripts()) {
-        populator.addScript(new ClassPathResource(script));
-      }
-      populator.execute(this.dataSource);
-    }
-  }
-
-}

pact-spring-data-rest-provider/src/test/java/com/example/framework/PactDatabaseStatesAutoConfiguration.java

@@ -1,70 +0,0 @@
-package com.example.framework;
-
-import au.com.dius.pact.provider.junit.PactRunner;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
-import org.springframework.boot.autoconfigure.jdbc.DataSourceBuilder;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.context.annotation.Bean;
-import org.springframework.context.annotation.Configuration;
-import org.springframework.jdbc.datasource.lookup.AbstractRoutingDataSource;
-
-import javax.sql.DataSource;
-import java.util.HashMap;
-import java.util.Map;
-
-/**
- * <p>
- * {@link org.springframework.boot.autoconfigure.EnableAutoConfiguration AutoConfiguration} that is activated when
- * the pact-jvm-provider-junit module is in the classpath.
- * </p>
- * <p>
- * This configuration provides a {@link DataSource} which allows to switch between multiple database states.
- * Each database state is defined by a name and a set of SQL scripts which set the database into the desired state.
- * The database states are configured via properties:
- * <pre>
- *   pact.databaseStates.&lt;NAME&gt;=/path/to/script1.sql,/path/to/script2.sql,...
- * </pre>
- * The NAME of the databaseState can be used with {@link DatabaseStateHolder#setCurrentDatabaseState(String)}
- * to set the {@link DataSource} into that state.
- * </p>
- */
-@Configuration
-@ConditionalOnClass(PactRunner.class)
-@EnableConfigurationProperties(PactProperties.class)
-public class PactDatabaseStatesAutoConfiguration {
-
-  @Bean
-  public DataSource dataSource(PactProperties pactProperties) {
-    AbstractRoutingDataSource dataSource = new AbstractRoutingDataSource() {
-      @Override
-      protected Object determineCurrentLookupKey() {
-        return DatabaseStateHolder.getCurrentDatabaseState();
-      }
-    };
-
-    Map<Object, Object> targetDataSources = new HashMap<>();
-    dataSource.setTargetDataSources(targetDataSources);
-
-    // create a DataSource for each DatabaseState
-    for (DatabaseState databaseState : pactProperties.getDatabaseStatesList()) {
-      DataSource ds = DataSourceBuilder
-              .create()
-              .url(String.format("jdbc:h2:mem:%s;DB_CLOSE_ON_EXIT=FALSE", databaseState.getStateName()))
-              .driverClassName("org.h2.Driver")
-              .username("sa")
-              .password("")
-              .build();
-      targetDataSources.put(databaseState.getStateName(), ds);
-      DatabaseStateHolder.setCurrentDatabaseState(databaseState.getStateName());
-    }
-
-    return dataSource;
-  }
-
-  @Bean
-  public DatabaseStatesInitializer databaseStatesInitializer(DataSource routingDataSource, PactProperties pactProperties) {
-    return new DatabaseStatesInitializer(routingDataSource, pactProperties.getDatabaseStatesList());
-  }
-
-
-}

pact-spring-data-rest-provider/src/test/java/com/example/framework/PactProperties.java

@@ -1,64 +0,0 @@
-package com.example.framework;
-
-import org.springframework.boot.context.properties.ConfigurationProperties;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-
-/**
- * Loads the properties "pact.databaseStates.<NAME>" into the Spring environment.
- */
-@ConfigurationProperties("pact")
-public class PactProperties {
-
-  private Map<String, String> databaseStates;
-
-  /**
-   * Retrieves a map with the names of the configured database states as keys and {@link DatabaseState} objects
-   * as values.
-   */
-  public List<DatabaseState> getDatabaseStatesList() {
-    List<DatabaseState> databaseStatesList = new ArrayList<>();
-    for (Map.Entry<String, String> entry : databaseStates.entrySet()) {
-      String stateName = entry.getKey();
-
-      // When reading a property as a Map, as is done for databaseStates, Spring Boot automatically adds numeric
-      // keys and moves the actual key into the value, separated by a comma. Thus, we have all entries duplicated
-      // and have to remove the entries with numeric keys.
-
-      if (!stateName.matches("^[0-9]+$")) {
-        String sqlScriptsString = entry.getValue();
-        String[] sqlScripts = sqlScriptsString.split(",");
-        databaseStatesList.add(new DatabaseState(stateName, sqlScripts));
-      }
-    }
-    return databaseStatesList;
-  }
-
-
-  static List<String> toCommandLineArguments(List<DatabaseState> databaseStates) {
-    List<String> args = new ArrayList<>();
-    for (DatabaseState databaseState : databaseStates) {
-      String argString = String.format("--pact.databaseStates.%s=", databaseState.getStateName());
-      int i = 0;
-      for (String scriptPath : databaseState.getSqlscripts()) {
-        argString += String.format("%s", scriptPath);
-        if (i < databaseState.getSqlscripts().length - 1) {
-          argString += ",";
-        }
-        i++;
-      }
-      args.add(argString);
-    }
-    return args;
-  }
-
-  public Map<String, String> getDatabaseStates() {
-    return databaseStates;
-  }
-
-  public void setDatabaseStates(Map<String, String> databaseStates) {
-    this.databaseStates = databaseStates;
-  }
-}

pact-spring-data-rest-provider/src/test/java/com/example/framework/SpringBootStarter.java

@@ -1,111 +0,0 @@
-package com.example.framework;
-
-import org.junit.rules.TestRule;
-import org.junit.runner.Description;
-import org.junit.runners.model.Statement;
-import org.springframework.boot.SpringApplication;
-import org.springframework.context.ApplicationContext;
-
-import java.util.ArrayList;
-import java.util.List;
-
-/**
- * <p>
- * Starts a Spring Boot application.
- * </p>
- * <p>
- * When included in a JUnit test with the {@link org.junit.ClassRule} annotation as in the example below, the Spring Boot application will be
- * started before any of the test methods are run.
- * <pre>
- * public class MyTest {
- *
- *   &#064;ClassRule
- *   public static SpringBootStarter starter = SpringBootStarter.builder()
- *     .withApplicationClass(MyApplication.class)
- *     ...
- *     .build();
- *
- *   &#064;Test
- *   public void test(){
- *     ...
- *   }
- *
- * }
- * </pre>
- * </p>
- */
-public class SpringBootStarter implements TestRule {
-
-  private final Class<?> applicationClass;
-
-  private final List<String> args;
-
-  private final List<DatabaseState> databaseStates;
-
-  /**
-   * Constructor.
-   *
-   * @param applicationClass the Spring Boot application class.
-   * @param databaseStates   list containing {@link DatabaseState} objects, each describing a database state
-   *                         in form of one or more SQL scripts.
-   * @param args             the command line arguments the application should be started with.
-   */
-  public SpringBootStarter(Class<?> applicationClass, List<DatabaseState> databaseStates, List<String> args) {
-    this.args = args;
-    this.applicationClass = applicationClass;
-    this.databaseStates = databaseStates;
-  }
-
-  @Override
-  public Statement apply(Statement base, Description description) {
-    return new Statement() {
-      @Override
-      public void evaluate() throws Throwable {
-        List<String> args = new ArrayList<>();
-        args.addAll(SpringBootStarter.this.args);
-        args.addAll(PactProperties.toCommandLineArguments(SpringBootStarter.this.databaseStates));
-        ApplicationContext context = SpringApplication.run(SpringBootStarter.this.applicationClass, args.toArray(new String[]{}));
-        base.evaluate();
-        SpringApplication.exit(context);
-      }
-    };
-  }
-
-  /**
-   * Creates a builder that provides a fluent API to create a new {@link SpringBootStarter} instance.
-   */
-  public static SpringBootStarterBuilder builder() {
-    return new SpringBootStarterBuilder();
-  }
-
-  public static class SpringBootStarterBuilder {
-
-    private Class<?> applicationClass;
-
-    private List<String> args = new ArrayList<>();
-
-    private List<DatabaseState> databaseStates = new ArrayList<>();
-
-    public SpringBootStarterBuilder withApplicationClass(Class<?> clazz) {
-      this.applicationClass = clazz;
-      return this;
-    }
-
-    public SpringBootStarterBuilder withArgument(String argument) {
-      this.args.add(argument);
-      return this;
-    }
-
-    public SpringBootStarterBuilder withDatabaseState(String stateName, String... sqlScripts) {
-      this.databaseStates.add(new DatabaseState(stateName, sqlScripts));
-      return this;
-    }
-
-    public SpringBootStarter build() {
-      return new SpringBootStarter(this.applicationClass, this.databaseStates, args);
-    }
-
-  }
-
-
-}

pact-spring-data-rest-provider/src/test/resources/META-INF/spring.factories

@@ -1 +0,0 @@
-org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.framework.PactDatabaseStatesAutoConfiguration

pact-spring-data-rest-provider/src/test/resources/address-collection.sql

@@ -1,2 +0,0 @@
-insert into address (id, street) values (1, 'Elm Street');
-insert into address (id, street) values (2, 'High Street');

pact-spring-data-rest-provider/src/test/resources/application-pact.properties

@@ -1,6 +0,0 @@
-server.port=8080
-#spring.jpa.generate-ddl=false
-spring.jpa.hibernate.ddl-auto=none
-
-pact.databaseStates[0]=single-address,/initial-schema.sql,/single-address.sql
-pact.databaseStates[1]=address-collection,/initial-schema.sql,/address-collection.sql

pact-spring-data-rest-provider/src/test/resources/initial-schema.sql

@@ -1,11 +0,0 @@
-create table CUSTOMER (
-  id NUMBER,
-  name VARCHAR
-);
-
-create table ADDRESS (
-  id NUMBER,
-  customer_id NUMBER,
-  street VARCHAR,
-  FOREIGN KEY (customer_id) REFERENCES CUSTOMER(id)
-);

pact-spring-data-rest-provider/src/test/resources/single-address.sql

@@ -1 +0,0 @@
-insert into address (id, street) values (1, 'Elm Street');

pact-spring-provider/src/main/resources/application.properties

@@ -1,7 +0,0 @@
-spring.datasource.url=jdbc:h2:mem:AZ;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
-spring.datasource.driverClassName=org.h2.Driver
-spring.datasource.username=sa
-spring.datasource.password=
-spring.h2.console.enabled=true
-
-logging.level.org.hibernate.SQL=OFF

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,27 @@
+apply plugin: 'org.springframework.boot'
+
+buildscript {
+    repositories {
+        mavenLocal()
+        jcenter()
+    }
+    dependencies {
+        classpath "org.springframework.boot:spring-boot-gradle-plugin:${springboot_version}"
+    }
+}
+
+
+repositories {
+    mavenLocal()
+    jcenter()
+}
+
+dependencies {
+    compile("org.springframework.boot:spring-boot-starter-data-jpa:${springboot_version}")
+    compile("org.springframework.boot:spring-boot-starter-web:${springboot_version}")
+    compile("org.springframework.cloud:spring-cloud-starter-feign:1.4.1.RELEASE")
+    compile('com.h2database:h2:1.4.196')
+    testCompile('org.codehaus.groovy:groovy-all:2.4.6')
+    testCompile("au.com.dius:pact-jvm-consumer-junit_2.11:3.5.2")
+    testCompile("org.springframework.boot:spring-boot-starter-test:${springboot_version}")
+}

pact/pact-feign-consumer/gradle.properties

@@ -0,0 +1,2 @@
+springboot_version=1.5.9.RELEASE
+verifier_version=1.2.2.RELEASE

pact/pact-feign-consumer/src/main/java/io/reflectoring/ConsumerApplication.java

@@ -0,0 +1,15 @@
+package io.reflectoring;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.netflix.feign.EnableFeignClients;
+
+@SpringBootApplication
+@EnableFeignClients
+public class ConsumerApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(ConsumerApplication.class, args);
+	}
+
+}

pact/pact-feign-consumer/src/main/java/io/reflectoring/FeignConfiguration.java

@@ -1,4 +1,4 @@
-package com.example.demo;
+package io.reflectoring;
 
 import feign.Logger;
 import org.springframework.context.annotation.Bean;

pact/pact-feign-consumer/src/main/java/io/reflectoring/IdObject.java

@@ -0,0 +1,19 @@
+package io.reflectoring;
+
+public class IdObject {
+
+	private long id;
+
+	public IdObject(long id) {
+		this.id = id;
+	}
+
+	public IdObject(){
+		// default constructor for JSON deserialization
+	}
+
+	public long getId() {
+		return id;
+	}
+
+}

pact/pact-feign-consumer/src/main/java/io/reflectoring/UserClient.java

@@ -0,0 +1,21 @@
+package io.reflectoring;
+
+import org.springframework.cloud.netflix.feign.FeignClient;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+@FeignClient(name = "userservice")
+public interface UserClient {
+
+  @RequestMapping(method = RequestMethod.GET, path = "/user-service/users/{id}")
+  User getUser(@PathVariable("id") Long id);
+
+  @RequestMapping(method = RequestMethod.PUT, path = "/user-service/users/{id}")
+  User updateUser(@PathVariable("id") Long id, @RequestBody User user);
+
+  @RequestMapping(method = RequestMethod.POST, path = "/user-service/users")
+  IdObject createUser(@RequestBody User user);
+
+}

pact/pact-feign-consumer/src/test/java/io/reflectoring/UserServiceConsumerTest.java

@@ -0,0 +1,83 @@
+package io.reflectoring;
+
+import au.com.dius.pact.consumer.Pact;
+import au.com.dius.pact.consumer.PactProviderRuleMk2;
+import au.com.dius.pact.consumer.PactVerification;
+import au.com.dius.pact.consumer.dsl.PactDslJsonBody;
+import au.com.dius.pact.consumer.dsl.PactDslWithProvider;
+import au.com.dius.pact.model.RequestResponsePact;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import static org.assertj.core.api.Assertions.assertThat;
+
+@RunWith(SpringRunner.class)
+@SpringBootTest(properties = {
+        // overriding provider address
+        "userservice.ribbon.listOfServers: localhost:8888"
+})
+public class UserServiceConsumerTest {
+
+  @Rule
+  public PactProviderRuleMk2 stubProvider = new PactProviderRuleMk2("userservice", "localhost", 8888, this);
+
+  @Autowired
+  private UserClient userClient;
+
+  @Pact(state = "provider accepts a new person", provider = "userservice", consumer = "userclient")
+  public RequestResponsePact createPersonPact(PactDslWithProvider builder) {
+    return builder
+            .given("provider accepts a new person")
+            .uponReceiving("a request to POST a person")
+            .path("/user-service/users")
+            .method("POST")
+            .willRespondWith()
+            .status(201)
+            .matchHeader("Content-Type", "application/json")
+            .body(new PactDslJsonBody()
+                    .integerType("id", 42))
+            .toPact();
+  }
+
+  @Pact(state = "person 42 exists", provider = "userservice", consumer = "userclient")
+  public RequestResponsePact updatePersonPact(PactDslWithProvider builder) {
+    return builder
+            .given("person 42 exists")
+            .uponReceiving("a request to PUT a person")
+            .path("/user-service/users/42")
+            .method("PUT")
+            .willRespondWith()
+            .status(200)
+            .matchHeader("Content-Type", "application/json")
+            .body(new PactDslJsonBody()
+                    .stringType("firstName", "Zaphod")
+                    .stringType("lastName", "Beeblebrox"))
+            .toPact();
+  }
+
+
+  @Test
+  @PactVerification(fragment = "createPersonPact")
+  public void verifyCreatePersonPact() {
+    User user = new User();
+    user.setFirstName("Zaphod");
+    user.setLastName("Beeblebrox");
+    IdObject id = userClient.createUser(user);
+    assertThat(id.getId()).isEqualTo(42);
+  }
+
+  @Test
+  @PactVerification(fragment = "updatePersonPact")
+  public void verifyUpdatePersonPact() {
+    User user = new User();
+    user.setFirstName("Zaphod");
+    user.setLastName("Beeblebrox");
+    User updatedUser = userClient.updateUser(42L, user);
+    assertThat(updatedUser.getFirstName()).isEqualTo("Zaphod");
+    assertThat(updatedUser.getLastName()).isEqualTo("Beeblebrox");
+  }
+
+}