Repository navigation
Expand file tree
/
Copy pathexample_test.go
More file actions
152 lines (127 loc) · 3.38 KB
/
Copy pathexample_test.go
File metadata and controls
152 lines (127 loc) · 3.38 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
package publiccode_test
import (
"errors"
"fmt"
"os"
"strings"
publiccode "github.com/publiccodeyml/libpubliccode/v5"
)
func ExampleNewDefaultParser() {
parser, err := publiccode.NewDefaultParser()
if err != nil {
panic(err)
}
_, err = parser.Parse("testdata/v0/valid/valid.minimal.yml")
if err != nil {
fmt.Println(err)
}
// Output:
}
func ExampleNewParser_disableNetwork() {
parser, err := publiccode.NewParser(publiccode.ParserConfig{
DisableNetwork: true,
})
if err != nil {
panic(err)
}
_, err = parser.Parse("testdata/v0/valid/valid.minimal.yml")
if err != nil {
fmt.Println(err)
}
// Output:
}
func ExampleParser_ParseStream() {
yaml := `
publiccodeYmlVersion: "0"
name: My Software
url: "https://github.com/example/example"
platforms:
- web
categories:
- cloud-management
developmentStatus: development
softwareType: "standalone/other"
description:
en-GB:
localisedName: My Software
shortDescription: >
A rather short description which
is probably useless
longDescription: >
Very long description of this software, also split
on multiple rows. You should note what the software
is and why one should need it. This is 158 characters.
Very long description of this software, also split
on multiple rows. You should note what the software
is and why one should need it. This is 316 characters.
Very long description of this software, also split
on multiple rows. You should note what the software
is and why one should need it. This is 474 characters.
Very long description of this software, also split
on multiple rows. You should note what the software
is and why one should need it. This is 632 characters.
features:
- Just one feature
legal:
license: AGPL-3.0-or-later
maintenance:
type: "community"
contacts:
- name: Francesco Rossi
localisation:
localisationReady: true
availableLanguages:
- en
`
parser, err := publiccode.NewParser(publiccode.ParserConfig{
DisableNetwork: true,
})
if err != nil {
panic(err)
}
_, err = parser.ParseStream(strings.NewReader(yaml))
if err != nil {
fmt.Println(err)
}
// Output:
}
// A valid document can return warnings through the error result.
func ExampleParser_ParseStream_warnings() {
data, err := os.ReadFile("testdata/v0/valid/valid.minimal.yml")
if err != nil {
panic(err)
}
// An older supported version produces a warning.
input := strings.Replace(string(data), `publiccodeYmlVersion: "0"`, `publiccodeYmlVersion: "0.7"`, 1)
parser, err := publiccode.NewParser(publiccode.ParserConfig{DisableNetwork: true})
if err != nil {
panic(err)
}
pc, err := parser.ParseStream(strings.NewReader(input))
valid := pc != nil
if err != nil {
results, ok := errors.AsType[publiccode.ValidationResults](err)
if !ok {
fmt.Println(err)
return
}
for _, result := range results {
var diagnostic publiccode.ValidationWarning
var validationError publiccode.ValidationError
switch {
case errors.As(result, &diagnostic):
fmt.Println("warning:", diagnostic.Key)
case errors.As(result, &validationError):
fmt.Println("error:", validationError.Key)
valid = false
default:
fmt.Println(result)
valid = false
}
}
}
fmt.Println("valid:", valid)
// Output:
// warning: publiccodeYmlVersion
// valid: true
}