You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
176 lines
4.8 KiB
Go
176 lines
4.8 KiB
Go
// Package dotenv is a go port of the ruby dotenv library (https://github.com/bkeepers/dotenv)
|
|
//
|
|
// Examples/readme can be found on the github page at https://github.com/joho/godotenv
|
|
//
|
|
// The TL;DR is that you make a .env file that looks something like
|
|
//
|
|
// SOME_ENV_VAR=somevalue
|
|
//
|
|
// and then in your go code you can call
|
|
//
|
|
// godotenv.Load()
|
|
//
|
|
// and all the env vars declared in .env will be available through os.Getenv("SOME_ENV_VAR")
|
|
package dotenv
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"os"
|
|
"regexp"
|
|
"strings"
|
|
|
|
"github.com/compose-spec/compose-go/template"
|
|
)
|
|
|
|
var utf8BOM = []byte("\uFEFF")
|
|
|
|
var startsWithDigitRegex = regexp.MustCompile(`^\s*\d.*`) // Keys starting with numbers are ignored
|
|
|
|
// LookupFn represents a lookup function to resolve variables from
|
|
type LookupFn func(string) (string, bool)
|
|
|
|
var noLookupFn = func(s string) (string, bool) {
|
|
return "", false
|
|
}
|
|
|
|
// Parse reads an env file from io.Reader, returning a map of keys and values.
|
|
func Parse(r io.Reader) (map[string]string, error) {
|
|
return ParseWithLookup(r, nil)
|
|
}
|
|
|
|
// ParseWithLookup reads an env file from io.Reader, returning a map of keys and values.
|
|
func ParseWithLookup(r io.Reader, lookupFn LookupFn) (map[string]string, error) {
|
|
data, err := io.ReadAll(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// seek past the UTF-8 BOM if it exists (particularly on Windows, some
|
|
// editors tend to add it, and it'll cause parsing to fail)
|
|
data = bytes.TrimPrefix(data, utf8BOM)
|
|
|
|
return UnmarshalBytesWithLookup(data, lookupFn)
|
|
}
|
|
|
|
// Load will read your env file(s) and load them into ENV for this process.
|
|
//
|
|
// Call this function as close as possible to the start of your program (ideally in main).
|
|
//
|
|
// If you call Load without any args it will default to loading .env in the current path.
|
|
//
|
|
// You can otherwise tell it which files to load (there can be more than one) like:
|
|
//
|
|
// godotenv.Load("fileone", "filetwo")
|
|
//
|
|
// It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults
|
|
func Load(filenames ...string) error {
|
|
return load(false, filenames...)
|
|
}
|
|
|
|
func load(overload bool, filenames ...string) error {
|
|
filenames = filenamesOrDefault(filenames)
|
|
for _, filename := range filenames {
|
|
err := loadFile(filename, overload)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ReadWithLookup gets all env vars from the files and/or lookup function and return values as
|
|
// a map rather than automatically writing values into env
|
|
func ReadWithLookup(lookupFn LookupFn, filenames ...string) (map[string]string, error) {
|
|
filenames = filenamesOrDefault(filenames)
|
|
envMap := make(map[string]string)
|
|
|
|
for _, filename := range filenames {
|
|
individualEnvMap, individualErr := readFile(filename, lookupFn)
|
|
|
|
if individualErr != nil {
|
|
return envMap, individualErr
|
|
}
|
|
|
|
for key, value := range individualEnvMap {
|
|
if startsWithDigitRegex.MatchString(key) {
|
|
continue
|
|
}
|
|
envMap[key] = value
|
|
}
|
|
}
|
|
|
|
return envMap, nil
|
|
}
|
|
|
|
// Read all env (with same file loading semantics as Load) but return values as
|
|
// a map rather than automatically writing values into env
|
|
func Read(filenames ...string) (map[string]string, error) {
|
|
return ReadWithLookup(nil, filenames...)
|
|
}
|
|
|
|
// UnmarshalBytesWithLookup parses env file from byte slice of chars, returning a map of keys and values.
|
|
func UnmarshalBytesWithLookup(src []byte, lookupFn LookupFn) (map[string]string, error) {
|
|
return UnmarshalWithLookup(string(src), lookupFn)
|
|
}
|
|
|
|
// UnmarshalWithLookup parses env file from string, returning a map of keys and values.
|
|
func UnmarshalWithLookup(src string, lookupFn LookupFn) (map[string]string, error) {
|
|
out := make(map[string]string)
|
|
err := newParser().parse(src, out, lookupFn)
|
|
return out, err
|
|
}
|
|
|
|
func filenamesOrDefault(filenames []string) []string {
|
|
if len(filenames) == 0 {
|
|
return []string{".env"}
|
|
}
|
|
return filenames
|
|
}
|
|
|
|
func loadFile(filename string, overload bool) error {
|
|
envMap, err := readFile(filename, nil)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
currentEnv := map[string]bool{}
|
|
rawEnv := os.Environ()
|
|
for _, rawEnvLine := range rawEnv {
|
|
key := strings.Split(rawEnvLine, "=")[0]
|
|
currentEnv[key] = true
|
|
}
|
|
|
|
for key, value := range envMap {
|
|
if !currentEnv[key] || overload {
|
|
_ = os.Setenv(key, value)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func readFile(filename string, lookupFn LookupFn) (map[string]string, error) {
|
|
file, err := os.Open(filename)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer file.Close()
|
|
|
|
return ParseWithLookup(file, lookupFn)
|
|
}
|
|
|
|
func expandVariables(value string, envMap map[string]string, lookupFn LookupFn) (string, error) {
|
|
retVal, err := template.Substitute(value, func(k string) (string, bool) {
|
|
if v, ok := lookupFn(k); ok {
|
|
return v, true
|
|
}
|
|
v, ok := envMap[k]
|
|
return v, ok
|
|
})
|
|
if err != nil {
|
|
return value, err
|
|
}
|
|
return retVal, nil
|
|
}
|