Improve exercise one.

jwloka · jwloka · commit 370b35d4c38a · 2017-03-13T16:21:18.000+01:00
Make structure of tests consistent in provider and consumer.
Restructure pact execution to move things next to each other.
Rename Provider test.
Add comments to each pact test.
Update presentation file accordingly.
diff --git a/address-service/src/test/java/net/nautsch/address/AddressTest.java b/address-service/src/test/java/net/nautsch/address/AddressTest.java
@@ -1,5 +1,7 @@
 package net.nautsch.address;
 
+import net.nautsch.address.builders.a;
+
 import org.junit.Test;
 
 import static org.hamcrest.CoreMatchers.is;
diff --git a/address-service/src/test/java/net/nautsch/address/builders/AddressBuilder.java b/address-service/src/test/java/net/nautsch/address/builders/AddressBuilder.java
@@ -1,4 +1,6 @@
-package net.nautsch.address;
+package net.nautsch.address.builders;
+
+import net.nautsch.address.Address;
 
 public class AddressBuilder {
 
diff --git a/address-service/src/test/java/net/nautsch/address/builders/a.java b/address-service/src/test/java/net/nautsch/address/builders/a.java
@@ -1,4 +1,4 @@
-package net.nautsch.address;
+package net.nautsch.address.builders;
 
 public class a {
 
diff --git a/address-service/src/test/java/net/nautsch/address/pact/PactProviderVerificationTest.java b/address-service/src/test/java/net/nautsch/address/pact/PactProviderVerificationTest.java
@@ -6,6 +6,7 @@
 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 org.junit.Before;
 import org.junit.runner.RunWith;
 import org.springframework.boot.test.context.SpringBootTest;
@@ -18,19 +19,19 @@
 @Provider("address_service")
 @PactFolder("pacts")
 //@PactBroker(host="broker.nautsch.net", port = "80")
-@SpringBootTest(webEnvironment= SpringBootTest.WebEnvironment.DEFINED_PORT)
-public class ProviderPactTest {
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
+public class PactProviderVerificationTest {
 
-    private static int port =8888;
+    private final static int PORT = 8888;
 
 
     @Before
     public void before() throws Exception {
-        TestContextManager testContextManager = new TestContextManager(ProviderPactTest.class);
+        TestContextManager testContextManager = new TestContextManager(PactProviderVerificationTest.class);
         testContextManager.prepareTestInstance(this);
     }
 
 
     @TestTarget
-    public final Target target = new HttpTarget(port);
+    public final Target target = new HttpTarget(PORT);
 }
diff --git a/invoice-service/src/test/java/net/nautsch/invoice/RecipientProviderTest.java b/invoice-service/src/test/java/net/nautsch/invoice/RecipientProviderTest.java
@@ -1,6 +1,8 @@
 package net.nautsch.invoice;
 
 import net.nautsch.invoice.adapters.address.AddressToRecipientConverter;
+import net.nautsch.invoice.builders.a;
+
 import org.junit.Test;
 
 import static org.hamcrest.CoreMatchers.notNullValue;
@@ -15,7 +17,7 @@ public class RecipientProviderTest {
     public void shouldDeliverRecipient() {
         // given
         AddressProvider addressProvider =
-                a.recipientProvider().delivering(a.address()).build();
+                a.addressProvider().delivering(a.address()).build();
 
         RecipientProvider sut = new RecipientProvider(addressProvider, new AddressToRecipientConverter());
         // when
diff --git a/invoice-service/src/test/java/net/nautsch/invoice/adapters/address/AddressToRecipientConverterTest.java b/invoice-service/src/test/java/net/nautsch/invoice/adapters/address/AddressToRecipientConverterTest.java
@@ -2,7 +2,7 @@
 
 import net.nautsch.invoice.Address;
 import net.nautsch.invoice.Recipient;
-import net.nautsch.invoice.a;
+import net.nautsch.invoice.builders.a;
 import org.junit.Test;
 
 import static org.hamcrest.CoreMatchers.is;
diff --git a/invoice-service/src/test/java/net/nautsch/invoice/builders/AddressBuilder.java b/invoice-service/src/test/java/net/nautsch/invoice/builders/AddressBuilder.java
@@ -1,4 +1,6 @@
-package net.nautsch.invoice;
+package net.nautsch.invoice.builders;
+
+import net.nautsch.invoice.Address;
 
 /**
  * test data builder.
@@ -8,6 +10,10 @@ public class AddressBuilder {
     private String surname = "surname";
     private String firstname = "firstname";
 
+    AddressBuilder() {
+        super();
+    }
+
     public Address build() {
         return new AddressDummy();
     }
diff --git a/invoice-service/src/test/java/net/nautsch/invoice/builders/AddressProviderBuilder.java b/invoice-service/src/test/java/net/nautsch/invoice/builders/AddressProviderBuilder.java
@@ -1,22 +1,29 @@
-package net.nautsch.invoice;
+package net.nautsch.invoice.builders;
+
+import net.nautsch.invoice.Address;
+import net.nautsch.invoice.AddressProvider;
 
 /**
  * test data builder.
  */
-class AddressProviderBuilder {
+public class AddressProviderBuilder {
 
     private Address addressToDeliver;
 
-    AddressProvider build() {
+    AddressProviderBuilder() {
+        super();
+    }
+
+    public AddressProvider build() {
         return new AddressProviderDummy();
     }
 
-    AddressProviderBuilder delivering(Address address) {
+    public AddressProviderBuilder delivering(Address address) {
         this.addressToDeliver = address;
         return this;
     }
 
-    AddressProviderBuilder delivering(AddressBuilder address) {
+    public AddressProviderBuilder delivering(AddressBuilder address) {
         this.delivering(address.build());
         return this;
     }
diff --git a/invoice-service/src/test/java/net/nautsch/invoice/builders/a.java b/invoice-service/src/test/java/net/nautsch/invoice/builders/a.java
@@ -1,11 +1,11 @@
-package net.nautsch.invoice;
+package net.nautsch.invoice.builders;
 
 /**
  * start point for all test data builders.
  */
 public class a {
 
-    public static AddressProviderBuilder recipientProvider() {
+    public static AddressProviderBuilder addressProvider() {
         return new AddressProviderBuilder();
     }
 
diff --git a/invoice-service/src/test/java/net/nautsch/invoice/pact/AddressServiceAdapterTest.java b/invoice-service/src/test/java/net/nautsch/invoice/pact/AddressServiceAdapterTest.java
@@ -1,78 +1,70 @@
-package net.nautsch.invoice.adapters.address;
+package net.nautsch.invoice.pact;
 
 import au.com.dius.pact.consumer.ConsumerPactBuilder;
 import au.com.dius.pact.consumer.PactError;
-import au.com.dius.pact.consumer.TestRun;
 import au.com.dius.pact.consumer.VerificationResult;
 import au.com.dius.pact.consumer.dsl.PactDslJsonBody;
 import au.com.dius.pact.model.MockProviderConfig;
 import au.com.dius.pact.model.PactFragment;
 import au.com.dius.pact.model.PactSpecVersion;
+import java.util.Collections;
+import java.util.function.Consumer;
 import net.nautsch.invoice.Address;
-import org.apache.http.entity.ContentType;
-import org.junit.Test;
+import net.nautsch.invoice.adapters.address.AddressServiceAdapter;
 
-import java.util.HashMap;
-import java.util.Map;
+import org.apache.http.HttpStatus;
+import org.junit.Test;
 
 import static au.com.dius.pact.consumer.ConsumerPactTest.PACT_VERIFIED;
+import static org.apache.http.entity.ContentType.APPLICATION_JSON;
 import static org.hamcrest.CoreMatchers.is;
 import static org.junit.Assert.assertThat;
 
 /**
- * integration test.
+ * Pact consumer test, generates the consumer contract.
  */
 public class AddressServiceAdapterTest {
 
     private static final String ADDRESS = "address_service";
     private static final String INVOICE = "invoice_service";
 
-
-    // tag::shouldDeliverAnAddress[]
+    // tag::shouldDeliverValidAddress[]
     @Test
-    public void shouldDeliverAnAddress() {
+    public void shouldDeliverValidAddress() {
         PactDslJsonBody responseBody = new PactDslJsonBody()
                 .stringType("firstName", "Jan")
                 .stringType("surname", "Wloka");
 
-        PactFragment fragment = buildPactFragment(responseBody, "get an address");
+        PactFragment pact = buildPact("", responseBody, "get an address");
 
-        runTest(fragment);
-    }
-    // end::shouldDeliverAnAddress[]
+        assertPact(pact, config -> {
+            Address actual = new AddressServiceAdapter(config.url()).getAddress("1");
 
-    private PactFragment buildPactFragment(PactDslJsonBody responseBody, String description) {
-        return buildPactFragment("", responseBody, description);
+            assertThat(actual.getFirstName(), is("Jan"));
+            assertThat(actual.getSurname(), is("Wloka"));
+        });
     }
+    // end::shouldDeliverValidAddress[]
 
-    private PactFragment buildPactFragment(String requestBody, PactDslJsonBody responseBody, String description) {
-        Map<String, String> headers = new HashMap<>();
-        headers.put("Content-Type", ContentType.APPLICATION_JSON.toString());
+    private PactFragment buildPact(String requestBody, PactDslJsonBody responseBody, String description) {
         return ConsumerPactBuilder
                 .consumer(INVOICE)
                 .hasPactWith(ADDRESS)
                 .uponReceiving(description)
                     .path("/addresses/1")
                     .method("GET")
                     .body(requestBody)
-                    .headers(new HashMap<>())
+                    .headers(Collections.emptyMap())
                 .willRespondWith()
-                    .status(200)
+                    .status(HttpStatus.SC_OK)
                     .body(responseBody)
-                    .headers(headers)
+                    .headers(Collections.singletonMap("Content-Type", APPLICATION_JSON.toString()))
                     .toFragment();
     }
 
-    private void runTest(final PactFragment pactFragment) {
+    private void assertPact(PactFragment pact, Consumer<MockProviderConfig> consumer) {
         MockProviderConfig config = MockProviderConfig.createDefault(PactSpecVersion.V3);
-        VerificationResult result = pactFragment.runConsumer(config, new TestRun() {
-            @Override
-            public void run(MockProviderConfig config) {
-                Address result = new AddressServiceAdapter(config.url()).getAddress("1");
-                assertThat(result.getFirstName(), is("Jan"));
-                assertThat(result.getSurname(), is("Wloka"));
-            }
-        });
+        VerificationResult result = pact.runConsumer(config, consumer::accept);
 
         if (result instanceof PactError) {
             throw new RuntimeException(((PactError)result).error());
diff --git a/presentation/src/docs/asciidoc/presentation.adoc b/presentation/src/docs/asciidoc/presentation.adoc
@@ -22,11 +22,16 @@ Let's exercise, hack and talk about
 
 image::service-example.png[consumer - communicate - producer]
 
-== Exercise-01 - Run the test
+== Exercise-01 - Run the tests
 
-* checkout repo `git@github.com:ollin/cdc-workshop.git`
-* cd into `cdc-workshop`
-* run `./gradlew check` (on windows: `./gradlew.bat check`)
+* *Get the code:*
+** checkout repo +
+     `git@github.com:ollin/cdc-workshop.git`
+** cd into `cdc-workshop`
+* *Check your setup:*
+** run `./gradlew check` (on windows: `./gradlew.bat`)
+* *Run the tests:*
+** run `./gradlew clean test` (on windows: `./gradlew.bat`)
 
 == Project Overview
 
@@ -67,14 +72,14 @@ image::service-overview.png[projects - producer - consumer]
 == Consumers test
 
 [source,java]
-.cdc-workshop/invoice-service/src/test/java/net/nautsch/invoice/adapters/address/AddressServiceAdapterTest.java
+.cdc-workshop/invoice-service/src/test/java/net/nautsch/invoice/pact/AddressServiceAdapterTest.java
 ----
 ...
-include::{invoice-sourcedir}/src/test/java/net/nautsch/invoice/adapters/address/AddressServiceAdapterTest.java[tags=shouldDeliverAnAddress]
+include::{invoice-sourcedir}/src/test/java/net/nautsch/invoice/pact/AddressServiceAdapterTest.java[tags=shouldDeliverValidAddress]
 ...
 ----
 
-== Exercise-02 - Add street
+== Exercise-02 - Add street to consumer
 
 The Consumer needs a street value
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package net.nautsch.address;`
	`1`	`+package net.nautsch.address.builders;`
`2`	`2`
`3`	`3`	`public class a {`
`4`	`4`