File: env.go

package info (click to toggle)
apptainer 1.4.5-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 12,780 kB
  • sloc: sh: 3,329; ansic: 1,706; awk: 414; python: 103; makefile: 54
file content (59 lines) | stat: -rw-r--r-- 1,868 bytes parent folder | download | duplicates (2)
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
// Copyright (c) Contributors to the Apptainer project, established as
//   Apptainer a Series of LF Projects LLC.
//   For website terms of use, trademark policy, privacy policy and other
//   project policies see https://lfprojects.org/policies
// Copyright (c) 2019-2020, 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 cmdline

import (
	"fmt"
	"strings"

	"github.com/apptainer/apptainer/pkg/sylog"
	"github.com/spf13/pflag"
)

func setValue(flag *pflag.Flag, value string) error {
	if err := flag.Value.Set(value); err != nil {
		return fmt.Errorf("unable to set flag %s to value %s: %s", flag.Name, value, err)
	}
	flag.Changed = true
	sylog.Debugf("Updated flag '%s' value to: %s", flag.Name, flag.Value)
	return nil
}

// EnvAppendValue combines command line and environment var into a single argument
func EnvAppendValue(flag *pflag.Flag, value string) error {
	v := strings.TrimSpace(value)
	if v == "" {
		return nil
	}
	return setValue(flag, value)
}

// EnvSetValue set flag value if CLI option/argument is unset and env var is set
func EnvSetValue(flag *pflag.Flag, value string) error {
	v := strings.TrimSpace(value)
	if flag.Changed || v == "" {
		return nil
	}
	// if flag is a string slice, sanitize slice by
	// trimming potential spaces in environment variable
	// value (eg: FOO="val1 , val2,val3")
	if flag.Value.Type() == "stringSlice" {
		vals := strings.Split(v, ",")
		for i, e := range vals {
			vals[i] = strings.TrimSpace(e)
		}
		v = strings.Join(vals, ",")
	}
	return setValue(flag, v)
}

// EnvHandler defines an environment handler type to set flag's values
// from environment variables
type EnvHandler func(*pflag.Flag, string) error