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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
package main
import (
"bytes"
"fmt"
"io/ioutil"
"os"
"path"
"path/filepath"
"strings"
"testing"
check "gopkg.in/check.v1"
"netbsd.org/pkglint/textproc"
"netbsd.org/pkglint/trace"
)
var equals = check.Equals
var deepEquals = check.DeepEquals
type Suite struct {
stdout bytes.Buffer
stderr bytes.Buffer
tmpdir string
checkC *check.C
}
// Init initializes the suite with the check.C instance for the actual
// test run. See https://github.com/go-check/check/issues/22
func (s *Suite) Init(c *check.C) {
if s.checkC != nil {
panic("Suite.Init must only be called once.")
}
s.checkC = c
}
func (s *Suite) c() *check.C {
if s.checkC == nil {
panic("Suite.Init must be called before accessing check.C.")
}
return s.checkC
}
func (s *Suite) Stdout() string {
defer s.stdout.Reset()
return s.stdout.String()
}
func (s *Suite) Stderr() string {
defer s.stderr.Reset()
return s.stderr.String()
}
// Returns and consumes the output from both stdout and stderr.
// The temporary directory is replaced with a tilde (~).
func (s *Suite) Output() string {
output := s.Stdout() + s.Stderr()
if s.tmpdir != "" {
output = strings.Replace(output, s.tmpdir, "~", -1)
}
return output
}
func (s *Suite) CheckOutputEmpty() {
s.c().Check(s.Output(), equals, "")
}
func (s *Suite) CheckOutputLines(expectedLines ...string) {
expectedOutput := ""
for _, expectedLine := range expectedLines {
expectedOutput += expectedLine + "\n"
}
s.c().Check(s.Output(), equals, expectedOutput)
}
// Arguments are either (lineno, orignl) or (lineno, orignl, textnl).
func (s *Suite) NewRawLines(args ...interface{}) []*RawLine {
rawlines := make([]*RawLine, len(args)/2)
j := 0
for i := 0; i < len(args); i += 2 {
lineno := args[i].(int)
orignl := args[i+1].(string)
textnl := orignl
if i+2 < len(args) {
if s, ok := args[i+2].(string); ok {
textnl = s
i++
}
}
rawlines[j] = &RawLine{lineno, orignl, textnl}
j++
}
return rawlines[:j]
}
func (s *Suite) NewLines(fname string, texts ...string) []Line {
result := make([]Line, len(texts))
for i, text := range texts {
textnl := text + "\n"
result[i] = NewLine(fname, i+1, text, s.NewRawLines(i+1, textnl))
}
return result
}
func (s *Suite) NewMkLines(fname string, lines ...string) *MkLines {
return NewMkLines(s.NewLines(fname, lines...))
}
func (s *Suite) BeginDebugToStdout() {
G.logOut = os.Stdout
trace.Out = os.Stdout
trace.Tracing = true
}
func (s *Suite) EndDebugToStdout() {
G.logOut = &s.stdout
trace.Out = &s.stdout
trace.Tracing = false
}
func (s *Suite) UseCommandLine(args ...string) {
exitcode := new(Pkglint).ParseCommandLine(append([]string{"pkglint"}, args...))
if exitcode != nil && *exitcode != 0 {
s.c().Fatalf("Cannot parse command line: %#v", args)
}
G.opts.LogVerbose = true // See SetUpTest
}
func (s *Suite) RegisterMasterSite(varname string, urls ...string) {
name2url := &G.globalData.MasterSiteVarToURL
url2name := &G.globalData.MasterSiteURLToVar
if *name2url == nil {
*name2url = make(map[string]string)
*url2name = make(map[string]string)
}
(*name2url)[varname] = urls[0]
for _, url := range urls {
(*url2name)[url] = varname
}
}
func (s *Suite) RegisterTool(tool *Tool) {
reg := G.globalData.Tools
if len(reg.byName) == 0 && len(reg.byVarname) == 0 {
reg = NewToolRegistry()
G.globalData.Tools = reg
}
if tool.Name != "" {
reg.byName[tool.Name] = tool
}
if tool.Varname != "" {
reg.byVarname[tool.Varname] = tool
}
}
func (s *Suite) CreateTmpFile(relFname, content string) (absFname string) {
c := s.c()
absFname = s.TmpDir() + "/" + relFname
err := os.MkdirAll(path.Dir(absFname), 0777)
c.Assert(err, check.IsNil)
err = ioutil.WriteFile(absFname, []byte(content), 0666)
c.Check(err, check.IsNil)
return
}
func (s *Suite) CreateTmpFileLines(relFname string, rawTexts ...string) (absFname string) {
text := ""
for _, rawText := range rawTexts {
text += rawText + "\n"
}
return s.CreateTmpFile(relFname, text)
}
func (s *Suite) LoadTmpFile(relFname string) (absFname string) {
c := s.c()
bytes, err := ioutil.ReadFile(s.TmpDir() + "/" + relFname)
c.Assert(err, check.IsNil)
return string(bytes)
}
func (s *Suite) TmpDir() string {
if s.tmpdir == "" {
s.tmpdir = filepath.ToSlash(s.c().MkDir())
}
return s.tmpdir
}
func (s *Suite) ExpectFatalError(action func()) {
if r := recover(); r != nil {
if _, ok := r.(pkglintFatal); ok {
action()
return
}
panic(r)
}
}
func (s *Suite) SetUpTest(c *check.C) {
G = GlobalVars{Testing: true}
textproc.Testing = true
G.logOut, G.logErr, trace.Out = &s.stdout, &s.stderr, &s.stdout
s.checkC = c
s.UseCommandLine( /* no arguments */ )
s.checkC = nil
G.opts.LogVerbose = true // To detect duplicate work being done
}
func (s *Suite) TearDownTest(c *check.C) {
G = GlobalVars{}
textproc.Testing = false
if out := s.Output(); out != "" {
fmt.Fprintf(os.Stderr, "Unchecked output in %q; check with: c.Check(s.Output(), equals, %q)", c.TestName(), out)
}
s.tmpdir = ""
}
var _ = check.Suite(new(Suite))
func Test(t *testing.T) { check.TestingT(t) }
|
