Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix nested include with env files #720

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 26 additions & 18 deletions loader/include.go
Original file line number Diff line number Diff line change
Expand Up @@ -109,28 +109,36 @@ func ApplyInclude(ctx context.Context, workingDir string, environment types.Mapp
WorkingDir: r.ProjectDirectory,
})

envFile := r.EnvFile
if len(r.EnvFile) == 0 {
f := filepath.Join(r.ProjectDirectory, ".env")
if s, err := os.Stat(f); err == nil && !s.IsDir() {
r.EnvFile = types.StringList{f}
}
} else {
envFile := []string{}
for _, f := range r.EnvFile {
if !filepath.IsAbs(f) {
f = filepath.Join(workingDir, f)
s, err := os.Stat(f)
if err != nil {
return err
}
if s.IsDir() {
return fmt.Errorf("%s is not a file", f)
}
envFile = types.StringList{".env"}
}

resolvedEnvFile := []string{}
for _, f := range envFile {
for _, loader := range options.ResourceLoaders {
if !loader.Accept(f) {
continue
}
path, err := loader.Load(ctx, f)
if err != nil {
return err
}
s, err := os.Stat(path)
if os.IsNotExist(err) && len(r.EnvFile) == 0 {
break // Skip if default .env not found
}
if err != nil {
return err
}
if s.IsDir() {
return fmt.Errorf("%s is not a file", f)
}
envFile = append(envFile, f)
resolvedEnvFile = append(resolvedEnvFile, path)
break
}
r.EnvFile = envFile
}
r.EnvFile = resolvedEnvFile

envFromFile, err := dotenv.GetEnvFromFile(environment, r.EnvFile)
if err != nil {
Expand Down
79 changes: 79 additions & 0 deletions loader/include_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,85 @@ services:

}

func TestLoadWithIncludeEnvTripleTimes(t *testing.T) {
fileName := "compose.yml"
tmpdir := t.TempDir()
// file in root
yaml := `
include:
- path:
- ./module/compose.yml
env_file:
- ./custom.env
services:
a:
image: alpine
environment:
- VAR_NAME`
createFile(t, tmpdir, `VAR_NAME=value`, "custom.env")
path := createFile(t, tmpdir, yaml, fileName)
// file in /module
yaml = `
include:
- path:
- ./submodule/compose.yml
env_file:
- ../custom.env
services:
b:
image: alpine
environment:
- VAR_NAME`
createFileSubDir(t, tmpdir, "module", yaml, fileName)

yaml = `
include:
- path:
- ./subsubmodule/compose.yml
env_file:
- ../../custom.env
services:
c:
image: alpine
environment:
- VAR_NAME`
createFileSubDir(t, tmpdir, "module/submodule", yaml, fileName)

yaml = `
services:
d:
image: alpine
environment:
- VAR_NAME`
createFileSubDir(t, tmpdir, "module/submodule/subsubmodule", yaml, fileName)

p, err := Load(types.ConfigDetails{
WorkingDir: tmpdir,
ConfigFiles: []types.ConfigFile{{
Filename: path,
}},
Environment: nil,
}, func(options *Options) {
options.SkipNormalization = true
options.ResolvePaths = true
options.SetProjectName("project", true)
})
assert.NilError(t, err)
a := p.Services["a"]
// make sure VAR_NAME is only accessible in include context
assert.Check(t, a.Environment["VAR_NAME"] == nil, "VAR_NAME should not be defined in environment")
b := p.Services["b"]
assert.Check(t, b.Environment["VAR_NAME"] != nil, "VAR_NAME is not defined in environment")
assert.Equal(t, *b.Environment["VAR_NAME"], "value")
c := p.Services["c"]
assert.Check(t, c.Environment["VAR_NAME"] != nil, "VAR_NAME is not defined in environment")
assert.Equal(t, *c.Environment["VAR_NAME"], "value")
d := p.Services["d"]
assert.Check(t, d.Environment["VAR_NAME"] != nil, "VAR_NAME is not defined in environment")
assert.Equal(t, *d.Environment["VAR_NAME"], "value")

}

func TestIncludeWithProjectDirectory(t *testing.T) {
var envs map[string]string
if runtime.GOOS == "windows" {
Expand Down
Loading