Skip to content

Latest commit

 

History

History
298 lines (230 loc) · 7.02 KB

cli.adoc

File metadata and controls

298 lines (230 loc) · 7.02 KB
Raw

CLI

In scope of this article the task term is a piece of work that is done on stories, scenarios, steps and other entities and that produces some output based on the work done.

The format of a task
./gradlew <task to perform>
The format of a task with arguments
./gradlew <task to perform> --args='<arguments to pass into the task>'
Note
 The tasks are available only through the gradlew command.

Run stories

The task runs test stories based on current tests configuration and tests state on the file system.

Debug stories

The task runs test stories omitting VIVIDUS initialization check based on current tests configuration and tests state on the file system.

Print available steps

The task prints all the steps that are available for the configured profiles, environments and suites in the alphabetical order.

Table 1. Options
Description Short notation Full notation Default value

Path to a file to save the list of the available steps

f

file

by default steps are printed into the console
macOS / Linux:
./gradlew printSteps --args='-f my-steps.txt'
Windows:
gradlew printSteps --args='-f my-steps.txt'
Output
vividus                                             Then `$value` matches `$regex`
vividus-plugin-web-app                              When I switch back to page
vividus-plugin-web-app                              When I press $keys on keyboard
                            COMPOSITE IN STEPS FILE Then an element with the name '$elementName' exists
                            COMPOSITE IN STEPS FILE When I click on an image with the name '$imageName'

Count steps

The task counts steps in the specified tests folder and prints them in the descending order.

Table 2. Options
Description Short notation Full notation Default value

Directory to count steps

d

dir

story

Number of steps to print

t

top

<no limits by default>
macOS / Linux:
./gradlew countSteps --args='-t 5 -d story/uat'
Windows:
gradlew countSteps --args='-t 5 -d story/uat'
Output
Top of the most used steps:                                                                  occurrence(s)
Then `$variable1` is $comparisonRule `$variable2`                                                      330
Given I am on page with URL `$pageURL`                                                                 127
Then number of elements found by `$locator` is $comparisonRule `$quantity`                             110
Given I initialize $scopes variable `$variableName` with value `$variableValue`                         83
When I change context to element located `$locator`                                                     59

Count scenario

The task counts and prints stories, scenarios and scenarios containing examples found in the specified tests folder.

Table 3. Options
Description Short notation Full notation Default value

Directory to count stories and scenarios

d

dir

story
macOS / Linux:
./gradlew countScenarios --args='-d story/uat'
Windows:
gradlew countScenarios --args='-d story/uat'
Output
5  | Stories
13 | Scenarios
6  | Scenarios with Examples

Validate known issues configuration

The task validates known issues format and prints the validated known issues into the console.

macOS / Linux:
./gradlew validateKnownIssues
Windows:
./gradlew validateKnownIssues
Output
Known issues found:
VVD-5
VVD-6
VVD-7
VVD-8

Find known issues by assertion pattern

The task used to find known issues contained in the test project by one or more assertion patterns.

Table 4. Options
Description Short notation Full notation Default value

Required path to a file that contains new-line-separated list of assertion patterns

f

file

<no default value>
Important
 If you miss the file argument into the task it will behave as described per [_validate_known_issues_configuration]
assertion-patterns.txt
.*Doctor Who.*
macOS / Linux:
./gradlew validateKnownIssues --args='-f ./assertion-failures.txt'
Windows:
gradlew validateKnownIssues --args='-f assertion-failures.txt'
Output
Known Issue | Assertion Error
VVD-6       | .*Doctor Who.*

Replace deprecated steps

The task replaces deprecated steps with actual ones in all stories(*.story files) and composite steps (*.steps files) along the path <project-name>/src/main/resources. Please note that some deprecated steps (for example which should be replaced with two steps) cannot be replaced automatically and must be refactored manually.

macOS / Linux:
./gradlew replaceDeprecatedSteps
Windows:
gradlew replaceDeprecatedSteps
Output (for cases when found steps which cannot be replaced automatically)
The step "When I check all checkboxes located by `xpath(.//input)`" from "CheckboxStepsTests.story - Scenario: Validation of step 'When I $checkboxState all checkboxes located by `$checkboxesLocator`'" is deprecated but cannot be replaced automatically, please replace it manually.
The step "When I check all checkboxes located by `xpath(.//input)`" from "composite.steps - Composite: When I run composite step with table:$table" is deprecated but cannot be replaced automatically, please replace it manually.

Replace deprecated properties

The task replaces deprecated properties with actual ones in all properties files along the path <project-name>/src/main/resources/properties.

macOS / Linux:
./gradlew replaceDeprecatedProperties
Windows:
gradlew replaceDeprecatedProperties

The examples below demonstrate property file with deprecated properties before and after applying the replaceDeprecatedProperties task.

Property file with deprecated entries before running the task replaceDeprecatedProperties
ui.visual.applitools.server-uri=https://eyes.applitools.com/
ui.visual.applitools.app-name=name
web.driver.CHROME.experimental-options={"prefs": {"profile": {"cookie_controls_mode": 0}}}
batch-6.story-execution-timeout=PT15M
Property file with replaced entries after running the task replaceDeprecatedProperties
applitools.server-uri=https://eyes.applitools.com/
applitools.app-name=name
web.driver.chrome.experimental-options={"prefs": {"profile": {"cookie_controls_mode": 0}}}
batch-6.story.execution-timeout=PT15M