-
Notifications
You must be signed in to change notification settings - Fork 42
Gepard Users' Guide
Gepard is a JUnit based test automation framework focusing on giving easy background for Test Automation engineers, those can focus on writing the test cases instead of focusing on how to do data driven things, how to deal with parallel test executions, how to deal with user readable reports etc.
Therefore this tool let you focus on test case writing.
Gepard has several modules, the main modules are:
- gepard-core - the core of the framework
- gepard-examples - contains several sample test cases
gepard-core supports:
- powerfull logging facility
- multi-threaded test execution
- multi-dimensional data-driven tests
- easy way of selecting desired testcase sets to run
- generates the necessary config file to re-run failed test cases - if necessary
- gradle support for compiling and running tests
- generates sophisticated test report in html, xml, csv and plain text format
- easily can be integrated to any CI/CT/CD environments
gepard-examples supports:
- example test cases those can be executed out of the box, includes examples for modules those are under construction too
Modules under construction:
- gepard-gherkin-jbehave and
-
gepard-gherkin-cucumber modules:
- These modules are under heavy construction, but both of the usable already - The aim is to provide extension module to Gepard and offer to use functional tests and BDD tests in the same framework. Both JBehave and Cucumber modules can be used in experimental mode already.
-
gepard-selenium module:
- This module is under construction, but usable already. The aim is to provide extension module to Gepard that integrates Selenium (WebDriver).
-
gepard-rest module (since V4.x):
- This module is under construction, but usable already. The aim is to provide extension module to Gepard that is used for REST API test. Also includes support for JIRA connection.
- gepard-android module:
- This module is under construction - cannot be used. The aim is to provide extension module to Gepard that integrates Appium framework.
Gepard requires Java Jdk 1.8 properly installed - nothing else. The tool is platform independent - as Java is. Executed on several Windows, Linux, and even on Sun Solaris.
The tool use several external 3rd party libraries. During the build, such jars will be downloaded to your machine and will be used.
Gepard has a gepard-project-template.zip
that contains a minimum runnable folder, that can be used as start of a test projects based on Gepard.
Just get it, unzip it somewhere, and execute gradlew.bat run
(or ./gradlew run on Linux) to execute the single built-in script initially. After the successful run, you may open the results in folder build/gepard-result
, opening index.html
in html
folder is recommended.
After calling the clean target, you may even check into your repository, as starting point of your test project.
First of all, you need to change the settings.gradle
and set the gradle project name properly.
rootProject.name = 'put-your-test-project-name-here'
After this you can load the gradle project (by loading the build.gradle
file) into your favorite IDE.
There are two main configuration file for Gepard:
- gepard.properties file, see details here: Gepard Configuration - gepard.properties
- testlist.txt file, see details here: Gepard Configuration - testlist.txt
The first thing is to get familiar with
- How to write basic tests, and later, get familiar with
- How to write data driven tests.
It is also recommended to get familiar with:
- The suggested Naming Conventions
- The suggested Coding Conventions for a Web application
- How Exceptions (Test failures) should be handled
- Timeouts in Gepard
- How to set-up a CI environment and run the tests in such environment
- How HTML test reports can be customized (for experts only!)
Have fun!
Just get gepard-examples src package, that contains many Test Class examples.
Remote Java debugging can be configured to listen to a specified socket which is opened by a running VM (default is 8000, see Connection properties Host/Port settings under Debug/Remote Java Application, in case of Eclipse). To configure remote debugging the empty default value of the jvm.arguments property should be overridden:
-Xdebug -Xnoagent -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n
The address defines the port the JVM opens and your debugger application can listen to. It means that after setting some breakpoints in your debugger application and launching the tests, you can connect the debugger to the running VM.