Repository navigation
Expand file tree
/
Copy pathparser_test.go
More file actions
373 lines (309 loc) · 10.2 KB
/
Copy pathparser_test.go
File metadata and controls
373 lines (309 loc) · 10.2 KB
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
package publiccode
import (
"bytes"
"errors"
"fmt"
"io"
"net/http"
"net/http/httptest"
"net/url"
"os"
"path/filepath"
"reflect"
"strings"
"sync"
"testing"
"time"
)
// Test that the exported YAML passes validation again, and that re-exporting it
// matches the first export (lossless roundtrip).
func TestExport(t *testing.T) {
parser, err := NewParser(ParserConfig{DisableNetwork: true})
if err != nil {
t.Errorf("Can't create Parser: %v", err)
}
publiccode, err := parser.Parse("testdata/v0/valid/valid.yml")
if err != nil {
t.Errorf("Failed to parse valid file: %v", err)
}
yaml1, err := publiccode.ToYAML()
if err != nil {
t.Errorf("Failed to export YAML: %v", err)
}
// var p2 *Parser
// if p2, err = NewParser("/dev/null"); err != nil {
// t.Errorf("Can't create Parser: %v", err)
// }
publiccode2, err := parser.ParseStream(bytes.NewBuffer(yaml1))
if err != nil {
t.Errorf("Failed to parse exported file: %v", err)
}
yaml2, err := publiccode2.ToYAML()
if err != nil {
t.Errorf("Failed to export YAML again: %v", err)
}
if !bytes.Equal(yaml1, yaml2) {
t.Errorf("Exported YAML files do not match; roundtrip is not lossless")
}
}
// TestParseConcurrent verifies that multiple goroutines can call Parse on the same
// Parser instance simultaneously without data races, and that each call uses the
// correct baseURL for its file.
//
// Run with "go test -race".
func TestParseConcurrent(t *testing.T) {
const goroutines = 40
parser, err := NewParser(ParserConfig{DisableNetwork: true})
if err != nil {
t.Fatalf("can't create parser: %v", err)
}
// Has a logo and screenshots that only exist under no-network/assets/img/
fileA := "testdata/v0/valid/no-network/valid.yml"
// lives in the parent directory and has no screenshots
fileB := "testdata/v0/valid/categories_empty.yml"
_, errA := parser.Parse(fileA)
_, errB := parser.Parse(fileB)
var wg sync.WaitGroup
type result struct {
file string
err error
}
results := make([]result, goroutines)
for i := range goroutines {
wg.Add(1)
go func(i int) {
defer wg.Done()
file := fileA
if i%2 == 1 {
file = fileB
}
_, results[i].err = parser.Parse(file)
results[i].file = file
}(i)
}
wg.Wait()
for i, r := range results {
var expected error
// If base URLs leaked between goroutines, a fileA goroutine
// receiving fileB's baseURL would fail to locate the screenshots
// and return spurious validation errors.
if r.file == fileA {
expected = errA
} else {
expected = errB
}
if !reflect.DeepEqual(r.err, expected) {
t.Errorf("goroutine %d (%s): got %v, want %v", i, r.file, r.err, expected)
}
}
}
// TestDefaultTimeout checks that the default HTTP timeout is set when
// ParserConfig.Timeout is zero.
func TestDefaultTimeout(t *testing.T) {
p, err := NewParser(ParserConfig{})
if err != nil {
t.Fatal(err)
}
if p.client.Timeout != defaultHTTPTimeout {
t.Errorf("expected default timeout %v, got %v", defaultHTTPTimeout, p.client.Timeout)
}
}
// TestParseTimeout checks that Parse() fails when the server exceeds the
// configured timeout while fetching the publiccode.yml itself.
func TestParseTimeout(t *testing.T) {
fixture, err := os.ReadFile("testdata/v0/valid/valid.yml")
if err != nil {
t.Fatal(err)
}
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
time.Sleep(50 * time.Millisecond)
w.Header().Set("Content-Type", "text/yaml")
w.Write(fixture) //nolint:errcheck
}))
defer srv.Close()
p, err := NewParser(ParserConfig{Timeout: 1 * time.Millisecond, AllowNetworkToPrivateHosts: true})
if err != nil {
t.Fatal(err)
}
_, err = p.Parse(srv.URL + "/publiccode.yml")
if err == nil {
t.Fatal("expected timeout error, got nil")
}
if lower := strings.ToLower(err.Error()); !strings.Contains(lower, "deadline exceeded") && !strings.Contains(lower, "timeout") {
t.Errorf("expected timeout error, got: %v", err)
}
}
// TestValidationTimeout checks that external validation checks (logo) fail when
// the server exceeds the configured timeout.
func TestValidationTimeout(t *testing.T) {
fixture, err := os.ReadFile("testdata/v0/valid/logo_with_url.yml")
if err != nil {
t.Fatal(err)
}
logo, err := os.ReadFile("testdata/v0/valid/assets/img/logo.png")
if err != nil {
t.Fatal(err)
}
for _, slow := range []bool{false, true} {
t.Run(fmt.Sprintf("slow=%t", slow), func(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if slow {
timer := time.NewTimer(time.Second)
defer timer.Stop()
select {
case <-r.Context().Done():
return
case <-timer.C:
}
}
_, _ = w.Write(logo)
}))
defer srv.Close()
p, err := NewParser(ParserConfig{
Timeout: 100 * time.Millisecond,
AllowNetworkToPrivateHosts: true,
BaseURL: srv.URL,
})
if err != nil {
t.Fatal(err)
}
transport := p.client.Transport
p.client.Transport = roundTripperFunc(func(r *http.Request) (*http.Response, error) {
// The repository check must not use the network or consume the logo timeout.
if r.URL.String() == "https://github.com/italia/developers.italia.it.git" {
return &http.Response{
StatusCode: http.StatusOK,
Header: make(http.Header),
Body: io.NopCloser(strings.NewReader("")),
}, nil
}
// Logo URL resolution also checks for self hosted VCS services.
if r.URL.String() == srv.URL+"/api" || r.URL.String() == srv.URL+"/swagger.v1.json" {
return &http.Response{
StatusCode: http.StatusNotFound,
Header: make(http.Header),
Body: io.NopCloser(strings.NewReader("")),
}, nil
}
if r.URL.String() != srv.URL+"/logo.png" {
t.Errorf("unexpected request: %s", r.URL)
return nil, fmt.Errorf("unexpected request: %s", r.URL)
}
return transport.RoundTrip(r)
})
yml := bytes.ReplaceAll(fixture,
[]byte("https://raw.githubusercontent.com/italia/publiccode-parser-go/2a1f25a36e0f2ab2d71efb67db8b66ff00573fbe/testdata/v0/valid/assets/img/logo.png"),
[]byte(srv.URL+"/logo.png"),
)
_, err = p.ParseStream(bytes.NewReader(yml))
if !slow {
if err != nil {
t.Fatalf("unexpected validation error for fast logo: %v", err)
}
return
}
var results ValidationResults
if !errors.As(err, &results) || len(results) != 1 {
t.Fatalf("expected one logo validation error, got: %v", err)
}
var validationError ValidationError
if !errors.As(results[0], &validationError) || validationError.Key != "logo" {
t.Fatalf("expected logo validation error, got: %v", results[0])
}
description := strings.ToLower(validationError.Description)
if !strings.Contains(description, "context deadline exceeded") && !strings.Contains(description, "client.timeout exceeded") {
t.Errorf("expected logo timeout, got: %v", validationError)
}
})
}
}
// Test the toURL function.
func TestToURL(t *testing.T) {
cwd := testWorkingDir(t)
var err error
expected := map[string]*url.URL{
"file.txt": {Scheme: "file", Path: cwd + "/file.txt"},
"/path/file.txt": {Scheme: "file", Path: "/path/file.txt"},
"https://developers.italia.it/": {Scheme: "https", Host: "developers.italia.it", Path: "/"},
"https://developers.italia.it/file.txt": {Scheme: "https", Host: "developers.italia.it", Path: "/file.txt"},
"http://developers.italia.it/": {Scheme: "http", Host: "developers.italia.it", Path: "/"},
}
for in, out := range expected {
var u *url.URL
if u, err = toURL(in); err != nil {
t.Errorf("%s: got error %v", in, err)
}
if *u != *out {
t.Errorf("%s: expected %v got %v", in, out, u)
}
}
}
// The diagnostics must name the file that was validated, whatever it is
// called, or an editor reading the errorformat output jumps to the wrong file.
func TestParseReportsInputFileName(t *testing.T) {
source, err := os.ReadFile("testdata/v0/invalid/categories_invalid.yml")
if err != nil {
t.Fatalf("can't read the fixture: %v", err)
}
file := filepath.Join(t.TempDir(), "my-amazing-code.yaml")
//nolint:gosec // The destination is a fixed filename under t.TempDir().
if err = os.WriteFile(file, source, 0o600); err != nil {
t.Fatalf("can't write the fixture copy: %v", err)
}
parser, err := NewParser(ParserConfig{DisableExternalChecks: true})
if err != nil {
t.Fatalf("can't create parser: %v", err)
}
_, err = parser.Parse(file)
var results ValidationResults
if !errors.As(err, &results) {
t.Fatalf("expected validation results, got %T: %v", err, err)
}
for _, result := range results {
var ve ValidationError
if errors.As(result, &ve) && ve.File != "my-amazing-code.yaml" {
t.Errorf("got file %q, want %q", ve.File, "my-amazing-code.yaml")
}
}
want := "my-amazing-code.yaml:13:5: error: "
if !strings.HasPrefix(results.Error(), want) {
t.Errorf("got %q, want a diagnostic starting with %q", results.Error(), want)
}
}
// A stream carries no name, so its diagnostics keep the default one.
func TestParseStreamReportsDefaultFileName(t *testing.T) {
source, err := os.ReadFile("testdata/v0/invalid/categories_invalid.yml")
if err != nil {
t.Fatalf("can't read the fixture: %v", err)
}
parser, err := NewParser(ParserConfig{DisableExternalChecks: true})
if err != nil {
t.Fatalf("can't create parser: %v", err)
}
_, err = parser.ParseStream(bytes.NewReader(source))
if err == nil {
t.Fatal("expected validation results, got nil")
}
want := "publiccode.yml:13:5: error: "
if !strings.HasPrefix(err.Error(), want) {
t.Errorf("got %q, want a diagnostic starting with %q", err.Error(), want)
}
}
// Test the fileNameFromURL function.
func TestFileNameFromURL(t *testing.T) {
expected := []struct {
in *url.URL
want string
}{
{nil, ""},
{&url.URL{Scheme: "file", Path: "/path/to/my-amazing-code.yaml"}, "my-amazing-code.yaml"},
{&url.URL{Scheme: "file", Path: ""}, ""},
{&url.URL{Scheme: "https", Host: "example.org", Path: "/dir/publiccode.yml"}, "publiccode.yml"},
{&url.URL{Scheme: "https", Host: "example.org", Path: "/"}, ""},
}
for _, test := range expected {
if got := fileNameFromURL(test.in); got != test.want {
t.Errorf("%v: expected %q got %q", test.in, test.want, got)
}
}
}