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
|
// Copyright 2025 syzkaller project authors. All rights reserved.
// Use of this source code is governed by Apache 2 LICENSE that can be found in the LICENSE file.
package tooltest
import (
"encoding/json"
"flag"
"fmt"
"io/fs"
"os"
"path/filepath"
"runtime"
"testing"
"github.com/google/go-cmp/cmp"
"github.com/google/syzkaller/pkg/clangtool"
"github.com/google/syzkaller/pkg/osutil"
"github.com/google/syzkaller/pkg/testutil"
"github.com/google/syzkaller/sys/targets"
)
var FlagUpdate = flag.Bool("update", false, "update golden files")
func TestClangTool[Output any, OutputPtr clangtool.OutputDataPtr[Output]](t *testing.T, tool string) {
if runtime.GOOS != targets.Linux {
t.Skip("clang tools can only be tested on linux")
}
ForEachTestFile(t, tool, func(t *testing.T, cfg *clangtool.Config, file string) {
out, err := clangtool.Run[Output, OutputPtr](cfg)
if err != nil {
t.Fatal(err)
}
got, err := json.MarshalIndent(out, "", "\t")
if err != nil {
t.Fatal(err)
}
CompareGoldenData(t, file+".json", got)
})
}
func LoadOutput[Output any, OutputPtr clangtool.OutputDataPtr[Output]](t *testing.T, dir string) OutputPtr {
out := OutputPtr(new(Output))
v := clangtool.NewVerifier(dir)
forEachTestFile(t, dir, func(t *testing.T, file string) {
tmp, err := osutil.ReadJSON[OutputPtr](file + ".json")
if err != nil {
t.Fatal(err)
}
out.Merge(tmp, v)
})
out.Finalize(v)
if err := v.Error(); err != nil {
t.Fatal(err)
}
return out
}
func ForEachTestFile(t *testing.T, tool string, fn func(t *testing.T, cfg *clangtool.Config, file string)) {
forEachTestFile(t, "testdata", func(t *testing.T, file string) {
t.Run(filepath.Base(file), func(t *testing.T) {
t.Parallel()
buildDir := t.TempDir()
commands := fmt.Sprintf(`[{
"file": "%s",
"directory": "%s",
"command": "clang -c %s -DKBUILD_BASENAME=foo"
}]`,
file, buildDir, file)
dbFile := filepath.Join(buildDir, "compile_commands.json")
if err := os.WriteFile(dbFile, []byte(commands), 0600); err != nil {
t.Fatal(err)
}
cfg := &clangtool.Config{
Tool: tool,
KernelSrc: osutil.Abs("testdata"),
KernelObj: buildDir,
CacheFile: filepath.Join(buildDir, filepath.Base(file)+".json"),
DebugTrace: &testutil.Writer{TB: t},
}
fn(t, cfg, file)
})
})
}
func forEachTestFile(t *testing.T, dir string, fn func(t *testing.T, file string)) {
var files []string
err := filepath.WalkDir(osutil.Abs(dir), func(path string, d fs.DirEntry, err error) error {
if d.Name()[0] != '.' && filepath.Ext(d.Name()) == ".c" {
files = append(files, path)
}
return err
})
if err != nil {
t.Fatal(err)
}
if len(files) == 0 {
t.Fatal("found no source files")
}
for _, file := range files {
fn(t, file)
}
}
func CompareGoldenFile(t *testing.T, goldenFile, gotFile string) {
got, err := os.ReadFile(gotFile)
if err != nil {
t.Fatal(err)
}
CompareGoldenData(t, goldenFile, got)
}
func CompareGoldenData(t *testing.T, goldenFile string, got []byte) {
if *FlagUpdate {
if err := os.WriteFile(goldenFile, got, 0644); err != nil {
t.Fatal(err)
}
}
want, err := os.ReadFile(goldenFile)
if err != nil {
t.Fatal(err)
}
if diff := cmp.Diff(want, got); diff != "" {
t.Fatal(diff)
}
}
|
