The purpose of this repository is to help users start creating automated tests using Vividus.
- The baseline is JDK 11. Latest JDK 15 is supported as well
- Configure
JAVA_HOME
environment variable - Update
PATH
environment variable: add$JAVA_HOME/bin
- Clone the repository:
git clone --recursive https://github.com/vividus-framework/vividus-starter.git
- Set the BUILD_SYSTEM_ROOT environment variable
export BUILD_SYSTEM_ROOT=/dir/where-you-cloned/vividus-starter/vividus-build-system
- Go to the local directory with your cloned repository:
cd vividus-starter
- Run your tests:
./gradlew runStories
- 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:
2020-11-18 16:22:17,650 [main] INFO org.vividus.bdd.report.allure.AllureReportGenerator - Allure report is successfully generated at: /dir/to/where/the/results-are-published/.out/vividus-demo/reports/allure
- 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 perperly, you should see your report.
- 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
- Install Eclipse IDE 2020-09
- Add JBehave plugin
- Go to the root directory of the test project
- Generates all Eclipse configuration files:
./gradlew eclipse
- Import the project to Eclipse