warewulf/overlays/debug/internal/debug_test.go

package debug

import (
	"bytes"
	"os"
	"regexp"
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/warewulf/warewulf/internal/app/wwctl/overlay/show"
	"github.com/warewulf/warewulf/internal/pkg/testenv"
	"github.com/warewulf/warewulf/internal/pkg/wwlog"
)

func Test_debugOverlay(t *testing.T) {
	variableData := regexp.MustCompile(`(?m)(BuildTime|BuildTimeUnix|BuildSource|DataStore):.*$`)
	hostname, _ := os.Hostname()

	env := testenv.New(t)
	defer env.RemoveAll()
	env.ImportFile("etc/warewulf/warewulf.conf", "warewulf.conf")
	env.ImportFile("etc/warewulf/nodes.conf", "nodes.conf")
	env.ImportFile("var/lib/warewulf/overlays/debug/rootfs/tstruct.md.ww", "../rootfs/tstruct.md.ww")
	env.Configure()

	tests := []struct {
		name string
		args []string
		log  string
	}{
		{
			name: "debug",
			args: []string{"--render", "node1", "debug", "tstruct.md.ww"},
			log:  debug,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			cmd := show.GetCommand()
			cmd.SetArgs(tt.args)
			stdout := bytes.NewBufferString("")
			stderr := bytes.NewBufferString("")
			logbuf := bytes.NewBufferString("")
			cmd.SetOut(stdout)
			cmd.SetErr(stderr)
			wwlog.SetLogWriter(logbuf)
			err := cmd.Execute()
			assert.NoError(t, err)
			assert.Empty(t, stdout.String())
			assert.Empty(t, stderr.String())
			assert.Equal(t, strings.ReplaceAll(tt.log, "%HOSTNAME%", hostname), variableData.ReplaceAllString(logbuf.String(), "${1}: REMOVED_BY_TEST"))
		})
	}
}

const debug = `backupFile: true
writeFile: true
Filename: tstruct.md
# Warewulf template struct (tstruct)

This Warewulf template serves as a complete example of the variables
available to Warewulf templates. It may also be rendered against a
node to debug its apparent configuration.

    wwctl overlay show --render $nodename debug tstruct.md.ww

The template data structure is defined in
internal/pkg/overlay/datastructure.go, though it also references
data from other structures.

## Build

- BuildHost: %HOSTNAME%
- BuildTime: REMOVED_BY_TEST
- BuildTimeUnix: REMOVED_BY_TEST
- BuildSource: REMOVED_BY_TEST
- Overlay: debug

## Warewulf server

- Port: 9873
- Secure: true
- UpdateInterval: 60
- AutobuildOverlays: true
- EnableHostOverlay: true

### Network

- Ipaddr: 192.168.0.1
- IpCIDR: 192.168.0.1/24
- Netmask: 255.255.255.0
- Network: 192.168.0.0
- NetworkCIDR: 192.168.0.0/24
- Ipaddr6: 2001:db8::1
- PrefixLen6: 64
- IpCIDR6: 2001:db8::1/64
- Network6: 2001:db8::
- NetworkCIDR6: 2001:db8::/64
- Ipv6: true

### DHCP

- Dhcp.Enabled: true
- Dhcp.Template: default
- Dhcp.RangeStart: 
- Dhcp.RangeEnd: 
- Dhcp.Range6Start: 
- Dhcp.Range6End: 
- Dhcp.SystemdName: dhcpd

### NFS

- Enabled: true
- SystemdName: nfsd

### SSH
- Key types:
  - ed25519
  - ecdsa
  - rsa
  - dsa
- First key type: ed25519

## Node

The current node may also be accessed as .ThisNode, which provides access to
node methods in addition to its fields.

- Id: node1
- Hostname: node1
- Comment: 
- ClusterName: 
- ImageName: rockylinux-9
- Ipxe: default
- RuntimeOverlay:
  - hosts
  - ssh.authorized_keys
  - syncuser
- SystemOverlay:
  - wwinit
  - wwclient
  - fstab
  - hostname
  - ssh.host_keys
  - issue
  - resolv
  - udev.netname
  - systemd.netname
  - ifcfg
  - ifupdown
  - NetworkManager
  - wicked
  - ignition
- Init: /sbin/init
- Root: initramfs
- AssetKey: 
- Discoverable: 
- Profiles:
  - default
- Tags:
- Kernel:
  - Version: 
  - Args: quiet crashkernel=no vga=791 net.naming-scheme=v238
- Ipmi:
  - UserName: user
  - Password: password
  - Ipaddr: 192.168.4.21
  - Netmask: 255.255.255.0
  - Port: 
  - Gateway: 192.168.4.1
  - Interface: 
  - Write: true
  - Tags:
- NetDevs[default]:
  - Type: 
  - OnBoot: true (true)
  - Device: wwnet0
  - Hwaddr: e6:92:39:49:7b:03
  - Ipaddr: 192.168.3.21
  - Netmask: 255.255.255.0
  - Gateway: 192.168.3.1
  - Ipaddr6: <nil>
  - PrefixLen6: 
  - IpCIDR6: 
  - Gateway6: <nil>
  - MTU: 
  - Primary: false
  - Tags:
- NetDevs[secondary]:
  - Type: 
  - OnBoot: true (true)
  - Device: wwnet1
  - Hwaddr: 9a:77:29:73:14:f1
  - Ipaddr: 192.168.3.22
  - Netmask: 255.255.255.0
  - Gateway: 192.168.3.1
  - Ipaddr6: <nil>
  - PrefixLen6: 
  - IpCIDR6: 
  - Gateway6: <nil>
  - MTU: 
  - Primary: false
  - Tags:
    - DNS1=8.8.8.8
    - DNS2=8.8.4.4
- NetDevs[tertiary]:
  - Type: 
  - OnBoot:  (true)
  - Device: wwnet3
  - Hwaddr: 9a:77:29:73:14:f8
  - Ipaddr: <nil>
  - Netmask: <nil>
  - Gateway: <nil>
  - Ipaddr6: 2001:db8::3
  - PrefixLen6: 64
  - IpCIDR6: 2001:db8::3/64
  - Gateway6: 2001:db8::1
  - MTU: 
  - Primary: false
  - Tags:

## Other nodes

All nodes in the registry are available to all templates in the .AllNodes
field. Each node provides access to all node fields, as shown above.

- AllNodes:
  - node1
  - node2
`