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
|
// SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
package saver2v3
import (
"bytes"
"testing"
"github.com/spdx/tools-golang/spdx/common"
"github.com/spdx/tools-golang/spdx/v2_3"
)
// ===== File section Saver tests =====
func TestSaver2_3FileSavesText(t *testing.T) {
f := &v2_3.File{
FileName: "/tmp/whatever.txt",
FileSPDXIdentifier: common.ElementID("File123"),
FileTypes: []string{
"TEXT",
"DOCUMENTATION",
},
Checksums: []common.Checksum{
{Algorithm: common.SHA1, Value: "85ed0817af83a24ad8da68c2b5094de69833983c"},
{Algorithm: common.SHA256, Value: "11b6d3ee554eedf79299905a98f9b9a04e498210b59f15094c916c91d150efcd"},
{Algorithm: common.MD5, Value: "624c1abb3664f4b35547e7c73864ad24"},
},
LicenseConcluded: "Apache-2.0",
LicenseInfoInFiles: []string{
"Apache-2.0",
"Apache-1.1",
},
LicenseComments: "this is a license comment(s)",
FileCopyrightText: "Copyright (c) Jane Doe",
ArtifactOfProjects: []*v2_3.ArtifactOfProject{
{
Name: "project1",
HomePage: "http://example.com/1/",
URI: "http://example.com/1/uri.whatever",
},
{
Name: "project2",
},
{
Name: "project3",
HomePage: "http://example.com/3/",
},
{
Name: "project4",
URI: "http://example.com/4/uri.whatever",
},
},
FileComment: "this is a file comment",
FileNotice: "This file may be used under either Apache-2.0 or Apache-1.1.",
FileContributors: []string{
"John Doe jdoe@example.com",
"EvilCorp",
},
FileAttributionTexts: []string{
"attributions",
`multi-line
attribution`,
},
FileDependencies: []string{
"f-1.txt",
"g.txt",
},
}
// what we want to get, as a buffer of bytes
want := bytes.NewBufferString(`FileName: /tmp/whatever.txt
SPDXID: SPDXRef-File123
FileType: TEXT
FileType: DOCUMENTATION
FileChecksum: SHA1: 85ed0817af83a24ad8da68c2b5094de69833983c
FileChecksum: SHA256: 11b6d3ee554eedf79299905a98f9b9a04e498210b59f15094c916c91d150efcd
FileChecksum: MD5: 624c1abb3664f4b35547e7c73864ad24
LicenseConcluded: Apache-2.0
LicenseInfoInFile: Apache-2.0
LicenseInfoInFile: Apache-1.1
LicenseComments: this is a license comment(s)
FileCopyrightText: Copyright (c) Jane Doe
ArtifactOfProjectName: project1
ArtifactOfProjectHomePage: http://example.com/1/
ArtifactOfProjectURI: http://example.com/1/uri.whatever
ArtifactOfProjectName: project2
ArtifactOfProjectName: project3
ArtifactOfProjectHomePage: http://example.com/3/
ArtifactOfProjectName: project4
ArtifactOfProjectURI: http://example.com/4/uri.whatever
FileComment: this is a file comment
FileNotice: This file may be used under either Apache-2.0 or Apache-1.1.
FileContributor: John Doe jdoe@example.com
FileContributor: EvilCorp
FileAttributionText: attributions
FileAttributionText: <text>multi-line
attribution</text>
FileDependency: f-1.txt
FileDependency: g.txt
`)
// render as buffer of bytes
var got bytes.Buffer
err := renderFile2_3(f, &got)
if err != nil {
t.Errorf("Expected nil error, got %v", err)
}
// check that they match
c := bytes.Compare(want.Bytes(), got.Bytes())
if c != 0 {
t.Errorf("Expected %v, got %v", want.String(), got.String())
}
}
func TestSaver2_3FileSavesSnippetsAlso(t *testing.T) {
sn1 := &v2_3.Snippet{
SnippetSPDXIdentifier: common.ElementID("Snippet19"),
SnippetFromFileSPDXIdentifier: common.MakeDocElementID("", "File123").ElementRefID,
Ranges: []common.SnippetRange{{StartPointer: common.SnippetRangePointer{Offset: 17}, EndPointer: common.SnippetRangePointer{Offset: 209}}},
SnippetLicenseConcluded: "GPL-2.0-or-later",
SnippetCopyrightText: "Copyright (c) John Doe 20x6",
}
sn2 := &v2_3.Snippet{
SnippetSPDXIdentifier: common.ElementID("Snippet20"),
SnippetFromFileSPDXIdentifier: common.MakeDocElementID("", "File123").ElementRefID,
Ranges: []common.SnippetRange{{StartPointer: common.SnippetRangePointer{Offset: 268}, EndPointer: common.SnippetRangePointer{Offset: 309}}},
SnippetLicenseConcluded: "WTFPL",
SnippetCopyrightText: "NOASSERTION",
}
sns := map[common.ElementID]*v2_3.Snippet{
common.ElementID("Snippet19"): sn1,
common.ElementID("Snippet20"): sn2,
}
f := &v2_3.File{
FileName: "/tmp/whatever.txt",
FileSPDXIdentifier: common.ElementID("File123"),
Checksums: []common.Checksum{
{Algorithm: common.SHA1, Value: "85ed0817af83a24ad8da68c2b5094de69833983c"},
},
LicenseConcluded: "Apache-2.0",
LicenseInfoInFiles: []string{
"Apache-2.0",
},
FileCopyrightText: "Copyright (c) Jane Doe",
Snippets: sns,
}
// what we want to get, as a buffer of bytes
want := bytes.NewBufferString(`FileName: /tmp/whatever.txt
SPDXID: SPDXRef-File123
FileChecksum: SHA1: 85ed0817af83a24ad8da68c2b5094de69833983c
LicenseConcluded: Apache-2.0
LicenseInfoInFile: Apache-2.0
FileCopyrightText: Copyright (c) Jane Doe
SnippetSPDXID: SPDXRef-Snippet19
SnippetFromFileSPDXID: SPDXRef-File123
SnippetByteRange: 17:209
SnippetLicenseConcluded: GPL-2.0-or-later
SnippetCopyrightText: Copyright (c) John Doe 20x6
SnippetSPDXID: SPDXRef-Snippet20
SnippetFromFileSPDXID: SPDXRef-File123
SnippetByteRange: 268:309
SnippetLicenseConcluded: WTFPL
SnippetCopyrightText: NOASSERTION
`)
// render as buffer of bytes
var got bytes.Buffer
err := renderFile2_3(f, &got)
if err != nil {
t.Errorf("Expected nil error, got %v", err)
}
// check that they match
c := bytes.Compare(want.Bytes(), got.Bytes())
if c != 0 {
t.Errorf("Expected %v, got %v", want.String(), got.String())
}
}
func TestSaver2_3FileOmitsOptionalFieldsIfEmpty(t *testing.T) {
f := &v2_3.File{
FileName: "/tmp/whatever.txt",
FileSPDXIdentifier: common.ElementID("File123"),
Checksums: []common.Checksum{
{Algorithm: common.SHA1, Value: "85ed0817af83a24ad8da68c2b5094de69833983c"},
},
LicenseConcluded: "Apache-2.0",
LicenseInfoInFiles: []string{
"Apache-2.0",
},
FileCopyrightText: "Copyright (c) Jane Doe",
}
// what we want to get, as a buffer of bytes
want := bytes.NewBufferString(`FileName: /tmp/whatever.txt
SPDXID: SPDXRef-File123
FileChecksum: SHA1: 85ed0817af83a24ad8da68c2b5094de69833983c
LicenseConcluded: Apache-2.0
LicenseInfoInFile: Apache-2.0
FileCopyrightText: Copyright (c) Jane Doe
`)
// render as buffer of bytes
var got bytes.Buffer
err := renderFile2_3(f, &got)
if err != nil {
t.Errorf("Expected nil error, got %v", err)
}
// check that they match
c := bytes.Compare(want.Bytes(), got.Bytes())
if c != 0 {
t.Errorf("Expected %v, got %v", want.String(), got.String())
}
}
func TestSaver2_3FileWrapsCopyrightMultiLine(t *testing.T) {
f := &v2_3.File{
FileName: "/tmp/whatever.txt",
FileSPDXIdentifier: common.ElementID("File123"),
Checksums: []common.Checksum{
{Algorithm: common.SHA1, Value: "85ed0817af83a24ad8da68c2b5094de69833983c"},
},
LicenseConcluded: "Apache-2.0",
LicenseInfoInFiles: []string{
"Apache-2.0",
},
FileCopyrightText: `Copyright (c) Jane Doe
Copyright (c) John Doe`,
}
// what we want to get, as a buffer of bytes
want := bytes.NewBufferString(`FileName: /tmp/whatever.txt
SPDXID: SPDXRef-File123
FileChecksum: SHA1: 85ed0817af83a24ad8da68c2b5094de69833983c
LicenseConcluded: Apache-2.0
LicenseInfoInFile: Apache-2.0
FileCopyrightText: <text>Copyright (c) Jane Doe
Copyright (c) John Doe</text>
`)
// render as buffer of bytes
var got bytes.Buffer
err := renderFile2_3(f, &got)
if err != nil {
t.Errorf("Expected nil error, got %v", err)
}
// check that they match
c := bytes.Compare(want.Bytes(), got.Bytes())
if c != 0 {
t.Errorf("Expected %v, got %v", want.String(), got.String())
}
}
func TestSaver2_3FileWrapsCommentsAndNoticesMultiLine(t *testing.T) {
f := &v2_3.File{
FileName: "/tmp/whatever.txt",
FileSPDXIdentifier: common.ElementID("File123"),
Checksums: []common.Checksum{
{Algorithm: common.SHA1, Value: "85ed0817af83a24ad8da68c2b5094de69833983c"},
},
LicenseComments: `this is a
multi-line license comment`,
LicenseConcluded: "Apache-2.0",
LicenseInfoInFiles: []string{
"Apache-2.0",
},
FileCopyrightText: "Copyright (c) Jane Doe",
FileComment: `this is a
multi-line file comment`,
FileNotice: `This file may be used
under either Apache-2.0 or Apache-1.1.`,
}
// what we want to get, as a buffer of bytes
want := bytes.NewBufferString(`FileName: /tmp/whatever.txt
SPDXID: SPDXRef-File123
FileChecksum: SHA1: 85ed0817af83a24ad8da68c2b5094de69833983c
LicenseConcluded: Apache-2.0
LicenseInfoInFile: Apache-2.0
LicenseComments: <text>this is a
multi-line license comment</text>
FileCopyrightText: Copyright (c) Jane Doe
FileComment: <text>this is a
multi-line file comment</text>
FileNotice: <text>This file may be used
under either Apache-2.0 or Apache-1.1.</text>
`)
// render as buffer of bytes
var got bytes.Buffer
err := renderFile2_3(f, &got)
if err != nil {
t.Errorf("Expected nil error, got %v", err)
}
// check that they match
c := bytes.Compare(want.Bytes(), got.Bytes())
if c != 0 {
t.Errorf("Expected %v, got %v", want.String(), got.String())
}
}
|
