- Project Creation
- Auto completion
- Quick Fix for unimplemented steps
- Execution and Debugging
- Run configurations
- Rephrase steps
- Find Usages
- Extract Concept
- Navigation from step to implementation (cmd/ctrl + b)
- File -> New Project.
- Choose 'Gauge'
- Choose the project location and java sdk
gauge-java is not installed, it will download it for the first time.
- File -> New Project
Create from Archetype
- Select the gauge archetype -
- If the
com.thoughtworks.gauge.mavenarchetype is not added select
- Enter GroupId: com.thoughtworks.gauge.maven
- Enter ArtifactId: gauge-archetype-java
- Enter Version: 1.0.1 or the latest version number
- Enter the
artifactIdfor your project.
Project Nameand finish
- The project will be created in batch mode, watch the console for progress.
- After project creation
close and re-open the projectto enable auto-complete features.
auto-importfor the project. Under
File > Settings > Maven > Importing, mark the checkbox
Import Maven projects automatically.
See gauge-maven-plugin for more details on using the gauge maven plugin.
Steps present in the current project can be listed by invoking the auto completion pop up
ctrl+space after the '*'. After choosing a step, it gets inserted with parameters highlighted, you can press
tab to cycle between the parameters and edit them.
If you have an unimplemented step in the spec file, it will be annotated saying 'undefined step'.
alt+enter can be pressed to open the quick fix pop up. The destination of the implementation can be chosen, either a new class or from a list of existing classes. It will then generate the step with required annotation and parameters.
A spec file can be formatted by pressing
ctrl+alt+shift l (in windows and linux) and
cmd+alt+shift l(in mac).
This formats all the elements of current spec including indentation of tables and steps.
- Specs can be executed by
right click -> Run spec.
- Execute all specs inside a directory by
right click -> Run specifications
A single scenario can be executed by doing a right click on the scenario which should be executed and choosing the scenario.
right click -> run -> Scenario Name
Note: If the right click is done in context other than that of scenario, by default, first scenario will be executed.
To run multiple specifications in parallel
- Right click on the
specsdirectory and select
- In the new Run configuration select
In Paralleloptions. This will distribute specs execution based on number of cores the machine has.
- You can also specify the
Number of parallel execution streams. This is optional
Caution: Select parallel nodes based on current systems performance. For example on a 2 core machine select upto 4 parallel streams. A very large number may affect performance.
ok. Now you can run this new configuration for parallel execution of specs.
Debugging can be performed the same way spec execution works.
- Right click on a specification or specs directory -> Debug. Execution will halt on marked breakpoints.
You can edit the run configuration to make changes to:
- The scenario or spec file to be executed
- The environment to run against
- Add a tag filter to the execution
- Choose the number of parallel streams
- Press Shift+F6 on a step to rephrase it.
- The parameters will be in
< >in the rephrase dialog. They can be reordered,removed or new parameters can be added.
- The rephrase change will reflect across all the specs in the project.
- Press cmd/ctrl+alt+F7 on step/concept to see the usages.
- In the editor, select the steps to be transformed into a concept.
- On the main menu or on the context menu of the selection, choose Refactor | Extract to Concept or press ⌥⌘C.
- In the Extract Concept dialog box that opens
- Specify the concept name with parameters to be passed from the usage. For Example: Say "hello" to "gauge".
- Select the file name from the spec file dropdown list or specify the new file name/path relative to the project.
- Click OK.
- The selected steps will be replaced with the specified concept name.