1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
|
// Copyright (c) 2018-2022, Sylabs Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package singularityconf
import (
"fmt"
"io"
"os"
"reflect"
"regexp"
"strconv"
"strings"
"text/template"
)
// Directives represents the configuration directives type
// holding directives mapped to their respective values.
type Directives map[string][]string
var parserReg = regexp.MustCompile(`(?m)^\s*([a-zA-Z _-]+)[[:blank:]]*=[[:blank:]]*(.*)$`)
// GetDirectives parses configuration directives from reader
// and returns a directive map with associated values.
func GetDirectives(reader io.Reader) (Directives, error) {
if reader == nil {
return make(Directives), nil
}
data, err := io.ReadAll(reader)
if err != nil {
return nil, fmt.Errorf("while reading data: %s", err)
}
directives := make(Directives)
for _, match := range parserReg.FindAllSubmatch(data, -1) {
if match != nil {
key := strings.TrimSpace(string(match[1]))
val := strings.TrimSpace(string(match[2]))
if val != "" {
directives[key] = append(directives[key], val)
}
}
}
return directives, nil
}
// HasDirective returns if the directive is present or not.
func HasDirective(directive string) bool {
if directive == "" {
return false
}
file := new(File)
elem := reflect.ValueOf(file).Elem()
for i := 0; i < elem.NumField(); i++ {
typeField := elem.Type().Field(i)
if typeField.Tag.Get("directive") == directive {
return true
}
}
return false
}
// GetConfig sets the corresponding interface fields associated
// with directives.
func GetConfig(directives Directives) (*File, error) {
file := new(File)
elem := reflect.ValueOf(file).Elem()
// Iterate over the fields of f and handle each type
for i := 0; i < elem.NumField(); i++ {
valueField := elem.Field(i)
typeField := elem.Type().Field(i)
dir, ok := typeField.Tag.Lookup("directive")
if !ok {
return nil, fmt.Errorf("no directive tag found for field %q", typeField.Name)
}
defaultValue := ""
if v, ok := typeField.Tag.Lookup("default"); ok {
defaultValue = v
}
authorized := []string{}
if v, ok := typeField.Tag.Lookup("authorized"); ok {
authorized = strings.Split(v, ",")
}
kind := typeField.Type.Kind()
value := []string{}
if len(directives[dir]) > 0 {
for _, dv := range directives[dir] {
if dv != "" {
value = append(value, strings.Split(dv, ",")...)
}
}
} else {
if defaultValue != "" && (kind != reflect.Slice || directives == nil) {
value = append(value, strings.Split(defaultValue, ",")...)
}
}
switch kind {
case reflect.Bool:
found := false
for _, a := range authorized {
if a == value[0] {
found = true
break
}
}
if !found && len(authorized) > 0 {
return nil, fmt.Errorf("value authorized for directive %q are %s", dir, authorized)
}
valueField.SetBool(value[0] == "yes")
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
n, err := strconv.ParseInt(value[0], 0, 64)
if err != nil {
return nil, err
}
valueField.SetInt(n)
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
n, err := strconv.ParseUint(value[0], 0, 64)
if err != nil {
return nil, err
}
valueField.SetUint(n)
case reflect.String:
if len(value) == 0 {
value = []string{""}
}
found := false
for _, a := range authorized {
if a == value[0] {
found = true
break
}
}
if !found && len(authorized) > 0 && value[0] != "" {
return nil, fmt.Errorf("value authorized for directive '%s' are %s", dir, authorized)
}
valueField.SetString(value[0])
case reflect.Slice:
l := len(value)
v := reflect.MakeSlice(typeField.Type, l, l)
valueField.Set(v)
switch t := valueField.Interface().(type) {
case []string:
for i, val := range value {
t[i] = strings.TrimSpace(val)
}
}
}
}
return file, nil
}
// Parse parses configuration file with the specified path.
func Parse(filepath string) (*File, error) {
if filepath == "" {
// grab the default configuration
return GetConfig(nil)
}
c, err := os.Open(filepath)
if err != nil {
return nil, err
}
defer c.Close()
directives, err := GetDirectives(c)
if err != nil {
return nil, fmt.Errorf("while parsing data: %s", err)
}
return GetConfig(directives)
}
// Generate executes the default template asset on File object if
// no custom template path is provided otherwise it uses the template
// found in the path.
func Generate(out io.Writer, tmplPath string, config *File) error {
var err error
var t *template.Template
if tmplPath != "" {
t, err = template.ParseFiles(tmplPath)
if err != nil {
return fmt.Errorf("unable to parse template %s: %s", tmplPath, err)
}
} else {
t, err = template.New("singularity.conf").Parse(TemplateAsset)
if err != nil {
return fmt.Errorf("unable to create template: %s", err)
}
}
if err := t.Execute(out, config); err != nil {
return fmt.Errorf("unable to execute template text for %s on %v: %v", t.Name(), config, err)
}
return nil
}
|