Merge

.github/CONTRIBUTING.md

@@ -1,22 +1,12 @@
 # Contribution Guidelines
 
-First of all, thanks for thinking of contributing to this project. :smile:
+First of all, thank you for your interest in contributing to this project !
 
-- Before sending a Pull Request, please make sure that you have had a discussion with the project admins.
-    - If a relevant issue already exists, discuss on the issue and make sure that the admins are okay with your approach
-    - If no relevant issue exists, open a new issue and discuss
+* Before submitting a [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) (PR), please make sure that you have had a discussion with the project-leads
+* If a [relevant issue](https://github.com/intuit/karate/issues) already exists, have a discussion within that issue (by commenting) - and make sure that the project-leads are okay with your approach
+* If no relevant issue exists, please [open a new issue](https://github.com/intuit/karate/issues) to start a discussion
+* Please proceed with a PR only *after* the project admins or owners are okay with your approach. We don't want you to spend time and effort working on something - only to find out later that it was not aligned with how the project developers were thinking about it !
+* You can refer to the [Developer Guide](https://github.com/intuit/karate/wiki/Developer-Guide) for information on how to build and test the project on your local / developer machine
+* **IMPORTANT**: Submit your PR(s) against the [`develop`](https://github.com/intuit/karate/tree/develop) branch of this repository
 
-    Please proceed with a Pull Request only after the project admins or owners are okay with your approach. It'd be sad if your Pull Request (and your hard work) isn't accepted just because it isn't ideologically compatible.
-
-- Install the required dependencies.
-    - Install Git so that you can clone and later submit a PR for this project.
-    - Install Java JDK (>= 1.8.0_112) installed, from [this link](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
-    - Install Eclipse from [this link](http://www.eclipse.org/downloads/).
-    - (optional) Install Maven from [this link](http://maven.apache.org), if you need to build the project from the command-line.
-
-- Have some issue with setting up the project?
-    - [How to open the project in Eclipse as a Maven project?](https://stackoverflow.com/a/36242422/143475)
-    - [Maven is not able to install the dependencies behind proxy!]()
-    - Not listed here? Kindly search on Google / Stack Overflow. If you don't find a solution, feel free to open up a new issue in the issue tracker and maybe subsequently add it here.
-
-- Send in your Pull Request(s) to the `develop` branch of this repository.
+If you are interested in project road-map items that you can potentially contribute to, please refer to the [Project Board](https://github.com/intuit/karate/projects/3).

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 ### Description
 
-Thanks for contributing this Pull Request. Make sure that you send in this Pull Request to the `develop` branch of this repository, add a brief description, and tag the relevant issue(s) and PR(s) below.
+Thanks for contributing this Pull Request. Make sure that you submit this Pull Request against the `develop` branch of this repository, add a brief description, and tag the relevant issue(s) and PR(s) below.
 
 - Relevant Issues : (compulsory)
 - Relevant PRs : (optional)

.gitignore

@@ -4,13 +4,22 @@ target/
 .project
 .settings
 .classpath
+.vscode
 *.iml
 build/
+bin/
 .gradle
 gradle
 gradlew
 gradlew.*
 dependency-reduced-pom.xml
+examples/zip-release/*.jar
 karate-demo/activemq-data/
+karate-demo/*.pem
+karate-demo/*.jks
+karate-demo/*.der
+karate-netty/*.pem
+karate-netty/*.jks
+karate-netty/*.der
 karate-junit4/src/test/java/com/intuit/karate/junit4/dev
 

.travis.yml

@@ -1,11 +1,7 @@
 language: java
+cache:
+  directories:
+  - "$HOME/.m2"
 jdk:
-  - oraclejdk8
-sudo: false
-addons:
-  apt:
-    packages:
-      - oracle-java8-installer
-install: true
-script: mvn install -P pre-release -Dmaven.javadoc.skip=true -B -V
-
+  - openjdk8
+script: mvn install -P pre-release -Dmaven.javadoc.skip=true -B -V -Djavacpp.platform=linux-x86_64

examples/consumer-driven-contracts/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+target/
+

examples/consumer-driven-contracts/README.md

@@ -0,0 +1,22 @@
+# Karate Consumer Driven Contracts Demo
+
+## References
+This is a simplified version of the [example in the Karate test-doubles documentation](https://github.com/intuit/karate/tree/master/karate-netty#consumer-provider-example) - with JMS / queues removed and simplified to be a stand-alone maven project.
+
+Also see [The World's Smallest Microservice](https://www.linkedin.com/pulse/worlds-smallest-micro-service-peter-thomas/).
+
+## Instructions
+* clone the project
+* `mvn clean test`
+
+## Main Artifacts
+| File | Description | Comment |
+| ---- | ----------- | ------- |
+| [PaymentService.java](payment-producer/src/main/java/payment/producer/PaymentService.java) | Producer | A very simple [Spring Boot](https://spring.io/projects/spring-boot) app / REST service |
+| [payment-contract.feature](payment-producer/src/test/java/payment/producer/contract/payment-contract.feature) | Contract + Functional Test | [Karate](https://github.com/intuit/karate) API test |
+| [PaymentContractTest.java](payment-producer/src/test/java/payment/producer/contract/PaymentContractTest.java) | Producer Integration Test | JUnit runner for the above |
+| [payment-mock.feature](payment-producer/src/test/java/payment/producer/mock/payment-mock.feature) | Mock / Stub | [Karate mock](https://github.com/intuit/karate/tree/master/karate-netty) that *perfectly* simulates the Producer ! | 
+| [PaymentContractAgainstMockTest.java](payment-producer/src/test/java/payment/producer/mock/PaymentContractAgainstMockTest.java) | Verify that the Mock is as per Contract | JUnit runner that points `payment-contract.feature` --> `payment-mock.feature` |
+| [Consumer.java](payment-consumer/src/main/java/payment/consumer/Consumer.java) | Consumer | A simple Java app that calls the Producer to do some work |
+| [ConsumerIntegrationTest.java](payment-consumer/src/test/java/payment/consumer/ConsumerIntegrationTest.java) | Consumer Integration Test | A JUnit *full* integration test, using the *real* Consumer and Producer |
+| [ConsumerIntegrationAgainstMockTest.java](payment-consumer/src/test/java/payment/consumer/ConsumerIntegrationAgainstMockTest.java) | Consumer Integration Test but using the Mock | Like the above but using the mock Producer |

examples/consumer-driven-contracts/payment-consumer/pom.xml

@@ -0,0 +1,27 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.intuit.karate.examples</groupId>
+        <artifactId>examples-cdc</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>examples-cdc-consumer</artifactId>
+    <packaging>jar</packaging>      
+
+    <dependencies>
+        <dependency>
+            <groupId>com.intuit.karate.examples</groupId>
+            <artifactId>examples-cdc-producer</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-io</groupId>
+            <artifactId>commons-io</artifactId>
+            <version>2.5</version>
+        </dependency>                                                        		
+    </dependencies>
+
+</project>

examples/consumer-driven-contracts/payment-consumer/src/main/java/payment/consumer/Consumer.java

@@ -0,0 +1,50 @@
+package payment.consumer;
+
+import com.intuit.karate.FileUtils;
+import com.intuit.karate.JsonUtils;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import org.apache.commons.io.IOUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import payment.producer.Payment;
+
+/**
+ *
+ * @author pthomas3
+ */
+public class Consumer {
+
+    private static final Logger logger = LoggerFactory.getLogger(Consumer.class);
+
+    private final String paymentServiceUrl;
+
+    public Consumer(String paymentServiceUrl) {
+        this.paymentServiceUrl = paymentServiceUrl;
+    }
+
+    private HttpURLConnection getConnection(String path) throws Exception {
+        URL url = new URL(paymentServiceUrl + path);
+        return (HttpURLConnection) url.openConnection();
+    }
+
+    public Payment create(Payment payment) {
+        try {
+            HttpURLConnection con = getConnection("/payments");
+            con.setRequestMethod("POST");
+            con.setDoOutput(true);
+            con.setRequestProperty("Content-Type", "application/json");
+            String json = JsonUtils.toJson(payment);
+            IOUtils.write(json, con.getOutputStream(), "utf-8");
+            int status = con.getResponseCode();
+            if (status != 200) {
+                throw new RuntimeException("status code was " + status);
+            }
+            String content = FileUtils.toString(con.getInputStream());
+            return JsonUtils.fromJson(content, Payment.class);
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+}

examples/consumer-driven-contracts/payment-consumer/src/test/java/logback-test.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>
+
+    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
+        <file>target/karate.log</file>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
+        </encoder>
+    </appender>    
+
+    <logger name="com.intuit.karate" level="DEBUG"/>
+    <logger name="com.mycompany" level="DEBUG"/>
+    <logger name="payment" level="DEBUG"/>
+
+    <root level="warn">
+        <appender-ref ref="STDOUT" />
+        <appender-ref ref="FILE" />
+    </root>
+
+</configuration>

examples/consumer-driven-contracts/payment-consumer/src/test/java/payment/consumer/ConsumerIntegrationAgainstMockTest.java

@@ -0,0 +1,44 @@
+package payment.consumer;
+
+import com.intuit.karate.netty.FeatureServer;
+import java.io.File;
+import org.junit.AfterClass;
+import org.junit.Test;
+import static org.junit.Assert.*;
+import org.junit.BeforeClass;
+import payment.producer.Payment;
+
+/**
+ *
+ * @author pthomas3
+ */
+public class ConsumerIntegrationAgainstMockTest {
+
+    private static FeatureServer server;
+    private static Consumer consumer;
+
+    @BeforeClass
+    public static void beforeClass() {
+        File file = new File("../payment-producer/src/test/java/payment/producer/mock/payment-mock.feature");
+        server = FeatureServer.start(file, 0, false, null);
+        String paymentServiceUrl = "http://localhost:" + server.getPort();
+        consumer = new Consumer(paymentServiceUrl);        
+    }    
+
+    @Test
+    public void testPaymentCreate() throws Exception {
+        Payment payment = new Payment();
+        payment.setAmount(5.67);
+        payment.setDescription("test one");
+        payment = consumer.create(payment);
+        assertTrue(payment.getId() > 0);
+        assertEquals(payment.getAmount(), 5.67, 0);
+        assertEquals(payment.getDescription(), "test one");    
+    }
+
+    @AfterClass
+    public static void afterClass() {
+        server.stop();
+    }    
+
+}

examples/consumer-driven-contracts/payment-consumer/src/test/java/payment/consumer/ConsumerIntegrationTest.java

@@ -0,0 +1,43 @@
+package payment.consumer;
+
+import org.junit.AfterClass;
+import org.junit.Test;
+import static org.junit.Assert.*;
+import org.junit.BeforeClass;
+import org.springframework.context.ConfigurableApplicationContext;
+import payment.producer.Payment;
+import payment.producer.PaymentService;
+
+/**
+ *
+ * @author pthomas3
+ */
+public class ConsumerIntegrationTest {
+
+    private static ConfigurableApplicationContext context;
+    private static Consumer consumer;
+
+    @BeforeClass
+    public static void beforeClass() {
+        context = PaymentService.start();
+        String paymentServiceUrl = "http://localhost:" + PaymentService.getPort(context);
+        consumer = new Consumer(paymentServiceUrl);       
+    }
+
+    @Test
+    public void testPaymentCreate() throws Exception {
+        Payment payment = new Payment();
+        payment.setAmount(5.67);
+        payment.setDescription("test one");
+        payment = consumer.create(payment);
+        assertTrue(payment.getId() > 0);
+        assertEquals(payment.getAmount(), 5.67, 0);
+        assertEquals(payment.getDescription(), "test one");
+    }
+
+    @AfterClass
+    public static void afterClass() {
+        PaymentService.stop(context);
+    }
+
+}

examples/consumer-driven-contracts/payment-producer/pom.xml

@@ -0,0 +1,29 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.intuit.karate.examples</groupId>
+        <artifactId>examples-cdc</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>examples-cdc-producer</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>        
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-dependencies</artifactId>
+            <version>${spring.boot.version}</version>
+            <type>pom</type>
+            <scope>import</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <version>${spring.boot.version}</version>
+        </dependency>                                                                            		
+    </dependencies>
+
+</project>

examples/consumer-driven-contracts/payment-producer/src/main/java/payment/producer/Payment.java

@@ -0,0 +1,37 @@
+package payment.producer;
+
+/**
+ *
+ * @author pthomas3
+ */
+public class Payment {
+
+    private int id;
+    private double amount;
+    private String description;
+
+    public int getId() {
+        return id;
+    }
+
+    public void setId(int id) {
+        this.id = id;
+    }
+
+    public double getAmount() {
+        return amount;
+    }
+
+    public void setAmount(double amount) {
+        this.amount = amount;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }        
+
+}