Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix ReportAfterSuite usage in docs
  • Loading branch information
austince authored and onsi committed Jul 23, 2022
1 parent f44af96 commit b1864ad
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/MIGRATING_TO_V2.md
Expand Up @@ -258,7 +258,7 @@ Ginkgo follows the following rules when generating reports using these new `--FO
Ginkgo now provides a new node, `ReportAfterSuite`, with the following properties and constraints:
- `ReportAfterSuite` nodes are passed a function that takes a `types.Report`:
```go
var _ = ReportAfterSuite(func(report types.Report) {
var _ = ReportAfterSuite("custom reporter", func(report types.Report) {
// do stuff with report
})
```
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Expand Up @@ -2762,7 +2762,7 @@ You should be aware that when running in parallel, each parallel process will be
/* === INVALID === */
var reportFile *os.File
BeforeSuite(func() {
reportFile = os.Open("report.custom")
reportFile = os.Create("report.custom")
})

ReportAfterEach(func(report SpecReport) {
Expand All @@ -2776,7 +2776,7 @@ you'll end up with multiple processes writing to the same file and the output wi
`ReportAfterSuite` nodes behave similarly to `AfterSuite` and can be placed at the top-level of your suite (typically in the suite bootstrap file). `ReportAfterSuite` nodes take a closure that accepts a single [`Report`]((https://pkg.go.dev/github.com/onsi/ginkgo/v2/types#Report)) argument:

```go
var _ = ReportAfterSuite(func(report Report) {
var _ = ReportAfterSuite("custom report", func(report Report) {
// process report
})
```
Expand All @@ -2790,10 +2790,10 @@ Finally, and most importantly, when running in parallel `ReportAfterSuite` **onl
So, we can rewrite our invalid `ReportAfterEach` example from above into a valid `ReportAfterSuite` example:
```go
ReportAfterSuite(func(report Report) {
f := os.Open("report.custom")
ReportAfterSuite("custom report", func(report Report) {
f := os.Create("report.custom")
for _, specReport := range report.SpecReports {
fmt.Fprintf(f, "%s | %s\n", report.FullText(), report.State)
fmt.Fprintf(f, "%s | %s\n", report.FullText(), specReport.State)
}
f.Close()
})
Expand Down

0 comments on commit b1864ad

Please sign in to comment.