forked from coop-cloud-mirrors/godotenv
		
	Compare commits
	
		
			21 Commits
		
	
	
		
			release-ac
			...
			v0.0.0-tes
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| cc9e9b7de7 | |||
| 0f21d20acb | |||
| 5c76d3e02c | |||
| 85a2237126 | |||
| add39c6f94 | |||
| 1b6c7eb7cc | |||
| b898a8b0d1 | |||
| 60df7dd66c | |||
| aa20cd96bb | |||
| a904479007 | |||
| a582f0c9d3 | |||
| 26b87a7e2c | |||
| 76d246ae25 | |||
| 139777a9ff | |||
| e74c6cadd5 | |||
| c40e9c6392 | |||
| ddf83eb33b | |||
| f562099a43 | |||
| c49ef66cd3 | |||
| c142d16052 | |||
| 4e2d182c9a | 
							
								
								
									
										10
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								.github/dependabot.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,10 @@ | ||||
| version: 2 | ||||
| updates: | ||||
|   - package-ecosystem: "gomod" | ||||
|     directory: / | ||||
|     schedule: | ||||
|       interval: "daily" | ||||
|   - package-ecosystem: "github-actions" | ||||
|     directory: "/" | ||||
|     schedule: | ||||
|       interval: "daily" | ||||
							
								
								
									
										48
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										48
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
								
							| @ -8,55 +8,13 @@ jobs: | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         go: [ '1.15', '1.14' ] | ||||
|         go: [ '1.19', '1.18', '1.17', '1.16', '1.15' ] | ||||
|         os: [ ubuntu-latest, macOS-latest, windows-latest ] | ||||
|     name: ${{ matrix.os }} Go ${{ matrix.go }} Tests | ||||
|     steps: | ||||
|       - uses: actions/checkout@v2 | ||||
|       - uses: actions/checkout@v3 | ||||
|       - name: Setup go | ||||
|         uses: actions/setup-go@v2 | ||||
|         uses: actions/setup-go@v3 | ||||
|         with: | ||||
|           go-version: ${{ matrix.go }} | ||||
|       - run: go test | ||||
|  | ||||
|   test-non-amd64: | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         arch: | ||||
|           # For some reasons this is segfaulting on go env | ||||
|           # - name: IBM Z and LinuxONE | ||||
|           #   architecture: "s390x" | ||||
|           - name: POWER8 | ||||
|             architecture: "ppc64le" | ||||
|      | ||||
|     runs-on: ubuntu-latest | ||||
|     name: Test on ${{ matrix.arch.name }}  | ||||
|     steps: | ||||
|       - uses: actions/checkout@v2 | ||||
|       - uses: uraimo/run-on-arch-action@master | ||||
|         with: | ||||
|           arch: ${{ matrix.arch.architecture }} | ||||
|           distro: ubuntu20.04 | ||||
|           env: | # YAML pipe | ||||
|             GOARCH: ${{ matrix.arch.architecture }} | ||||
|             CGO_ENABLED: 0 | ||||
|           run: | | ||||
|             apt-get update | ||||
|             apt-get install -q -y curl wget git | ||||
|             latestGo=$(curl "https://golang.org/VERSION?m=text") | ||||
|             wget "https://dl.google.com/go/${latestGo}.linux-${GOARCH}.tar.gz" | ||||
|             rm -f $(which go) | ||||
|             rm -rf /usr/local/go | ||||
|             tar -C /usr/local -xzf "${latestGo}.linux-${GOARCH}.tar.gz" | ||||
|             export PATH=/usr/local/go/bin:$PATH | ||||
|             printf "Using go at: $(which go)\n" | ||||
|             printf "Go version: $(go version)\n" | ||||
|             printf "\n\nGo environment:\n\n" | ||||
|             go env | ||||
|             printf "\n\nSystem environment:\n\n" | ||||
|             env | ||||
|             go get -insecure -v -t -d ./... | ||||
|             go test ./... | ||||
|             cd ./cmd/godotenv | ||||
|             go build -trimpath -ldflags="-w -s" -v | ||||
							
								
								
									
										72
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										72
									
								
								.github/workflows/codeql-analysis.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,72 @@ | ||||
