Support env.local, et al. or support --envfile CLI option

[hparra]

dbmate does not support additional .env files, e.g. .env.local or .env.development.local due to joho/godotenv#10

Possible solutions of varying completeness:

• Have loadDotEnv also load .env.local
• Add --envfile option which specifies file for godotenv.Load()
• Use a fork of godotenv which implements Add support for .env.local joho/godotenv#10

[msdrigg]

I also would like this issue supported

[amacneil]

Happy to accept a PR for this, I think it would only be a few lines of code

[msdrigg]

I haven't written any go code, but if this is still sitting open in a week or two, I may give it a try.

Also, if anyone does write a pr, I would definitely prefer the solution of

Add --envfile option which specifies file for godotenv.Load()

[jahilliard]

I'd love this too.

[jahilliard]

Looks like something like godotenv.Load(".env.local") is supported.

[hamza512b]

I fixed it in this pr #491
Can @amacneil please look at it when you have time?

[dossy]

Thanks for submitting the PR, @hamza512b. I've reviewed it, with requested changes.

[dossy]

For everyone who is interested in this feature, please take a look at #491. Specifically, the behavior when the specified file does not exist, where we silently ignore and continue, and the behavior when multiple files are specified by repeating --env-file <filename>, where each file is applied in order and not stopping at the first found file.

The tests illustrate the expected behaviors:

dbmate/main_test.go

Lines 63 to 180 in 857ffed

	func TestLoadEnvFiles(t *testing.T) {
	setup := func(t *testing.T) {
	cwd, err := os.Getwd()
	if err != nil {
	t.Fatal(err)
	}
	env := os.Environ()
	os.Clearenv()
	err = os.Chdir("fixtures/loadEnvFiles")
	if err != nil {
	t.Fatal(err)
	}
	t.Cleanup(func() {
	err := os.Chdir(cwd)
	if err != nil {
	t.Fatal(err)
	}
	os.Clearenv()
	for _, e := range env {
	pair := strings.SplitN(e, "=", 2)
	os.Setenv(pair[0], pair[1])
	}
	})
	}
	t.Run("default file is .env", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{})
	require.NoError(t, err)
	require.Equal(t, 1, len(os.Environ()))
	require.Equal(t, "default", os.Getenv("TEST_DOTENV"))
	})
	t.Run("valid file", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{"--env-file", "first.txt"})
	require.NoError(t, err)
	require.Equal(t, 1, len(os.Environ()))
	require.Equal(t, "one", os.Getenv("FIRST"))
	})
	t.Run("two valid files", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{"--env-file", "first.txt", "--env-file", "second.txt"})
	require.NoError(t, err)
	require.Equal(t, 2, len(os.Environ()))
	require.Equal(t, "one", os.Getenv("FIRST"))
	require.Equal(t, "two", os.Getenv("SECOND"))
	})
	t.Run("nonexistent file", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{"--env-file", "nonexistent.txt"})
	require.NoError(t, err)
	require.Equal(t, 0, len(os.Environ()))
	})
	t.Run("no overload", func(t *testing.T) {
	setup(t)
	// we do not load values over existing values
	os.Setenv("FIRST", "not one")
	err := loadEnvFiles([]string{"--env-file", "first.txt"})
	require.NoError(t, err)
	require.Equal(t, 1, len(os.Environ()))
	require.Equal(t, "not one", os.Getenv("FIRST"))
	})
	t.Run("invalid file", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{"--env-file", "invalid.txt"})
	require.Error(t, err)
	require.Contains(t, err.Error(), "unexpected character \"\\n\" in variable name near \"INVALID ENV FILE\\n\"")
	require.Equal(t, 0, len(os.Environ()))
	})
	t.Run("invalid file followed by a valid file", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{"--env-file", "invalid.txt", "--env-file", "first.txt"})
	require.Error(t, err)
	require.Contains(t, err.Error(), "unexpected character \"\\n\" in variable name near \"INVALID ENV FILE\\n\"")
	require.Equal(t, 0, len(os.Environ()))
	})
	t.Run("valid file followed by an invalid file", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{"--env-file", "first.txt", "--env-file", "invalid.txt"})
	require.Error(t, err)
	require.Contains(t, err.Error(), "unexpected character \"\\n\" in variable name near \"INVALID ENV FILE\\n\"")
	require.Equal(t, 1, len(os.Environ()))
	require.Equal(t, "one", os.Getenv("FIRST"))
	})
	t.Run("valid file followed by an invalid file followed by a valid file", func(t *testing.T) {
	setup(t)
	err := loadEnvFiles([]string{"--env-file", "first.txt", "--env-file", "invalid.txt", "--env-file", "second.txt"})
	require.Error(t, err)
	require.Contains(t, err.Error(), "unexpected character \"\\n\" in variable name near \"INVALID ENV FILE\\n\"")
	// files after an invalid file should not get loaded
	require.Equal(t, 1, len(os.Environ()))
	require.Equal(t, "one", os.Getenv("FIRST"))
	})
	}

[dossy]

Update: #491 has been merged, and should land in a release after v2.8.0, probably v2.9.0.