Bring in changes from joschi/openapi-diff

.circleci/config.yml

@@ -14,17 +14,23 @@ jobs:
       - restore_cache:
           key: openapi-diff-{{ checksum "pom.xml" }}
 
-      - run: mvn dependency:go-offline
+      - run: ./mvnw package -X
 
       - save_cache:
           paths:
             - ~/.m2
           key: openapi-diff-{{ checksum "pom.xml" }}
 
-      - run: mvn package -X
-
+      - run:
+          name: Save test results
+          command: |
+            mkdir -p ~/test-results/junit/
+            find . -type f -regex ".*/target/surefire-reports/.*xml" -exec cp {} ~/test-results/junit/ \;
+          when: always
       - store_test_results:
-          path: target/surefire-reports
+          path: ~/test-results
 
       - store_artifacts:
-          path: target/openapi-diff-*-SNAPSHOT.jar
+          path: core/target/openapi-diff-*-SNAPSHOT.jar
+      - store_artifacts:
+          path: cli/target/openapi-diff-*-SNAPSHOT.jar

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: maven
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10

.github/workflows/maven.yml

@@ -0,0 +1,33 @@
+name: Test
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+jobs:
+  build:
+    runs-on: 'ubuntu-latest'
+    strategy:
+      fail-fast: false
+      matrix:
+        java_version: ['8', '11', '14']
+    env:
+      JAVA_OPTS: "-XX:+TieredCompilation -XX:TieredStopAtLevel=1"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK
+      uses: joschi/setup-jdk@v1
+      with:
+        java-version: ${{ matrix.java_version }}
+    - uses: actions/cache@v1
+      with:
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+        restore-keys: |
+          ${{ runner.os }}-maven-
+    - name: Build with Maven
+      run: ./mvnw -V -B -ff install '-DskipTests=true' '-Dmaven.javadoc.skip=true'
+    - name: Run tests
+      run: ./mvnw -V -B -ff verify

.mvn/wrapper/maven-wrapper.properties

@@ -0,0 +1 @@
+distributionUrl=https://repo1.maven.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip

Dockerfile

@@ -1,18 +1,10 @@
-FROM maven:3.5-jdk-8-alpine as build
-WORKDIR /app
-COPY ./ /app
-RUN mvn install -q && \
-  mvn package -q && \
-  ls /app/target/ && \
-  MVN_VERSION=$(mvn -q \
-    -Dexec.executable="echo" \
-    -Dexec.args='${project.version}' \
-    --non-recursive \
-    org.codehaus.mojo:exec-maven-plugin:1.6.0:exec) && \
-  mv /app/target/openapi-diff-${MVN_VERSION}-jar-with-dependencies.jar /app/openapi-diff.jar
+FROM openjdk:8-jdk-alpine AS build
+WORKDIR /build
+COPY ./ /build
+RUN ./mvnw -V -B -ff -P docker package -q
 
 FROM openjdk:8-jre-alpine
 WORKDIR /app
-COPY --from=0 /app/openapi-diff.jar /app
+COPY --from=build /build/cli/target/openapi-diff-jar-with-dependencies.jar /app/openapi-diff.jar
 ENTRYPOINT ["java", "-jar", "/app/openapi-diff.jar"]
 CMD ["--help"]

README.md

@@ -1,34 +1,63 @@
 # OpenAPI-diff 
 
-Compare two OpenAPI specifications(3.x) and render the difference to html file or markdown file.
+Compare two OpenAPI specifications (3.x) and render the difference to HTML plaintext, or Markdown files.
 
