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

Remove os.Umask from overlay.BuildOverlayIndir

Browse Source 
Adds tests to ensure that the overlay image contains the correct permissions.

Signed-off-by: Jonathon Anderson <janderson@ciq.com>
This commit is contained in:
Jonathon Anderson
2024-12-23 09:47:28 -07:00
parent 1affdc1883
commit 53e5805fbe
7 changed files with 70 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
internal/pkg/overlay/overlay.go
View File

@@ -10,7 +10,6 @@ import (
"path/filepath"
"regexp"
"strings"
"syscall"
"text/template"
"github.com/Masterminds/sprig/v3"
@@ -251,9 +250,6 @@ func BuildOverlayIndir(nodeData node.Node, overlayNames []string, outputDir stri
return fmt.Errorf("overlay names contains illegal characters: %v", overlayNames)
}
// Temporarily set umask to 0000, so directories in the overlay retain permissions
defer syscall.Umask(syscall.Umask(0))
wwlog.Verbose("Processing node/overlays: %s/%s", nodeData.Id(), strings.Join(overlayNames, ","))
for _, overlayName := range overlayNames {
wwlog.Verbose("Building overlay %s for node %s in %s", overlayName, nodeData.Id(), outputDir)

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

@@ -13,6 +13,8 @@ import (
"github.com/warewulf/warewulf/internal/pkg/node"
"github.com/warewulf/warewulf/internal/pkg/testenv"
"github.com/warewulf/warewulf/internal/pkg/util"
"github.com/cavaliergopher/cpio"
)
func Test_OverlayMethods(t *testing.T) {
@@ -259,6 +261,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays []string
image string
contents []string
perms []int
hasFiles bool
}{
{
@@ -292,6 +295,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1"},
image: "o1.img",
contents: []string{"o1.txt"},
perms: []int{0644},
},
{
description: "if multiple overlays are specified without a node, then the combined overlay is built directly in the overlay directory",
@@ -300,6 +304,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1", "o2"},
image: "o1-o2.img",
contents: []string{"o1.txt", "o2.txt"},
perms: []int{0644, 0644},
},
{
description: "if a single node overlay is specified, then the overlay is built in a node overlay directory",
@@ -308,6 +313,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1"},
image: "node1/o1.img",
contents: []string{"o1.txt"},
perms: []int{0644},
},
{
description: "if multiple node overlays are specified, then the combined overlay is built in a node overlay directory",
@@ -316,6 +322,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1", "o2"},
image: "node1/o1-o2.img",
contents: []string{"o1.txt", "o2.txt"},
perms: []int{0644, 0644},
},
{
description: "if no node system overlays are specified, then context pointed overlay is generated",
@@ -340,6 +347,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1"},
image: "node1/__SYSTEM__.img",
contents: []string{"o1.txt"},
perms: []int{0644},
},
{
description: "if a single node runtime overlay is specified, then a runtime overlay image is generated in a node overlay directory",
@@ -348,6 +356,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1"},
image: "node1/__RUNTIME__.img",
contents: []string{"o1.txt"},
perms: []int{0644},
},
{
description: "if multiple node system overlays are specified, then a system overlay image is generated with the contents of both overlays",
@@ -356,6 +365,7 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1", "o2"},
image: "node1/__SYSTEM__.img",
contents: []string{"o1.txt", "o2.txt"},
perms: []int{0644, 0644},
},
{
description: "if multiple node runtime overlays are specified, then a runtime overlay image is generated with the contents of both overlays",
@@ -364,45 +374,48 @@ func Test_BuildOverlay(t *testing.T) {
overlays: []string{"o1", "o2"},
image: "node1/__RUNTIME__.img",
contents: []string{"o1.txt", "o2.txt"},
perms: []int{0644, 0644},
},
{
description: "validating altered permissions are retained",
nodeName: "node1",
context: "runtime",
overlays: []string{"o3"},
image: "node1/__RUNTIME__.img",
contents: []string{"subdir", "subdir/o3.txt"},
perms: []int{0700, 0600},
},
}
conf := warewulfconf.Get()
overlayDir, overlayDirErr := os.MkdirTemp(os.TempDir(), "ww-test-overlay-*")
assert.NoError(t, overlayDirErr)
defer os.RemoveAll(overlayDir)
conf.Paths.WWOverlaydir = overlayDir
assert.NoError(t, os.Mkdir(path.Join(overlayDir, "o1"), 0700))
{
_, err := os.Create(path.Join(overlayDir, "o1", "o1.txt"))
assert.NoError(t, err)
}
assert.NoError(t, os.Mkdir(path.Join(overlayDir, "o2"), 0700))
{
_, err := os.Create(path.Join(overlayDir, "o2", "o2.txt"))
assert.NoError(t, err)
}
env := testenv.New(t)
defer env.RemoveAll(t)
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)
for _, tt := range tests {
nodeInfo := node.NewNode(tt.nodeName)
t.Run(tt.description, func(t *testing.T) {
provisionDir, provisionDirErr := os.MkdirTemp(os.TempDir(), "ww-test-provision-*")
assert.NoError(t, provisionDirErr)
defer os.RemoveAll(provisionDir)
conf.Paths.WWProvisiondir = provisionDir
err := BuildOverlay(nodeInfo, tt.context, tt.overlays)
assert.NoError(t, err)
if tt.image != "" {
image := path.Join(provisionDir, "overlays", tt.image)
image := env.GetPath(path.Join("srv/warewulf/overlays", tt.image))
assert.FileExists(t, image)
sort.Strings(tt.contents)
files, err := util.CpioFiles(image)
headers, err := readCpio(image)
assert.NoError(t, err)
sort.Strings(files)
assert.Equal(t, tt.contents, files)
assert.Equal(t, len(tt.contents), len(headers))
for i, file := range tt.contents {
assert.Equal(t, file, headers[file].Name)
if len(tt.perms) > i {
assert.Equal(t, tt.perms[i], int(headers[file].Mode.Perm()))
}
}
} else {
dirName := path.Join(provisionDir, "overlays", tt.nodeName)
dirName := env.GetPath(path.Join("srv/warewulf/overlays", tt.nodeName))
isEmpty := dirIsEmpty(t, dirName)
assert.True(t, isEmpty, "%v should be empty, but isn't", dirName)
}
@@ -630,3 +643,24 @@ func dirIsEmpty(t *testing.T, name string) bool {
t.Log(dirnames)
return false
}
func readCpio(name string) (headers map[string]*cpio.Header, err error) {
f, err := os.Open(name)
if err != nil {
return headers, err
}
defer f.Close()
reader := cpio.NewReader(f)
headers = make(map[string]*cpio.Header)
for {
header, err := reader.Next()
if err == io.EOF {
return headers, nil
}
if err != nil {
return headers, err
}
headers[header.Name] = header
}
}

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

@@ -112,6 +112,14 @@ func (env *TestEnv) MkdirAll(t *testing.T, dirName string) {
assert.NoError(t, 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) {
err := os.Chmod(env.GetPath(fileName), os.FileMode(mode))
assert.NoError(t, err)
}
// WriteFile writes content to fileName, creating any necessary
// intermediate directories relative to the test environment.
//

31
internal/pkg/util/cpio.go
View File

@@ -1,31 +0,0 @@
package util
import (
"io"
"os"
"github.com/sassoftware/go-rpmutils/cpio"
)
/*
Opens cpio archive and returns the file list
*/
func CpioFiles(name string) (files []string, err error) {
f, err := os.Open(name)
if err != nil {
return files, err
}
defer f.Close()
reader := cpio.NewReader(f)
for {
header, err := reader.Next()
if err == io.EOF {
return files, nil
}
if err != nil {
return files, err
}
files = append(files, header.Filename())
}
}