forked from matoous/godox
-
Notifications
You must be signed in to change notification settings - Fork 0
/
godox_test.go
188 lines (164 loc) · 5.58 KB
/
godox_test.go
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
package godox_test
import (
"flag"
"go/parser"
"go/token"
"os"
"path/filepath"
"testing"
"github.com/matoous/godox"
"github.com/matoous/godox/config"
)
// nolint // reason this is a unit test
func TestParse(t *testing.T) {
t.Parallel()
flag.Parse()
tests := []struct {
path string
result []string
includeTests bool
}{
{
path: "./fixtures/00",
result: []string{
`fixtures/00/example1.go:3: Line contains TODO/BUG/FIXME: "TODO"`,
},
},
{
path: "./fixtures/01",
result: []string{
`fixtures/01/example1.go:14: Line contains TODO/BUG/FIXME: "TODO(fix): something (Line 13)"`,
`fixtures/01/example1.go:21: Line contains TODO/BUG/FIXME: "todo compare apples to oranges on a supe..."`,
`fixtures/01/example1.go:25: Line contains TODO/BUG/FIXME: "TODO: Multiline C1 (Line 24)"`,
`fixtures/01/example1.go:26: Line contains TODO/BUG/FIXME: "TODO: Multiline C2 (Line 25)"`,
`fixtures/01/example1.go:27: Line contains TODO/BUG/FIXME: "FIXME: Your attitude (Line 26)"`,
`fixtures/01/example1.go:28: Line contains TODO/BUG/FIXME: "todo тут какой-то очень-очень-очень-очен..."`,
`fixtures/01/example2.go:5: Line contains TODO/BUG/FIXME: "TODO: Add JSON tag (Line 4)"`,
`fixtures/01/example2.go:6: Line contains TODO/BUG/FIXME: "toDO add more fields (Line 5)"`,
`fixtures/01/example2.go:12: Line contains TODO/BUG/FIXME: "TODO: multiline todo 1 (Line 11)"`,
`fixtures/01/example2.go:16: Line contains TODO/BUG/FIXME: "TOdo multiline todo 2 (Line 15)"`,
},
},
{
path: "./fixtures/02",
result: []string{
`fixtures/02/example3.go:4: Line contains TODO/BUG/FIXME: "TODO: remove foo (Line 3)"`,
`fixtures/02/example3.go:8: Line contains TODO/BUG/FIXME: "TODO: Rename field (Line 7)"`,
`fixtures/02/example3.go:11: Line contains TODO/BUG/FIXME: "TODO: get cat food (Line 10)"`,
`fixtures/02/example3.go:16: Line contains TODO/BUG/FIXME: "todo : todo comment (Line 15)"`,
`fixtures/02/example3_test.go:9: Line contains TODO/BUG/FIXME: "TODO write test"`,
},
includeTests: true,
},
{
path: "./fixtures/03",
result: []string{
`fixtures/03/main.go:1: Line contains TODO/BUG/FIXME: "TODO: Add package documentation"`,
`fixtures/03/main.go:2: Line contains TODO/BUG/FIXME: "TODO: Write an actual application"`,
`fixtures/03/main.go:9: Line contains TODO/BUG/FIXME: "FIXME: Spelling"`,
`fixtures/03/main.go:14: Line contains TODO/BUG/FIXME: "TODO: Multi line 1"`,
`fixtures/03/main.go:15: Line contains TODO/BUG/FIXME: "TODO: Multi line 2"`,
`fixtures/03/main.go:16: Line contains TODO/BUG/FIXME: "FIXME: Mutli line 3"`,
},
},
{
path: "./fixtures/04",
},
}
for _, tt := range tests {
tt := tt //nolint // reason tt is ok on this context
t.Run(tt.path, func(t *testing.T) {
t.Parallel()
var messages []godox.Message
_ = filepath.Walk(tt.path, func(path string, info os.FileInfo, _ error) error {
fset := token.NewFileSet()
if info.IsDir() {
return nil
}
f, err := parser.ParseFile(fset, path, nil, parser.ParseComments)
if err != nil {
panic(err)
}
goDoxSettings := config.GoDoxSettings{}
res := godox.Run(f, fset, &goDoxSettings)
messages = append(messages, res...)
return nil
})
a, b := len(messages), len(tt.result)
switch {
case b == 0 && a != b:
t.Errorf("should expect no messages, instead got:\n%q", messages)
case a > b:
t.Errorf("should return less messages (got %d, expects %d)", a, b)
case a < b:
t.Errorf("should return more messages (got %d, expect %d)", a, b)
}
for i := range tt.result {
if tt.result[i] != messages[i].Message {
t.Errorf("not equal\nexpected: %s\nactual: %s", tt.result[i], messages[i])
}
}
})
}
}
func TestFormat(t *testing.T) {
t.Parallel()
flag.Parse()
tests := []struct {
path string
result []string
includeTests bool
}{
{
path: "./fixtures/05",
result: []string{
"fixtures/05/example1.go:9: Line does not match the expected format: ^TODO\\([a-z]+\\)\\s+.+$, \"TODO This is a comment.\"",
"fixtures/05/example1.go:11: Line does not match the expected format: ^TODO\\([a-z]+\\)\\s+.+$, \"TODO Multi line 1\"",
"fixtures/05/example1.go:12: Line does not match the expected format: ^TODO\\([a-z]+\\)\\s+.+$, \"TODO Multi line 2\"",
},
},
}
for _, tt := range tests {
tt := tt //nolint // reason tt is ok on this context
t.Run(tt.path, func(t *testing.T) {
t.Parallel()
var messages []godox.Message
_ = filepath.Walk(tt.path, func(path string, info os.FileInfo, _ error) error {
fset := token.NewFileSet()
if info.IsDir() {
return nil
}
f, err := parser.ParseFile(fset, path, nil, parser.ParseComments)
if err != nil {
panic(err)
}
goDoxSettings := config.GoDoxSettings{
Format: true,
FormatRules: []config.GoDoxFormatRule{
{
Keyword: "TODO",
RegularExpression: `^TODO\([a-z]+\)\s+.+$`,
},
},
}
res := godox.Run(f, fset, &goDoxSettings)
messages = append(messages, res...)
return nil
})
a, b := len(messages), len(tt.result)
switch {
case b == 0 && a != b:
t.Errorf("should expect no messages, instead got:\n%q", messages)
case a > b:
t.Errorf("should return less messages (got %d, expects %d)", a, b)
case a < b:
t.Errorf("should return more messages (got %d, expect %d)", a, b)
}
for i := range tt.result {
if tt.result[i] != messages[i].Message {
t.Errorf("not equal\nexpected: %s\nactual: %s", tt.result[i], messages[i])
}
}
})
}
}