gauge
gauge copied to clipboard
Create a Gauge command or plugin to list all Steps in a project.
Is your feature request related to a problem? Please describe. Currently, we use maven dependencies/Jar files to inherit pre-built Steps into our Java Test projects. This is very useful as many steps are common amongst QA team members, so rather than duplicate effort, we put them into common jar files for testers to use. Works Great.
Common Steps defined in Jar Files (ui.jar, ws.jar, jdbc.jar etc)
* UI: Go to URL "url".
* WS: Make Rest call to "url".
* SQL: Query "select * from table" using database "database"
We need a way to document/List all the existing Test Steps in current project including the ones in the Jar/classpath.
Describe the solution you'd like
- We could use
gauge list --steps
- We could use a plugin like
spectacle
to generate an html page with a list of Steps and their inputs - This could also work for Concepts
Describe alternatives you've considered
I would write some code, that would go around looking for @Step
annotations in the classpath and generate a list of steps that way. I would also look at the inputs to the step in order to provide the user more detail. However, this might be useful feature for others as well, so a common solution might be better.
It would be nice if the @Step
annotation had fields like description
to provide more details about the step like what the inputs are and what the output of the step is.
@Step(name="This is a Step",
description="This is a more detailed explanation of what's going on here.")
public void test()
{
// implement here
}
Additional context I use Gauge with Java, Maven and Spring.