This repository has no description
1//go:build linux
2
3package microvm
4
5import (
6 "encoding/json"
7 "os"
8 "path/filepath"
9 "strings"
10 "testing"
11)
12
13func writeSpecFile(t *testing.T, path string) {
14 t.Helper()
15 data, err := json.Marshal(validImageSpec())
16 if err != nil {
17 t.Fatal(err)
18 }
19 if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
20 t.Fatal(err)
21 }
22 if err := os.WriteFile(path, data, 0o644); err != nil {
23 t.Fatal(err)
24 }
25}
26
27func TestResolveImageConventionalLayouts(t *testing.T) {
28 cases := []struct {
29 name string
30 layout func(t *testing.T, dir string)
31 }{
32 {
33 name: "directory with spec.json",
34 layout: func(t *testing.T, dir string) {
35 writeSpecFile(t, filepath.Join(dir, "nixos", "spec.json"))
36 },
37 },
38 {
39 name: "flat <name>.json",
40 layout: func(t *testing.T, dir string) {
41 writeSpecFile(t, filepath.Join(dir, "nixos.json"))
42 },
43 },
44 }
45
46 for _, tc := range cases {
47 t.Run(tc.name, func(t *testing.T) {
48 dir := t.TempDir()
49 tc.layout(t, dir)
50
51 e := testEngine(t, dir)
52 spec, path, name, err := e.resolveImage("nixos")
53 if err != nil {
54 t.Fatalf("resolveImage: %v", err)
55 }
56 if name != "nixos" {
57 t.Fatalf("name = %q, want nixos", name)
58 }
59 if !strings.HasPrefix(path, dir) {
60 t.Fatalf("resolved path %q not under image dir %q", path, dir)
61 }
62 if spec.Shell == "" {
63 t.Fatal("resolved spec not loaded")
64 }
65 })
66 }
67}
68
69func TestResolveImageDirectoryMissingSpec(t *testing.T) {
70 dir := t.TempDir()
71 if err := os.MkdirAll(filepath.Join(dir, "nixos"), 0o755); err != nil {
72 t.Fatal(err)
73 }
74
75 e := testEngine(t, dir)
76 _, _, _, err := e.resolveImage("nixos")
77 if err == nil || !strings.Contains(err.Error(), imageSpecFileName) {
78 t.Fatalf("directory without %s should error, got: %v", imageSpecFileName, err)
79 }
80}
81
82func TestResolveImageRequiresImageDirOnlyWhenUsed(t *testing.T) {
83 e := testEngine(t, "")
84 _, _, _, err := e.resolveImage("nixos")
85 if err == nil || !strings.Contains(err.Error(), "SPINDLE_MICROVM_PIPELINES_IMAGE_DIR") {
86 t.Fatalf("missing image directory should error when resolving an image, got: %v", err)
87 }
88}
89
90func TestResolveImageRejectsPaths(t *testing.T) {
91 e := testEngine(t, t.TempDir())
92 for _, name := range []string{"/etc/passwd", "../evil", "sub/evil", "..", "."} {
93 if _, _, _, err := e.resolveImage(name); err == nil || !strings.Contains(err.Error(), "must be a plain name") {
94 t.Fatalf("name %q should be rejected as a path, got: %v", name, err)
95 }
96 }
97}
98
99func validImageSpec() ImageSpec {
100 return ImageSpec{
101 Arch: "x86_64",
102 BootArgs: "console=ttyS0",
103 Initrd: "initrd",
104 Kernel: "kernel",
105 RunnerConfig: RunnerConfig{
106 Machine: "microvm",
107 },
108 MemoryMiB: 2048,
109 Shell: "/bin/sh",
110 StoreDisk: "store-disk",
111 VCPUs: 2,
112 }
113}
114
115func TestImageSpecValidateWithoutBaseConfigHash(t *testing.T) {
116 spec := validImageSpec()
117 if err := spec.Validate(); err != nil {
118 t.Fatalf("non-NixOS image spec should validate: %v", err)
119 }
120 if spec.SupportsConfigActivation() {
121 t.Fatal("spec without baseConfigHash should not support config activation")
122 }
123
124 spec.BaseConfigHash = "abcdef"
125 if !spec.SupportsConfigActivation() {
126 t.Fatal("spec with baseConfigHash should support config activation")
127 }
128}
129
130func TestImageSpecRequiresShell(t *testing.T) {
131 spec := validImageSpec()
132 spec.Shell = ""
133 err := spec.Validate()
134 if err == nil || !strings.Contains(err.Error(), "shell") {
135 t.Fatalf("spec without shell should fail validation, got: %v", err)
136 }
137}