VIVIDUS Starter
The purpose of this repository is to help users start creating automated tests using VIVIDUS.
- Prerequisites
- How to create own test project using starter
- How to run the tests via CLI
- How to view the test execution results
- How to use IDE for the tests development
- Support
Prerequisites
Install and configure Git
- Download and install Git client
- Configure your identity
Install Java
- The baseline is LTS JDK 17. LTS JDK 11 and the latest JDK 18 are supported as well
- Configure
JAVA_HOME
environment variable - Update
PATH
environment variable:- Windows: add
%JAVA_HOME%/bin
- macOS / Linux: add
$JAVA_HOME/bin
- Windows: add
How to create own test project using starter
- Login to Github: http://github.com. (Create a new account before if you don't have any)
- Generate your own project based on the starter project:
- Open generator
- Provide repository name for your test project
- Choose option to make your repository
Public
orPrivate
(Private
is recommended from start, it can be changed in future)
- Clone your newly generated repository:
git clone --recursive your_generated_project_link.git
- Go to the local directory with your cloned repository:
cd your_repository_name
- Create your tests
How to use IDE for the tests development
Eclipse
Prerequisites
- Install Eclipse IDE 2022-03
- Add JBehave plugin
Import the project
- Go to the root directory of the test project
- Generates all Eclipse configuration files:
./gradlew eclipse
- Import the project to Eclipse
How to run the tests via CLI
- Assuming you are in the local directory with your cloned repository run your tests via Gradle:
./gradlew runStories
How to view the test execution results
- At the end of any test run, VIVIDUS will give you a link to where the corresponding test result was published. It should look like this:
2022-04-12 13:38:15,523 [main] INFO org.vividus.report.allure.AllureReportGenerator - Allure report is successfully generated at /dir/to/where/the/results-are-published/.out/vividus-demo/reports/allure/index.html
- cd into the directory.
cd /dir/to/where/the/results-are-published/.out/vividus-demo/reports/allure
- Start a webserver of your choice, in the example below we are using a node webserver through port 3456
✔ ~/dir/to/where/the/results-are-published/.out/vividus-demo/reports/allure $ http-server -p 3456
- Launch a browser, type
localhost:3456
into the URL. If you followed the instructions properly, you should see your report.