Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/godogx/expandvars
Expand variables in cucumber/godog tests
https://github.com/godogx/expandvars
bdd cucumber functional-testing gherkin go godog godog-extension golang integration-testing testing
Last synced: about 2 months ago
JSON representation
Expand variables in cucumber/godog tests
- Host: GitHub
- URL: https://github.com/godogx/expandvars
- Owner: godogx
- License: mit
- Created: 2021-09-07T06:40:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-13T15:17:40.000Z (about 1 year ago)
- Last Synced: 2023-12-13T16:35:47.695Z (about 1 year ago)
- Topics: bdd, cucumber, functional-testing, gherkin, go, godog, godog-extension, golang, integration-testing, testing
- Language: Go
- Homepage:
- Size: 52.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Variables Expander for Cucumber Steps
[](https://github.com/godogx/expandvars/releases/latest)
[](https://github.com/godogx/expandvars/actions/workflows/test.yaml)
[](https://codecov.io/gh/godogx/expandvars)
[](https://goreportcard.com/report/github.com/godogx/expandvars)
[](https://pkg.go.dev/github.com/godogx/expandvars)
A lifesaver expander for [`cucumber/godog`](https://github.com/cucumber/godog) because, sometimes, you have to use variables in your steps.
## Prerequisites
- `Go >= 1.16`
## Install
```bash
go get github.com/godogx/expandvars
```
## Usage
Initiate a new `StepExpander` with `expandvars.NewStepExpander()` then add it to `ScenarioInitializer` by
calling `StepExpander.RegisterContext(*testing.T, *godog.ScenarioContext)`
```go
package main
import (
"fmt"
"math/rand"
"strings"
"testing"
"github.com/cucumber/godog"
"github.com/godogx/expandvars"
"github.com/stretchr/testify/assert"
)
func TestIntegration(t *testing.T) {
expander := expandvars.NewStepExpander(
strings.NewReplacer("$TO", "Berlin"),
expandvars.Pairs{
"HUSBAND": "John",
},
func() expandvars.Pairs {
return expandvars.Pairs{
"RAND": fmt.Sprintf("%d", rand.Int63()),
}
},
expandvars.BeforeScenario(func() expandvars.Pairs {
return expandvars.Pairs{
"SCENARIO_RAND": fmt.Sprintf("%d", rand.Int63()),
}
}),
func(s string) string {
return strings.ReplaceAll(s, "$FROM", "Paris")
},
expandvars.Expander(func(s string) string {
return strings.ReplaceAll(s, "$TRANSPORT", "by bus")
}),
// OS env vars.
expandvars.EnvExpander,
)
suite := godog.TestSuite{
Name: "Integration",
ScenarioInitializer: func(ctx *godog.ScenarioContext) {
expander.RegisterContext(ctx)
},
Options: &godog.Options{
Strict: true,
Randomize: rand.Int63(),
},
}
// Run the suite.
}
```
In your tests, just use `$VARIABLE_NAME` in the step or the argument, like this:
```gherkin
Scenario: var is replaced
Given var NAME is replaced in step text: $NAME
Then step text is:
"""
map var NAME is replaced in step text: John
"""
Given var NAME is replaced in step argument (string)
"""
NAME=$NAME
"""
Then step argument is a string:
"""
NAME=John
"""
Given env var NAME is replaced in step argument (table)
| col 1 | col 2 | col 3 |
| value 1 | $NAME | value 3 |
Then step argument is a table:
| col 1 | col 2 | col 3 |
| value 1 | John | value 3 |
```
```gherkin
Scenario: .github files
Then there should be only these files in "$TEST_DIR/.github":
"""
- workflows:
- golangci-lint.yaml
- test.yaml
"""
```
### Expanders
The expanders could be any of these:
1. A `Replacer` interface
```go
type Replacer interface {
Replace(string) string
}
```
2. A `Replacer` `func(string) string` function.
For example, you could use `os.ExpandEnv` or its alias `expandvars.EnvExpander`
3. A map or vars (without the `$`) `map[string]string`
```go
var _ = expandvars.NewStepExpander(expandvars.Pairs{
"HUSBAND": "John",
"WIFE": "Jane",
})
```
4. A provider that provides a map of vars (without the `$`) `map[string]string`. The provider will be called every step.
```go
var _ = expandvars.NewStepExpander(func() expandvars.Pairs {
return map[string]string{
"RAND": fmt.Sprintf("%d", rand.Int63()),
}
})
```
5. A `BeforeScenario` provides a map of vars (without the `$`) `map[string]string`. The provider will be called only once before every scenario.
**Note**: If you need `expandvars.EnvExpander` or `os.ExpandEnv`, put it in the end of the chain. Because it replaces not-found vars with empty strings, other
expanders won't have a chance to do their jobs if you put it in the beginning.