Merge pull request #115 from mnottale/single-file

Support single-file mode: experimental merge/split commands, init -s.

Author: mnottale

cmd/init.go

@@ -13,17 +13,19 @@ var initCmd = &cobra.Command{
 	Long:  `Start building a Docker application. Will automatically detect a docker-compose.yml file in the current directory.`,
 	Args:  cli.ExactArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
-		return packager.Init(args[0], initComposeFile, initDescription, initMaintainers)
+		return packager.Init(args[0], initComposeFile, initDescription, initMaintainers, initSingleFile)
 	},
 }
 
 var initComposeFile string
 var initDescription string
 var initMaintainers []string
+var initSingleFile bool
 
 func init() {
 	rootCmd.AddCommand(initCmd)
 	initCmd.Flags().StringVarP(&initComposeFile, "compose-file", "c", "", "Initial Compose file (optional)")
 	initCmd.Flags().StringVarP(&initDescription, "description", "d", "", "Initial description (optional)")
 	initCmd.Flags().StringArrayVarP(&initMaintainers, "maintainer", "m", []string{}, "Maintainer (name:email) (optional)")
+	initCmd.Flags().BoolVarP(&initSingleFile, "single-file", "s", false, "Create a single-file application")
 }

cmd/merge.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"github.com/docker/cli/cli"
+	"github.com/docker/lunchbox/internal"
+	"github.com/docker/lunchbox/packager"
+	"github.com/spf13/cobra"
+)
+
+var mergeCmd = &cobra.Command{
+	Use:   "merge [<app-name>] [-o output_dir]",
+	Short: "Merge the application as a single file multi-document YAML",
+	Args:  cli.RequiresMaxArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return packager.Merge(firstOrEmpty(args), mergeOutputFile)
+	},
+}
+
+var mergeOutputFile string
+
+func init() {
+	if internal.Experimental == "on" {
+		rootCmd.AddCommand(mergeCmd)
+		mergeCmd.Flags().StringVarP(&mergeOutputFile, "output", "o", "-", "Output file (default: stdout)")
+	}
+}

cmd/split.go

@@ -0,0 +1,26 @@
+package cmd
+
+import (
+	"github.com/docker/cli/cli"
+	"github.com/docker/lunchbox/internal"
+	"github.com/docker/lunchbox/packager"
+	"github.com/spf13/cobra"
+)
+
+var splitCmd = &cobra.Command{
+	Use:   "split [<app-name>] [-o output_dir]",
+	Short: "Split a single-file application into multiple files",
+	Args:  cli.RequiresMaxArgs(1),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return packager.Split(firstOrEmpty(args), splitOutputDir)
+	},
+}
+
+var splitOutputDir string
+
+func init() {
+	if internal.Experimental == "on" {
+		rootCmd.AddCommand(splitCmd)
+		splitCmd.Flags().StringVarP(&splitOutputDir, "output", "o", "-", "Output directory")
+	}
+}

e2e/binary_test.go

@@ -166,6 +166,28 @@ targets:
 	)
 
 	assert.Assert(t, fs.Equal(dirName, manifest))
