cmd/safcm/config/files_test.go

   1 // Copyright (C) 2021  Simon Ruderich
   2 //
   3 // This program is free software: you can redistribute it and/or modify
   4 // it under the terms of the GNU General Public License as published by
   5 // the Free Software Foundation, either version 3 of the License, or
   6 // (at your option) any later version.
   7 //
   8 // This program is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 package config
  17
  18 import (
  19         "fmt"
  20         "io/fs"
  21         "os"
  22         "syscall"
  23         "testing"
  24
  25         "ruderich.org/simon/safcm"
  26         "ruderich.org/simon/safcm/testutil"
  27 )
  28
  29 func chmod(name string, perm int) {
  30         err := os.Chmod(name, FullPermToFileMode(perm))
  31         if err != nil {
  32                 panic(err)
  33         }
  34 }
  35
  36 func TestLoadFiles(t *testing.T) {
  37         cwd, err := os.Getwd()
  38         if err != nil {
  39                 t.Fatal(err)
  40         }
  41         defer os.Chdir(cwd)
  42
  43         err = os.Chdir("../testdata/project")
  44         if err != nil {
  45                 t.Fatal(err)
  46         }
  47
  48         chmod("files-invalid-perm-dir/files", 0500)
  49         defer chmod("files-invalid-perm-dir/files", 0700)
  50         chmod("files-invalid-perm-dir/files/etc/", 0755)
  51         chmod("files-invalid-perm-dir/files/etc/resolv.conf", 0644)
  52         chmod("files-invalid-perm-dir-setgid/files", 0755)
  53         chmod("files-invalid-perm-dir-setgid/files/etc/", 02755)
  54         chmod("files-invalid-perm-dir-setgid/files/etc/resolv.conf", 0644)
  55         chmod("files-invalid-perm-file/files", 0755)
  56         chmod("files-invalid-perm-file/files/etc/", 0755)
  57         chmod("files-invalid-perm-file/files/etc/resolv.conf", 0600)
  58         chmod("files-invalid-perm-file-executable/files", 0755)
  59         chmod("files-invalid-perm-file-executable/files/etc", 0755)
  60         chmod("files-invalid-perm-file-executable/files/etc/rc.local", 0750)
  61         chmod("files-invalid-perm-file-sticky/files", 0755)
  62         chmod("files-invalid-perm-file-sticky/files/etc", 0755)
  63         chmod("files-invalid-perm-file-sticky/files/etc/resolv.conf", 01644)
  64
  65         err = syscall.Mkfifo("files-invalid-type/files/invalid", 0644)
  66         if err != nil {
  67                 t.Fatal(err)
  68         }
  69         defer os.Remove("files-invalid-type/files/invalid")
  70
  71         const errMsg = `
  72 The actual permissions and user/group of files and directories are not used
  73 (except for +x on files). 0644/0755 and current remote user/group is used per
  74 default. Apply different file permissions via permissions.yaml. To prevent
  75 confusion files must be manually chmodded 0644/0755 and directories 0755 or
  76 via "safcm fixperms".
  77 `
  78
  79         tests := []struct {
  80                 group  string
  81                 exp    map[string]*safcm.File
  82                 expErr error
  83         }{
  84
  85                 {
  86                         "empty",
  87                         nil,
  88                         nil,
  89                 },
  90
  91                 {
  92                         "group",
  93                         map[string]*safcm.File{
  94                                 "/": {
  95                                         Path: "/",
  96                                         Mode: fs.ModeDir | 0755,
  97                                         Uid:  -1,
  98                                         Gid:  -1,
  99                                 },
 100                                 "/etc": {
 101                                         Path: "/etc",
 102                                         Mode: fs.ModeDir | 0755,
 103                                         Uid:  -1,
 104                                         Gid:  -1,
 105                                 },
 106                                 "/etc/.hidden": {
 107                                         Path: "/etc/.hidden",
 108                                         Mode: 0644,
 109                                         Uid:  -1,
 110                                         Gid:  -1,
 111                                         Data: []byte("..."),
 112                                 },
 113                                 "/etc/motd": {
 114                                         Path: "/etc/motd",
 115                                         Mode: 0644,
 116                                         Uid:  -1,
 117                                         Gid:  -1,
 118                                         Data: []byte(`Welcome to
 119 {{- if .IsHost "host1.example.org"}} Host ONE
 120 {{- else if "host2"}} Host TWO
 121 {{- end}}
 122
 123 {{if .InGroup "detected_linux"}}
 124 This is GNU/Linux host
 125 {{end}}
 126 {{if .InGroup "detected_freebsd"}}
 127 This is FreeBSD host
 128 {{end}}
 129 `),
 130                                 },
 131                                 "/etc/rc.local": {
 132                                         Path: "/etc/rc.local",
 133                                         Mode: 0755,
 134                                         Uid:  -1,
 135                                         Gid:  -1,
 136                                         Data: []byte("#!/bin/sh\n"),
 137                                 },
 138                                 "/etc/resolv.conf": {
 139                                         Path: "/etc/resolv.conf",
 140                                         Mode: 0644,
 141                                         Uid:  -1,
 142                                         Gid:  -1,
 143                                         Data: []byte("nameserver ::1\n"),
 144                                 },
 145                                 "/etc/test": {
 146                                         Path: "/etc/test",
 147                                         Mode: fs.ModeSymlink | 0777,
 148                                         Uid:  -1,
 149                                         Gid:  -1,
 150                                         Data: []byte("doesnt-exist"),
 151                                 },
 152                         },
 153                         nil,
 154                 },
 155
 156                 {
 157                         "files-invalid-type",
 158                         nil,
 159                         fmt.Errorf("files-invalid-type: \"files-invalid-type/files/invalid\": file type not supported"),
 160                 },
 161                 {
 162                         "files-invalid-perm-dir",
 163                         nil,
 164                         fmt.Errorf("files-invalid-perm-dir: \"files-invalid-perm-dir/files\": invalid permissions 0500" + errMsg),
 165                 },
 166                 {
 167                         "files-invalid-perm-dir-setgid",
 168                         nil,
 169                         fmt.Errorf("files-invalid-perm-dir-setgid: \"files-invalid-perm-dir-setgid/files/etc\": invalid permissions 02755" + errMsg),
 170                 },
 171                 {
 172                         "files-invalid-perm-file",
 173                         nil,
 174                         fmt.Errorf("files-invalid-perm-file: \"files-invalid-perm-file/files/etc/resolv.conf\": invalid permissions 0600" + errMsg),
 175                 },
 176                 {
 177                         "files-invalid-perm-file-executable",
 178                         nil,
 179                         fmt.Errorf("files-invalid-perm-file-executable: \"files-invalid-perm-file-executable/files/etc/rc.local\": invalid permissions 0750" + errMsg),
 180                 },
 181                 {
 182                         "files-invalid-perm-file-sticky",
 183                         nil,
 184                         fmt.Errorf("files-invalid-perm-file-sticky: \"files-invalid-perm-file-sticky/files/etc/resolv.conf\": invalid permissions 01644" + errMsg),
 185                 },
 186         }
 187
 188         for _, tc := range tests {
 189                 t.Run(tc.group, func(t *testing.T) {
 190                         res, err := LoadFiles(tc.group)
 191                         testutil.AssertEqual(t, "res", res, tc.exp)
 192                         testutil.AssertErrorEqual(t, "err", err, tc.expErr)
 193                 })
 194         }
 195 }