-[![CircleCI](https://circleci.com/gh/quen2404/openapi-diff/tree/master.svg?style=svg)](https://circleci.com/gh/quen2404/openapi-diff/tree/master)
+[![Test](https://github.com/joschi/openapi-diff/workflows/Test/badge.svg)](https://github.com/joschi/openapi-diff/actions?query=branch%3Amaster+workflow%3ATest+)
 
 # Requirements
-`jdk1.8+`
+
+* Java 8
 
 # Feature
-* Supports OpenAPi spec v3.0.
-* Depth comparison of parameters, responses, endpoint, http method(GET,POST,PUT,DELETE...)
+
+* Supports OpenAPI spec v3.0.
+* Depth comparison of parameters, responses, endpoint, http method (GET,POST,PUT,DELETE...)
 * Supports swagger api Authorization
 * Render difference of property with Expression Language
-* html & markdown render
+* HTML & Markdown render
 
 # Maven
 
-Available on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.qdesrame%22%20AND%20a%3A%22openapi-diff%22)
+Available on [Maven Central](https://search.maven.org/artifact/com.github.joschi.openapi-diff/core)
 
 ```xml
 <dependency>
-    <groupId>com.qdesrame</groupId>
-    <artifactId>openapi-diff</artifactId>
-    <version>1.2.0</version>
+  <groupId>com.github.joschi.openapi-diff</groupId>
+  <artifactId>core</artifactId>
+  <version>${openapi-diff-version}</version>
 </dependency>
 ```
 
 # Docker
 
-Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/) as `quen2404/openapi-diff`.
+Available on [Docker Hub](https://hub.docker.com/r/joschi/openapi-diff/) as `joschi/openapi-diff`.
+
+```bash
+# docker run joschi/openapi-diff:latest
+usage: openapi-diff <old> <new>
+    --debug                     Print debugging information
+    --error                     Print error information
+    --fail-on-changed           Fail if API changed but is backward
+                                compatible
+    --fail-on-incompatible      Fail only if API changes broke backward
+                                compatibility
+ -h,--help                      print this message
+    --header <property=value>   use given header for authorisation
+    --html <file>               export diff as html in given file
+    --info                      Print additional information
+ -l,--log <level>               use given level for log (TRACE, DEBUG,
+                                INFO, WARN, ERROR, OFF). Default: ERROR
+    --markdown <file>           export diff as markdown in given file
+    --off                       No information printed
+    --query <property=value>    use query param for authorisation
+    --state                     Only output diff state: no_changes,
+                                incompatible, compatible
+    --text <file>               export diff as text in given file
+    --trace                     be extra verbose
+    --version                   print the version information and exit
+    --warn                      Print warning information
+```
+
 
 ## Build the image
 
@@ -42,19 +71,20 @@ You can replace the local image name `local-openapi-diff` by any name of your ch
 
 ## Run an instance
 
-In this example the `$(pwd)/src/test/resources` directory is mounted in the `/specs` directory of the container
+In this example the `$(pwd)/core/src/test/resources` directory is mounted in the `/specs` directory of the container
 in readonly mode (`ro`).
 
 ```bash
 docker run -t \
-  -v $(pwd)/src/test/resources:/specs:ro \
-  quen2404/openapi-diff /specs/path_1.yaml /specs/path_2.yaml
+  -v $(pwd)/core/src/test/resources:/specs:ro \
+  joschi/openapi-diff /specs/path_1.yaml /specs/path_2.yaml
 ```
 
-The remote name `quen2404/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.
+The remote name `joschi/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.
 
 # Usage
-OpenDiff can read swagger api spec from json file or http.
+
+openapi-diff can read OpenAPI specs from JSON files or HTTP URLs.
 
 ## Command Line
 
@@ -70,13 +100,12 @@ usage: openapi-diff <old> <new>
  -l,--log <level>               use given level for log (TRACE, DEBUG,
                                 INFO, WARN, ERROR, OFF). Default: ERROR
     --markdown <file>           export diff as markdown in given file
- -o,--output <format=file>      use given format (html, markdown) for
-                                output in file
     --off                       No information printed
     --query <property=value>    use query param for authorisation
     --state                     Only output diff state: no_changes,
                                 incompatible, compatible
     --fail-on-incompatible      Fail only if API changes broke backward compatibility
+    --fail-on-changed           Fail if API changed but is backward compatible
     --trace                     be extra verbose
     --version                   print the version information and exit
     --warn                      Print warning information
@@ -100,6 +129,7 @@ public class Main {
 ### Render difference
 ---
 #### HTML
+
 ```java
 String html = new HtmlRender("Changelog",
         "http://deepoove.com/swagger-diff/stylesheets/demo.css")
@@ -117,6 +147,7 @@ try {
 ```
 
 #### Markdown
+
 ```java
 String render = new MarkdownRender().render(diff);
 try {
@@ -131,11 +162,13 @@ try {
 ```
 
 ### Extensions
+
 This project uses Java Service Provider Inteface (SPI) so additional extensions can be added. 
 
-To build your own extension, you simply need to create a `src/main/resources/META-INF/services/com.qdesrame.openapi.diff.compare.ExtensionDiff` file with the full classname of your implementation.  Your class must also implement the `com.qdesrame.openapi.diff.compare.ExtensionDiff` interface.  Then, including your library with the `openapi-diff` module will cause it to be triggered automatically.
+To build your own extension, you simply need to create a `src/main/resources/META-INF/services/com.qdesrame.openapi.diff.core.compare.ExtensionDiff` file with the full classname of your implementation.  Your class must also implement the `com.qdesrame.openapi.diff.core.compare.ExtensionDiff` interface.  Then, including your library with the `openapi-diff` module will cause it to be triggered automatically.
+
+# Examples
 
-# Example
 ### CLI Output
 
 ```text
@@ -234,6 +267,7 @@ To build your own extension, you simply need to create a `src/main/resources/MET
 ```
 
 ### Markdown
+
 ```markdown
 ### What's New
 ---
@@ -308,10 +342,12 @@ To build your own extension, you simply need to create a `src/main/resources/MET
 ```
 
 # License
+
 openapi-diff is released under the Apache License 2.0.
 
 # Thanks
-* Adarsh Sharma / [adarshsharma](https://github.com/adarshsharma)
 
+* Adarsh Sharma / [adarshsharma](https://github.com/adarshsharma)
+* Quentin Desramé / [quen2404](https://github.com/quen2404)
 * [Sayi](https://github.com/Sayi) for his project [swagger-diff](https://github.com/Sayi/swagger-diff) 
   which was a source of inspiration for this tool

cli/pom.xml

@@ -0,0 +1,67 @@
+<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.github.joschi.openapi-diff</groupId>
+        <artifactId>parent</artifactId>
+        <version>2.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>cli</artifactId>
+    <packaging>jar</packaging>
+
+    <name>openapi-diff-cli</name>
+    <description>CLI for openapi-diff</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.github.joschi.openapi-diff</groupId>
+            <artifactId>core</artifactId>
+            <version>2.0.0-SNAPSHOT</version>
+        </dependency>
+        <dependency>
+            <groupId>commons-cli</groupId>
+            <artifactId>commons-cli</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+        </dependency>
+    </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <configuration>
+                    <descriptorRefs>
+                        <descriptorRef>jar-with-dependencies</descriptorRef>
+                    </descriptorRefs>
+                    <archive>
+                        <manifest>
+                            <mainClass>com.qdesrame.openapi.diff.cli.Main</mainClass>
+                        </manifest>
+                    </archive>
+                    <finalName>openapi-diff</finalName>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>make-assembly</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>