├── .github └── workflows │ └── build.yml ├── .gitignore ├── build.gradle ├── coverage └── configuration.json ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── test └── java └── io └── eroshenkoam └── swagger ├── CreatePetTest.java ├── LogFilter.java └── Pet.java /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | pull_request: 5 | branches: 6 | - '*' 7 | push: 8 | branches: 9 | - 'master' 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v1 16 | - name: Set up JDK 1.8 17 | uses: actions/setup-java@v1 18 | with: 19 | java-version: 1.8 20 | - name: Test 21 | run: ./gradlew clean test 22 | - name: Coverage 23 | run: ./gradlew coverageReport 24 | - uses: actions/upload-artifact@v2 25 | with: 26 | name: coverage.html 27 | path: coverage.html -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Idea 2 | .idea 3 | *.iml 4 | 5 | # Gradle 6 | .gradle 7 | build 8 | 9 | # Coverage 10 | .coverage 11 | coverage.html 12 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'java' 3 | id 'de.undercouch.download' version '4.0.4' 4 | } 5 | 6 | ext { 7 | coverageDownloadUrl = 'https://dl.bintray.com/viclovsky/maven/com/github/viclovsky/swagger/coverage/swagger-coverage-commandline/1.3.0/swagger-coverage-commandline-1.3.0.zip' 8 | coverageCommandline = './.coverage/swagger-coverage-commandline-1.3.0/bin/swagger-coverage-commandline' 9 | swaggerDownloadUrl = 'https://petstore.swagger.io/v2/swagger.json' 10 | 11 | coverageConfiguration = './coverage/configuration.json' 12 | coverageOutput = './swagger-coverage-output' 13 | coverageSwagger = './build/swagger.json' 14 | } 15 | 16 | group 'org.example' 17 | version '1.0-SNAPSHOT' 18 | 19 | sourceCompatibility = 1.8 20 | 21 | repositories { 22 | mavenLocal() 23 | mavenCentral() 24 | maven { url 'https://dl.bintray.com/viclovsky/maven/' } 25 | } 26 | 27 | task downloadSwagger(type: Download) { 28 | src "${swaggerDownloadUrl}" 29 | dest "${coverageSwagger}" 30 | } 31 | 32 | task downloadCommandline(type: Download) { 33 | src "${coverageDownloadUrl}" 34 | dest file(".coverage/commandline.zip") 35 | doFirst { 36 | mkdir file(".coverage") 37 | } 38 | } 39 | 40 | task unzipCommandline(type: Copy) { 41 | dependsOn("downloadCommandline") 42 | def zipFile = file(".coverage/commandline.zip") 43 | from zipTree(zipFile) 44 | into file(".coverage") 45 | } 46 | 47 | task coverageReport(type: Exec) { 48 | dependsOn('downloadSwagger', 'unzipCommandline') 49 | 50 | commandLine "${coverageCommandline}", "-s", "${coverageSwagger}", "-i", "${coverageOutput}", '-c', "${coverageConfiguration}" 51 | workingDir '.' 52 | } 53 | 54 | test { 55 | useJUnitPlatform() 56 | } 57 | 58 | dependencies { 59 | compile("io.rest-assured:rest-assured:4.3.0") 60 | compile("com.fasterxml.jackson.core:jackson-databind:2.11.0") 61 | compile("com.github.viclovsky.swagger.coverage:swagger-coverage-rest-assured:1.3.0") 62 | 63 | testCompile("org.junit.jupiter:junit-jupiter-api:5.3.0") 64 | testCompile("org.junit.jupiter:junit-jupiter-engine:5.3.0") 65 | testCompile("org.junit.jupiter:junit-jupiter-params:5.3.0") 66 | } -------------------------------------------------------------------------------- /coverage/configuration.json: -------------------------------------------------------------------------------- 1 | { 2 | "writers": { 3 | "html": { 4 | "filename": "coverage.html", 5 | "type": "html", 6 | "locale": "ru" 7 | } 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/eroshenkoam/swagger-coverage-example/01ca88da5ed76c927c88d30352b5fd4731208a01/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue Jun 16 13:04:21 MSK 2020 2 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-all.zip 3 | distributionBase=GRADLE_USER_HOME 4 | distributionPath=wrapper/dists 5 | zipStorePath=wrapper/dists 6 | zipStoreBase=GRADLE_USER_HOME 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS='"-Xmx64m"' 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS="-Xmx64m" 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'swagger-covarage-example' 2 | 3 | -------------------------------------------------------------------------------- /src/test/java/io/eroshenkoam/swagger/CreatePetTest.java: -------------------------------------------------------------------------------- 1 | package io.eroshenkoam.swagger; 2 | 3 | import com.fasterxml.jackson.databind.ObjectMapper; 4 | import com.github.viclovsky.swagger.coverage.SwaggerCoverageRestAssured; 5 | import io.restassured.builder.RequestSpecBuilder; 6 | import io.restassured.specification.RequestSpecification; 7 | import org.junit.jupiter.api.Test; 8 | 9 | import static io.restassured.RestAssured.given; 10 | import static org.hamcrest.Matchers.equalTo; 11 | 12 | public class CreatePetTest { 13 | 14 | @Test 15 | public void testPetCreation() { 16 | final RequestSpecification spec = new RequestSpecBuilder() 17 | .setBaseUri("https://petstore.swagger.io/v2") 18 | .addHeader("Accept", "application/json") 19 | .addHeader("Content-Type", "application/json") 20 | .addFilter(new SwaggerCoverageRestAssured()) 21 | .build(); 22 | 23 | final Pet pet = new Pet(); 24 | pet.setName("chappy"); 25 | pet.setStatus("available"); 26 | 27 | final Pet created = given() 28 | .spec(spec) 29 | .body(pet) 30 | .when() 31 | .post("/pet") 32 | .then() 33 | .extract() 34 | .as(Pet.class); 35 | 36 | given() 37 | .spec(spec) 38 | .when() 39 | .get("/pet/{id}", created.getId()) 40 | .then() 41 | .statusCode(200) 42 | .body("name", equalTo(pet.getName())); 43 | } 44 | 45 | } 46 | -------------------------------------------------------------------------------- /src/test/java/io/eroshenkoam/swagger/LogFilter.java: -------------------------------------------------------------------------------- 1 | package io.eroshenkoam.swagger; 2 | 3 | import io.restassured.filter.Filter; 4 | import io.restassured.filter.FilterContext; 5 | import io.restassured.response.Response; 6 | import io.restassured.specification.FilterableRequestSpecification; 7 | import io.restassured.specification.FilterableResponseSpecification; 8 | 9 | public class LogFilter implements Filter { 10 | @Override 11 | public Response filter(final FilterableRequestSpecification requestSpec, 12 | final FilterableResponseSpecification responseSpec, 13 | final FilterContext ctx) { 14 | final String method = requestSpec.getMethod(); 15 | System.out.println(String.format("Method: %s", method)); 16 | 17 | final String uri = requestSpec.getURI(); 18 | System.out.println(String.format("URI: %s", uri)); 19 | 20 | requestSpec.getHeaders().forEach(header -> { 21 | System.out.println(String.format("Header: %s=%s", header.getName(), header.getValue())); 22 | }); 23 | 24 | return ctx.next(requestSpec, responseSpec); 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /src/test/java/io/eroshenkoam/swagger/Pet.java: -------------------------------------------------------------------------------- 1 | package io.eroshenkoam.swagger; 2 | 3 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 4 | 5 | @JsonIgnoreProperties(ignoreUnknown = true) 6 | public class Pet { 7 | 8 | private Long id; 9 | private String name; 10 | private String status; 11 | 12 | public Long getId() { 13 | return id; 14 | } 15 | 16 | public void setId(Long id) { 17 | this.id = id; 18 | } 19 | 20 | public String getName() { 21 | return name; 22 | } 23 | 24 | public void setName(String name) { 25 | this.name = name; 26 | } 27 | 28 | public String getStatus() { 29 | return status; 30 | } 31 | 32 | public void setStatus(String status) { 33 | this.status = status; 34 | } 35 | } 36 | --------------------------------------------------------------------------------