mirror of
				https://github.com/joho/godotenv.git
				synced 2025-11-03 22:42:47 +00:00 
			
		
		
		
	Compare commits
	
		
			111 Commits
		
	
	
		
			v1
			...
			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 | |||
| 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 | |||
| a79fa1e548 | |||
| 144189c1ed | |||
| 3dd2dbe832 | |||
| 9f04f40640 | |||
| e6264cf869 | |||
| 9739509bea | |||
| b1bb9d9fc3 | |||
| 5d289f4405 | |||
| 88e7c8bd35 | |||
| c9360df4d1 | |||
| 59f20222da | |||
| 9d9ddadf44 | |||
| 390de3704e | |||
| ebf1036af6 | |||
| a905e99577 | |||
| 6f30f0c011 | |||
| 84bf91f40e | |||
| b9324c6f3c | |||
| 12b7e03247 | |||
| 3ddb2792f3 | |||
| 325433c502 | |||
| 034acc2190 | |||
| cd1272609d | |||
| eaf676fc03 | |||
| a42a65518c | |||
| b01826f956 | |||
| 6a1233b2f6 | |||
| d10b3fbe00 | |||
| 0a959c8d8f | |||
| bcaccd4f68 | |||
| 22e45bfff4 | |||
| 2fc79dff51 | |||
| 726cc8b906 | |||
| 861984c215 | |||
| 0ff0c0fc7a | |||
| 4ed13390c0 | |||
| 008304c688 | |||
| 443e926da0 | |||
| 2ed25fcb28 | |||
| f6581828bb | |||
| d29c003c20 | |||
| 19b5c2bf30 | |||
| e1c92610d7 | |||
| ead2e75027 | |||
| dc9cc93c4e | 
							
								
								
									
										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.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@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
 | 
			
		||||
							
								
								
									
										97
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										97
									
								
								README.md
									
									
									
									
									
								
							@ -1,6 +1,6 @@
 | 
			
		||||
# GoDotEnv [](https://app.wercker.com/project/bykey/507594c2ec7e60f19403a568dfea0f78)
 | 
			
		||||
# 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)
 | 
			
		||||
@ -96,6 +104,45 @@ myEnv, err := godotenv.Read()
 | 
			
		||||
s3Bucket := myEnv["S3_BUCKET"]
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
... or from an `io.Reader` instead of a local file
 | 
			
		||||
 | 
			
		||||
```go
 | 
			
		||||
reader := getRemoteFile()
 | 
			
		||||
myEnv, err := godotenv.Parse(reader)
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
... or from a `string` if you so desire
 | 
			
		||||
 | 
			
		||||
```go
 | 
			
		||||
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`
 | 
			
		||||
@ -106,11 +153,35 @@ godotenv -f /some/path/to/.env some_command with some args
 | 
			
		||||
 | 
			
		||||
If you don't specify `-f` it will fall back on the default of loading `.env` in `PWD`
 | 
			
		||||
 | 
			
		||||
### Writing Env Files
 | 
			
		||||
 | 
			
		||||
Godotenv can also write a map representing the environment to a correctly-formatted and escaped file
 | 
			
		||||
 | 
			
		||||
```go
 | 
			
		||||
env, err := godotenv.Unmarshal("KEY=value")
 | 
			
		||||
err := godotenv.Write(env, "./.env")
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
... or to a string
 | 
			
		||||
 | 
			
		||||
```go
 | 
			
		||||
env, err := godotenv.Unmarshal("KEY=value")
 | 
			
		||||
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`)
 | 
			
		||||
@ -118,10 +189,12 @@ Contributions are most welcome! The parser itself is pretty stupidly naive and I
 | 
			
		||||
4. Push to the branch (`git push origin my-new-feature`)
 | 
			
		||||
5. Create new Pull Request
 | 
			
		||||
 | 
			
		||||
## CI
 | 
			
		||||
## Releases
 | 
			
		||||
 | 
			
		||||
