1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
package types_test
import (
"fmt"
"reflect"
"strings"
. "github.com/onsi/ginkgo/v2"
"github.com/onsi/ginkgo/v2/formatter"
"github.com/onsi/ginkgo/v2/types"
. "github.com/onsi/gomega"
)
var _ = Describe("GinkgoErrors", func() {
BeforeEach(func() {
formatter.SingletonFormatter.ColorMode = formatter.ColorModePassthrough
})
AfterEach(func() {
formatter.SingletonFormatter.ColorMode = formatter.ColorModeTerminal
})
DescribeTable("error render cases", func(err error, expected ...string) {
Expect(err.Error()).To(HavePrefix(strings.Join(expected, "\n")))
},
Entry("an error with only a heading",
types.GinkgoError{
Heading: "Error! Error!",
},
"{{bold}}{{red}}Error! Error!{{/}}",
"",
),
Entry("an error with all the things",
types.GinkgoError{
Heading: "Error! Error!",
CodeLocation: types.CodeLocation{FileName: "foo.go", LineNumber: 17},
Message: "An error occurred.\nWelp!",
DocLink: "the-doc-section",
},
"{{bold}}{{red}}Error! Error!{{/}}",
"{{gray}}foo.go:17{{/}}",
" An error occurred.",
" Welp!",
"",
" {{bold}}Learn more at:{{/}}",
" {{cyan}}{{underline}}http://onsi.github.io/ginkgo/#the-doc-section{{/}}",
),
Entry("an error that successfully loads the line of its CodeLocation",
types.GinkgoError{
Heading: "Error! Error!",
CodeLocation: types.NewCodeLocation(0),
Message: "An error occurred.\nWelp!",
DocLink: "the-doc-section",
},
"{{bold}}{{red}}Error! Error!{{/}}",
"{{light-gray}}CodeLocation: types.NewCodeLocation(0),{{/}}",
fmt.Sprintf("{{gray}}%s:%d{{/}}", types.NewCodeLocation(0).FileName, types.NewCodeLocation(0).LineNumber-6),
" An error occurred.",
" Welp!",
"",
" {{bold}}Learn more at:{{/}}",
" {{cyan}}{{underline}}http://onsi.github.io/ginkgo/#the-doc-section{{/}}",
),
)
It("validates that all errors point to working documentation", func() {
v := reflect.ValueOf(types.GinkgoErrors)
Ω(v.NumMethod()).Should(BeNumerically(">", 0))
invalidLinks := []string{}
for i := 0; i < v.NumMethod(); i += 1 {
m := v.Method(i)
args := []reflect.Value{}
for j := 0; j < m.Type().NumIn(); j += 1 {
args = append(args, reflect.Zero(m.Type().In(j)))
}
ginkgoError := m.Call(args)[0].Interface().(types.GinkgoError)
if ginkgoError.DocLink != "" {
success, _ := ContainElement(ginkgoError.DocLink).Match(anchors.DocAnchors["index.md"])
if !success {
invalidLinks = append(invalidLinks, ginkgoError.DocLink)
}
}
}
Ω(invalidLinks).Should(BeEmpty(), "Detected invalid links. Available links are: %s", strings.Join(anchors.DocAnchors["index.md"], "\n"))
})
})
|
