Merge pull request #608 from ndeloof/nosingle

Remove support for "single file" app definition

Author: Ulysses Souza

README.md

@@ -40,13 +40,13 @@ With `docker app` [installed](#installation) let's create an Application Package
 based on this Compose file:
 
 ```console
-$ docker app init --single-file hello
+$ docker app init hello
 $ ls
 docker-compose.yml
 hello.dockerapp
 ```
 
-We created a new file `hello.dockerapp` that contains three YAML documents:
+We created a new folder `hello.dockerapp` that contains three YAML documents:
 - metadata
 - the Compose file
 - parameters for your application
@@ -60,22 +60,19 @@ description: A simple text server
 maintainers:
 - name: yourusername
   email:
+```
 
----
+```yaml
 version: '3.2'
 services:
   hello:
     image: hashicorp/http-echo
     command: ["-text", "hello world"]
     ports:
       - 5678:5678
-
----
-{}
 ```
 
-Let's edit the parameters section and add the following default values for our
-application:
+And an empty `parameters.yml. Let's edit and add the following default values for our applicatoin
 
 ```yaml
 port: 5678
@@ -287,19 +284,6 @@ New-Item -ItemType Directory -Path ~/.docker/cli-plugins -ErrorAction SilentlyCo
 cp docker-app-plugin-windows.exe ~/.docker/cli-plugins/docker-app.exe
 ```
 
-## Single file or directory representation
-
-If you prefer having the three core documents in separate YAML files, omit the
-`--single-file` option to the `docker app init` command. This will create a
-directory instead of a single file, containing `metadata.yml`,
-`docker-compose.yml` and `parameters.yml`.
-
-Converting between the two formats can be achieved by using the
-`docker app split` and `docker app merge` commands.
-
-**Note**: You cannot store attachments in the single file format. If you want to
-use attachments you should use the directory format.
-
 ## Attachments (Storing additional files)
 
 If you want to store additional files in the application package, such as
@@ -374,11 +358,9 @@ Commands:
   inspect     Shows metadata, parameters and a summary of the Compose file for a given application
   install     Install an application
   list        List the installations and their last known installation result
-  merge       Merge a directory format Docker Application definition into a single file
   pull        Pull an application package from a registry
   push        Push an application package to a registry
   render      Render the Compose file for an Application Package
-  split       Split a single-file Docker Application definition into the directory format
   status      Get the installation status of an application
   uninstall   Uninstall an application
   upgrade     Upgrade an installed application

e2e/commands_test.go

@@ -1,11 +1,9 @@
 package e2e
 
 import (
-	"bytes"
 	"encoding/json"
 	"fmt"
 	"io/ioutil"
-	"path"
 	"path/filepath"
 	"regexp"
 	"strings"
@@ -130,27 +128,6 @@ maintainers:
 	cmd.Command = dockerCli.Command("app", "validate", testAppName)
 	stdOut = icmd.RunCmd(cmd).Assert(t, icmd.Success).Combined()
 	golden.Assert(t, stdOut, "validate-output.golden")
-
-	// test single-file init
-	cmd.Command = dockerCli.Command("app",
-		"init", "myapp",
-		"--compose-file", tmpDir.Join(internal.ComposeFileName),
-		"--description", "some description",
-		"--maintainer", "dev1",
-		"--maintainer", "dev2:[email protected]",
-		"--single-file",
-	)
-	icmd.RunCmd(cmd).Assert(t, icmd.Success)
-
-	appData, err := ioutil.ReadFile(tmpDir.Join("myapp.dockerapp"))
-	assert.NilError(t, err)
-	golden.Assert(t, string(appData), "init-singlefile.dockerapp")
-	// Check various commands work on single-file app package
-	cmd.Command = dockerCli.Command("app", "inspect", "myapp")
-	icmd.RunCmd(cmd).Assert(t, icmd.Success)
-
-	cmd.Command = dockerCli.Command("app", "render", "myapp")
-	icmd.RunCmd(cmd).Assert(t, icmd.Success)
 }
 
 func TestDetectApp(t *testing.T) {
@@ -187,82 +164,6 @@ func TestDetectApp(t *testing.T) {
 	})
 }
 
