kelvin/warewulf
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Benchmarking for wwctl overlay build

Browse Source 
- Benchmarks overlay build in an environment with 1000 nodes
- Updates testenv to support both benchmarks and tests

To execute:

```
go test github.com/warewulf/warewulf/internal/app/wwctl/overlay/build -bench Benchmark_Overlay_Build
```

Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2024-12-23 18:17:57 -07:00
parent 276e67fc54
commit a18913924d
55 changed files with 3361 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
internal/pkg/container/imprt_test.go
View File

@@ -32,14 +32,14 @@ func Test_ImportContainerDir(t *testing.T) {
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
src := "/tmp/testcontainer"
env.CreateFile(t, filepath.Join(src, "/bin/sh"))
env.CreateFile(filepath.Join(src, "/bin/sh"))
for _, file := range tt.files {
env.CreateFile(t, filepath.Join(src, file))
env.CreateFile(filepath.Join(src, file))
}
for _, socket := range tt.sockets {
env.MkdirAll(t, filepath.Dir(filepath.Join(src, socket)))
env.MkdirAll(filepath.Dir(filepath.Join(src, socket)))
assert.NoError(t, unix.Mknod(env.GetPath(filepath.Join(src, socket)), unix.S_IFSOCK|0777, 0))
}
assert.NoError(t, ImportDirectory(env.GetPath(src), "testcontainer"))

4
internal/pkg/container/initramfs_test.go
View File

@@ -65,9 +65,9 @@ func TestFindInitramfs(t *testing.T) {
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
for _, init := range tt.initramfs {
env.CreateFile(t, filepath.Join("/var/lib/warewulf/chroots/image/rootfs", init))
env.CreateFile(filepath.Join("/var/lib/warewulf/chroots/image/rootfs", init))
}
initramfs := FindInitramfs("image", tt.ver)

12
internal/pkg/kernel/kernel_test.go
View File

@@ -88,10 +88,10 @@ func Test_FindKernel(t *testing.T) {
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
rootfs := "/var/lib/warewulf/chroots/testcontainer/rootfs"
for _, file := range tt.files {
env.CreateFile(t, filepath.Join(rootfs, file))
env.CreateFile(filepath.Join(rootfs, file))
}
kernels := FindKernels("testcontainer")
@@ -151,10 +151,10 @@ func Test_FromNode(t *testing.T) {
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
rootfs := "/var/lib/warewulf/chroots/testcontainer/rootfs"
for _, file := range tt.files {
env.CreateFile(t, filepath.Join(rootfs, file))
env.CreateFile(filepath.Join(rootfs, file))
}
node := node.EmptyNode()
node.ContainerName = "testcontainer"
@@ -200,11 +200,11 @@ func Test_FindAllKernels(t *testing.T) {
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
for container, files := range tt.files {
rootfs := filepath.Join(filepath.Join("/var/lib/warewulf/chroots", container), "rootfs")
for _, file := range files {
env.CreateFile(t, filepath.Join(rootfs, file))
env.CreateFile(filepath.Join(rootfs, file))
}
}
kernels := FindAllKernels()

4
internal/pkg/node/fields_test.go
View File

@@ -72,8 +72,8 @@ nodes:
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
env.WriteFile(t, "/etc/warewulf/nodes.conf", tt.nodesConf)
defer env.RemoveAll()
env.WriteFile("/etc/warewulf/nodes.conf", tt.nodesConf)
registry, regErr := New()
assert.NoError(t, regErr)

8
internal/pkg/node/mergo_test.go
View File

@@ -180,8 +180,8 @@ nodeprofiles:
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
env.WriteFile(t, "/etc/warewulf/nodes.conf", tt.nodesConf)
defer env.RemoveAll()
env.WriteFile("/etc/warewulf/nodes.conf", tt.nodesConf)
registry, regErr := New()
assert.NoError(t, regErr)
@@ -763,8 +763,8 @@ nodeprofiles:
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
env.WriteFile(t, "/etc/warewulf/nodes.conf", tt.nodesConf)
defer env.RemoveAll()
env.WriteFile("/etc/warewulf/nodes.conf", tt.nodesConf)
registry, regErr := New()
assert.NoError(t, regErr)

38
internal/pkg/overlay/overlay_test.go
View File

@@ -20,17 +20,17 @@ import (
func Test_OverlayMethods(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
// Setup test data
sitedir := "/var/lib/warewulf/overlays/"
distdir := "/usr/share/warewulf/overlays/"
env.WriteFile(t, path.Join(sitedir, "siteonly/rootfs/testfile"), "a site overlay")
env.WriteFile(t, path.Join(distdir, "distonly/rootfs/testfile"), "a distribution overlay")
env.WriteFile(t, path.Join(sitedir, "legacy/testfile"), "a legacy overlay")
env.WriteFile(t, path.Join(sitedir, "both/rootfs/testfile"), "the site version")
env.WriteFile(t, path.Join(distdir, "both/rootfs/testfile"), "the distribution version")
env.WriteFile(path.Join(sitedir, "siteonly/rootfs/testfile"), "a site overlay")
env.WriteFile(path.Join(distdir, "distonly/rootfs/testfile"), "a distribution overlay")
env.WriteFile(path.Join(sitedir, "legacy/testfile"), "a legacy overlay")
env.WriteFile(path.Join(sitedir, "both/rootfs/testfile"), "the site version")
env.WriteFile(path.Join(distdir, "both/rootfs/testfile"), "the distribution version")
var tests = map[string]struct {
name string
@@ -215,19 +215,19 @@ T3
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
for fileName, content := range tt.overlayFiles {
env.WriteFile(t, fileName, content)
env.WriteFile(fileName, content)
}
for _, dirName := range tt.overlayDirs {
env.MkdirAll(t, dirName)
env.MkdirAll(dirName)
}
for linkName, target := range tt.overlaySymlinks {
env.Symlink(t, target, linkName)
env.Symlink(target, linkName)
}
env.MkdirAll(t, tt.outputDir)
env.MkdirAll(tt.outputDir)
assert.NoError(t, BuildOverlayIndir(tt.node, []node.Node{tt.node}, tt.overlays, env.GetPath(tt.outputDir)))
dirFiles := tt.outputDirs
@@ -238,9 +238,9 @@ T3
dirFiles = append(dirFiles, outputFile)
}
sort.Strings(dirFiles)
assert.Equal(t, dirFiles, env.ReadDir(t, tt.outputDir))
assert.Equal(t, dirFiles, env.ReadDir(tt.outputDir))
for fileName, content := range tt.outputFiles {
assert.Equal(t, content, env.ReadFile(t, path.Join(tt.outputDir, fileName)))
assert.Equal(t, content, env.ReadFile(path.Join(tt.outputDir, fileName)))
}
for _, dirName := range tt.outputDirs {
assert.True(t, util.IsDir(env.GetPath(path.Join(tt.outputDir, dirName))), fmt.Sprintf("%s is not a directory", dirName))
@@ -389,13 +389,13 @@ func Test_BuildOverlay(t *testing.T) {
}
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
env.CreateFile(t, "var/lib/warewulf/overlays/o1/rootfs/o1.txt")
env.CreateFile(t, "var/lib/warewulf/overlays/o2/rootfs/o2.txt")
env.CreateFile(t, "var/lib/warewulf/overlays/o3/rootfs/subdir/o3.txt.ww")
env.Chmod(t, "var/lib/warewulf/overlays/o3/rootfs/subdir", 0700)
env.Chmod(t, "var/lib/warewulf/overlays/o3/rootfs/subdir/o3.txt.ww", 0600)
env.CreateFile("var/lib/warewulf/overlays/o1/rootfs/o1.txt")
env.CreateFile("var/lib/warewulf/overlays/o2/rootfs/o2.txt")
env.CreateFile("var/lib/warewulf/overlays/o3/rootfs/subdir/o3.txt.ww")
env.Chmod("var/lib/warewulf/overlays/o3/rootfs/subdir", 0700)
env.Chmod("var/lib/warewulf/overlays/o3/rootfs/subdir/o3.txt.ww", 0600)
for _, tt := range tests {
nodeInfo := node.NewNode(tt.nodeName)

106
internal/pkg/testenv/testenv.go
View File

@@ -7,6 +7,7 @@ package testenv
import (
"os"
"os/exec"
"path"
"path/filepath"
"testing"
@@ -25,6 +26,8 @@ nodes:
`
type TestEnv struct {
t *testing.T
b *testing.B
BaseDir string
}
@@ -51,18 +54,42 @@ const Cachedir = "var/cache"
// Asserts no errors occur.
func New(t *testing.T) (env *TestEnv) {
env = new(TestEnv)
env.t = t
env.init()
return env
}
// NewBenchmark creates a benchmark environment in a temporary directory and configures
// Warewulf to use it.
//
// Caller is responsible to delete env.BaseDir by calling
// env.RemoveAll. Note that this does not restore Warewulf to its
// previous state.
//
// Asserts no errors occur.
func NewBenchmark(b *testing.B) (env *TestEnv) {
env = new(TestEnv)
env.b = b
env.init()
return env
}
// init creates a temporary directory and configured Warewulf to use it on behalf of
// New() or NewBenchmark().
//
// Asserts no errors occur.
func (env *TestEnv) init() {
tmpDir, err := os.MkdirTemp(os.TempDir(), "ww4test-*")
assert.NoError(t, err)
env.assertNoError(err)
env.BaseDir = tmpDir
env.WriteFile(t, path.Join(Sysconfdir, "warewulf/nodes.conf"), initNodesConf)
env.WriteFile(t, path.Join(Sysconfdir, "warewulf/warewulf.conf"), initWarewulfConf)
env.WriteFile(path.Join(Sysconfdir, "warewulf/nodes.conf"), initNodesConf)
env.WriteFile(path.Join(Sysconfdir, "warewulf/warewulf.conf"), initWarewulfConf)
// re-read warewulf.conf
conf := config.New()
err = conf.Read(env.GetPath(path.Join(Sysconfdir, "warewulf/warewulf.conf")))
assert.NoError(t, err)
env.assertNoError(err)
conf.Paths.Sysconfdir = env.GetPath(Sysconfdir)
conf.Paths.Bindir = env.GetPath(Bindir)
@@ -91,10 +118,24 @@ func New(t *testing.T) (env *TestEnv) {
conf.Paths.WWChrootdir,
conf.Paths.WWProvisiondir,
} {
env.MkdirAll(t, confPath)
env.MkdirAll(confPath)
}
}
// assertNoError handles error conditions generated by env,
// using the semantics of either a testing or a benchmark environment.
func (env *TestEnv) assertNoError(err error, msgAndArgs ...interface{}) {
if env.t != nil {
assert.NoError(env.t, err, msgAndArgs...)
}
return
if env.b != nil && err != nil {
if len(msgAndArgs) == 0 {
env.b.Errorf("%s", err)
} else {
env.b.Errorf(msgAndArgs[0].(string), (msgAndArgs[1:])...)
}
}
}
// GetPath returns the absolute path name for fileName specified
@@ -107,70 +148,77 @@ func (env *TestEnv) GetPath(fileName string) string {
// to the test environment.
//
// Asserts no errors occur.
func (env *TestEnv) MkdirAll(t *testing.T, dirName string) {
func (env *TestEnv) MkdirAll(dirName string) {
err := os.MkdirAll(env.GetPath(dirName), 0755)
assert.NoError(t, err)
env.assertNoError(err)
}
// Chmod changes the mode of fileName in the test environment, which must already exist.
//
// Asserts no errors occur.
func (env *TestEnv) Chmod(t *testing.T, fileName string, mode int) {
func (env *TestEnv) Chmod(fileName string, mode int) {
err := os.Chmod(env.GetPath(fileName), os.FileMode(mode))
assert.NoError(t, err)
env.assertNoError(err)
}
// WriteFile writes content to fileName, creating any necessary
// intermediate directories relative to the test environment.
//
// Asserts no errors occur.
func (env *TestEnv) WriteFile(t *testing.T, fileName string, content string) {
func (env *TestEnv) WriteFile(fileName string, content string) {
dirName := filepath.Dir(fileName)
env.MkdirAll(t, dirName)
env.MkdirAll(dirName)
f, err := os.Create(env.GetPath(fileName))
assert.NoError(t, err)
env.assertNoError(err)
defer f.Close()
_, err = f.WriteString(content)
assert.NoError(t, err)
env.assertNoError(err)
err = os.Chtimes(env.GetPath(fileName),
time.Date(2006, time.February, 1, 3, 4, 5, 0, time.UTC),
time.Date(2006, time.February, 1, 3, 4, 5, 0, time.UTC))
assert.NoError(t, err)
env.assertNoError(err)
}
// ImportFile writes the contents of inputFileName to fileName,
// creating any necessary intermediate directories relative to the
// test environment.
func (env *TestEnv) ImportFile(t *testing.T, fileName string, inputFileName string) {
func (env *TestEnv) ImportFile(fileName string, inputFileName string) {
buffer, err := os.ReadFile(inputFileName)
assert.NoError(t, err)
env.WriteFile(t, fileName, string(buffer))
env.assertNoError(err)
env.WriteFile(fileName, string(buffer))
}
func (env *TestEnv) ImportDir(dirName string, inputDirName string) {
env.MkdirAll(path.Dir(dirName))
cmd := exec.Command("cp", "--recursive", inputDirName, env.GetPath(dirName))
output, err := cmd.CombinedOutput()
env.assertNoError(err, string(output))
}
// CreateFile creates an empty file at fileName, creating any necessary intermediate directories
// relative to the test environment.
func (env *TestEnv) CreateFile(t *testing.T, fileName string) {
env.WriteFile(t, fileName, "")
func (env *TestEnv) CreateFile(fileName string) {
env.WriteFile(fileName, "")
}
// Symlink creates a symlink at fileName to target, creating any necessary intermediate directories
// relative to the test environment.
func (env *TestEnv) Symlink(t *testing.T, target string, fileName string) {
func (env *TestEnv) Symlink(target string, fileName string) {
dirName := filepath.Dir(fileName)
env.MkdirAll(t, dirName)
env.MkdirAll(dirName)
err := os.Symlink(target, env.GetPath(fileName))
assert.NoError(t, err)
env.assertNoError(err)
}
// ReadFile returns the content of fileName as converted to a
// string.
//
// Asserts no errors occur.
func (env *TestEnv) ReadFile(t *testing.T, fileName string) string {
func (env *TestEnv) ReadFile(fileName string) string {
buffer, err := os.ReadFile(env.GetPath(fileName))
assert.NoError(t, err)
env.assertNoError(err)
return string(buffer)
}
@@ -178,9 +226,9 @@ func (env *TestEnv) ReadFile(t *testing.T, fileName string) string {
// slice of strings.
//
// Asserts no errors occur.
func (env *TestEnv) ReadDir(t *testing.T, dirName string) []string {
func (env *TestEnv) ReadDir(dirName string) []string {
entries, err := os.ReadDir(env.GetPath(dirName))
assert.NoError(t, err)
env.assertNoError(err)
var entryStrs []string
for _, entry := range entries {
entryStrs = append(entryStrs, entry.Name())
@@ -192,7 +240,7 @@ func (env *TestEnv) ReadDir(t *testing.T, dirName string) []string {
// for the test environment.
//
// Asserts no errors occur.
func (env *TestEnv) RemoveAll(t *testing.T) {
func (env *TestEnv) RemoveAll() {
err := os.RemoveAll(env.BaseDir)
assert.NoError(t, err)
env.assertNoError(err)
}

6
internal/pkg/testenv/testenv_test.go
View File

@@ -9,7 +9,7 @@ import (
func Test_Basic(t *testing.T) {
env := New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
nodedb, err := node.New()
assert.NoError(t, err)
nodes, err := nodedb.FindAllNodes()
@@ -19,13 +19,13 @@ func Test_Basic(t *testing.T) {
func Test_two_nodes(t *testing.T) {
env := New(t)
env.WriteFile(t, "etc/warewulf/nodes.conf", `nodeprofiles:
env.WriteFile("etc/warewulf/nodes.conf", `nodeprofiles:
default: {}
nodes:
node1: {}
node2: {}
`)
defer env.RemoveAll(t)
defer env.RemoveAll()
nodedb, err := node.New()
assert.NoError(t, err)
nodes, err := nodedb.FindAllNodes()

4
internal/pkg/upgrade/node_test.go
View File

@@ -775,10 +775,10 @@ func Test_UpgradeNodesYaml(t *testing.T) {
for _, tt := range nodesYamlUpgradeTests {
t.Run(tt.name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
if tt.files != nil {
for fileName, content := range tt.files {
env.WriteFile(t, fileName, content)
env.WriteFile(fileName, content)
}
}
legacy, err := ParseNodes([]byte(tt.legacyYaml))

12
internal/pkg/util/util_test.go
View File

@@ -30,10 +30,10 @@ func Test_FindFiles(t *testing.T) {
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
env.MkdirAll(t, "/test")
defer env.RemoveAll()
env.MkdirAll("/test")
for _, file_ := range tt.createFiles {
env.CreateFile(t, filepath.Join("/test", file_))
env.CreateFile(filepath.Join("/test", file_))
}
files := FindFiles(env.GetPath("/test"))
@@ -80,10 +80,10 @@ func Test_FindFilterFiles(t *testing.T) {
for name, tt := range tests {
t.Run(name, func(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
env.MkdirAll(t, "/test")
defer env.RemoveAll()
env.MkdirAll("/test")
for _, file_ := range tt.createFiles {
env.CreateFile(t, filepath.Join("/test", file_))
env.CreateFile(filepath.Join("/test", file_))
}
files, err := FindFilterFiles(env.GetPath("/test"), tt.include, tt.exclude, true)

18
internal/pkg/warewulfd/provision_test.go
View File

@@ -36,9 +36,9 @@ var provisionSendTests = []struct {
func Test_ProvisionSend(t *testing.T) {
env := testenv.New(t)
defer env.RemoveAll(t)
defer env.RemoveAll()
env.WriteFile(t, "etc/warewulf/nodes.conf", `nodeprofiles:
env.WriteFile("etc/warewulf/nodes.conf", `nodeprofiles:
default:
container name: suse
nodes:
@@ -65,7 +65,7 @@ nodes:
version: 1.1.1`)
// create a arp file as for grub we look up the ip address through the arp cache
env.WriteFile(t, "/var/tmp/arpcache", `IP address HW type Flags HW address Mask Device
env.WriteFile("/var/tmp/arpcache", `IP address HW type Flags HW address Mask Device
10.10.10.10 0x1 0x2 00:00:00:ff:ff:ff * dummy
10.10.10.11 0x1 0x2 00:00:00:00:ff:ff * dummy
10.10.10.12 0x1 0x2 00:00:00:00:00:ff * dummy`)
@@ -74,12 +74,12 @@ nodes:
defer func() {
arpFile = prevArpFile
}()
env.CreateFile(t, "/var/lib/warewulf/chroots/suse/rootfs/boot/vmlinuz-1.1.0")
env.CreateFile(t, "/var/lib/warewulf/chroots/suse/rootfs/usr/lib64/efi/shim.efi")
env.CreateFile(t, "/var/lib/warewulf/chroots/suse/rootfs/usr/share/efi/x86_64/grub.efi")
env.CreateFile(t, "/var/lib/warewulf/chroots/suse/rootfs/boot/initramfs-1.1.0.img")
env.WriteFile(t, "/etc/warewulf/ipxe/test.ipxe", "{{.KernelVersion}}{{range $devname, $netdev := .NetDevs}}{{if and $netdev.Hwaddr $netdev.Device}} ifname={{$netdev.Device}}:{{$netdev.Hwaddr}} {{end}}{{end}}")
env.WriteFile(t, "/etc/warewulf/grub/grub.cfg.ww", "{{ .Tags.GrubMenuEntry }}")
env.CreateFile("/var/lib/warewulf/chroots/suse/rootfs/boot/vmlinuz-1.1.0")
env.CreateFile("/var/lib/warewulf/chroots/suse/rootfs/usr/lib64/efi/shim.efi")
env.CreateFile("/var/lib/warewulf/chroots/suse/rootfs/usr/share/efi/x86_64/grub.efi")
env.CreateFile("/var/lib/warewulf/chroots/suse/rootfs/boot/initramfs-1.1.0.img")
env.WriteFile("/etc/warewulf/ipxe/test.ipxe", "{{.KernelVersion}}{{range $devname, $netdev := .NetDevs}}{{if and $netdev.Hwaddr $netdev.Device}} ifname={{$netdev.Device}}:{{$netdev.Hwaddr}} {{end}}{{end}}")
env.WriteFile("/etc/warewulf/grub/grub.cfg.ww", "{{ .Tags.GrubMenuEntry }}")
dbErr := LoadNodeDB()
assert.NoError(t, dbErr)

2
internal/pkg/warewulfd/util_test.go
View File

@@ -78,7 +78,7 @@ var getOverlayFileTests = []struct {
func Test_getOverlayFile(t *testing.T) {
env := testenv.New(t)
env.WriteFile(t, "etc/warewulf/nodes.conf", `
env.WriteFile("etc/warewulf/nodes.conf", `
nodes:
node1: {} `)
conf := warewulfconf.Get()