feat: parallel [#52] (#54)

* Add parallel flag

* go 1.18.4

* parallel

.github/workflows/check.yml

@@ -14,7 +14,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: '1.18.3'
+          go-version: '1.18.4'
         id: go
 
       - name: Check out code into the Go module directory

.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: '1.18.3'
+          go-version: '1.18.4'
 
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v2

Dockerfile

@@ -1,4 +1,4 @@
-ARG GOLANG_DOCKER_TAG=1.18.3-alpine3.15
+ARG GOLANG_DOCKER_TAG=1.18.4-alpine3.15
 ARG ALPINE_DOCKER_TAG=3.15
 
 FROM golang:$GOLANG_DOCKER_TAG as builder

Makefile

@@ -1,4 +1,4 @@
-GOLANG_CI_LINT_VER:=v1.46.2
+GOLANG_CI_LINT_VER:=v1.47.2
 OUT_BIN?=${PWD}/bin/gherkingen
 COVER_PACKAGES=./...
 VERSION?=${shell git describe --tags}

README.md

@@ -182,7 +182,9 @@ gherkingen --help
 
 Usage of gherkingen [FEATURE_FILE]:
   -format string
-        output format: json, go, raw (default "go")
+        output format: autodetect, json, go, raw (default "autodetect")
+  -go-parallel
+        add parallel mark
   -help
         print usage
   -list
@@ -193,6 +195,8 @@ Usage of gherkingen [FEATURE_FILE]:
         The same calls to the generator always produces the same output
   -template string
         template file (default "@/std.struct.v1.go.tmpl")
+  -version
+        print version
 ```
 
 ## Running in docker

internal/app/app.feature

@@ -70,3 +70,13 @@ Feature: Application command line tool
     Examples:
     | <feature>   | <template> |
     | app.feature | not_found  |
+
+  Scenario: User wants to run tests in parallel
+    When `-go-parallel` is provided
+    And `scenario.feature` is given
+    Then generated code contains `t.Parallel()`
+
+  Scenario: User wants to run tests sequentially
+    When `-go-parallel` is not provided
+    And `scenario.feature` is given
+    Then generated code doesn't contain `t.Parallel()`

internal/app/app.go

@@ -42,6 +42,11 @@ func Run(arguments []string, out io.Writer, version string) (err error) {
 		false,
 		"print usage",
 	)
+	goParallel := flag.Bool(
+		"go-parallel",
+		false,
+		"add parallel mark",
+	)
 	listCmd := flag.Bool(
 		"list",
 		false,
@@ -82,12 +87,13 @@ func Run(arguments []string, out io.Writer, version string) (err error) {
 	case *helpCmd, inputFile == "":
 		return runHelp()
 	default:
-		return runGenerator(
-			out,
-			model.Format(*outputFormat),
-			*templateFile,
-			inputFile,
-			*packageName,
-		)
+		return runGenerator(appArgs{
+			Output:       out,
+			OutputFormat: model.Format(*outputFormat),
+			TemplateFile: *templateFile,
+			InputFile:    inputFile,
+			PackageName:  *packageName,
+			GoParallel:   *goParallel,
+		})
 	}
 }

internal/app/app_test.go

@@ -224,6 +224,32 @@ func TestApplicationCommandLineTool(t *testing.T) {
 			})
 		})
 	})
+
+	f.Scenario("User wants to run tests in parallel", func(t *testing.T, f *bdd.Feature) {
+		arguments := []string{}
+		f.When("`-go-parallel` is provided", func() {
+			arguments = append(arguments, "-go-parallel")
+		})
+		f.And("`app.feature` is given", func() {
+			arguments = append(arguments, "../generator/examples/scenario.feature")
+		})
+		f.Then("generated code contains `t.Parallel()`", func() {
+			assert.Contains(t, runApp(t, arguments, true), "t.Parallel()")
+		})
+	})
+
+	f.Scenario("User wants to run tests sequentially", func(t *testing.T, f *bdd.Feature) {
+		arguments := []string{}
+		f.When("`-go-parallel` is provided", func() {
+			// Go on.
+		})
+		f.And("`app.feature` is given", func() {
+			arguments = append(arguments, "../generator/examples/scenario.feature")
+		})
+		f.Then("generated code doesn't contain `t.Parallel()`", func() {
+			assert.NotContains(t, runApp(t, arguments, true), "t.Parallel()")
+		})
+	})
 }
 
 func runApp(tb testing.TB, arguments []string, ok bool) string {

internal/app/generator.go

@@ -12,39 +12,49 @@ import (
 	"github.com/hedhyw/gherkingen/v2/internal/model"
 )
 
+// appArgs contains required arguments for runGenerator.
+type appArgs struct {
+	Output       io.Writer
+	OutputFormat model.Format
+	TemplateFile string
+	InputFile    string
+	PackageName  string
+	GoParallel   bool
+}
+
 func runGenerator(
-	out io.Writer,
-	outputFormat model.Format,
-	templateFile string,
-	inputFile string,
-	packageName string,
+	args appArgs,
 ) (err error) {
-	templateSource, err := readTemplate(templateFile)
+	templateSource, err := readTemplate(args.TemplateFile)
 	if err != nil {
 		return err
 	}
 
-	if outputFormat == model.FormatAutoDetect {
-		outputFormat = detectFormat(templateFile)
+	if args.OutputFormat == model.FormatAutoDetect {
+		args.OutputFormat = detectFormat(args.TemplateFile)
 	}
 
-	inputSource, err := readInput(inputFile)
+	inputSource, err := readInput(args.InputFile)
 	if err != nil {
 		return err
 	}
 
+	goPlugin := goplugin.New(goplugin.Args{
+		Parallel: args.GoParallel,
+	})
+
 	data, err := generator.Generate(generator.Args{
-		Format:         outputFormat,
+		Format:         args.OutputFormat,
 		InputSource:    inputSource,
 		TemplateSource: templateSource,
-		PackageName:    packageName,
-		Plugin:         multiplugin.New(goplugin.New()),
+		PackageName:    args.PackageName,
+		Plugin:         multiplugin.New(goPlugin),
 	})
 	if err != nil {
 		return err
 	}
 
-	fmt.Fprint(out, string(data))
+	fmt.Fprint(args.Output, string(data))
 
 	return nil
 }

internal/assets/std.struct.v1.go.tmpl

@@ -25,8 +25,12 @@ import (
     {{- $Scenario := . -}}
     f.{{ $Scenario.PluginData.GoName }}({{ $Scenario.PluginData.GoValue }}, func({{- /*
         t is usualy unused if there are no examples 
-    */ -}}{{- if $Scenario.Examples -}}_{{- else -}}t{{- end -}} *testing.T, f *bdd.Feature) {
+    */ -}}{{- if and $Scenario.Examples (not $Scenario.PluginData.GoParallel) -}}_{{- else -}}t{{- end -}} *testing.T, f *bdd.Feature) {
         {{- range $Scenario.Examples }}
+        {{- if $Scenario.PluginData.GoParallel }}
+            t.Parallel()
+
+        {{ end -}}
 
         {{- /* Define test case struct. */ -}}
 
@@ -49,6 +53,10 @@ import (
 		}
 
         f.TestCases(testCases, func(t *testing.T, f *bdd.Feature, tc testCase) {
+            {{- if $Scenario.PluginData.GoParallel }}
+            t.Parallel()
+
+            {{ end -}}
             {{- if $Scenario.PluginData.GoHasBackground }}
             _ = background(t, f)
             {{- end -}}
@@ -60,6 +68,10 @@ import (
             {{- end }}
         })
         {{- else }}
+        {{- if $Scenario.PluginData.GoParallel }}
+        t.Parallel()
+
+        {{ end -}}
         {{- range $Scenario.Steps }}
         f.{{ .PluginData.GoName }}({{.PluginData.GoValue}}, func() {
             {{- if $Scenario.PluginData.GoHasBackground }}
@@ -74,7 +86,11 @@ import (
 
 {{ define "Rule" }}
     {{ $Rule := . }}
-    f.{{ $Rule.PluginData.GoName }}({{ $Rule.PluginData.GoValue }}, func(_ *testing.T, f *bdd.Feature) {
+    f.{{ $Rule.PluginData.GoName }}({{ $Rule.PluginData.GoValue }}, func({{- if $Rule.PluginData.GoParallel -}}t{{- else -}}_{{- end -}} *testing.T, f *bdd.Feature) {
+        {{- if $Rule.PluginData.GoParallel }}
+            t.Parallel()
+
+        {{ end -}}
         {{- range $Rule.Children -}}
 
         {{- if .Background }}
@@ -90,6 +106,10 @@ import (
 {{ end }}
 
 func Test{{ .Feature.PluginData.GoName }}(t *testing.T) {
+    {{- if .Feature.PluginData.GoParallel }}
+    t.Parallel()
+
+    {{ end -}}
     f := bdd.NewFeature(t, {{ .Feature.PluginData.GoValue }})
     {{ if .Feature.PluginData.GoComment }}
     /* {{ .Feature.PluginData.GoComment }} */

internal/docplugin/goplugin/goplugin.go

@@ -21,21 +21,31 @@ const (
 	dataFieldGoName       = "GoName"
 	dataFieldGoComment    = "GoComment"
 	dataFieldGoBackground = "GoHasBackground"
+	dataFieldGoparallel   = "GoParallel"
 )
 
 // GoPlugin injects golang specific information: go types, aliases.
 type GoPlugin struct {
 	aliaser             *goaliaser.Aliaser
 	exampleNameReplacer *strings.Replacer
 	usedExampleNames    map[string]struct{}
+
+	args Args
+}
+
+// Args contains optional arguments for GoPlugin.
+type Args struct {
+	Parallel bool
 }
 
 // New initializes a new go plugin.
-func New() *GoPlugin {
+func New(args Args) *GoPlugin {
 	return &GoPlugin{
 		aliaser:             goaliaser.New(),
 		exampleNameReplacer: strings.NewReplacer(" ", "_", "\t", "_"),
 		usedExampleNames:    make(map[string]struct{}),
+
+		args: args,
 	}
 }
 
@@ -150,16 +160,19 @@ func (p GoPlugin) handleStruct(
 		val.PluginData[dataFieldGoValue] = p.aliaser.StringValue(val.Name)
 		val.PluginData[dataFieldGoType] = string(goTypeString)
 		val.PluginData[dataFieldGoComment] = p.prepareFeatureDescription(val.Description)
+		val.PluginData[dataFieldGoparallel] = p.args.Parallel
 		p.processFeatureBackground(val)
 	case model.Rule:
 		val.PluginData[dataFieldGoName] = p.aliaser.NameAlias(val.Keyword)
 		val.PluginData[dataFieldGoValue] = p.aliaser.StringValue(val.Name)
 		val.PluginData[dataFieldGoType] = string(goTypeString)
+		val.PluginData[dataFieldGoparallel] = p.args.Parallel
 		p.processRuleBackground(val)
 	case model.Scenario:
 		val.PluginData[dataFieldGoName] = p.aliaser.NameAlias(val.Keyword)
 		val.PluginData[dataFieldGoValue] = p.aliaser.StringValue(val.Name)
 		val.PluginData[dataFieldGoType] = string(goTypeString)
+		val.PluginData[dataFieldGoparallel] = p.args.Parallel
 	case model.Step:
 		val.PluginData[dataFieldGoName] = p.aliaser.NameAlias(val.Keyword)
 		val.PluginData[dataFieldGoValue] = p.aliaser.StringValue(val.Text)