forked from CycloneDX/cyclonedx-go
/
roundtrip_test.go
122 lines (102 loc) · 3.69 KB
/
roundtrip_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
// This file is part of CycloneDX Go
//
// Licensed under the Apache License, Version 2.0 (the “License”);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an “AS IS” BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) OWASP Foundation. All Rights Reserved.
package cyclonedx
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"os"
"os/exec"
"path/filepath"
"strings"
"testing"
"github.com/bradleyjkemp/cupaloy/v2"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
var roundTripSnapshotter = cupaloy.NewDefaultConfig().
WithOptions(cupaloy.SnapshotSubdirectory("./testdata/snapshots"))
var subTestNameSlashReplacer = strings.NewReplacer("/", "_")
func TestRoundTripJSON(t *testing.T) {
bomFilePaths, err := filepath.Glob("./testdata/*.json")
require.NoError(t, err)
for _, bomFilePath := range bomFilePaths {
t.Run(filepath.Base(bomFilePath), func(t *testing.T) {
// Read original BOM JSON
bomFile, err := os.Open(bomFilePath)
require.NoError(t, err)
// Decode BOM
bom := new(BOM)
require.NoError(t, NewBOMDecoder(bomFile, BOMFileFormatJSON).Decode(bom))
bomFile.Close()
// Encode BOM again
buf := new(bytes.Buffer)
tempFile, err := ioutil.TempFile("", "*_"+subTestNameSlashReplacer.Replace(t.Name()))
require.NoError(t, err)
encoder := NewBOMEncoder(io.MultiWriter(buf, tempFile), BOMFileFormatJSON)
encoder.SetPretty(true)
require.NoError(t, encoder.Encode(bom))
tempFile.Close() // Required for CLI to be able to access the file
// Sanity checks: BOM has to be valid
assertValidBOM(t, tempFile.Name())
os.Remove(tempFile.Name())
// Compare with snapshot
assert.NoError(t, roundTripSnapshotter.SnapshotMulti(filepath.Base(bomFilePath), buf.String()))
})
}
}
func TestRoundTripXML(t *testing.T) {
bomFilePaths, err := filepath.Glob("./testdata/*.xml")
require.NoError(t, err)
for _, bomFilePath := range bomFilePaths {
t.Run(filepath.Base(bomFilePath), func(t *testing.T) {
// Read original BOM XML
bomFile, err := os.Open(bomFilePath)
require.NoError(t, err)
// Decode BOM
bom := new(BOM)
require.NoError(t, NewBOMDecoder(bomFile, BOMFileFormatXML).Decode(bom))
bomFile.Close()
// Encode BOM again
buf := new(bytes.Buffer)
tempFile, err := ioutil.TempFile("", "*_"+subTestNameSlashReplacer.Replace(t.Name()))
require.NoError(t, err)
encoder := NewBOMEncoder(io.MultiWriter(buf, tempFile), BOMFileFormatXML)
encoder.SetPretty(true)
require.NoError(t, encoder.Encode(bom))
tempFile.Close() // Required for CLI to be able to access the file
// Sanity check: BOM has to be valid
assertValidBOM(t, tempFile.Name())
os.Remove(tempFile.Name())
// Compare with snapshot
assert.NoError(t, roundTripSnapshotter.SnapshotMulti(filepath.Base(bomFilePath), buf.String()))
})
}
}
func assertValidBOM(t *testing.T, bomFilePath string) {
inputFormat := "xml"
if strings.HasSuffix(bomFilePath, ".json") {
inputFormat = "json"
}
valCmd := exec.Command("cyclonedx", "validate", "--input-file", bomFilePath, "--input-format", inputFormat, "--input-version", "v1_4", "--fail-on-errors")
valOut, err := valCmd.CombinedOutput()
if !assert.NoError(t, err) {
// Provide some context when test is failing
fmt.Printf("validation error: %s\n", string(valOut))
}
}