forked from coop-cloud-mirrors/godotenv
		
	Compare commits
	
		
			64 Commits
		
	
	
		
			v1.2.0
			...
			fix-godoc-
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 758dea7629 | |||
| 85a2237126 | |||
| add39c6f94 | |||
| 1b6c7eb7cc | |||
| b898a8b0d1 | |||
| 60df7dd66c | |||
| aa20cd96bb | |||
| a904479007 | |||
| a582f0c9d3 | |||
| 26b87a7e2c | |||
| 76d246ae25 | |||
| 139777a9ff | |||
| e74c6cadd5 | |||
| c40e9c6392 | |||
| ddf83eb33b | |||
| f562099a43 | |||
| c49ef66cd3 | |||
| c142d16052 | |||
| 4e2d182c9a | |||
| 65218afbaa | |||
| aa035a1808 | |||
| 23296b91aa | |||
| e57c08db27 | |||
| 573e9186b2 | |||
| 5451d82b77 | |||
| 0da8ce72f0 | |||
| 3e4069b9b2 | |||
| a4d9cf1d6d | |||
| 7fbe752d59 | |||
| 46ee0dcae8 | |||
| bc7d5cd181 | |||
| 6e653f9adf | |||
| fccdfd265d | |||
| f4e7418908 | |||
| 63ea8bf09b | |||
| 29b5be9cdc | |||
| d6ee6871f2 | |||
| dbcf4b53b8 | |||
| b09de681dc | |||
| 992ab0ec47 | |||
| 5c0e6c6ab1 | |||
| 61baafa627 | |||
| 823f94bb9a | |||
| 263a1dda9d | |||
| 79711eebaf | |||
| 69ed1d913a | |||
| 2841430efc | |||
| 5917dd2291 | |||
| c0b86d615e | |||
| 3896766f7d | |||
| 23d116af35 | |||
| 2d8b3aab88 | |||
| 1709ab122c | |||
| 8ad714e304 | |||
| 6bb0851667 | |||
| 06e67b5ef3 | |||
| 2707e9ff66 | |||
| 50c29652a0 | |||
| 33977c2d8d | |||
| 9be76b3741 | |||
| 6d367c18ed | |||
| 05be8ccbf7 | |||
| 0f92a24bb0 | |||
| b7bbb3624e | 
							
								
								
									
										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" | ||||
							
								
								
									
										20
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										20
									
								
								.github/workflows/ci.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,20 @@ | ||||
