Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhatthm/surveysteps
Survey steps for cucumber/godog
https://github.com/nhatthm/surveysteps
bdd console cucumber functional-testing gherkin go godog godog-extension golang integration-testing prompt survey surveymock testing
Last synced: 5 days ago
JSON representation
Survey steps for cucumber/godog
- Host: GitHub
- URL: https://github.com/nhatthm/surveysteps
- Owner: nhatthm
- License: mit
- Created: 2022-08-29T11:37:04.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T18:46:09.000Z (27 days ago)
- Last Synced: 2024-12-14T14:24:29.276Z (8 days ago)
- Topics: bdd, console, cucumber, functional-testing, gherkin, go, godog, godog-extension, golang, integration-testing, prompt, survey, surveymock, testing
- Language: Go
- Homepage: https://go.nhat.io/surveysteps
- Size: 216 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cucumber Survey steps for Go
[](https://github.com/nhatthm/surveysteps/releases/latest)
[](https://github.com/nhatthm/surveysteps/actions/workflows/test.yaml)
[](https://codecov.io/gh/nhatthm/surveysteps)
[](https://goreportcard.com/report/go.nhat.io/surveysteps)
[](https://pkg.go.dev/go.nhat.io/surveysteps)
[](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)
Tests with `AlecAivazis/survey` and `cucumber/godog`
## Prerequisites
- `Go >= 1.17`
## Install
```bash
go get go.nhat.io/surveysteps
```
## Usage
### Supported Types
| Type | Supported | Supported Actions |
|:--------------|:---------:|:-----------------------------------------------------------------------------------------------------------|
| `Confirm` | ✓ |
- Answer `yes`, `no` or a custom one
- Interrupt (`^C`)
- Ask for help
| `Editor` | ✘ | |
| `Input` | ✘ | |
| `Multiline` | ✓ |
- Answer
- No answer
- Interrupt (`^C`)
| `Multiselect` | ✘ | |
| `Password` | ✓ |
- Answer (+ check for `*`)
- No answer
- Interrupt (`^C`)
- Ask for help
| `Select` | ✘ | |
## Setup
Step 1: Register to `godog`
Initialize a `surveysteps.Manager` with `surveysteps.New()` then add it into the `ScenarioInitializer`
Step 2: Pass `stdio` to the prompts
Same as [`surveyexpect`](https://github.com/nhatthm/surveyexpect#expect), you have to define a way to inject `terminal.Stdio` into the prompts in your code. For
every scenario, the manager will start a new terminal emulator. Without the injection, there is no way to capture and response to the prompts.
You can register to the `Start` event and use the provided `terminal.Stdio` accordingly.
For example:
```go
package mypackage
import (
"math/rand"
"testing"
survey "github.com/AlecAivazis/survey/v2"
"github.com/AlecAivazis/survey/v2/terminal"
"github.com/cucumber/godog"
"go.nhat.io/surveyexpect/options"
"go.nhat.io/surveysteps"
)
type Wizard struct {
stdio terminal.Stdio
}
func (w *Wizard) start(_ *godog.Scenario, stdio terminal.Stdio) {
w.stdio = stdio
}
func (w *Wizard) ask() (bool, error) {
var response bool
p := &survey.Confirm{Message: "Confirm?"}
err := survey.AskOne(p, &response, options.WithStdio(w.stdio))
return response, err
}
func TestIntegration(t *testing.T) {
wizard := &Wizard{}
m := surveysteps.New(t).
WithStarter(wizard.start)
suite := godog.TestSuite{
Name: "Integration",
ScenarioInitializer: func(ctx *godog.ScenarioContext) {
m.RegisterContext(ctx)
},
Options: &godog.Options{
Strict: true,
Output: out,
Randomize: rand.Int63(),
},
}
// Run the suite that triggers wizard.ask()
}
```
See more: [#Examples](#Examples)
## Steps
### Confirm
#### Yes
Expect to see a Confirm prompt and answer `yes`.
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? confirm prompt "([^"]*)".* answers? yes`
Example:
```gherkin
Scenario: Receive a yes
Given I see a confirm prompt "Confirm? (y/N)", I answer yes
Then ask for confirm "Confirm?", receive yes
```
#### No
Expect to see a Confirm prompt and answer `no`.
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? confirm prompt "([^"]*)".* answers? no`
Example:
```gherkin
Scenario: Receive a no
Given I see a confirm prompt "Confirm? (y/N)", I answer no
Then ask for confirm "Confirm?", receive no
```
#### Invalid answer
Expect to see a Confirm prompt and answer an invalid response (not a `yes` or `no`).
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? confirm prompt "([^"]*)".* answers? "([^"]*)"`
Example:
```gherkin
Scenario: Invalid answer
Given I see a confirm prompt "Confirm? (y/N)", I answer "nahhh"
# Because the answer is invalid, survey will prompt again.
And then I see another confirm prompt "Confirm? (y/N)", I answer no
Then ask for confirm "Confirm?", receive no
```
#### Interrupt
Expect to see a Confirm prompt and interrupt (^C).
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? confirm prompt "([^"]*)".* interrupts?`
Example:
```gherkin
Scenario: Interrupted
Given I see a confirm prompt "Confirm? (y/N)", I interrupt
Then ask for confirm "Confirm?", get interrupted
```
#### With Help
Expect to see a Confirm prompt, ask for help and then expect to see a Help message.
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? confirm prompt "([^"]*)".* asks? for help and sees? "([^"]*)"`
Example:
```gherkin
Scenario: With help and receive a yes
Given I see a confirm prompt "Confirm? [? for help] (y/N)", I ask for help and see "This action cannot be undone"
And then I see another confirm prompt "Confirm? (y/N)", I answer yes
Then ask for confirm "Confirm?" with help "This action cannot be undone", receive yes
```
### Multiline
#### No Answer
Expect to see a Multiline prompt and give no answer.
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? multiline prompt "([^"]*)".* answers?: ""`
Example:
```gherkin
Scenario: Receive an empty answer
Given I see a multiline prompt "Enter comment", I answer ""
Then ask for multiline "Enter comment", receive:
"""
"""
```
#### Multiline Answer
Expect to see a Multiline prompt and give an answer.
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? multiline prompt "([^"]*)".* answers?:`
Example:
```gherkin
Scenario: Receive a multiline answer
Given I see a multiline prompt "Enter comment", I answer:
"""
This is the first
line
this is the second line
"""
Then ask for multiline "Enter comment", receive:
"""
This is the first
line
this is the second line
"""
```
#### Interrupt
Expect to see a Multiline prompt and interrupt (^C).
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? multiline prompt "([^"]*)".* interrupts?`
Example:
```gherkin
Scenario: Interrupted
Given I see a multiline prompt "Enter comment", I interrupt
Then ask for multiline "Enter comment", get interrupted
```
### Password
#### Answer
Expect to see a Password prompt and answer it.
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? password prompt "([^"]*)".* answers? "([^"]*)"`
Example:
```gherkin
Scenario: Receive an answer
Given I see a password prompt "Enter password:", I answer "123456"
Then ask for password "Enter password:", receive "123456"
```
#### Interrupt
Expect to see a Password prompt and interrupt (^C).
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? password prompt "([^"]*)".* interrupts?`
Example:
```gherkin
Scenario: Interrupted
Given I see a password prompt "Enter password:", I interrupt
Then ask for password "Enter password:", get interrupted
```
#### With Help
Expect to see a Password prompt, ask for help and then expect to see a Help message.
Pattern: `(?:(?:get)|(?:see))s? a(?:nother)? password prompt "([^"]*)".* asks? for help and sees? "([^"]*)"`
Example:
```gherkin
Scenario: With help and receive an answer
Given I see a password prompt "Enter password: [? for help]", I ask for help and see "It is a secret"
And then I see another password prompt "Enter password:", I answer "123456"
Then ask for password "Enter password:" with help "It is a secret", receive "123456"
```
## Examples
- Register for injection: https://github.com/nhatthm/surveysteps/blob/master/features/bootstrap/godog_test.go#L47
- Inject: https://github.com/nhatthm/surveysteps/blob/master/features/bootstrap/survey.go#L36-L41
- Use: https://github.com/nhatthm/surveysteps/blob/master/features/bootstrap/survey.go#L57
Full suite: https://go.nhat.io/surveysteps/tree/master/features
## Donation
If this project help you reduce time to develop, you can give me a cup of coffee :)
### Paypal donation
[](https://www.paypal.com/donate/?hosted_button_id=PJZSGJN57TDJY)
or scan this
