Skip to content
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
13 changes: 9 additions & 4 deletions cmd/compose/compose.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
"syscall"

"github.com/compose-spec/compose-go/v2/cli"
"github.com/compose-spec/compose-go/v2/consts"
"github.com/compose-spec/compose-go/v2/dotenv"
"github.com/compose-spec/compose-go/v2/loader"
composepaths "github.com/compose-spec/compose-go/v2/paths"
Expand Down Expand Up @@ -281,7 +282,8 @@ func defaultStringArrayVar(env string) []string {
func (o *ProjectOptions) projectOrName(ctx context.Context, dockerCli command.Cli, services ...string) (*types.Project, string, error) {
name := o.ProjectName
var project *types.Project
if len(o.ConfigPaths) > 0 || o.ProjectName == "" {
// COMPOSE_FILE is the environment equivalent of -f
if len(o.ConfigPaths) > 0 || os.Getenv(consts.ComposeFilePath) != "" || o.ProjectName == "" {
backend, err := compose.NewComposeService(dockerCli)
if err != nil {
return nil, "", err
Expand All @@ -299,9 +301,12 @@ func (o *ProjectOptions) projectOrName(ctx context.Context, dockerCli command.Cl
if jobErr, replaced := jobTargetErr(ctx, dockerCli, o, services, err); replaced {
return nil, "", jobErr
}
envProjectName := os.Getenv(ComposeProjectName)
if envProjectName != "" {
return nil, envProjectName, nil
if envProjectName := os.Getenv(ComposeProjectName); envProjectName != "" {
// -p takes precedence over COMPOSE_PROJECT_NAME
if name == "" {
name = envProjectName
}
return nil, name, nil
}
Comment thread
glours marked this conversation as resolved.
Resolved
return nil, "", err
}
Expand Down
58 changes: 58 additions & 0 deletions cmd/compose/compose_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package compose

import (
"path/filepath"
"testing"

"github.com/compose-spec/compose-go/v2/types"
Expand Down Expand Up @@ -77,3 +78,60 @@ func TestProjectOrNameRefusesJob(t *testing.T) {
assert.ErrorContains(t, err, "no such service: typo")
})
}

// COMPOSE_FILE is the environment equivalent of -f: with -p, the model must be
// loaded from it too, otherwise the project is rebuilt from container labels
// and anything not stored in them (e.g. pre_stop hooks) is silently skipped.
func TestProjectOrNameLoadsComposeFileFromEnv(t *testing.T) {
dir := t.TempDir()
mustWrite(t, dir, "compose.yaml", "services:\n web:\n image: nginx\n pre_stop:\n - command: echo bye\n")
path := filepath.Join(dir, "compose.yaml")
opts := &ProjectOptions{ProjectName: "other"}

t.Run("-p with COMPOSE_FILE loads the project", func(t *testing.T) {
t.Setenv("COMPOSE_FILE", path)
project, name, err := opts.projectOrName(t.Context(), nil)
assert.NilError(t, err)
assert.Assert(t, project != nil)
assert.Equal(t, name, "other")
assert.Equal(t, len(project.Services["web"].PreStop), 1)
})

t.Run("-p without COMPOSE_FILE stays label-driven", func(t *testing.T) {
unsetEnv(t, "COMPOSE_FILE")
project, name, err := opts.projectOrName(t.Context(), nil)
assert.NilError(t, err)
assert.Assert(t, project == nil)
assert.Equal(t, name, "other")
})
}

// When the model can't be loaded, the label-driven fallback must honor the
// usual precedence: -p over COMPOSE_PROJECT_NAME.
func TestProjectOrNameFallbackNamePrecedence(t *testing.T) {
stale := filepath.Join(t.TempDir(), "missing.yaml")
t.Setenv("COMPOSE_PROJECT_NAME", "from-env")

t.Run("-p wins over COMPOSE_PROJECT_NAME", func(t *testing.T) {
opts := &ProjectOptions{ProjectName: "from-flag", ConfigPaths: []string{stale}}
project, name, err := opts.projectOrName(t.Context(), nil)
assert.NilError(t, err)
assert.Assert(t, project == nil)
assert.Equal(t, name, "from-flag")
})

t.Run("a load error is still reported when COMPOSE_PROJECT_NAME is not set", func(t *testing.T) {
unsetEnv(t, "COMPOSE_PROJECT_NAME")
opts := &ProjectOptions{ProjectName: "from-flag", ConfigPaths: []string{stale}}
_, _, err := opts.projectOrName(t.Context(), nil)
assert.ErrorContains(t, err, "missing.yaml")
})

t.Run("COMPOSE_PROJECT_NAME is used without -p", func(t *testing.T) {
opts := &ProjectOptions{ConfigPaths: []string{stale}}
project, name, err := opts.projectOrName(t.Context(), nil)
assert.NilError(t, err)
assert.Assert(t, project == nil)
assert.Equal(t, name, "from-env")
})
}
Loading