| name: CI | ||||
|  | ||||
| on: [push] | ||||
|  | ||||
| jobs: | ||||
|   test: | ||||
|     runs-on: ${{ matrix.os }} | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         go: [ '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@v3 | ||||
|       - name: Setup go | ||||
|         uses: actions/setup-go@v3 | ||||
|         with: | ||||
|           go-version: ${{ matrix.go }} | ||||
|       - run: go test | ||||
							
								
								
									
										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 | ||||
| @ -1,8 +0,0 @@ | ||||
| language: go | ||||
|  | ||||
| go: | ||||
|   - 1.8 | ||||
|  | ||||
| os: | ||||
|   - linux | ||||
|   - osx | ||||
							
								
								
									
										61
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										61
									
								
								README.md
									
									
									
									
									
								
							| @ -1,6 +1,6 @@ | ||||
| # GoDotEnv [](https://travis-ci.org/joho/godotenv) [](https://ci.appveyor.com/project/joho/godotenv) [](https://goreportcard.com/report/github.com/joho/godotenv) | ||||
| # 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() { | ||||
| @ -110,6 +118,31 @@ content := getRemoteFileContent() | ||||
| myEnv, err := godotenv.Unmarshal(content) | ||||
| ``` | ||||
|  | ||||
| ### Precedence & Conventions | ||||
|  | ||||
| Existing envs take precedence of envs that are loaded later. | ||||
|  | ||||
| The [convention](https://github.com/bkeepers/dotenv#what-other-env-files-can-i-use) | ||||
| for managing multiple environments (i.e. development, test, production) | ||||
| is to create an env named `{YOURAPP}_ENV` and load envs in this order: | ||||
|  | ||||
| ```go | ||||
| env := os.Getenv("FOO_ENV") | ||||
| if "" == env { | ||||
|   env = "development" | ||||
| } | ||||
|  | ||||
| godotenv.Load(".env." + env + ".local") | ||||
| if "test" != env { | ||||
|   godotenv.Load(".env.local") | ||||
| } | ||||
| godotenv.Load(".env." + env) | ||||
| godotenv.Load() // The Original .env | ||||
| ``` | ||||
|  | ||||
| If you need to, you can also use `godotenv.Overload()` to defy this convention | ||||
| and overwrite existing envs instead of only supplanting them. Use with caution. | ||||
|  | ||||
| ### Command Mode | ||||
|  | ||||
| Assuming you've installed the command as above and you've got `$GOPATH/bin` in your `$PATH` | ||||
| @ -138,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`) | ||||
| @ -154,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](http://whoisjohnbarton.com) based off the tests/fixtures in the original library. | ||||
| 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. | ||||
|  | ||||
| @ -19,7 +19,7 @@ func main() { | ||||
| 	flag.Parse() | ||||
|  | ||||
| 	usage := ` | ||||
| Run a process with a env setup from a .env file | ||||
| Run a process with an env setup from a .env file | ||||
|  | ||||
| godotenv [-f ENV_FILE_PATHS] COMMAND_ARGS | ||||
|  | ||||
|  | ||||
| @ -6,3 +6,4 @@ OPTION_E="1" | ||||
| OPTION_F="2" | ||||
| OPTION_G="" | ||||
| OPTION_H="\n" | ||||
| OPTION_I = "echo 'asd'" | ||||
|  | ||||
							
								
								
									
										5
									
								
								fixtures/substitutions.env
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								fixtures/substitutions.env
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,5 @@ | ||||
| OPTION_A=1 | ||||
| OPTION_B=${OPTION_A} | ||||
| OPTION_C=$OPTION_B | ||||
| OPTION_D=${OPTION_A}${OPTION_B} | ||||
| OPTION_E=${OPTION_NOT_DEFINED} | ||||
							
								
								
									
										113
									
								
								godotenv.go
									
									
									
									
									
								
							
							
						
						
									
										113
									
								
								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 | ||||
| // | ||||
| @ -22,6 +22,7 @@ import ( | ||||
| 	"os/exec" | ||||
| 	"regexp" | ||||
| 	"sort" | ||||
| 	"strconv" | ||||
| 	"strings" | ||||
| ) | ||||
|  | ||||
| @ -29,15 +30,15 @@ const doubleQuoteSpecialChars = "\\\n\r\"!$`" | ||||
|  | ||||
| // 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) | ||||
|  | ||||
| @ -52,15 +53,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) | ||||
|  | ||||
| @ -112,7 +113,7 @@ func Parse(r io.Reader) (envMap map[string]string, err error) { | ||||
| 	for _, fullLine := range lines { | ||||
| 		if !isIgnoredLine(fullLine) { | ||||
| 			var key, value string | ||||
| 			key, value, err = parseLine(fullLine) | ||||
| 			key, value, err = parseLine(fullLine, envMap) | ||||
|  | ||||
| 			if err != nil { | ||||
| 				return | ||||
| @ -123,7 +124,7 @@ func Parse(r io.Reader) (envMap map[string]string, err error) { | ||||
| 	return | ||||
| } | ||||
|  | ||||
| //Unmarshal reads an env file from a string, returning a map of keys and values. | ||||
| // 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)) | ||||
| } | ||||
| @ -131,7 +132,7 @@ func Unmarshal(str string) (envMap map[string]string, err error) { | ||||
| // 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. | ||||
| @ -145,17 +146,22 @@ 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, error := Marshal(envMap) | ||||
| 	if error != nil { | ||||
| 		return error | ||||
| 	content, err := Marshal(envMap) | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	file, error := os.Create(filename) | ||||
| 	if error != nil { | ||||
| 		return error | ||||
| 	file, err := os.Create(filename) | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	_, err := file.WriteString(content) | ||||
| 	defer file.Close() | ||||
| 	_, err = file.WriteString(content + "\n") | ||||
| 	if err != nil { | ||||
| 		return err | ||||
| 	} | ||||
| 	file.Sync() | ||||
| 	return err | ||||
| } | ||||
|  | ||||
| @ -164,7 +170,11 @@ func Write(envMap map[string]string, filename string) error { | ||||
| func Marshal(envMap map[string]string) (string, error) { | ||||
| 	lines := make([]string, 0, len(envMap)) | ||||
| 	for k, v := range envMap { | ||||
| 		lines = append(lines, fmt.Sprintf(`%s="%s"`, k, doubleQuoteEscape(v))) | ||||
| 		if d, err := strconv.Atoi(v); err == nil { | ||||
| 			lines = append(lines, fmt.Sprintf(`%s=%d`, k, d)) | ||||
| 		} else { | ||||
| 			lines = append(lines, fmt.Sprintf(`%s="%s"`, k, doubleQuoteEscape(v))) | ||||
| 		} | ||||
| 	} | ||||
| 	sort.Strings(lines) | ||||
| 	return strings.Join(lines, "\n"), nil | ||||
| @ -209,7 +219,9 @@ func readFile(filename string) (envMap map[string]string, err error) { | ||||
| 	return Parse(file) | ||||
| } | ||||
|  | ||||
| func parseLine(line string) (key string, value string, err error) { | ||||
| var exportRegex = regexp.MustCompile(`^\s*(?:export\s+)?(.*?)\s*$`) | ||||
|  | ||||
| func parseLine(line string, envMap map[string]string) (key string, value string, err error) { | ||||
| 	if len(line) == 0 { | ||||
| 		err = errors.New("zero length string") | ||||
| 		return | ||||
| @ -256,27 +268,40 @@ func parseLine(line string) (key string, value string, err error) { | ||||
| 	if strings.HasPrefix(key, "export") { | ||||
| 		key = strings.TrimPrefix(key, "export") | ||||
| 	} | ||||
| 	key = strings.Trim(key, " ") | ||||
| 	key = strings.TrimSpace(key) | ||||
|  | ||||
| 	key = exportRegex.ReplaceAllString(splitString[0], "$1") | ||||
|  | ||||
| 	// Parse the value | ||||
| 	value = parseValue(splitString[1]) | ||||
| 	value = parseValue(splitString[1], envMap) | ||||
| 	return | ||||
| } | ||||
|  | ||||
| func parseValue(value string) string { | ||||
| var ( | ||||
| 	singleQuotesRegex  = regexp.MustCompile(`\A'(.*)'\z`) | ||||
| 	doubleQuotesRegex  = regexp.MustCompile(`\A"(.*)"\z`) | ||||
| 	escapeRegex        = regexp.MustCompile(`\\.`) | ||||
| 	unescapeCharsRegex = regexp.MustCompile(`\\([^$])`) | ||||
| ) | ||||
|  | ||||
| func parseValue(value string, envMap map[string]string) string { | ||||
|  | ||||
| 	// trim | ||||
| 	value = strings.Trim(value, " ") | ||||
|  | ||||
| 	// check if we've got quoted values or possible escapes | ||||
| 	if len(value) > 1 { | ||||
| 		first := string(value[0:1]) | ||||
| 		last := string(value[len(value)-1:]) | ||||
| 		if first == last && strings.ContainsAny(first, `"'`) { | ||||
| 		singleQuotes := singleQuotesRegex.FindStringSubmatch(value) | ||||
|  | ||||
| 		doubleQuotes := doubleQuotesRegex.FindStringSubmatch(value) | ||||
|  | ||||
| 		if singleQuotes != nil || doubleQuotes != nil { | ||||
| 			// pull the quotes off the edges | ||||
| 			value = value[1 : len(value)-1] | ||||
| 			// handle escapes | ||||
| 			escapeRegex := regexp.MustCompile(`\\.`) | ||||
| 		} | ||||
|  | ||||
| 		if doubleQuotes != nil { | ||||
| 			// expand newlines | ||||
| 			value = escapeRegex.ReplaceAllStringFunc(value, func(match string) string { | ||||
| 				c := strings.TrimPrefix(match, `\`) | ||||
| 				switch c { | ||||
| @ -285,17 +310,41 @@ func parseValue(value string) string { | ||||
| 				case "r": | ||||
| 					return "\r" | ||||
| 				default: | ||||
| 					return c | ||||
| 					return match | ||||
| 				} | ||||
| 			}) | ||||
| 			// unescape characters | ||||
| 			value = unescapeCharsRegex.ReplaceAllString(value, "$1") | ||||
| 		} | ||||
|  | ||||
| 		if singleQuotes == nil { | ||||
| 			value = expandVariables(value, envMap) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	return value | ||||
| } | ||||
|  | ||||
| var expandVarRegex = regexp.MustCompile(`(\\)?(\$)(\()?\{?([A-Z0-9_]+)?\}?`) | ||||
|  | ||||
| func expandVariables(v string, m map[string]string) string { | ||||
| 	return expandVarRegex.ReplaceAllStringFunc(v, func(s string) string { | ||||
| 		submatch := expandVarRegex.FindStringSubmatch(s) | ||||
|  | ||||
| 		if submatch == nil { | ||||
| 			return s | ||||
| 		} | ||||
| 		if submatch[1] == "\\" || submatch[2] == "(" { | ||||
| 			return submatch[0][1:] | ||||
| 		} else if submatch[4] != "" { | ||||
| 			return m[submatch[4]] | ||||
| 		} | ||||
| 		return s | ||||
| 	}) | ||||
| } | ||||
|  | ||||
| func isIgnoredLine(line string) bool { | ||||
| 	trimmedLine := strings.Trim(line, " \n\t") | ||||
| 	trimmedLine := strings.TrimSpace(line) | ||||
| 	return len(trimmedLine) == 0 || strings.HasPrefix(trimmedLine, "#") | ||||
| } | ||||
|  | ||||
|  | ||||
							
								
								
									
										115
									
								
								godotenv_test.go
									
									
									
									
									
								
							
							
						
						
									
										115
									
								
								godotenv_test.go
									
									
									
									
									
								
							| @ -5,13 +5,14 @@ import ( | ||||
| 	"fmt" | ||||
| 	"os" | ||||
| 	"reflect" | ||||
| 	"strings" | ||||
| 	"testing" | ||||
| ) | ||||
|  | ||||
| var noopPresets = make(map[string]string) | ||||
|  | ||||
| func parseAndCompare(t *testing.T, rawEnvLine string, expectedKey string, expectedValue string) { | ||||
| 	key, value, _ := parseLine(rawEnvLine) | ||||
| 	key, value, _ := parseLine(rawEnvLine, noopPresets) | ||||
| 	if key != expectedKey || value != expectedValue { | ||||
| 		t.Errorf("Expected '%v' to parse as '%v' => '%v', got '%v' => '%v' instead", rawEnvLine, expectedKey, expectedValue, key, value) | ||||
| 	} | ||||
| @ -130,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 | ||||
| @ -161,7 +162,7 @@ func TestLoadExportedEnv(t *testing.T) { | ||||
| 	envFileName := "fixtures/exported.env" | ||||
| 	expectedValues := map[string]string{ | ||||
| 		"OPTION_A": "2", | ||||
| 		"OPTION_B": "\n", | ||||
| 		"OPTION_B": "\\n", | ||||
| 	} | ||||
|  | ||||
| 	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets) | ||||
| @ -182,16 +183,94 @@ func TestLoadQuotedEnv(t *testing.T) { | ||||
| 		"OPTION_A": "1", | ||||
| 		"OPTION_B": "2", | ||||
| 		"OPTION_C": "", | ||||
| 		"OPTION_D": "\n", | ||||
| 		"OPTION_D": "\\n", | ||||
| 		"OPTION_E": "1", | ||||
| 		"OPTION_F": "2", | ||||
| 		"OPTION_G": "", | ||||
| 		"OPTION_H": "\n", | ||||
| 		"OPTION_I": "echo 'asd'", | ||||
| 	} | ||||
|  | ||||
| 	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets) | ||||
| } | ||||
|  | ||||
| func TestSubstitutions(t *testing.T) { | ||||
| 	envFileName := "fixtures/substitutions.env" | ||||
| 	expectedValues := map[string]string{ | ||||
| 		"OPTION_A": "1", | ||||
| 		"OPTION_B": "1", | ||||
| 		"OPTION_C": "1", | ||||
| 		"OPTION_D": "11", | ||||
| 		"OPTION_E": "", | ||||
| 	} | ||||
|  | ||||
| 	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets) | ||||
| } | ||||
|  | ||||
| func TestExpanding(t *testing.T) { | ||||
| 	tests := []struct { | ||||
| 		name     string | ||||
| 		input    string | ||||
| 		expected map[string]string | ||||
| 	}{ | ||||
| 		{ | ||||
| 			"expands variables found in values", | ||||
| 			"FOO=test\nBAR=$FOO", | ||||
| 			map[string]string{"FOO": "test", "BAR": "test"}, | ||||
| 		}, | ||||
| 		{ | ||||
| 			"parses variables wrapped in brackets", | ||||
| 			"FOO=test\nBAR=${FOO}bar", | ||||
| 			map[string]string{"FOO": "test", "BAR": "testbar"}, | ||||
| 		}, | ||||
| 		{ | ||||
| 			"expands undefined variables to an empty string", | ||||
| 			"BAR=$FOO", | ||||
| 			map[string]string{"BAR": ""}, | ||||
| 		}, | ||||
| 		{ | ||||
| 			"expands variables in double quoted strings", | ||||
| 			"FOO=test\nBAR=\"quote $FOO\"", | ||||
| 			map[string]string{"FOO": "test", "BAR": "quote test"}, | ||||
| 		}, | ||||
| 		{ | ||||
| 			"does not expand variables in single quoted strings", | ||||
| 			"BAR='quote $FOO'", | ||||
| 			map[string]string{"BAR": "quote $FOO"}, | ||||
| 		}, | ||||
| 		{ | ||||
| 			"does not expand escaped variables", | ||||
| 			`FOO="foo\$BAR"`, | ||||
| 			map[string]string{"FOO": "foo$BAR"}, | ||||
| 		}, | ||||
| 		{ | ||||
| 			"does not expand escaped variables", | ||||
| 			`FOO="foo\${BAR}"`, | ||||
| 			map[string]string{"FOO": "foo${BAR}"}, | ||||
| 		}, | ||||
| 		{ | ||||
| 			"does not expand escaped variables", | ||||
| 			"FOO=test\nBAR=\"foo\\${FOO} ${FOO}\"", | ||||
| 			map[string]string{"FOO": "test", "BAR": "foo${FOO} test"}, | ||||
| 		}, | ||||
| 	} | ||||
|  | ||||
| 	for _, tt := range tests { | ||||
| 		t.Run(tt.name, func(t *testing.T) { | ||||
| 			env, err := Parse(strings.NewReader(tt.input)) | ||||
| 			if err != nil { | ||||
| 				t.Errorf("Error: %s", err.Error()) | ||||
| 			} | ||||
| 			for k, v := range tt.expected { | ||||
| 				if strings.Compare(env[k], v) != 0 { | ||||
| 					t.Errorf("Expected: %s, Actual: %s", v, env[k]) | ||||
| 				} | ||||
| 			} | ||||
| 		}) | ||||
| 	} | ||||
|  | ||||
| } | ||||
|  | ||||
| func TestActualEnvVarsAreLeftAlone(t *testing.T) { | ||||
| 	os.Clearenv() | ||||
| 	os.Setenv("OPTION_A", "actualenv") | ||||
| @ -233,17 +312,24 @@ func TestParsing(t *testing.T) { | ||||
|  | ||||
| 	// parses export keyword | ||||
| 	parseAndCompare(t, "export OPTION_A=2", "OPTION_A", "2") | ||||
| 	parseAndCompare(t, `export OPTION_B='\n'`, "OPTION_B", "\n") | ||||
| 	parseAndCompare(t, `export OPTION_B='\n'`, "OPTION_B", "\\n") | ||||
| 	parseAndCompare(t, "export exportFoo=2", "exportFoo", "2") | ||||
| 	parseAndCompare(t, "exportFOO=2", "exportFOO", "2") | ||||
| 	parseAndCompare(t, "export_FOO =2", "export_FOO", "2") | ||||
| 	parseAndCompare(t, "export.FOO= 2", "export.FOO", "2") | ||||
| 	parseAndCompare(t, "export\tOPTION_A=2", "OPTION_A", "2") | ||||
| 	parseAndCompare(t, "  export OPTION_A=2", "OPTION_A", "2") | ||||
| 	parseAndCompare(t, "\texport OPTION_A=2", "OPTION_A", "2") | ||||
|  | ||||
| 	// it 'expands newlines in quoted strings' do | ||||
| 	// 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=") | ||||
|  | ||||
| @ -276,10 +362,15 @@ func TestParsing(t *testing.T) { | ||||
| 	parseAndCompare(t, `KEY="`, "KEY", "\"") | ||||
| 	parseAndCompare(t, `KEY="value`, "KEY", "\"value") | ||||
|  | ||||
| 	// leading whitespace should be ignored | ||||
| 	parseAndCompare(t, " KEY =value", "KEY", "value") | ||||
| 	parseAndCompare(t, "   KEY=value", "KEY", "value") | ||||
| 	parseAndCompare(t, "\tKEY=value", "KEY", "value") | ||||
|  | ||||
| 	// it 'throws an error if line format is incorrect' do | ||||
| 	// expect{env('lol$wut')}.to raise_error(Dotenv::FormatError) | ||||
| 	badlyFormattedLine := "lol$wut" | ||||
| 	_, _, err := parseLine(badlyFormattedLine) | ||||
| 	_, _, err := parseLine(badlyFormattedLine, noopPresets) | ||||
| 	if err == nil { | ||||
| 		t.Errorf("Expected \"%v\" to return error, but it didn't", badlyFormattedLine) | ||||
| 	} | ||||
| @ -292,6 +383,10 @@ func TestLinesToIgnore(t *testing.T) { | ||||
| 		t.Error("Line with nothing but line break wasn't ignored") | ||||
| 	} | ||||
|  | ||||
| 	if !isIgnoredLine("\r\n") { | ||||
| 		t.Error("Line with nothing but windows-style line break wasn't ignored") | ||||
| 	} | ||||
|  | ||||
| 	if !isIgnoredLine("\t\t ") { | ||||
| 		t.Error("Line full of whitespace wasn't ignored") | ||||
| 	} | ||||
| @ -347,9 +442,11 @@ func TestWrite(t *testing.T) { | ||||
| 	//but single quotes are left alone | ||||
| 	writeAndCompare(`key=va'lu'e`, `key="va'lu'e"`) | ||||
| 	// newlines, backslashes, and some other special chars are escaped | ||||
| 	writeAndCompare(`foo="$ba\n\r\\r!"`, `foo="\$ba\n\r\\r\!"`) | ||||
| 	writeAndCompare(`foo="\n\r\\r!"`, `foo="\n\r\\r\!"`) | ||||
| 	// lines should be sorted | ||||
| 	writeAndCompare("foo=bar\nbaz=buzz", "baz=\"buzz\"\nfoo=\"bar\"") | ||||
| 	// integers should not be quoted | ||||
| 	writeAndCompare(`key="10"`, `key=10`) | ||||
|  | ||||
| } | ||||
|  | ||||
|  | ||||
		Reference in New Issue
	
	Block a user
	