Linux: [](https://app.wercker.com/project/bykey/507594c2ec7e60f19403a568dfea0f78) Windows: [](https://ci.appveyor.com/project/joho/godotenv)
 | 
			
		||||
Releases should follow [Semver](http://semver.org/) though the first couple of releases are `v1` and `v1.1`.
 | 
			
		||||
 | 
			
		||||
Use [annotated tags for all releases](https://github.com/joho/godotenv/issues/30). Example `git tag -a v1.2.1`
 | 
			
		||||
 | 
			
		||||
## 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.
 | 
			
		||||
 | 
			
		||||
@ -11,5 +11,5 @@ package autoload
 | 
			
		||||
import "github.com/joho/godotenv"
 | 
			
		||||
 | 
			
		||||
func init() {
 | 
			
		||||
	_ = godotenv.Load()
 | 
			
		||||
	godotenv.Load()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@ -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
 | 
			
		||||
 | 
			
		||||
@ -45,7 +45,7 @@ example
 | 
			
		||||
 | 
			
		||||
	// take rest of args and "exec" them
 | 
			
		||||
	cmd := args[0]
 | 
			
		||||
	cmdArgs := args[1:len(args)]
 | 
			
		||||
	cmdArgs := args[1:]
 | 
			
		||||
 | 
			
		||||
	err := godotenv.Exec(envFilenames, cmd, cmdArgs)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										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'
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										2
									
								
								fixtures/invalid1.env
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								fixtures/invalid1.env
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,2 @@
 | 
			
		||||
INVALID LINE
 | 
			
		||||
foo=bar
 | 
			
		||||
@ -3,3 +3,5 @@ OPTION_B=2
 | 
			
		||||
OPTION_C= 3
 | 
			
		||||
OPTION_D =4
 | 
			
		||||
OPTION_E = 5
 | 
			
		||||
OPTION_F = 
 | 
			
		||||
OPTION_G=
 | 
			
		||||
@ -6,3 +6,14 @@ OPTION_E="1"
 | 
			
		||||
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"
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										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}
 | 
			
		||||
							
								
								
									
										318
									
								
								godotenv.go
									
									
									
									
									
								
							
							
						
						
									
										318
									
								
								godotenv.go
									
									
									
									
									
								
							@ -1,44 +1,59 @@
 | 
			
		||||
/*
 | 
			
		||||
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 avaiable through os.Getenv("SOME_ENV_VAR")
 | 
			
		||||
*/
 | 
			
		||||
// 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
 | 
			
		||||
//
 | 
			
		||||
// 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 godotenv
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"bufio"
 | 
			
		||||
	"errors"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"io"
 | 
			
		||||
	"io/ioutil"
 | 
			
		||||
	"os"
 | 
			
		||||
	"os/exec"
 | 
			
		||||
	"regexp"
 | 
			
		||||
	"sort"
 | 
			
		||||
	"strconv"
 | 
			
		||||
	"strings"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
	Call this function as close as possible to the start of your program (ideally in main)
 | 
			
		||||
const doubleQuoteSpecialChars = "\\\n\r\"!$`"
 | 
			
		||||
 | 
			
		||||
	If you call Load without any args it will default to loading .env in the current path
 | 
			
		||||
// 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
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	You can otherwise tell it which files to load (there can be more than one) like
 | 
			
		||||
	return UnmarshalBytes(data)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
		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
 | 
			
		||||
*/
 | 
			
		||||
// 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) (err error) {
 | 
			
		||||
	filenames = filenamesOrDefault(filenames)
 | 
			
		||||
 | 
			
		||||
	for _, filename := range filenames {
 | 
			
		||||
		err = loadFile(filename)
 | 
			
		||||
		err = loadFile(filename, false)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return // return early on a spazout
 | 
			
		||||
		}
 | 
			
		||||
@ -46,10 +61,31 @@ func Load(filenames ...string) (err error) {
 | 
			
		||||
	return
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
  Read all env (with same file loading semantics as Load) but return values as
 | 
			
		||||
  a map rather than automatically writing values into env
 | 
			
		||||
*/
 | 
			
		||||
// 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).
 | 
			
		||||
//
 | 
			
		||||
// 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:
 | 
			
		||||
//
 | 
			
		||||
//		godotenv.Overload("fileone", "filetwo")
 | 
			
		||||
//
 | 
			
		||||
// 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)
 | 
			
		||||
 | 
			
		||||
	for _, filename := range filenames {
 | 
			
		||||
		err = loadFile(filename, true)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			return // return early on a spazout
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	return
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// 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) (envMap map[string]string, err error) {
 | 
			
		||||
	filenames = filenamesOrDefault(filenames)
 | 
			
		||||
	envMap = make(map[string]string)
 | 
			
		||||
@ -70,17 +106,30 @@ func Read(filenames ...string) (envMap map[string]string, err error) {
 | 
			
		||||
	return
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
  Loads env vars from the specified filenames (empty map falls back to default)
 | 
			
		||||
  then executes the cmd specified.
 | 
			
		||||
// 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 UnmarshalBytes([]byte(str))
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
  Simply hooks up os.Stdin/err/out to the command and calls Run()
 | 
			
		||||
// 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)
 | 
			
		||||
 | 
			
		||||
  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.
 | 
			
		||||
*/
 | 
			
		||||
	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().
 | 
			
		||||
//
 | 
			
		||||
// 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
 | 
			
		||||
@ -89,25 +138,66 @@ func Exec(filenames []string, cmd string, cmdArgs []string) error {
 | 
			
		||||
	return command.Run()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// 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 {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	file, err := os.Create(filename)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	defer file.Close()
 | 
			
		||||
	_, err = file.WriteString(content + "\n")
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
	return file.Sync()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Marshal outputs the given environment as a dotenv-formatted environment file.
 | 
			
		||||
// Each line is in the format: KEY="VALUE" where VALUE is backslash-escaped.
 | 
			
		||||
func Marshal(envMap map[string]string) (string, error) {
 | 
			
		||||
	lines := make([]string, 0, len(envMap))
 | 
			
		||||
	for k, v := range envMap {
 | 
			
		||||
		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
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func filenamesOrDefault(filenames []string) []string {
 | 
			
		||||
	if len(filenames) == 0 {
 | 
			
		||||
		return []string{".env"}
 | 
			
		||||
	} else {
 | 
			
		||||
		return filenames
 | 
			
		||||
	}
 | 
			
		||||
	return filenames
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func loadFile(filename string) (err error) {
 | 
			
		||||
func loadFile(filename string, overload bool) error {
 | 
			
		||||
	envMap, err := readFile(filename)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return
 | 
			
		||||
		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 {
 | 
			
		||||
		os.Setenv(key, value)
 | 
			
		||||
		if !currentEnv[key] || overload {
 | 
			
		||||
			_ = os.Setenv(key, value)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return
 | 
			
		||||
	return nil
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func readFile(filename string) (envMap map[string]string, err error) {
 | 
			
		||||
@ -117,27 +207,12 @@ func readFile(filename string) (envMap map[string]string, err error) {
 | 
			
		||||
	}
 | 
			
		||||
	defer file.Close()
 | 
			
		||||
 | 
			
		||||
	envMap = make(map[string]string)
 | 
			
		||||
 | 
			
		||||
	var lines []string
 | 
			
		||||
	scanner := bufio.NewScanner(file)
 | 
			
		||||
	for scanner.Scan() {
 | 
			
		||||
		lines = append(lines, scanner.Text())
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	for _, fullLine := range lines {
 | 
			
		||||
		if !isIgnoredLine(fullLine) {
 | 
			
		||||
			key, value, err := parseLine(fullLine)
 | 
			
		||||
 | 
			
		||||
			if err == nil && os.Getenv(key) == "" {
 | 
			
		||||
				envMap[key] = value
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	return
 | 
			
		||||
	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
 | 
			
		||||
@ -147,7 +222,7 @@ func parseLine(line string) (key string, value string, err error) {
 | 
			
		||||
	if strings.Contains(line, "#") {
 | 
			
		||||
		segmentsBetweenHashes := strings.Split(line, "#")
 | 
			
		||||
		quotesAreOpen := false
 | 
			
		||||
		segmentsToKeep := make([]string, 0)
 | 
			
		||||
		var segmentsToKeep []string
 | 
			
		||||
		for _, segment := range segmentsBetweenHashes {
 | 
			
		||||
			if strings.Count(segment, "\"") == 1 || strings.Count(segment, "'") == 1 {
 | 
			
		||||
				if quotesAreOpen {
 | 
			
		||||
@ -166,46 +241,109 @@ func parseLine(line string) (key string, value string, err error) {
 | 
			
		||||
		line = strings.Join(segmentsToKeep, "#")
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// now split key from value
 | 
			
		||||
	firstEquals := strings.Index(line, "=")
 | 
			
		||||
	firstColon := strings.Index(line, ":")
 | 
			
		||||
	splitString := strings.SplitN(line, "=", 2)
 | 
			
		||||
 | 
			
		||||
	if len(splitString) != 2 {
 | 
			
		||||
		// try yaml mode!
 | 
			
		||||
	if firstColon != -1 && (firstColon < firstEquals || firstEquals == -1) {
 | 
			
		||||
		//this is a yaml-style line
 | 
			
		||||
		splitString = strings.SplitN(line, ":", 2)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	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.Trim(key, " ")
 | 
			
		||||
 | 
			
		||||
	key = strings.TrimPrefix(key, "export")
 | 
			
		||||
 | 
			
		||||
	key = strings.TrimSpace(key)
 | 
			
		||||
 | 
			
		||||
	key = exportRegex.ReplaceAllString(splitString[0], "$1")
 | 
			
		||||
 | 
			
		||||
	// Parse the value
 | 
			
		||||
	value = splitString[1]
 | 
			
		||||
	// trim
 | 
			
		||||
	value = strings.Trim(value, " ")
 | 
			
		||||
 | 
			
		||||
	// check if we've got quoted values
 | 
			
		||||
	if strings.Count(value, "\"") == 2 || strings.Count(value, "'") == 2 {
 | 
			
		||||
		// pull the quotes off the edges
 | 
			
		||||
		value = strings.Trim(value, "\"'")
 | 
			
		||||
 | 
			
		||||
		// expand quotes
 | 
			
		||||
		value = strings.Replace(value, "\\\"", "\"", -1)
 | 
			
		||||
		// expand newlines
 | 
			
		||||
		value = strings.Replace(value, "\\n", "\n", -1)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	value = parseValue(splitString[1], envMap)
 | 
			
		||||
	return
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func isIgnoredLine(line string) bool {
 | 
			
		||||
	trimmedLine := strings.Trim(line, " \n\t")
 | 
			
		||||
	return len(trimmedLine) == 0 || strings.HasPrefix(trimmedLine, "#")
 | 
			
		||||
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 {
 | 
			
		||||
		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]
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		if doubleQuotes != nil {
 | 
			
		||||
			// expand newlines
 | 
			
		||||
			value = escapeRegex.ReplaceAllStringFunc(value, func(match string) string {
 | 
			
		||||
				c := strings.TrimPrefix(match, `\`)
 | 
			
		||||
				switch c {
 | 
			
		||||
				case "n":
 | 
			
		||||
					return "\n"
 | 
			
		||||
				case "r":
 | 
			
		||||
					return "\r"
 | 
			
		||||
				default:
 | 
			
		||||
					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 doubleQuoteEscape(line string) string {
 | 
			
		||||
	for _, c := range doubleQuoteSpecialChars {
 | 
			
		||||
		toReplace := "\\" + string(c)
 | 
			
		||||
		if c == '\n' {
 | 
			
		||||
			toReplace = `\n`
 | 
			
		||||
		}
 | 
			
		||||
		if c == '\r' {
 | 
			
		||||
			toReplace = `\r`
 | 
			
		||||
		}
 | 
			
		||||
		line = strings.Replace(line, string(c), toReplace, -1)
 | 
			
		||||
	}
 | 
			
		||||
	return line
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										382
									
								
								godotenv_test.go
									
									
									
									
									
								
							
							
						
						
									
										382
									
								
								godotenv_test.go
									
									
									
									
									
								
							@ -1,22 +1,32 @@
 | 
			
		||||
package godotenv
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"bytes"
 | 
			
		||||
	"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)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func loadEnvAndCompareValues(t *testing.T, envFileName string, expectedValues map[string]string) {
 | 
			
		||||
func loadEnvAndCompareValues(t *testing.T, loader func(files ...string) error, envFileName string, expectedValues map[string]string, presets map[string]string) {
 | 
			
		||||
	// first up, clear the env
 | 
			
		||||
	os.Clearenv()
 | 
			
		||||
 | 
			
		||||
	err := Load(envFileName)
 | 
			
		||||
	for k, v := range presets {
 | 
			
		||||
		os.Setenv(k, v)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	err := loader(envFileName)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatalf("Error loading %v", envFileName)
 | 
			
		||||
	}
 | 
			
		||||
@ -25,7 +35,7 @@ func loadEnvAndCompareValues(t *testing.T, envFileName string, expectedValues ma
 | 
			
		||||
		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)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
@ -38,6 +48,14 @@ func TestLoadWithNoArgsLoadsDotEnv(t *testing.T) {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestOverloadWithNoArgsOverloadsDotEnv(t *testing.T) {
 | 
			
		||||
	err := Overload()
 | 
			
		||||
	pathError := err.(*os.PathError)
 | 
			
		||||
	if pathError == nil || pathError.Op != "open" || pathError.Path != ".env" {
 | 
			
		||||
		t.Errorf("Didn't try and open .env by default")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestLoadFileNotFound(t *testing.T) {
 | 
			
		||||
	err := Load("somefilethatwillneverexistever.env")
 | 
			
		||||
	if err == nil {
 | 
			
		||||
@ -45,6 +63,13 @@ func TestLoadFileNotFound(t *testing.T) {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestOverloadFileNotFound(t *testing.T) {
 | 
			
		||||
	err := Overload("somefilethatwillneverexistever.env")
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		t.Error("File wasn't found but Overload didn't return an error")
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestReadPlainEnv(t *testing.T) {
 | 
			
		||||
	envFileName := "fixtures/plain.env"
 | 
			
		||||
	expectedValues := map[string]string{
 | 
			
		||||
@ -53,6 +78,8 @@ func TestReadPlainEnv(t *testing.T) {
 | 
			
		||||
		"OPTION_C": "3",
 | 
			
		||||
		"OPTION_D": "4",
 | 
			
		||||
		"OPTION_E": "5",
 | 
			
		||||
		"OPTION_F": "",
 | 
			
		||||
		"OPTION_G": "",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	envMap, err := Read(envFileName)
 | 
			
		||||
@ -71,6 +98,53 @@ func TestReadPlainEnv(t *testing.T) {
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestParse(t *testing.T) {
 | 
			
		||||
	envMap, err := Parse(bytes.NewReader([]byte("ONE=1\nTWO='2'\nTHREE = \"3\"")))
 | 
			
		||||
	expectedValues := map[string]string{
 | 
			
		||||
		"ONE":   "1",
 | 
			
		||||
		"TWO":   "2",
 | 
			
		||||
		"THREE": "3",
 | 
			
		||||
	}
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		t.Fatalf("error parsing env: %v", err)
 | 
			
		||||
	}
 | 
			
		||||
	for key, value := range expectedValues {
 | 
			
		||||
		if envMap[key] != value {
 | 
			
		||||
			t.Errorf("expected %s to be %s, got %s", key, value, envMap[key])
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestLoadDoesNotOverride(t *testing.T) {
 | 
			
		||||
	envFileName := "fixtures/plain.env"
 | 
			
		||||
 | 
			
		||||
	// ensure NO overload
 | 
			
		||||
	presets := map[string]string{
 | 
			
		||||
		"OPTION_A": "do_not_override",
 | 
			
		||||
		"OPTION_B": "",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	expectedValues := map[string]string{
 | 
			
		||||
		"OPTION_A": "do_not_override",
 | 
			
		||||
		"OPTION_B": "",
 | 
			
		||||
	}
 | 
			
		||||
	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, presets)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestOverloadDoesOverride(t *testing.T) {
 | 
			
		||||
	envFileName := "fixtures/plain.env"
 | 
			
		||||
 | 
			
		||||
	// ensure NO overload
 | 
			
		||||
	presets := map[string]string{
 | 
			
		||||
		"OPTION_A": "do_not_override",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	expectedValues := map[string]string{
 | 
			
		||||
		"OPTION_A": "1",
 | 
			
		||||
	}
 | 
			
		||||
	loadEnvAndCompareValues(t, Overload, envFileName, expectedValues, presets)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestLoadPlainEnv(t *testing.T) {
 | 
			
		||||
	envFileName := "fixtures/plain.env"
 | 
			
		||||
	expectedValues := map[string]string{
 | 
			
		||||
@ -81,17 +155,17 @@ func TestLoadPlainEnv(t *testing.T) {
 | 
			
		||||
		"OPTION_E": "5",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	loadEnvAndCompareValues(t, envFileName, expectedValues)
 | 
			
		||||
	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestLoadExportedEnv(t *testing.T) {
 | 
			
		||||
	envFileName := "fixtures/exported.env"
 | 
			
		||||
	expectedValues := map[string]string{
 | 
			
		||||
		"OPTION_A": "2",
 | 
			
		||||
		"OPTION_B": "\n",
 | 
			
		||||
		"OPTION_B": "\\n",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	loadEnvAndCompareValues(t, envFileName, expectedValues)
 | 
			
		||||
	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestLoadEqualsEnv(t *testing.T) {
 | 
			
		||||
@ -100,7 +174,7 @@ func TestLoadEqualsEnv(t *testing.T) {
 | 
			
		||||
		"OPTION_A": "postgres://localhost:5432/database?sslmode=disable",
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	loadEnvAndCompareValues(t, envFileName, expectedValues)
 | 
			
		||||
	loadEnvAndCompareValues(t, Load, envFileName, expectedValues, noopPresets)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestLoadQuotedEnv(t *testing.T) {
 | 
			
		||||
@ -109,14 +183,124 @@ 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'",
 | 
			
		||||
		"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, envFileName, expectedValues)
 | 
			
		||||
	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 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) {
 | 
			
		||||
@ -138,30 +322,46 @@ func TestParsing(t *testing.T) {
 | 
			
		||||
	parseAndCompare(t, "FOO= bar", "FOO", "bar")
 | 
			
		||||
 | 
			
		||||
	// parses double quoted values
 | 
			
		||||
	parseAndCompare(t, "FOO=\"bar\"", "FOO", "bar")
 | 
			
		||||
	parseAndCompare(t, `FOO="bar"`, "FOO", "bar")
 | 
			
		||||
 | 
			
		||||
	// parses single quoted values
 | 
			
		||||
	parseAndCompare(t, "FOO='bar'", "FOO", "bar")
 | 
			
		||||
 | 
			
		||||
	// parses escaped double quotes
 | 
			
		||||
	parseAndCompare(t, "FOO=escaped\\\"bar\"", "FOO", "escaped\"bar")
 | 
			
		||||
	parseAndCompare(t, `FOO="escaped\"bar"`, "FOO", `escaped"bar`)
 | 
			
		||||
 | 
			
		||||
	// parses single quotes inside double quotes
 | 
			
		||||
	parseAndCompare(t, `FOO="'d'"`, "FOO", `'d'`)
 | 
			
		||||
 | 
			
		||||
	// parses yaml style options
 | 
			
		||||
	parseAndCompare(t, "OPTION_A: 1", "OPTION_A", "1")
 | 
			
		||||
 | 
			
		||||
	//parses yaml values with equal signs
 | 
			
		||||
	parseAndCompare(t, "OPTION_A: Foo=bar", "OPTION_A", "Foo=bar")
 | 
			
		||||
 | 
			
		||||
	// parses non-yaml options with colons
 | 
			
		||||
	parseAndCompare(t, "OPTION_A=1:B", "OPTION_A", "1:B")
 | 
			
		||||
 | 
			
		||||
	// 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")
 | 
			
		||||
	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=")
 | 
			
		||||
 | 
			
		||||
@ -175,48 +375,148 @@ func TestParsing(t *testing.T) {
 | 
			
		||||
 | 
			
		||||
	// it 'allows # in quoted value' do
 | 
			
		||||
	// expect(env('foo="bar#baz" # comment')).to eql('foo' => 'bar#baz')
 | 
			
		||||
	parseAndCompare(t, "FOO=\"bar#baz\" # comment", "FOO", "bar#baz")
 | 
			
		||||
	parseAndCompare(t, `FOO="bar#baz" # comment`, "FOO", "bar#baz")
 | 
			
		||||
	parseAndCompare(t, "FOO='bar#baz' # comment", "FOO", "bar#baz")
 | 
			
		||||
	parseAndCompare(t, "FOO=\"bar#baz#bang\" # comment", "FOO", "bar#baz#bang")
 | 
			
		||||
	parseAndCompare(t, `FOO="bar#baz#bang" # comment`, "FOO", "bar#baz#bang")
 | 
			
		||||
 | 
			
		||||
	// it 'parses # in quoted values' do
 | 
			
		||||
	// expect(env('foo="ba#r"')).to eql('foo' => 'ba#r')
 | 
			
		||||
	// expect(env("foo='ba#r'")).to eql('foo' => 'ba#r')
 | 
			
		||||
	parseAndCompare(t, "FOO=\"ba#r\"", "FOO", "ba#r")
 | 
			
		||||
	parseAndCompare(t, `FOO="ba#r"`, "FOO", "ba#r")
 | 
			
		||||
	parseAndCompare(t, "FOO='ba#r'", "FOO", "ba#r")
 | 
			
		||||
 | 
			
		||||
	//newlines and backslashes should be escaped
 | 
			
		||||
	parseAndCompare(t, `FOO="bar\n\ b\az"`, "FOO", "bar\n baz")
 | 
			
		||||
	parseAndCompare(t, `FOO="bar\\\n\ b\az"`, "FOO", "bar\\\n baz")
 | 
			
		||||
	parseAndCompare(t, `FOO="bar\\r\ b\az"`, "FOO", "bar\\r baz")
 | 
			
		||||
 | 
			
		||||
	parseAndCompare(t, `="value"`, "", "value")
 | 
			
		||||
	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)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
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("\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")
 | 
			
		||||
	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)
 | 
			
		||||
			}
 | 
			
		||||
		})
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestErrorReadDirectory(t *testing.T) {
 | 
			
		||||
	envFileName := "fixtures/"
 | 
			
		||||
	envMap, err := Read(envFileName)
 | 
			
		||||
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		t.Errorf("Expected error, got %v", envMap)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestErrorParsing(t *testing.T) {
 | 
			
		||||
	envFileName := "fixtures/invalid1.env"
 | 
			
		||||
	envMap, err := Read(envFileName)
 | 
			
		||||
	if err == nil {
 | 
			
		||||
		t.Errorf("Expected error, got %v", envMap)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
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)
 | 
			
		||||
		actual, _ := Marshal(envMap)
 | 
			
		||||
		if expected != actual {
 | 
			
		||||
			t.Errorf("Expected '%v' (%v) to write as '%v', got '%v' instead.", env, envMap, expected, actual)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	//just test some single lines to show the general idea
 | 
			
		||||
	//TestRoundtrip makes most of the good assertions
 | 
			
		||||
 | 
			
		||||
	//values are always double-quoted
 | 
			
		||||
	writeAndCompare(`key=value`, `key="value"`)
 | 
			
		||||
	//double-quotes are escaped
 | 
			
		||||
	writeAndCompare(`key=va"lu"e`, `key="va\"lu\"e"`)
 | 
			
		||||
	//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="\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`)
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestRoundtrip(t *testing.T) {
 | 
			
		||||
	fixtures := []string{"equals.env", "exported.env", "plain.env", "quoted.env"}
 | 
			
		||||
	for _, fixture := range fixtures {
 | 
			
		||||
		fixtureFilename := fmt.Sprintf("fixtures/%s", fixture)
 | 
			
		||||
		env, err := readFile(fixtureFilename)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			t.Errorf("Expected '%s' to read without error (%v)", fixtureFilename, err)
 | 
			
		||||
		}
 | 
			
		||||
		rep, err := Marshal(env)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			t.Errorf("Expected '%s' to Marshal (%v)", fixtureFilename, err)
 | 
			
		||||
		}
 | 
			
		||||
		roundtripped, err := Unmarshal(rep)
 | 
			
		||||
		if err != nil {
 | 
			
		||||
			t.Errorf("Expected '%s' to Mashal and Unmarshal (%v)", fixtureFilename, err)
 | 
			
		||||
		}
 | 
			
		||||
		if !reflect.DeepEqual(env, roundtripped) {
 | 
			
		||||
			t.Errorf("Expected '%s' to roundtrip as '%v', got '%v' instead", fixtureFilename, env, roundtripped)
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										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
 | 
			
		||||
}
 | 
			
		||||
@ -1 +0,0 @@
 | 
			
		||||
box: pjvds/golang
 | 
			
		||||
		Reference in New Issue
	
	Block a user