Export internal formatters (cucumber#372)

Author: leviable

CHANGELOG.md

@@ -13,11 +13,12 @@ This document is formatted according to the principles of [Keep A CHANGELOG](htt
 ### Added
 
 - Support for step definitions without return ([364](https://github.com/cucumber/godog/pull/364) - [titouanfreville])
-- Contextualized hooks for scenarios and steps ([409](https://github.com/cucumber/godog/pull/409)) - [vearutop])
-- Step result status in After hook ([409](https://github.com/cucumber/godog/pull/409)) - [vearutop])
-- Support auto converting doc strings to plain strings ([380](https://github.com/cucumber/godog/pull/380)) - [chirino])
-- Use multiple formatters in the same test run ([392](https://github.com/cucumber/godog/pull/392)) - [vearutop])
-- Added `RetrieveFeatures()` method to `godog.TestSuite` ([276](https://github.com/cucumber/godog/pull/276)) - [radtriste])
+- Contextualized hooks for scenarios and steps ([409](https://github.com/cucumber/godog/pull/409) - [vearutop])
+- Step result status in After hook ([409](https://github.com/cucumber/godog/pull/409) - [vearutop])
+- Support auto converting doc strings to plain strings ([380](https://github.com/cucumber/godog/pull/380) - [chirino])
+- Use multiple formatters in the same test run ([392](https://github.com/cucumber/godog/pull/392) - [vearutop])
+- Added `RetrieveFeatures()` method to `godog.TestSuite` ([276](https://github.com/cucumber/godog/pull/276) - [radtriste])
+- Added support to create custom formatters ([372](https://github.com/cucumber/godog/pull/372) - [leviable])
 
 ### Changed
 

_examples/custom-formatter/README.md

@@ -0,0 +1,19 @@
+
+# Custom Formatter Example
+
+This example custom formatter demonstrates some ways to build and use custom formatters with godog
+
+
+## Emoji Progress
+
+The first example is the Emoji formatter, built on top of the Progress formatter that is included with godog.
+
+To run it:
+
+```
+$ godog -f emoji
+```
+
+Which would output step progress as emojis rather than text:
+
+![](imgs/emoji-output-example.png)

_examples/custom-formatter/custom.go

@@ -0,0 +1,122 @@
+package main
+
+import (
+	"fmt"
+	"io"
+	"math"
+
+	"github.com/cucumber/godog"
+)
+
+const (
+	passedEmoji    = "✅"
+	skippedEmoji   = "➖"
+	failedEmoji    = "❌"
+	undefinedEmoji = "❓"
+	pendingEmoji   = "🚧"
+)
+
+func init() {
+	godog.Format("emoji", "Progress formatter with emojis", emojiFormatterFunc)
+}
+
+func emojiFormatterFunc(suite string, out io.Writer) godog.Formatter {
+	return newEmojiFmt(suite, out)
+}
+
+func newEmojiFmt(suite string, out io.Writer) *emojiFmt {
+	return &emojiFmt{
+		ProgressFmt: godog.NewProgressFmt(suite, out),
+		out:         out,
+	}
+}
+
+type emojiFmt struct {
+	*godog.ProgressFmt
+
+	out io.Writer
+}
+
+func (f *emojiFmt) TestRunStarted() {}
+
+func (f *emojiFmt) Passed(scenario *godog.Scenario, step *godog.Step, match *godog.StepDefinition) {
+	f.ProgressFmt.Base.Passed(scenario, step, match)
+
+	f.ProgressFmt.Base.Lock.Lock()
+	defer f.ProgressFmt.Base.Lock.Unlock()
+
+	f.step(step.Id)
+}
+
+func (f *emojiFmt) Skipped(scenario *godog.Scenario, step *godog.Step, match *godog.StepDefinition) {
+	f.ProgressFmt.Base.Skipped(scenario, step, match)
+
+	f.ProgressFmt.Base.Lock.Lock()
+	defer f.ProgressFmt.Base.Lock.Unlock()
+
+	f.step(step.Id)
+}
+
+func (f *emojiFmt) Undefined(scenario *godog.Scenario, step *godog.Step, match *godog.StepDefinition) {
+	f.ProgressFmt.Base.Undefined(scenario, step, match)
+
+	f.ProgressFmt.Base.Lock.Lock()
+	defer f.ProgressFmt.Base.Lock.Unlock()
+
+	f.step(step.Id)
+}
+
+func (f *emojiFmt) Failed(scenario *godog.Scenario, step *godog.Step, match *godog.StepDefinition, err error) {
+	f.ProgressFmt.Base.Failed(scenario, step, match, err)
+
+	f.ProgressFmt.Base.Lock.Lock()
+	defer f.ProgressFmt.Base.Lock.Unlock()
+
+	f.step(step.Id)
+}
+
+func (f *emojiFmt) Pending(scenario *godog.Scenario, step *godog.Step, match *godog.StepDefinition) {
+	f.ProgressFmt.Base.Pending(scenario, step, match)
+
+	f.ProgressFmt.Base.Lock.Lock()
+	defer f.ProgressFmt.Base.Lock.Unlock()
+
+	f.step(step.Id)
+}
+
+func (f *emojiFmt) Summary() {
+	f.printSummaryLegend()
+	f.ProgressFmt.Summary()
+}
+
+func (f *emojiFmt) printSummaryLegend() {
+	fmt.Fprint(f.out, "\n\nOutput Legend:\n")
+	fmt.Fprint(f.out, fmt.Sprintf("\t%s Passed\n", passedEmoji))
+	fmt.Fprint(f.out, fmt.Sprintf("\t%s Failed\n", failedEmoji))
+	fmt.Fprint(f.out, fmt.Sprintf("\t%s Skipped\n", skippedEmoji))
+	fmt.Fprint(f.out, fmt.Sprintf("\t%s Undefined\n", undefinedEmoji))
+	fmt.Fprint(f.out, fmt.Sprintf("\t%s Pending\n", pendingEmoji))
+}
+
+func (f *emojiFmt) step(pickleStepID string) {
+	pickleStepResult := f.Storage.MustGetPickleStepResult(pickleStepID)
+
+	switch pickleStepResult.Status {
+	case godog.StepPassed:
+		fmt.Fprint(f.out, fmt.Sprintf(" %s", passedEmoji))
+	case godog.StepSkipped:
+		fmt.Fprint(f.out, fmt.Sprintf(" %s", skippedEmoji))
+	case godog.StepFailed:
+		fmt.Fprint(f.out, fmt.Sprintf(" %s", failedEmoji))
+	case godog.StepUndefined:
+		fmt.Fprint(f.out, fmt.Sprintf(" %s", undefinedEmoji))
+	case godog.StepPending:
+		fmt.Fprint(f.out, fmt.Sprintf(" %s", pendingEmoji))
+	}
+
+	*f.Steps++
+
+	if math.Mod(float64(*f.Steps), float64(f.StepsPerRow)) == 0 {
+		fmt.Fprintf(f.out, " %d\n", *f.Steps)
+	}
+}

_examples/custom-formatter/emoji.go

@@ -0,0 +1,26 @@
+# file: $GOPATH/godogs/features/godogs.feature
+Feature: Custom emoji formatter examples
+  In order to be happy
+  As a hungry gopher
+  I need to be able to eat godogs
+
+  Scenario: Passing test
+    Given there are 12 godogs
+    When I eat 5
+    Then there should be 7 remaining
+
+  Scenario: Failing and Skipped test
+    Given there are 12 godogs
+    When I eat 5
+    Then there should be 6 remaining
+     And there should be 4 remaining
+
+  Scenario: Undefined steps
+    Given there are 12 godogs
+    When I eat 5
+    Then this step is not defined
+
+  Scenario: Pending step
+    Given there are 12 godogs
+    When I eat 5
+    Then this step is pending

_examples/custom-formatter/features/emoji.feature

@@ -3,10 +3,11 @@ module custom-formatter
 go 1.14
 
 require (
-	github.com/cucumber/gherkin-go/v11 v11.0.0 // indirect
 	github.com/cucumber/godog v0.10.1-0.20210705192606-df8c6e49b40b
-	github.com/cucumber/messages-go/v10 v10.0.3 // indirect
-	github.com/cucumber/messages-go/v16 v16.0.1
 	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
 	github.com/hashicorp/go-memdb v1.3.2 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/spf13/pflag v1.0.5
 )
+
+replace github.com/cucumber/godog => ../..