cmd/safcm/config/files_test.go

   1 // SPDX-License-Identifier: GPL-3.0-or-later
   2 // Copyright (C) 2021-2024  Simon Ruderich
   3
   4 package config
   5
   6 import (
   7         "fmt"
   8         "io/fs"
   9         "os"
  10         "runtime"
  11         "testing"
  12
  13         "ruderich.org/simon/safcm"
  14         ft "ruderich.org/simon/safcm/remote/sync/filetest"
  15         "ruderich.org/simon/safcm/testutil"
  16 )
  17
  18 func chmod(name string, mode fs.FileMode) {
  19         err := os.Chmod(name, mode)
  20         if err != nil {
  21                 panic(err)
  22         }
  23 }
  24
  25 func TestLoadFiles(t *testing.T) {
  26         cwd, err := os.Getwd()
  27         if err != nil {
  28                 t.Fatal(err)
  29         }
  30         defer os.Chdir(cwd) //nolint:errcheck
  31
  32         err = os.Chdir("../testdata/project")
  33         if err != nil {
  34                 t.Fatal(err)
  35         }
  36
  37         // Regular users cannot create sticky files
  38         skipInvalidSticky := os.Getuid() != 0 &&
  39                 (runtime.GOOS == "freebsd" || runtime.GOOS == "openbsd")
  40
  41         chmod("files-invalid-perm-dir/files", 0500)
  42         defer chmod("files-invalid-perm-dir/files", 0700)
  43         chmod("files-invalid-perm-dir/files/etc/", 0755)
  44         chmod("files-invalid-perm-dir/files/etc/resolv.conf", 0644)
  45         chmod("files-invalid-perm-dir-setgid/files", 0755)
  46         chmod("files-invalid-perm-dir-setgid/files/etc/", 0755|fs.ModeSetgid)
  47         chmod("files-invalid-perm-dir-setgid/files/etc/resolv.conf", 0644)
  48         chmod("files-invalid-perm-file/files", 0755)
  49         chmod("files-invalid-perm-file/files/etc/", 0755)
  50         chmod("files-invalid-perm-file/files/etc/resolv.conf", 0600)
  51         chmod("files-invalid-perm-file-executable/files", 0755)
  52         chmod("files-invalid-perm-file-executable/files/etc", 0755)
  53         chmod("files-invalid-perm-file-executable/files/etc/rc.local", 0750)
  54         if !skipInvalidSticky {
  55                 chmod("files-invalid-perm-file-sticky/files", 0755)
  56                 chmod("files-invalid-perm-file-sticky/files/etc", 0755)
  57                 chmod("files-invalid-perm-file-sticky/files/etc/resolv.conf",
  58                         0644|fs.ModeSticky)
  59         }
  60
  61         ft.CreateFifo("files-invalid-type/files/invalid", 0644)
  62         defer os.Remove("files-invalid-type/files/invalid")
  63
  64         const errMsg = `
  65
  66 The actual permissions and user/group of files and directories are not used
  67 (except for +x on files). 0644/0755 and current remote user/group is used per
  68 default. Apply different file permissions via permissions.yaml. To prevent
  69 confusion files must be manually chmodded 0644/0755 and directories 0755 or
  70 via "safcm fixperms".
  71 `
  72
  73         tests := []struct {
  74                 group  string
  75                 skip   bool
  76                 exp    map[string]*safcm.File
  77                 expErr error
  78         }{
  79
  80                 {
  81                         "empty",
  82                         false,
  83                         nil,
  84                         nil,
  85                 },
  86
  87                 {
  88                         "group",
  89                         false,
  90                         map[string]*safcm.File{
  91                                 "/": {
  92                                         Path: "/",
  93                                         Mode: fs.ModeDir | 0755,
  94                                         Uid:  -1,
  95                                         Gid:  -1,
  96                                 },
  97                                 "/etc": {
  98                                         Path: "/etc",
  99                                         Mode: fs.ModeDir | 0755,
 100                                         Uid:  -1,
 101                                         Gid:  -1,
 102                                 },
 103                                 "/etc/.hidden": {
 104                                         Path: "/etc/.hidden",
 105                                         Mode: 0644,
 106                                         Uid:  -1,
 107                                         Gid:  -1,
 108                                         Data: []byte("..."),
 109                                 },
 110                                 "/etc/motd": {
 111                                         Path: "/etc/motd",
 112                                         Mode: 0644,
 113                                         Uid:  -1,
 114                                         Gid:  -1,
 115                                         Data: []byte(`Welcome to
 116 {{- if .IsHost "host1.example.org"}} Host ONE
 117 {{- else if "host2"}} Host TWO
 118 {{- end}}
 119
 120 {{if .InGroup "detected_linux"}}
 121 This is GNU/Linux host
 122 {{end}}
 123 {{if .InGroup "detected_freebsd"}}
 124 This is FreeBSD host
 125 {{end}}
 126
 127 {{if .InGroup "all"}}
 128 all
 129 {{end}}
 130 {{if .InGroup "host1.example.org"}}
 131 host1.example.org
 132 {{end}}
 133 {{if .InGroup "host2"}}
 134 host2
 135 {{end}}
 136 {{if .InGroup "host3.example.net"}}
 137 host3.example.net
 138 {{end}}
 139 `),
 140                                 },
 141                                 "/etc/rc.local": {
 142                                         Path: "/etc/rc.local",
 143                                         Mode: 0755,
 144                                         Uid:  -1,
 145                                         Gid:  -1,
 146                                         Data: []byte("#!/bin/sh\n"),
 147                                 },
 148                                 "/etc/resolv.conf": {
 149                                         Path: "/etc/resolv.conf",
 150                                         Mode: 0644,
 151                                         Uid:  -1,
 152                                         Gid:  -1,
 153                                         Data: []byte("nameserver ::1\n"),
 154                                 },
 155                                 "/etc/test": {
 156                                         Path: "/etc/test",
 157                                         Mode: fs.ModeSymlink | 0777,
 158                                         Uid:  -1,
 159                                         Gid:  -1,
 160                                         Data: []byte("doesnt-exist"),
 161                                 },
 162                         },
 163                         nil,
 164                 },
 165
 166                 {
 167                         "files-invalid-type",
 168                         false,
 169                         nil,
 170                         fmt.Errorf("files-invalid-type: \"files-invalid-type/files/invalid\": file type not supported"),
 171                 },
 172                 {
 173                         "files-invalid-perm-dir",
 174                         false,
 175                         nil,
 176                         fmt.Errorf("files-invalid-perm-dir: \"files-invalid-perm-dir/files\": invalid permissions 0500" + errMsg),
 177                 },
 178                 {
 179                         "files-invalid-perm-dir-setgid",
 180                         false,
 181                         nil,
 182                         fmt.Errorf("files-invalid-perm-dir-setgid: \"files-invalid-perm-dir-setgid/files/etc\": invalid permissions 02755" + errMsg),
 183                 },
 184                 {
 185                         "files-invalid-perm-file",
 186                         false,
 187                         nil,
 188                         fmt.Errorf("files-invalid-perm-file: \"files-invalid-perm-file/files/etc/resolv.conf\": invalid permissions 0600" + errMsg),
 189                 },
 190                 {
 191                         "files-invalid-perm-file-executable",
 192                         false,
 193                         nil,
 194                         fmt.Errorf("files-invalid-perm-file-executable: \"files-invalid-perm-file-executable/files/etc/rc.local\": invalid permissions 0750" + errMsg),
 195                 },
 196                 {
 197                         "files-invalid-perm-file-sticky",
 198                         skipInvalidSticky,
 199                         nil,
 200                         fmt.Errorf("files-invalid-perm-file-sticky: \"files-invalid-perm-file-sticky/files/etc/resolv.conf\": invalid permissions 01644" + errMsg),
 201                 },
 202         }
 203
 204         for _, tc := range tests {
 205                 t.Run(tc.group, func(t *testing.T) {
 206                         if tc.skip {
 207                                 t.SkipNow()
 208                         }
 209
 210                         res, err := LoadFiles(tc.group)
 211                         testutil.AssertEqual(t, "res", res, tc.exp)
 212                         testutil.AssertErrorEqual(t, "err", err, tc.expErr)
 213                 })
 214         }
 215 }