Gepard Developers' Guide - epam/Gepard GitHub Wiki

Main Information

GIT: [email protected]:epam/Gepard.git 

Issues: GitHub issues page

Gradle is used as build tool.

Main gradle tasks

  • clean -> to clean it up
  • jar -> to compile all sources and create all the jars
  • javadoc -> creates Java documentation
  • cleanIdea idea -> clean and regenerate IntelliJ IDEA module files (like .iml files) 
  • cleanEclipse eclipse -> as above, but for Eclipse
  • checkstyleMain -> to create checkstyle report
  • install -> to prepare and install Maven poms, and install jars in local maven repo
  • jacoco/sonar -> run Java Code Coverage, and Sonar evaluations
  • run -> executing tests

How to setup Development Environment

Prerequisites

  • Gepard V4.x -> Installed JDK 1.8.*. (For older Gepard versions you may use JDK 1.7.x too.)
  • Installed IntelliJ IDE (V14.x recommended), with git, gradle, gherkin, checkstyle plugins
  • Installed git
  • Optional for git: TortoiseGit

Gradle setup

  • No need to setup, use: "gradlew.bat" in Windows or "./gradlew" in Unix/Linux.
  • You may run gradle tasks immediately.

First execution

  • Open a command line
  • Go to  and start gradlew.bat clean build run
  • If everything goes ok, the test execution starts and a report is generated at <your working directory>/gepard-examples/build/gepard-result folder. If no other output is preferred, use html/index.html for the results. Note: Some of the example test cases will fail - this is designed this way to show how Gepard handles failure situation.

Debugging

  • Add a break point into a test case
  • Run the application in debug mode in your IDE, by using gradle plugin - select the "run" target.