| # For most projects, this workflow file will not need changing; you simply need | ||||
| # to commit it to your repository. | ||||
| # | ||||
| # You may wish to alter this file to override the set of languages analyzed, | ||||
| # or to provide custom queries or build logic. | ||||
| # | ||||
| # ******** NOTE ******** | ||||
| # We have attempted to detect the languages in your repository. Please check | ||||
| # the `language` matrix defined below to confirm you have the correct set of | ||||
| # supported CodeQL languages. | ||||
| # | ||||
| name: "CodeQL" | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [ "main" ] | ||||
|   pull_request: | ||||
|     # The branches below must be a subset of the branches above | ||||
|     branches: [ "main" ] | ||||
|   schedule: | ||||
|     - cron: '31 4 * * 2' | ||||
|  | ||||
| jobs: | ||||
|   analyze: | ||||
|     name: Analyze | ||||
|     runs-on: ubuntu-latest | ||||
|     permissions: | ||||
|       actions: read | ||||
|       contents: read | ||||
|       security-events: write | ||||
|  | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         language: [ 'go' ] | ||||
|         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] | ||||
|         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support | ||||
|  | ||||
|     steps: | ||||
|     - name: Checkout repository | ||||
|       uses: actions/checkout@v3 | ||||
|  | ||||
|     # Initializes the CodeQL tools for scanning. | ||||
|     - name: Initialize CodeQL | ||||
|       uses: github/codeql-action/init@v2 | ||||
|       with: | ||||
|         languages: ${{ matrix.language }} | ||||
|         # If you wish to specify custom queries, you can do so here or in a config file. | ||||
|         # By default, queries listed here will override any specified in a config file. | ||||
|         # Prefix the list here with "+" to use these queries and those in the config file. | ||||
|          | ||||
|         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs | ||||
|         # queries: security-extended,security-and-quality | ||||
|  | ||||
|          | ||||
|     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java). | ||||
|     # If this step fails, then you should remove it and run the build manually (see below) | ||||
|     - name: Autobuild | ||||
|       uses: github/codeql-action/autobuild@v2 | ||||
|  | ||||
|     # ℹ️ Command-line programs to run using the OS shell. | ||||
|     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun | ||||
|  | ||||
|     #   If the Autobuild fails above, remove it and uncomment the following three lines.  | ||||
|     #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. | ||||
|  | ||||
|     # - run: | | ||||
|     #   echo "Run, Build Application using script" | ||||
|     #   ./location_of_script_within_repo/buildscript.sh | ||||
|  | ||||
|     - name: Perform CodeQL Analysis | ||||
|       uses: github/codeql-action/analyze@v2 | ||||
							
								
								
									
										31
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										31
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,31 @@ | ||||
| on: | ||||
|   push: | ||||
|     tags: | ||||
|     - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 | ||||
|  | ||||
| name: Upload Release Assets | ||||
|  | ||||
| jobs: | ||||
|   build: | ||||
|     name: Upload Release Assets | ||||
|     runs-on: ubuntu-latest | ||||
|     steps: | ||||
|       - name: Checkout code | ||||
|         uses: actions/checkout@v3 | ||||
|       - name: Generate build files | ||||
|         uses: thatisuday/go-cross-build@v1.0.2 | ||||
|         with: | ||||
|             platforms: 'linux/amd64, linux/ppc64le, darwin/amd64, darwin/arm64, windows/amd64' | ||||
|             package: 'cmd/godotenv' | ||||
|             name: 'godotenv' | ||||
|             compress: 'true' | ||||
|             dest: 'dist' | ||||
|       - name: Publish Binaries | ||||
|         uses: svenstaro/upload-release-action@v2 | ||||
|         with: | ||||
|           repo_token: ${{ secrets.GITHUB_TOKEN }} | ||||
|           release_name: Release ${{ github.ref }} | ||||
|           tag: ${{ github.ref }} | ||||
|           file: dist/* | ||||
|           file_glob: true | ||||
|           overwrite: true | ||||
							
								
								
									
										36
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										36
									
								
								README.md
									
									
									
									
									
								
							| @ -1,6 +1,6 @@ | ||||
| # GoDotEnv  [](https://goreportcard.com/report/github.com/joho/godotenv) | ||||
|  | ||||
| A Go (golang) port of the Ruby dotenv project (which loads env vars from a .env file) | ||||
| A Go (golang) port of the Ruby [dotenv](https://github.com/bkeepers/dotenv) project (which loads env vars from a .env file). | ||||
|  | ||||
| From the original Library: | ||||
|  | ||||
| @ -8,9 +8,9 @@ From the original Library: | ||||
| > | ||||
| > But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. Dotenv load variables from a .env file into ENV when the environment is bootstrapped. | ||||
|  | ||||
| It can be used as a library (for loading in env for your own daemons etc) or as a bin command. | ||||
| It can be used as a library (for loading in env for your own daemons etc.) or as a bin command. | ||||
|  | ||||
| There is test coverage and CI for both linuxish and windows environments, but I make no guarantees about the bin version working on windows. | ||||
| There is test coverage and CI for both linuxish and Windows environments, but I make no guarantees about the bin version working on Windows. | ||||
|  | ||||
| ## Installation | ||||
|  | ||||
| @ -21,6 +21,13 @@ go get github.com/joho/godotenv | ||||
| ``` | ||||
|  | ||||
| or if you want to use it as a bin command | ||||
|  | ||||
| go >= 1.17 | ||||
| ```shell | ||||
| go install github.com/joho/godotenv/cmd/godotenv@latest | ||||
| ``` | ||||
|  | ||||
| go < 1.17 | ||||
| ```shell | ||||
| go get github.com/joho/godotenv/cmd/godotenv | ||||
| ``` | ||||
| @ -40,9 +47,10 @@ Then in your Go app you can do something like | ||||
| package main | ||||
|  | ||||
| import ( | ||||
|     "github.com/joho/godotenv" | ||||
|     "log" | ||||
|     "os" | ||||
|  | ||||
|     "github.com/joho/godotenv" | ||||
| ) | ||||
|  | ||||
| func main() { | ||||
| @ -67,8 +75,8 @@ import _ "github.com/joho/godotenv/autoload" | ||||
| While `.env` in the project root is the default, you don't have to be constrained, both examples below are 100% legit | ||||
|  | ||||
| ```go | ||||
| _ = godotenv.Load("somerandomfile") | ||||
| _ = godotenv.Load("filenumberone.env", "filenumbertwo.env") | ||||
| godotenv.Load("somerandomfile") | ||||
| godotenv.Load("filenumberone.env", "filenumbertwo.env") | ||||
| ``` | ||||
|  | ||||
| If you want to be really fancy with your env file you can do comments and exports (below is a valid env file) | ||||
| @ -163,9 +171,17 @@ content, err := godotenv.Marshal(env) | ||||
|  | ||||
| ## Contributing | ||||
|  | ||||
| Contributions are most welcome! The parser itself is pretty stupidly naive and I wouldn't be surprised if it breaks with edge cases. | ||||
| Contributions are welcome, but with some caveats. | ||||
|  | ||||
| *code changes without tests will not be accepted* | ||||
| This library has been declared feature complete (see [#182](https://github.com/joho/godotenv/issues/182) for background) and will not be accepting issues or pull requests adding new functionality or breaking the library API. | ||||
|  | ||||
| Contributions would be gladly accepted that: | ||||
|  | ||||
| * bring this library's parsing into closer compatibility with the mainline dotenv implementations, in particular [Ruby's dotenv](https://github.com/bkeepers/dotenv) and [Node.js' dotenv](https://github.com/motdotla/dotenv) | ||||
| * keep the library up to date with the go ecosystem (ie CI bumps, documentation changes, changes in the core libraries) | ||||
| * bug fixes for use cases that pertain to the library's purpose of easing development of codebases deployed into twelve factor environments | ||||
|  | ||||
| *code changes without tests and references to peer dotenv implementations will not be accepted* | ||||
|  | ||||
| 1. Fork it | ||||
| 2. Create your feature branch (`git checkout -b my-new-feature`) | ||||
| @ -179,10 +195,6 @@ Releases should follow [Semver](http://semver.org/) though the first couple of r | ||||
|  | ||||
| Use [annotated tags for all releases](https://github.com/joho/godotenv/issues/30). Example `git tag -a v1.2.1` | ||||
|  | ||||
| ## CI | ||||
|  | ||||
| Linux: [](https://travis-ci.org/joho/godotenv) Windows: [](https://ci.appveyor.com/project/joho/godotenv) | ||||
|  | ||||
| ## Who? | ||||
|  | ||||
| The original library [dotenv](https://github.com/bkeepers/dotenv) was written by [Brandon Keepers](http://opensoul.org/), and this port was done by [John Barton](https://johnbarton.co/) based off the tests/fixtures in the original library. | ||||
|  | ||||
							
								
								
									
										4
									
								
								fixtures/comments.env
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										4
									
								
								fixtures/comments.env
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,4 @@ | ||||
| # Full line comment | ||||
| foo=bar # baz | ||||
| bar=foo#baz | ||||
| baz="foo"#bar | ||||
| @ -1,2 +1 @@ | ||||
| export OPTION_A='postgres://localhost:5432/database?sslmode=disable' | ||||
|  | ||||
|  | ||||
| @ -7,3 +7,13 @@ OPTION_F="2" | ||||
| OPTION_G="" | ||||
| OPTION_H="\n" | ||||
| OPTION_I = "echo 'asd'" | ||||
| OPTION_J='line 1 | ||||
| line 2' | ||||
| OPTION_K='line one | ||||
| this is \'quoted\' | ||||
| one more line' | ||||
| OPTION_L="line 1 | ||||
| line 2" | ||||
| OPTION_M="line one | ||||
| this is \"quoted\" | ||||
| one more line" | ||||
|  | ||||
							
								
								
									
										94
									
								
								godotenv.go
									
									
									
									
									
								
							
							
						
						
									
										94
									
								
								godotenv.go
									
									
									
									
									
								
							| @ -1,6 +1,6 @@ | ||||
| // Package godotenv 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 | ||||
| // 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 | ||||
| // | ||||
| @ -14,10 +14,10 @@ | ||||
| package godotenv | ||||
|  | ||||
| import ( | ||||
| 	"bufio" | ||||
| 	"errors" | ||||
| 	"fmt" | ||||
| 	"io" | ||||
| 	"io/ioutil" | ||||
| 	"os" | ||||
| 	"os/exec" | ||||
| 	"regexp" | ||||
| @ -28,17 +28,27 @@ import ( | ||||
|  | ||||
| const doubleQuoteSpecialChars = "\\\n\r\"!$`" | ||||
|  | ||||
| // Parse reads an env file from io.Reader, returning a map of keys and values. | ||||
| func Parse(r io.Reader) (map[string]string, error) { | ||||
| 	data, err := ioutil.ReadAll(r) | ||||
| 	if err != nil { | ||||
| 		return nil, err | ||||
| 	} | ||||
|  | ||||
| 	return UnmarshalBytes(data) | ||||
| } | ||||
|  | ||||
| // 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) | ||||
| // 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 | ||||
| // 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 | ||||
| // 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 | ||||
| // 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) (err error) { | ||||
| 	filenames = filenamesOrDefault(filenames) | ||||
|  | ||||
| @ -53,15 +63,15 @@ func Load(filenames ...string) (err error) { | ||||
|  | ||||
| // Overload 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) | ||||
| // Call this function as close as possible to the start of your program (ideally in main). | ||||
| // | ||||
| // If you call Overload without any args it will default to loading .env in the current path | ||||
| // If you call Overload 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 | ||||
| // You can otherwise tell it which files to load (there can be more than one) like: | ||||
| // | ||||
| //		godotenv.Overload("fileone", "filetwo") | ||||
| // | ||||
| // It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefilly set all vars. | ||||
| // It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefully set all vars. | ||||
| func Overload(filenames ...string) (err error) { | ||||
| 	filenames = filenamesOrDefault(filenames) | ||||
|  | ||||
| @ -96,48 +106,30 @@ func Read(filenames ...string) (envMap map[string]string, err error) { | ||||
| 	return | ||||
| } | ||||
|  | ||||
| // Parse reads an env file from io.Reader, returning a map of keys and values. | ||||
| func Parse(r io.Reader) (envMap map[string]string, err error) { | ||||
| 	envMap = make(map[string]string) | ||||
|  | ||||
| 	var lines []string | ||||
| 	scanner := bufio.NewScanner(r) | ||||
| 	for scanner.Scan() { | ||||
| 		lines = append(lines, scanner.Text()) | ||||
| 	} | ||||
|  | ||||
| 	if err = scanner.Err(); err != nil { | ||||
| 		return | ||||
| 	} | ||||
|  | ||||
| 	for _, fullLine := range lines { | ||||
| 		if !isIgnoredLine(fullLine) { | ||||
| 			var key, value string | ||||
| 			key, value, err = parseLine(fullLine, envMap) | ||||
|  | ||||
| 			if err != nil { | ||||
| 				return | ||||
| 			} | ||||
| 			envMap[key] = value | ||||
| 		} | ||||
| 	} | ||||
| 	return | ||||
| } | ||||
|  | ||||
| // Unmarshal reads an env file from a string, returning a map of keys and values. | ||||
| func Unmarshal(str string) (envMap map[string]string, err error) { | ||||
| 	return Parse(strings.NewReader(str)) | ||||
| 	return UnmarshalBytes([]byte(str)) | ||||
| } | ||||
|  | ||||
| // UnmarshalBytes parses env file from byte slice of chars, returning a map of keys and values. | ||||
| func UnmarshalBytes(src []byte) (map[string]string, error) { | ||||
| 	out := make(map[string]string) | ||||
| 	err := parseBytes(src, out) | ||||
|  | ||||
| 	return out, err | ||||
| } | ||||
|  | ||||
| // Exec loads env vars from the specified filenames (empty map falls back to default) | ||||
| // then executes the cmd specified. | ||||
| // | ||||
| // Simply hooks up os.Stdin/err/out to the command and calls Run() | ||||
| // Simply hooks up os.Stdin/err/out to the command and calls Run(). | ||||
| // | ||||
| // If you want more fine grained control over your command it's recommended | ||||
| // that you use `Load()` or `Read()` and the `os/exec` package yourself. | ||||
| func Exec(filenames []string, cmd string, cmdArgs []string) error { | ||||
| 	Load(filenames...) | ||||
| 	if err := Load(filenames...); err != nil { | ||||
| 		return err | ||||
| 	} | ||||
|  | ||||
| 	command := exec.Command(cmd, cmdArgs...) | ||||
| 	command.Stdin = os.Stdin | ||||
| @ -146,7 +138,7 @@ func Exec(filenames []string, cmd string, cmdArgs []string) error { | ||||
| 	return command.Run() | ||||
| } | ||||
|  | ||||
| // Write serializes the given environment and writes it to a file | ||||
| // Write serializes the given environment and writes it to a file. | ||||
| func Write(envMap map[string]string, filename string) error { | ||||
| 	content, err := Marshal(envMap) | ||||
| 	if err != nil { | ||||
| @ -157,12 +149,11 @@ func Write(envMap map[string]string, filename string) error { | ||||
| 		return err | ||||
| 	} | ||||
| 	defer file.Close() | ||||
| 	_, err = file.WriteString(content) | ||||
| 	_, err = file.WriteString(content + "\n") | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	file.Sync() | ||||
| 	return err | ||||
| 	return file.Sync() | ||||
| } | ||||
|  | ||||
| // Marshal outputs the given environment as a dotenv-formatted environment file. | ||||
| @ -202,7 +193,7 @@ func loadFile(filename string, overload bool) error { | ||||
|  | ||||
| 	for key, value := range envMap { | ||||
| 		if !currentEnv[key] || overload { | ||||
| 			os.Setenv(key, value) | ||||
| 			_ = os.Setenv(key, value) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| @ -259,15 +250,15 @@ func parseLine(line string, envMap map[string]string) (key string, value string, | ||||
| 	} | ||||
|  | ||||
| 	if len(splitString) != 2 { | ||||
| 		err = errors.New("Can't separate key from value") | ||||
| 		err = errors.New("can't separate key from value") | ||||
| 		return | ||||
| 	} | ||||
|  | ||||
| 	// Parse the key | ||||
| 	key = splitString[0] | ||||
| 	if strings.HasPrefix(key, "export") { | ||||
|  | ||||
| 	key = strings.TrimPrefix(key, "export") | ||||
| 	} | ||||
|  | ||||
| 	key = strings.TrimSpace(key) | ||||
|  | ||||
| 	key = exportRegex.ReplaceAllString(splitString[0], "$1") | ||||
| @ -343,11 +334,6 @@ func expandVariables(v string, m map[string]string) string { | ||||
| 	}) | ||||
| } | ||||
|  | ||||
| func isIgnoredLine(line string) bool { | ||||
| 	trimmedLine := strings.TrimSpace(line) | ||||
| 	return len(trimmedLine) == 0 || strings.HasPrefix(trimmedLine, "#") | ||||
| } | ||||
|  | ||||
| func doubleQuoteEscape(line string) string { | ||||
| 	for _, c := range doubleQuoteSpecialChars { | ||||
| 		toReplace := "\\" + string(c) | ||||
|  | ||||
							
								
								
									
										104
									
								
								godotenv_test.go
									
									
									
									
									
								
							
							
						
						
									
										104
									
								
								godotenv_test.go
									
									
									
									
									
								
							| @ -35,7 +35,7 @@ func loadEnvAndCompareValues(t *testing.T, loader func(files ...string) error, e | ||||
| 		envValue := os.Getenv(k) | ||||
| 		v := expectedValues[k] | ||||
| 		if envValue != v { | ||||
| 			t.Errorf("Mismatch for key '%v': expected '%v' got '%v'", k, v, envValue) | ||||
| 			t.Errorf("Mismatch for key '%v': expected '%#v' got '%#v'", k, v, envValue) | ||||
| 		} | ||||
| 	} | ||||
| } | ||||
| @ -131,7 +131,7 @@ func TestLoadDoesNotOverride(t *testing.T) { | ||||
| 	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, presets) | ||||
| } | ||||
|  | ||||
| func TestOveroadDoesOverride(t *testing.T) { | ||||
| func TestOverloadDoesOverride(t *testing.T) { | ||||
| 	envFileName := "fixtures/plain.env" | ||||
|  | ||||
| 	// ensure NO overload | ||||
| @ -189,6 +189,10 @@ func TestLoadQuotedEnv(t *testing.T) { | ||||
| 		"OPTION_G": "", | ||||
| 		"OPTION_H": "\n", | ||||
| 		"OPTION_I": "echo 'asd'", | ||||
| 		"OPTION_J": "line 1\nline 2", | ||||
| 		"OPTION_K": "line one\nthis is \\'quoted\\'\none more line", | ||||
| 		"OPTION_L": "line 1\nline 2", | ||||
| 		"OPTION_M": "line one\nthis is \"quoted\"\none more line", | ||||
| 	} | ||||
|  | ||||
| 	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets) | ||||
| @ -271,6 +275,34 @@ func TestExpanding(t *testing.T) { | ||||
|  | ||||
| } | ||||
|  | ||||
| func TestVariableStringValueSeparator(t *testing.T) { | ||||
| 	input := "TEST_URLS=\"stratum+tcp://stratum.antpool.com:3333\nstratum+tcp://stratum.antpool.com:443\"" | ||||
| 	want := map[string]string{ | ||||
| 		"TEST_URLS": "stratum+tcp://stratum.antpool.com:3333\nstratum+tcp://stratum.antpool.com:443", | ||||
| 	} | ||||
| 	got, err := Parse(strings.NewReader(input)) | ||||
| 	if err != nil { | ||||
| 		t.Error(err) | ||||
| 	} | ||||
|  | ||||
| 	if len(got) != len(want) { | ||||
| 		t.Fatalf( | ||||
| 			"unexpected value:\nwant:\n\t%#v\n\ngot:\n\t%#v", want, got) | ||||
| 	} | ||||
|  | ||||
| 	for k, wantVal := range want { | ||||
| 		gotVal, ok := got[k] | ||||
| 		if !ok { | ||||
| 			t.Fatalf("key %q doesn't present in result", k) | ||||
| 		} | ||||
| 		if wantVal != gotVal { | ||||
| 			t.Fatalf( | ||||
| 				"mismatch in %q value:\nwant:\n\t%s\n\ngot:\n\t%s", k, | ||||
| 				wantVal, gotVal) | ||||
| 		} | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func TestActualEnvVarsAreLeftAlone(t *testing.T) { | ||||
| 	os.Clearenv() | ||||
| 	os.Setenv("OPTION_A", "actualenv") | ||||
| @ -325,11 +357,11 @@ func TestParsing(t *testing.T) { | ||||
| 	// expect(env('FOO="bar\nbaz"')).to eql('FOO' => "bar\nbaz") | ||||
| 	parseAndCompare(t, `FOO="bar\nbaz"`, "FOO", "bar\nbaz") | ||||
|  | ||||
| 	// it 'parses varibales with "." in the name' do | ||||
| 	// it 'parses variables with "." in the name' do | ||||
| 	// expect(env('FOO.BAR=foobar')).to eql('FOO.BAR' => 'foobar') | ||||
| 	parseAndCompare(t, "FOO.BAR=foobar", "FOO.BAR", "foobar") | ||||
|  | ||||
| 	// it 'parses varibales with several "=" in the value' do | ||||
| 	// it 'parses variables with several "=" in the value' do | ||||
| 	// expect(env('FOO=foobar=')).to eql('FOO' => 'foobar=') | ||||
| 	parseAndCompare(t, "FOO=foobar=", "FOO", "foobar=") | ||||
|  | ||||
| @ -377,33 +409,38 @@ func TestParsing(t *testing.T) { | ||||
| } | ||||
|  | ||||
| func TestLinesToIgnore(t *testing.T) { | ||||
| 	// it 'ignores empty lines' do | ||||
| 	// expect(env("\n \t  \nfoo=bar\n \nfizz=buzz")).to eql('foo' => 'bar', 'fizz' => 'buzz') | ||||
| 	if !isIgnoredLine("\n") { | ||||
| 		t.Error("Line with nothing but line break wasn't ignored") | ||||
| 	cases := map[string]struct { | ||||
| 		input string | ||||
| 		want  string | ||||
| 	}{ | ||||
| 		"Line with nothing but line break": { | ||||
| 			input: "\n", | ||||
| 		}, | ||||
| 		"Line with nothing but windows-style line break": { | ||||
| 			input: "\r\n", | ||||
| 		}, | ||||
| 		"Line full of whitespace": { | ||||
| 			input: "\t\t ", | ||||
| 		}, | ||||
| 		"Comment": { | ||||
| 			input: "# Comment", | ||||
| 		}, | ||||
| 		"Indented comment": { | ||||
| 			input: "\t # comment", | ||||
| 		}, | ||||
| 		"non-ignored value": { | ||||
| 			input: `export OPTION_B='\n'`, | ||||
| 			want:  `export OPTION_B='\n'`, | ||||
| 		}, | ||||
| 	} | ||||
|  | ||||
| 	if !isIgnoredLine("\r\n") { | ||||
| 		t.Error("Line with nothing but windows-style line break wasn't ignored") | ||||
| 	for n, c := range cases { | ||||
| 		t.Run(n, func(t *testing.T) { | ||||
| 			got := string(getStatementStart([]byte(c.input))) | ||||
| 			if got != c.want { | ||||
| 				t.Errorf("Expected:\t %q\nGot:\t %q", c.want, got) | ||||
| 			} | ||||
|  | ||||
| 	if !isIgnoredLine("\t\t ") { | ||||
| 		t.Error("Line full of whitespace wasn't ignored") | ||||
| 	} | ||||
|  | ||||
| 	// it 'ignores comment lines' do | ||||
| 	// expect(env("\n\n\n # HERE GOES FOO \nfoo=bar")).to eql('foo' => 'bar') | ||||
| 	if !isIgnoredLine("# comment") { | ||||
| 		t.Error("Comment wasn't ignored") | ||||
| 	} | ||||
|  | ||||
| 	if !isIgnoredLine("\t#comment") { | ||||
| 		t.Error("Indented comment wasn't ignored") | ||||
| 	} | ||||
|  | ||||
| 	// make sure we're not getting false positives | ||||
| 	if isIgnoredLine(`export OPTION_B='\n'`) { | ||||
| 		t.Error("ignoring a perfectly valid line to parse") | ||||
| 		}) | ||||
| 	} | ||||
| } | ||||
|  | ||||
| @ -424,6 +461,17 @@ func TestErrorParsing(t *testing.T) { | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func TestComments(t *testing.T) { | ||||
| 	envFileName := "fixtures/comments.env" | ||||
| 	expectedValues := map[string]string{ | ||||
| 		"foo": "bar", | ||||
| 		"bar": "foo#baz", | ||||
| 		"baz": "foo", | ||||
| 	} | ||||
|  | ||||
| 	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets) | ||||
| } | ||||
|  | ||||
| func TestWrite(t *testing.T) { | ||||
| 	writeAndCompare := func(env string, expected string) { | ||||
| 		envMap, _ := Unmarshal(env) | ||||
|  | ||||
							
								
								
									
										207
									
								
								parser.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										207
									
								
								parser.go
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,207 @@ | ||||
| package godotenv | ||||
|  | ||||
| import ( | ||||
| 	"bytes" | ||||
| 	"errors" | ||||
| 	"fmt" | ||||
| 	"strings" | ||||
| 	"unicode" | ||||
| ) | ||||
|  | ||||
| const ( | ||||
| 	charComment       = '#' | ||||
| 	prefixSingleQuote = '\'' | ||||
| 	prefixDoubleQuote = '"' | ||||
|  | ||||
| 	exportPrefix = "export" | ||||
| ) | ||||
|  | ||||
| func parseBytes(src []byte, out map[string]string) error { | ||||
| 	src = bytes.Replace(src, []byte("\r\n"), []byte("\n"), -1) | ||||
| 	cutset := src | ||||
| 	for { | ||||
| 		cutset = getStatementStart(cutset) | ||||
| 		if cutset == nil { | ||||
| 			// reached end of file | ||||
| 			break | ||||
| 		} | ||||
|  | ||||
| 		key, left, err := locateKeyName(cutset) | ||||
| 		if err != nil { | ||||
| 			return err | ||||
| 		} | ||||
|  | ||||
| 		value, left, err := extractVarValue(left, out) | ||||
| 		if err != nil { | ||||
| 			return err | ||||
| 		} | ||||
|  | ||||
| 		out[key] = value | ||||
| 		cutset = left | ||||
| 	} | ||||
|  | ||||
| 	return nil | ||||
| } | ||||
|  | ||||
| // getStatementPosition returns position of statement begin. | ||||
| // | ||||
| // It skips any comment line or non-whitespace character. | ||||
| func getStatementStart(src []byte) []byte { | ||||
| 	pos := indexOfNonSpaceChar(src) | ||||
| 	if pos == -1 { | ||||
| 		return nil | ||||
| 	} | ||||
|  | ||||
| 	src = src[pos:] | ||||
| 	if src[0] != charComment { | ||||
| 		return src | ||||
| 	} | ||||
|  | ||||
| 	// skip comment section | ||||
| 	pos = bytes.IndexFunc(src, isCharFunc('\n')) | ||||
| 	if pos == -1 { | ||||
| 		return nil | ||||
| 	} | ||||
|  | ||||
| 	return getStatementStart(src[pos:]) | ||||
| } | ||||
|  | ||||
| // locateKeyName locates and parses key name and returns rest of slice | ||||
| func locateKeyName(src []byte) (key string, cutset []byte, err error) { | ||||
| 	// trim "export" and space at beginning | ||||
| 	src = bytes.TrimLeftFunc(bytes.TrimPrefix(src, []byte(exportPrefix)), isSpace) | ||||
|  | ||||
| 	// locate key name end and validate it in single loop | ||||
| 	offset := 0 | ||||
| loop: | ||||
| 	for i, char := range src { | ||||
| 		rchar := rune(char) | ||||
| 		if isSpace(rchar) { | ||||
| 			continue | ||||
| 		} | ||||
|  | ||||
| 		switch char { | ||||
| 		case '=', ':': | ||||
| 			// library also supports yaml-style value declaration | ||||
| 			key = string(src[0:i]) | ||||
| 			offset = i + 1 | ||||
| 			break loop | ||||
| 		case '_': | ||||
| 		default: | ||||
| 			// variable name should match [A-Za-z0-9_] | ||||
| 			if unicode.IsLetter(rchar) || unicode.IsNumber(rchar) { | ||||
| 				continue | ||||
| 			} | ||||
|  | ||||
| 			return "", nil, fmt.Errorf( | ||||
| 				`unexpected character %q in variable name near %q`, | ||||
| 				string(char), string(src)) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	if len(src) == 0 { | ||||
| 		return "", nil, errors.New("zero length string") | ||||
| 	} | ||||
|  | ||||
| 	// trim whitespace | ||||
| 	key = strings.TrimRightFunc(key, unicode.IsSpace) | ||||
| 	cutset = bytes.TrimLeftFunc(src[offset:], isSpace) | ||||
| 	return key, cutset, nil | ||||
| } | ||||
|  | ||||
| // extractVarValue extracts variable value and returns rest of slice | ||||
| func extractVarValue(src []byte, vars map[string]string) (value string, rest []byte, err error) { | ||||
| 	quote, hasPrefix := hasQuotePrefix(src) | ||||
| 	if !hasPrefix { | ||||
| 		// unquoted value - read until whitespace | ||||
| 		end := bytes.IndexFunc(src, unicode.IsSpace) | ||||
| 		if end == -1 { | ||||
| 			return expandVariables(string(src), vars), nil, nil | ||||
| 		} | ||||
|  | ||||
| 		return expandVariables(string(src[0:end]), vars), src[end:], nil | ||||
| 	} | ||||
|  | ||||
| 	// lookup quoted string terminator | ||||
| 	for i := 1; i < len(src); i++ { | ||||
| 		if char := src[i]; char != quote { | ||||
| 			continue | ||||
| 		} | ||||
|  | ||||
| 		// skip escaped quote symbol (\" or \', depends on quote) | ||||
| 		if prevChar := src[i-1]; prevChar == '\\' { | ||||
| 			continue | ||||
| 		} | ||||
|  | ||||
| 		// trim quotes | ||||
| 		trimFunc := isCharFunc(rune(quote)) | ||||
| 		value = string(bytes.TrimLeftFunc(bytes.TrimRightFunc(src[0:i], trimFunc), trimFunc)) | ||||
| 		if quote == prefixDoubleQuote { | ||||
| 			// unescape newlines for double quote (this is compat feature) | ||||
| 			// and expand environment variables | ||||
| 			value = expandVariables(expandEscapes(value), vars) | ||||
| 		} | ||||
|  | ||||
| 		return value, src[i+1:], nil | ||||
| 	} | ||||
|  | ||||
| 	// return formatted error if quoted string is not terminated | ||||
| 	valEndIndex := bytes.IndexFunc(src, isCharFunc('\n')) | ||||
| 	if valEndIndex == -1 { | ||||
| 		valEndIndex = len(src) | ||||
| 	} | ||||
|  | ||||
| 	return "", nil, fmt.Errorf("unterminated quoted value %s", src[:valEndIndex]) | ||||
| } | ||||
|  | ||||
| func expandEscapes(str string) string { | ||||
| 	out := escapeRegex.ReplaceAllStringFunc(str, func(match string) string { | ||||
| 		c := strings.TrimPrefix(match, `\`) | ||||
| 		switch c { | ||||
| 		case "n": | ||||
| 			return "\n" | ||||
| 		case "r": | ||||
| 			return "\r" | ||||
| 		default: | ||||
| 			return match | ||||
| 		} | ||||
| 	}) | ||||
| 	return unescapeCharsRegex.ReplaceAllString(out, "$1") | ||||
| } | ||||
|  | ||||
| func indexOfNonSpaceChar(src []byte) int { | ||||
| 	return bytes.IndexFunc(src, func(r rune) bool { | ||||
| 		return !unicode.IsSpace(r) | ||||
| 	}) | ||||
| } | ||||
|  | ||||
| // hasQuotePrefix reports whether charset starts with single or double quote and returns quote character | ||||
| func hasQuotePrefix(src []byte) (prefix byte, isQuored bool) { | ||||
| 	if len(src) == 0 { | ||||
| 		return 0, false | ||||
| 	} | ||||
|  | ||||
| 	switch prefix := src[0]; prefix { | ||||
| 	case prefixDoubleQuote, prefixSingleQuote: | ||||
| 		return prefix, true | ||||
| 	default: | ||||
| 		return 0, false | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func isCharFunc(char rune) func(rune) bool { | ||||
| 	return func(v rune) bool { | ||||
| 		return v == char | ||||
| 	} | ||||
| } | ||||
|  | ||||
| // isSpace reports whether the rune is a space character but not line break character | ||||
| // | ||||
| // this differs from unicode.IsSpace, which also applies line break as space | ||||
| func isSpace(r rune) bool { | ||||
| 	switch r { | ||||
| 	case '\t', '\v', '\f', '\r', ' ', 0x85, 0xA0: | ||||
| 		return true | ||||
| 	} | ||||
| 	return false | ||||
| } | ||||
		Reference in New Issue
	
	Block a user
	