+
+	// test single-file init
+	args = []string{
+		"init",
+		"tac",
+		"-c",
+		filepath.Join(inputDir, "docker-compose.yml"),
+		"-d",
+		"my cool app",
+		"-m", "bob",
+		"-m", "joe:[email protected]",
+		"-s",
+	}
+	cmd = exec.Command(dockerApp, args...)
+	output, err = cmd.CombinedOutput()
+	if err != nil {
+		fmt.Println(string(output))
+	}
+	assert.NilError(t, err)
+	defer os.Remove("tac.dockerapp")
+	appData, _ := ioutil.ReadFile("tac.dockerapp")
+	golden.Assert(t, string(appData), "init-singlefile.dockerapp")
 }
 
 func TestInspectBinary(t *testing.T) {
@@ -226,3 +248,41 @@ func TestHelmBinary(t *testing.T) {
 	golden.AssertBytes(t, values, "helm-expected.chart/values.yaml")
 	golden.AssertBytes(t, stack, "helm-expected.chart/templates/stack.yaml")
 }
+
+func TestSplitMergeBinary(t *testing.T) {
+	dockerApp, hasExperimental := getBinary(t)
+	if !hasExperimental {
+		t.Skip("experimental mode needed for this test")
+	}
+	app := "render/envvariables"
+	cmd := exec.Command(dockerApp, "merge", app, "-o", "remerged.dockerapp")
+	output, err := cmd.CombinedOutput()
+	if err != nil {
+		fmt.Println(string(output))
+	}
+	assert.NilError(t, err)
+	defer os.Remove("remerged.dockerapp")
+	// test that inspect works on single-file
+	cmd = exec.Command(dockerApp, "inspect", "remerged")
+	output, err = cmd.CombinedOutput()
+	if err != nil {
+		fmt.Println(string(output))
+	}
+	assert.NilError(t, err)
+	golden.Assert(t, string(output), "envvariables-inspect.golden")
+	// split it
+	cmd = exec.Command(dockerApp, "split", "remerged", "-o", "splitted.dockerapp")
+	output, err = cmd.CombinedOutput()
+	if err != nil {
+		fmt.Println(string(output))
+	}
+	assert.NilError(t, err)
+	defer os.RemoveAll("splitted.dockerapp")
+	cmd = exec.Command(dockerApp, "inspect", "splitted")
+	output, err = cmd.CombinedOutput()
+	if err != nil {
+		fmt.Println(string(output))
+	}
+	assert.NilError(t, err)
+	golden.Assert(t, string(output), "envvariables-inspect.golden")
+}

e2e/testdata/init-singlefile.dockerapp

@@ -0,0 +1,21 @@
+version: 0.1.0
+name: tac
+description: my cool app
+maintainers:
+- name: bob
+  email: ""
+- name: joe
+  email: [email protected]
+targets:
+  swarm: true
+  kubernetes: true
+
+--
+services:
+  nginx:
+    image: nginx:${NGINX_VERSION}
+    command: nginx $NGINX_ARGS
+
+--
+NGINX_ARGS: FILL ME
+NGINX_VERSION: latest

packager/extract.go

@@ -76,23 +76,59 @@ func Extract(appname string) (string, func(), error) {
 		// directory: already decompressed
 		return appname, noop, nil
 	}
-	// not a dir: probably a tarball package, extract that in a temp dir
+	// not a dir: single-file or a tarball package, extract that in a temp dir
 	tempDir, err := ioutil.TempDir("", "dockerapp")
 	if err != nil {
 		return "", noop, err
 	}
+	defer func() {
+		if err != nil {
+			os.RemoveAll(tempDir)
+		}
+	}()
 	appDir := filepath.Join(tempDir, filepath.Base(appname))
-	if err := os.Mkdir(appDir, 0755); err != nil {
-		os.RemoveAll(tempDir)
+	if err = os.Mkdir(appDir, 0755); err != nil {
 		return "", noop, err
 	}
-	if err = extract(appname, appDir); err != nil {
-		os.RemoveAll(tempDir)
+	if err = extract(appname, appDir); err == nil {
+		return appDir, func() { os.RemoveAll(tempDir) }, nil
+	}
+	if err = extractSingleFile(appname, appDir); err != nil {
 		return "", noop, err
 	}
+	// not a tarball, single-file then
 	return appDir, func() { os.RemoveAll(tempDir) }, nil
 }
 
+func extractSingleFile(appname, appDir string) error {
+	// not a tarball, single-file then
+	data, err := ioutil.ReadFile(appname)
+	if err != nil {
+		return err
+	}
+	parts := strings.Split(string(data), "\n--")
+	if len(parts) != 3 {
+		return fmt.Errorf("malformed single-file application: expected 3 documents")
+	}
+	names := []string{"metadata.yml", "docker-compose.yml", "settings.yml"}
+	for i, p := range parts {
+		data := ""
+		if i == 0 {
+			data = p
+		} else {
+			d := strings.SplitN(p, "\n", 2)
+			if len(d) > 1 {
+				data = d[1]
+			}
+		}
+		err = ioutil.WriteFile(filepath.Join(appDir, names[i]), []byte(data), 0644)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 func extract(appname, outputDir string) error {
 	f, err := os.Open(appname)
 	if err != nil {

packager/init.go

@@ -17,7 +17,7 @@ import (
 
 // Init is the entrypoint initialization function.
 // It generates a new application package based on the provided parameters.
-func Init(name string, composeFile string, description string, maintainers []string) error {
+func Init(name string, composeFile string, description string, maintainers []string, singleFile bool) error {
 	if err := utils.ValidateAppName(name); err != nil {
 		return err
 	}
@@ -45,7 +45,20 @@ func Init(name string, composeFile string, description string, maintainers []str
 	} else {
 		err = initFromComposeFile(name, composeFile)
 	}
-	return err
+	if err != nil {
+		return err
+	}
+	if !singleFile {
+		return nil
+	}
+	// Merge as a single file
+	temp := "_temp_dockerapp__.dockerapp"
+	err = os.Rename(dirName, temp)
+	if err != nil {
+		return err
+	}
+	defer os.RemoveAll(temp)
+	return Merge(temp, dirName)
 }
 
 func initFromScratch(name string) error {

packager/split.go

@@ -0,0 +1,64 @@
+package packager
+
+import (
+	"io"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+)
+
+// Split converts an app package to the split version
+func Split(appname string, outputDir string) error {
+	appname, cleanup, err := Extract(appname)
+	if err != nil {
+		return err
+	}
+	defer cleanup()
+	err = os.Mkdir(outputDir, 0755)
+	if err != nil {
+		return err
+	}
+	names := []string{"metadata.yml", "docker-compose.yml", "settings.yml"}
+	for _, n := range names {
+		input, err := ioutil.ReadFile(filepath.Join(appname, n))
+		if err != nil {
+			return err
+		}
+		err = ioutil.WriteFile(filepath.Join(outputDir, n), input, 0644)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// Merge converts an app-package to the single-file merged version
+func Merge(appname string, outputFile string) error {
+	appname, cleanup, err := Extract(appname)
+	if err != nil {
+		return err
+	}
+	defer cleanup()
+	var target io.Writer
+	if outputFile == "-" {
+		target = os.Stdout
+	} else {
+		target, err = os.Create(outputFile)
+		if err != nil {
+			return err
+		}
+		defer target.(io.WriteCloser).Close()
+	}
+	names := []string{"metadata.yml", "docker-compose.yml", "settings.yml"}
+	for i, n := range names {
+		input, err := ioutil.ReadFile(filepath.Join(appname, n))
+		if err != nil {
+			return err
+		}
+		target.Write(input)
+		if i != 2 {
+			io.WriteString(target, "\n--\n")
+		}
+	}
+	return nil
+}