README.md

Vividus Starter

The purpose of this repository is to help users start creating automated tests using Vividus.

• Prerequisites
  • Install and configure Git
  • Install Java
• How to run the existing tests
• How to view the test results
• How to create own test project using starter
• How to use IDE for the tests development
  • Eclipse
    • Prerequisites
    • Import the project
• Support

Prerequisites

Install and configure Git

1. Download and install Git client
2. Configure your identity

Install Java

1. The baseline is JDK 11. The latest JDK 15 is supported as well
2. Configure JAVA_HOME environment variable
3. Update PATH environment variable:
   • Windows: add %JAVA_HOME%/bin
   • macOS / Linux: add $JAVA_HOME/bin

How to run the existing tests

1. Clone the repository:

   git clone --recursive https://github.com/vividus-framework/vividus-starter.git

2. Set the VIVIDUS_BUILD_SYSTEM_HOME environment variable

   export VIVIDUS_BUILD_SYSTEM_HOME=/dir/where-you-cloned/vividus-starter/vividus-build-system

3. Go to the local directory with your cloned repository:

   cd vividus-starter

4. Run your tests:

   ./gradlew runStories

How to view the test results

1. 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

2. cd into the directory.

   cd /dir/to/where/the/results-are-published/.out/vividus-demo/reports/allure

3. 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

4. launch a browser, type localhost:3456 into the URL. If you followed the instructions perperly, you should see your report.

How to create own test project using starter

1. Login to Github: http://github.com. (Create a new account before if you don't have any)
2. 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 or Private (Private is recommended from start, it can be changed in future)
3. Clone your newly generated repository:

   git clone --recursive your_generated_project_link.git

4. Go to the local directory with your cloned repository:

   cd your_repository_name

How to use IDE for the tests development

Eclipse

Prerequisites

1. Install Eclipse IDE 2020-09
2. Add JBehave plugin

Import the project

1. Go to the root directory of the test project
2. Generates all Eclipse configuration files:

   ./gradlew eclipse

3. Import the project to Eclipse

Support

Slack