feat: add prism Docker setup (#626)

Author: childish-sambino

.gitignore

@@ -17,3 +17,4 @@ examples/Example.java
 .vscode
 sendgrid-java.jar
 dependency-reduced-pom.xml
+prism*

.travis.yml

@@ -1,35 +1,19 @@
 language: java
 before_install:
   - echo $GPG_SECRET_KEYS | base64 --decode | $GPG_EXECUTABLE --import --batch || true
-matrix:
-  include:
-    - jdk: openjdk7
-      dist: trusty
-    - jdk: openjdk8
-      dist: xenial
-    - jdk: openjdk11
-      dist: xenial
-    - jdk: oraclejdk7
-      dist: precise
-    - jdk: oraclejdk8
-      dist: trusty
-    - jdk: oraclejdk11
-      dist: trusty
-  allow_failures:
-    - jdk: openjdk7
-    - jdk: oraclejdk7
-before_script:
-  - "./scripts/startPrism.sh &"
-  - sleep 20
-install:
-  - mvn --settings .maven.xml install -DskipTests=true -Dgpg.skip -Dmaven.javadoc.skip=true -B -V
+env:
+  - version=8
+  - version=11
+script:
+  - make test-docker
+
 deploy:
   - provider: script
     script: mvn clean deploy --settings .maven.xml -DskipTests=true -B -U -Prelease
     edge: true
     on:
       tags: true
-      jdk: openjdk8
+      condition: $version = 8
       branch: master
 
 notifications:

CONTRIBUTING.md

@@ -128,25 +128,9 @@ All test files are in the [`tests`](https://github.com/sendgrid/sendgrid-java/tr
 
 For the purposes of contributing to this repo, please update the [`SendGridTest.java`](https://github.com/sendgrid/sendgrid-java/tree/master/src/test/java/com/sendgrid/SendGridTest.java) file with unit tests as you modify the code.
 
-1. Download [prism](http://stoplight.io/platform/prism/) for your platform ([Mac OS X](https://github.com/stoplightio/prism/releases/download/v0.6.21/prism_darwin_amd64), [Linux](https://github.com/stoplightio/prism/releases/download/v0.6.21/prism_linux_amd64), [Windows](https://github.com/stoplightio/prism/releases/download/v0.6.21/prism_windows_amd64.exe)) and save the binary to the sendgrid-java directory (or any directory you would like. The sendgrid-java directory is chosen mostly for convenience.)
+The integration tests require a Twilio SendGrid mock API in order to execute. We've simplified setting this up using Docker to run the tests. You will just need [Docker Desktop](https://docs.docker.com/get-docker/) and `make`.
 
-1. Add execute permissions
-
-   ```bash
-   chmod +x prism
-   ```
-
-1. In a separate terminal, cd into the directory you chose for prism and start the sendgrid local server which the tests will use.
-
-   ```bash
-   ./prism run --mock --list --spec https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/oai_stoplight.json
-   ```
-
-1. Now you can run the test suite from the root of the project
-
-   ```bash
-   ./gradlew test -i
-   ```
+Once these are available, simply execute the Docker test target to run all tests: `make test-docker`. This command can also be used to open an interactive shell into the container where this library is installed. To start a *bash* shell for example, use this command: `command=bash make test-docker`.
 
 <a name="style-guidelines-and-naming-conventions"></a>
 ## Style Guidelines & Naming Conventions

Dockerfile

@@ -0,0 +1,21 @@
+ARG version=latest
+FROM openjdk:$version
+
+# version <= 11
+RUN apt-get update \
+    && apt-get install -y make maven || true
+COPY prism/prism/nginx/cert.crt /usr/local/share/ca-certificates/cert.crt
+RUN update-ca-certificates || true
+
+# version > 11
+RUN yum update -y \
+    && yum install -y make wget || true
+RUN wget http://repos.fedorapeople.org/repos/dchen/apache-maven/epel-apache-maven.repo -O /etc/yum.repos.d/epel-apache-maven.repo \
+    && yum install -y maven || true
+RUN keytool -import -trustcacerts -cacerts -storepass changeit -noprompt \
+    -alias api.sendgrid.com -file /usr/local/share/ca-certificates/cert.crt || true
+
+WORKDIR /app
+COPY . .
+
+RUN make install

Makefile

@@ -1,17 +1,20 @@
-.PHONY: install test test-integration clean
+.PHONY: install test test-integ test-docker clean
 
 VERSION := $(shell mvn help:evaluate -Dexpression=project.version --batch-mode | grep -e '^[^\[]')
 install:
 	@java -version || (echo "Java is not installed, please install Java >= 7"; exit 1);
-	mvn clean install -DskipTests=true -Dgpg.skip -B
+	mvn clean install -DskipTests=true -Dgpg.skip -Dmaven.javadoc.skip=true -B
 	cp target/sendgrid-java-$(VERSION)-shaded.jar sendgrid-java.jar
 
 test:
 	mvn test
 
-test-integration:
-	./scripts/startPrism.sh &
-	sleep 5
+test-integ: test
+
+version ?= latest
+test-docker:
+	curl -s https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/prism/prism.sh -o prism.sh
+	version=$(version) bash ./prism.sh
 
 clean:
 	mvn clean