-func patchEndOfLine(t *testing.T, eol []byte, name, fromDir, toDir string) {
-	buf := golden.Get(t, filepath.Join(fromDir, name))
-	bytes.ReplaceAll(buf, []byte{'\n'}, eol)
-	assert.NilError(t, ioutil.WriteFile(filepath.Join(toDir, name), buf, 0644))
-}
-
-func TestSplitMerge(t *testing.T) {
-	testCases := []struct {
-		name       string
-		lineEnding []byte
-	}{
-		{
-			name:       "without-crlf",
-			lineEnding: []byte{'\n'},
-		},
-		{
-			name:       "with-crlf",
-			lineEnding: []byte{'\r', '\n'},
-		},
-	}
-	for _, test := range testCases {
-		t.Run(test.name, func(t *testing.T) {
-			cmd, cleanup := dockerCli.createTestCmd()
-			defer cleanup()
-
-			tmpDir := fs.NewDir(t, "split_merge", fs.WithDir("my.dockerapp"))
-			defer tmpDir.Remove()
-
-			inputDir := filepath.Join("render", "envvariables", "my.dockerapp")
-			testDataDir := tmpDir.Join("my.dockerapp")
-
-			// replace the line ending from the versioned test data files and put them to a temp dir
-			for _, name := range internal.FileNames {
-				patchEndOfLine(t, test.lineEnding, name, inputDir, testDataDir)
-			}
-
-			// Merge a multi-files app to a single-file app
-			cmd.Command = dockerCli.Command("app", "merge", testDataDir, "--output", tmpDir.Join("remerged.dockerapp"))
-			icmd.RunCmd(cmd).Assert(t, icmd.Success)
-
-			cmd.Dir = tmpDir.Path()
-
-			// test that inspect works on single-file
-			cmd.Command = dockerCli.Command("app", "inspect", "remerged")
-			result := icmd.RunCmd(cmd).Assert(t, icmd.Success)
-			golden.Assert(t, result.Combined(), "envvariables-inspect.golden")
-
-			// split it
-			cmd.Command = dockerCli.Command("app", "split", "remerged", "--output", "split.dockerapp")
-			icmd.RunCmd(cmd).Assert(t, icmd.Success)
-
-			// test that inspect still works
-			cmd.Command = dockerCli.Command("app", "inspect", "remerged")
-			result = icmd.RunCmd(cmd).Assert(t, icmd.Success)
-			golden.Assert(t, result.Combined(), "envvariables-inspect.golden")
-
-			// the split app must be the same as the original one
-			manifest := fs.Expected(
-				t,
-				fs.WithMode(0755),
-				fs.WithFile(internal.MetadataFileName, string(golden.Get(t, path.Join(testDataDir, internal.MetadataFileName))), fs.WithMode(0644)),
-				fs.WithFile(internal.ComposeFileName, string(golden.Get(t, path.Join(testDataDir, internal.ComposeFileName))), fs.WithMode(0644)),
-				fs.WithFile(internal.ParametersFileName, string(golden.Get(t, path.Join(testDataDir, internal.ParametersFileName))), fs.WithMode(0644)),
-			)
-			assert.Assert(t, fs.Equal(tmpDir.Join("split.dockerapp"), manifest))
-
-			// test inplace
-			cmd.Command = dockerCli.Command("app", "merge", "split")
-			icmd.RunCmd(cmd).Assert(t, icmd.Success)
-
-			cmd.Command = dockerCli.Command("app", "split", "split")
-			icmd.RunCmd(cmd).Assert(t, icmd.Success)
-		})
-	}
-}
-
 func TestBundle(t *testing.T) {
 	cmd, cleanup := dockerCli.createTestCmd()
 	defer cleanup()

e2e/testdata/plugin-usage-experimental.golden

@@ -9,11 +9,9 @@ Commands:
   inspect     Shows metadata, parameters and a summary of the Compose file for a given application
   install     Install an application
   list        List the installations and their last known installation result
-  merge       Merge a directory format Docker Application definition into a single file
   pull        Pull an application package from a registry
   push        Push an application package to a registry
   render      Render the Compose file for an Application Package
-  split       Split a single-file Docker Application definition into the directory format
   status      Get the installation status of an application
   uninstall   Uninstall an application
   upgrade     Upgrade an installed application

e2e/testdata/plugin-usage.golden

@@ -9,11 +9,9 @@ Commands:
   inspect     Shows metadata, parameters and a summary of the Compose file for a given application
   install     Install an application
   list        List the installations and their last known installation result
-  merge       Merge a directory format Docker Application definition into a single file
   pull        Pull an application package from a registry
   push        Push an application package to a registry
   render      Render the Compose file for an Application Package
-  split       Split a single-file Docker Application definition into the directory format
   status      Get the installation status of an application
   uninstall   Uninstall an application
   upgrade     Upgrade an installed application

e2e/testdata/render/singlefile/env.yml

@@ -0,0 +1,7 @@
+version: '3.6'
+services:
+  hello:
+    image: hashicorp/http-echo:0.2.3
+    command: ["-text", "${text}"]
+    ports:
+     - ${port}:5678