Merge pull request #343 from dustinrc/multi-composefile-envvar

Parse multifile COMPOSE_FILE envvar, w/ side effect

Author: vdemeester

cli/command/command.go

@@ -2,6 +2,7 @@ package command
 
 import (
 	"os"
+	"strings"
 
 	"github.com/docker/libcompose/cli/app"
 	"github.com/docker/libcompose/project"
@@ -10,7 +11,14 @@ import (
 
 // Populate updates the specified project context based on command line arguments and subcommands.
 func Populate(context *project.Context, c *cli.Context) {
-	context.ComposeFiles = c.GlobalStringSlice("file")
+	// urfave/cli does not distinguish whether the first string in the slice comes from the envvar
+	// or is from a flag. Worse off, it appends the flag values to the envvar value instead of
+	// overriding it. To ensure the multifile envvar case is always handled, the first string
+	// must always be split. It gives a more consistent behavior, then, to split each string in
+	// the slice.
+	for _, v := range c.GlobalStringSlice("file") {
+		context.ComposeFiles = append(context.ComposeFiles, strings.Split(v, string(os.PathListSeparator))...)
+	}
 
 	if len(context.ComposeFiles) == 0 {
 		context.ComposeFiles = []string{"docker-compose.yml"}

cli/docker/app/factory_test.go

@@ -3,6 +3,7 @@ package app
 import (
 	"flag"
 	"io/ioutil"
+	"os"
 	"path/filepath"
 	"testing"
 
@@ -55,3 +56,88 @@ func TestProjectFactoryProjectNameIsNormalized(t *testing.T) {
 		}
 	}
 }
+
+func TestProjectFactoryFileArgMayContainMultipleFiles(t *testing.T) {
+	sep := string(os.PathListSeparator)
+	fileCases := []struct {
+		requested []string
+		available []string
+		expected  []string
+	}{
+		{
+			requested: []string{},
+			available: []string{"docker-compose.yml"},
+			expected:  []string{"docker-compose.yml"},
+		},
+		{
+			requested: []string{},
+			available: []string{"docker-compose.yml", "docker-compose.override.yml"},
+			expected:  []string{"docker-compose.yml", "docker-compose.override.yml"},
+		},
+		{
+			requested: []string{"one.yml"},
+			available: []string{"one.yml"},
+			expected:  []string{"one.yml"},
+		},
+		{
+			requested: []string{"one.yml"},
+			available: []string{"docker-compose.yml", "one.yml"},
+			expected:  []string{"one.yml"},
+		},
+		{
+			requested: []string{"one.yml", "two.yml", "three.yml"},
+			available: []string{"one.yml", "two.yml", "three.yml"},
+			expected:  []string{"one.yml", "two.yml", "three.yml"},
+		},
+		{
+			requested: []string{"one.yml" + sep + "two.yml" + sep + "three.yml"},
+			available: []string{"one.yml", "two.yml", "three.yml"},
+			expected:  []string{"one.yml", "two.yml", "three.yml"},
+		},
+		{
+			requested: []string{"one.yml" + sep + "two.yml", "three.yml" + sep + "four.yml"},
+			available: []string{"one.yml", "two.yml", "three.yml", "four.yml"},
+			expected:  []string{"one.yml", "two.yml", "three.yml", "four.yml"},
+		},
+		{
+			requested: []string{"one.yml", "two.yml" + sep + "three.yml"},
+			available: []string{"one.yml", "two.yml", "three.yml"},
+			expected:  []string{"one.yml", "two.yml", "three.yml"},
+		},
+	}
+
+	for _, fileCase := range fileCases {
+		tmpDir, err := ioutil.TempDir("", "project-factory-test")
+		if err != nil {
+			t.Fatal(err)
+		}
+		defer os.RemoveAll(tmpDir)
+		if err = os.Chdir(tmpDir); err != nil {
+			t.Fatal(err)
+		}
+
+		for _, file := range fileCase.available {
+			ioutil.WriteFile(file, []byte(`hello:
+    image: busybox`), 0700)
+		}
+		globalSet := flag.NewFlagSet("test", 0)
+		// Set the project-name flag
+		globalSet.String("project-name", "example", "doc")
+		// Set the compose file flag
+		fcr := cli.StringSlice(fileCase.requested)
+		globalSet.Var(&fcr, "file", "doc")
+		c := cli.NewContext(nil, globalSet, nil)
+		factory := &ProjectFactory{}
+		p, err := factory.Create(c)
+		if err != nil {
+			t.Fatal(err)
+		}
+
+		for i, v := range p.(*project.Project).Files {
+			if v != fileCase.expected[i] {
+				t.Fatalf("requested %s, available %s, expected %s, got %s",
+					fileCase.requested, fileCase.available, fileCase.expected, p.(*project.Project).Files)
+			}
+		}
+	}
+}