cmd/safcm/config/hosts.go

   1 // Config: parse hosts.yaml
   2
   3 // Copyright (C) 2021-2024  Simon Ruderich
   4 //
   5 // This program is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 package config
  19
  20 import (
  21         "fmt"
  22         "os"
  23         "strings"
  24
  25         "gopkg.in/yaml.v2"
  26 )
  27
  28 type Hosts struct {
  29         List []*Host
  30         Map  map[string]*Host
  31 }
  32
  33 type Host struct {
  34         Name string `yaml:"name"`
  35
  36         SshUser string `yaml:"ssh_user"`
  37 }
  38
  39 func LoadHosts() (*Hosts, error) {
  40         const path = "hosts.yaml"
  41
  42         var hostList []*Host
  43         x, err := os.ReadFile(path)
  44         if err != nil {
  45                 return nil, err
  46         }
  47         err = yaml.UnmarshalStrict(x, &hostList)
  48         if err != nil {
  49                 return nil, fmt.Errorf("%s: failed to load: %v", path, err)
  50         }
  51
  52         hostMap := make(map[string]*Host)
  53         for _, x := range hostList {
  54                 errPrefix := fmt.Sprintf("%s: host %q:", path, x.Name)
  55                 if x.Name == GroupAll {
  56                         return nil, fmt.Errorf(
  57                                 "%s conflict with pre-defined group %q",
  58                                 errPrefix, x.Name)
  59                 }
  60                 if strings.HasPrefix(x.Name, GroupDetectedPrefix) {
  61                         return nil, fmt.Errorf(
  62                                 "%s name must not start with %q "+
  63                                         "(reserved for detected groups)",
  64                                 errPrefix, GroupDetectedPrefix)
  65                 }
  66                 if strings.Contains(x.Name, GroupSpecialSeparator) {
  67                         return nil, fmt.Errorf(
  68                                 "%s name must not contain %q",
  69                                 errPrefix, GroupSpecialSeparator)
  70                 }
  71
  72                 if hostMap[x.Name] != nil {
  73                         return nil, fmt.Errorf("%s host name already exists",
  74                                 errPrefix)
  75                 }
  76                 hostMap[x.Name] = x
  77         }
  78
  79         return &Hosts{
  80                 List: hostList,
  81                 Map:  hostMap,
  82         }, nil
  83 }