Skip to content

Commit

Permalink
Added support and documentation for gradle
Browse files Browse the repository at this point in the history
  • Loading branch information
Sdaas committed Oct 18, 2020
1 parent 8f449f5 commit 43c80bc
Show file tree
Hide file tree
Showing 8 changed files with 412 additions and 26 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ target/
!**/src/main/**
!**/src/test/**

## Gradle
.gradle/

### STS ###
.apt_generated
.classpath
Expand Down
100 changes: 80 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,8 @@

### Karate Starter

This Getting Started Guide shows how to setup a SpringBoot based REST service and test it using Karate (0.9.6).
consists of

1. A SpringBoot based Rest service which acts as the system under test
2. Karate DSL scripts to test this
This Getting Started Guide shows how to setup a SpringBoot based REST service and test it using Karate (0.9.6) from
within `IntelliJ`, `maven`, and `gradle`.

### The Rest Service

Expand Down Expand Up @@ -47,6 +44,7 @@ summary is that:
* For every feature file package, you need to have an empty test-class in the same package under `src/test/java`
* Karate recommends to keep the `*.feature` files in the same folder as the test-class
* The `<build>` section of the `pom.xml` needs a small tweak for this ..
* (Similar change needed in build.gradle file)

In this example, we have two features `hello` and `person`. Their `*.feature` files and test-classes
are kept in `src/test/java/karate/hello` and `src/test/java/karate/person` respectively
Expand Down Expand Up @@ -82,6 +80,7 @@ executed from the command-line.
Logging configuration is controlled by the `/test/java/logback.xml` file as explained in the Karate documentation
on [logging](https://github.com/intuit/karate#logging).


### Running the tests

We have three types of tests - unit tests, Spring integration tests, and Karate tests. Ideally we want
Expand All @@ -91,20 +90,59 @@ to be able to run them from both the command-line and the IDE.
* Spring integration tests : run slower because the entire application context has to be created
* Karate tests : require the system under test to be running


#### Running the Unit and Spring integration test
##### From IntelliJ

Right click on `/test/java/com.daasworld.hellokarate` and "Run all tests"

##### From command-line using Maven

Make sure that all the `.java` files in `com.daasworld` are configured to be treated as test classes. And
to ignore all the tests in the `karate` folder.

From the IntelliJ IDE, right click on `/test/java/com.daasworld.hellokarate` and "Run all tests"
From the command line, run
```
$ mvn test
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
<configuration>
<excludes>
<exclude>karate/**/*.java</exclude>
</excludes>
<includes>
<include>com/**/*.java</include>
</includes>
</configuration>
</plugin>
```
To run the tests
```
mvn test
```
##### From command-line using Gradle
```
./gradlew test --tests com.daasworld.hellokarate.*
```

Note that the `maven surefire plugin` is configured to treat all `.java` files in `com.daasworld` as Test classes
and to ignore all tests in the `karate` folder.

#### Running the Karate Tests
##### From Command Line
##### From IntelliJ

The Karate tests can also be invoked from within IntelliJ in multiple ways

* Right-click on `test/java/karate/KarateTests` to run all the tests
* Right-click on the individual runners (e.g., `test/java/karate/person/PersonRunner`) to run all the tests there
* Right-click on a `*.feature` file to run only that feature
* To run a single scenario, open the feature file, and right click on the specific scenario

The test results can be viewed in the browser at `file:///<projectroot>/target/surefire-reports/karate-summary.html`

Note:

* Right-clicking to run a `.feature` file will not work if the file path contains spaces (e.g, `~/Idea Projects/....`)
This is known bug in Karate. See [1283](https://github.com/intuit/karate/issues/1283)


##### From command-line using Maven

Karate does NOT start up the system under test. So first start up the application by running
```
Expand All @@ -127,18 +165,40 @@ To run only a single scenario, specify its line number as shown below
$ mvn test "-Dkarate.options=classpath:karate/hello/hello1.feature:13" -Dtest=HelloRunner
```

##### From IntelliJ
The test results can be viewed in the browser at `file:///<projectroot>/target/surefire-reports/karate-summary.html`

The Karate tests can also be invoked from within IntelliJ in multiple ways
##### From command-line using Gradle

* Right-click on `test/java/karate/KarateTests` to run all the tests
* Right-click on the individual runners (e.g., `test/java/karate/person/PersonRunner`) to run all the tests there
* Right-click on a `*.feature` file to run all only that feature
Start up the application
```
$ ./gradlew clean bootRun
```

Note: Right-clicking to run a `.feature` file will not work if the file path contains spaces (e.g, `~/Idea Projects/....`)
This is known bug in Karate. See [1283](https://github.com/intuit/karate/issues/1283)
All the Karate tests are in the `karate.test` folder. To run these tests
```
$ ./gradlew test --tests KarateTests
```
To run only those tests in the `karate.hello` package
```
$ ./gradlew test --tests HelloRunner
```
To run only the tests in `demo1.feature`
```
$ ./gradlew test --tests HelloRunner -Dkarate.options=classpath:karate/hello/hello1.feature
```
To run only one scenario, you need to specify the line number, as shown below
```
$ ./gradlew test --tests HelloRunner -Dkarate.options=classpath:karate/hello/hello1.feature:7
```

The test results can be viewed in the browser at `file:///<projectroot>/build/surefire-reports/karate-summary.html`

Note : The test report from the IDE and the command-line are generated in DIFFERENT places. Reports for test run from the IDE are stored
in the `target` folder. Report for tests run from the command-line are stored in the `build` folder.

### References

* [Karate](https://github.com/intuit/karate) github repo
* [Spring Boot](https://spring.io/projects/spring-boot)


44 changes: 44 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
plugins {
id 'org.springframework.boot' version '2.3.3.RELEASE'
id 'io.spring.dependency-management' version '1.0.8.RELEASE'
id 'java'
}

group = 'com.daasworld.hellokarate'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

repositories {
mavenCentral()
}

dependencies {
implementation 'org.springframework.boot:spring-boot-starter-web'
testImplementation('org.springframework.boot:spring-boot-starter-test') {
exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
}

testImplementation('org.junit.jupiter:junit-jupiter-api:5.4.2')
testRuntime('org.junit.jupiter:junit-jupiter-engine:5.4.2')

testImplementation 'com.intuit.karate:karate-junit5:0.9.6'
testImplementation 'com.intuit.karate:karate-apache:0.9.6'
}

test {
useJUnitPlatform()
systemProperty "karate.options", System.properties.getProperty("karate.options")
systemProperty "karate.env", System.properties.getProperty("karate.env")
outputs.upToDateWhen { false }
testLogging.showStandardStreams = true
}

sourceSets {
test {
resources {
srcDir file('src/test/java')
exclude '**/*.java'
}

}
}
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
185 changes: 185 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
#!/usr/bin/env sh

#
# Copyright 2015 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar


# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`

JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=`save "$@"`

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

exec "$JAVACMD" "$@"
Loading

0 comments on commit 43c80bc

Please sign in to comment.