Move file names as constants

Signed-off-by: Silvin Lubecki <silvin.lubecki@docker.com>

Author: silvin-lubecki

e2e/binary_test.go

@@ -174,7 +174,7 @@ targets:
 	envData := "# some comment\nNGINX_VERSION=latest"
 	inputDir := randomName("app_input_")
 	os.Mkdir(inputDir, 0755)
-	ioutil.WriteFile(filepath.Join(inputDir, "docker-compose.yml"), []byte(composeData), 0644)
+	ioutil.WriteFile(filepath.Join(inputDir, internal.ComposeFileName), []byte(composeData), 0644)
 	ioutil.WriteFile(filepath.Join(inputDir, ".env"), []byte(envData), 0644)
 	defer os.RemoveAll(inputDir)
 
@@ -186,7 +186,7 @@ targets:
 		"init",
 		testAppName,
 		"-c",
-		filepath.Join(inputDir, "docker-compose.yml"),
+		filepath.Join(inputDir, internal.ComposeFileName),
 		"-d",
 		"my cool app",
 		"-m", "bob",
@@ -196,9 +196,9 @@ targets:
 	manifest := fs.Expected(
 		t,
 		fs.WithMode(0755),
-		fs.WithFile("metadata.yml", meta, fs.WithMode(0644)), // too many variables, cheating
-		fs.WithFile("docker-compose.yml", composeData, fs.WithMode(0644)),
-		fs.WithFile("settings.yml", "NGINX_ARGS: FILL ME\nNGINX_VERSION: latest\n", fs.WithMode(0644)),
+		fs.WithFile(internal.MetadataFileName, meta, fs.WithMode(0644)), // too many variables, cheating
+		fs.WithFile(internal.ComposeFileName, composeData, fs.WithMode(0644)),
+		fs.WithFile(internal.SettingsFileName, "NGINX_ARGS: FILL ME\nNGINX_VERSION: latest\n", fs.WithMode(0644)),
 	)
 
 	assert.Assert(t, fs.Equal(dirName, manifest))
@@ -208,7 +208,7 @@ targets:
 		"init",
 		"tac",
 		"-c",
-		filepath.Join(inputDir, "docker-compose.yml"),
+		filepath.Join(inputDir, internal.ComposeFileName),
 		"-d",
 		"my cool app",
 		"-m", "bob",

internal/names.go

@@ -12,11 +12,17 @@ const (
 	AppExtension = ".dockerapp"
 	// The label used to distinguish applications from Docker images.
 	ImageLabel = "com.docker.application"
+	// MetadataFileName is metadata file name
+	MetadataFileName = "metadata.yml"
+	// ComposeFileName is compose file name
+	ComposeFileName = "docker-compose.yml"
+	// SettingsFileName is settings file name
+	SettingsFileName = "settings.yml"
 )
 
 var (
 	// Application file names, in order.
-	FileNames = []string{"metadata.yml", "docker-compose.yml", "settings.yml"}
+	FileNames = []string{MetadataFileName, ComposeFileName, SettingsFileName}
 )
 
 var appNameRe, _ = regexp.Compile("^[a-zA-Z][a-zA-Z0-9_-]+$")

internal/packager/init.go

@@ -45,8 +45,8 @@ func Init(name string, composeFile string, description string, maintainers []str
 	}
 
 	if composeFile == "" {
-		if _, err := os.Stat("docker-compose.yml"); err == nil {
-			composeFile = "docker-compose.yml"
+		if _, err := os.Stat(internal.ComposeFileName); err == nil {
+			composeFile = internal.ComposeFileName
 		}
 	}
 	if composeFile == "" {
@@ -62,9 +62,9 @@ func Init(name string, composeFile string, description string, maintainers []str
 	}
 	// Merge as a single file
 	// Add some helfpful comments to distinguish the sections
-	prependToFile(filepath.Join(dirName, "docker-compose.yml"), "# This section contains the Compose file that describes your application services.\n")
-	prependToFile(filepath.Join(dirName, "settings.yml"), "# This section contains the default values for your application settings.\n")
-	prependToFile(filepath.Join(dirName, "metadata.yml"), "# This section contains your application metadata.\n")
+	prependToFile(filepath.Join(dirName, internal.ComposeFileName), "# This section contains the Compose file that describes your application services.\n")
+	prependToFile(filepath.Join(dirName, internal.SettingsFileName), "# This section contains the default values for your application settings.\n")
+	prependToFile(filepath.Join(dirName, internal.MetadataFileName), "# This section contains your application metadata.\n")
 	temp := "_temp_dockerapp__.dockerapp"
 	err = os.Rename(dirName, temp)
 	if err != nil {
@@ -89,10 +89,10 @@ func initFromScratch(name string) error {
 
 	dirName := internal.DirNameFromAppName(name)
 
-	if err := ioutil.WriteFile(filepath.Join(dirName, "docker-compose.yml"), composeData, 0644); err != nil {
+	if err := ioutil.WriteFile(filepath.Join(dirName, internal.ComposeFileName), composeData, 0644); err != nil {
 		return err
 	}
-	return ioutil.WriteFile(filepath.Join(dirName, "settings.yml"), []byte{'\n'}, 0644)
+	return ioutil.WriteFile(filepath.Join(dirName, internal.SettingsFileName), []byte{'\n'}, 0644)
 }
 
 func parseEnv(env string, target map[string]string) {
@@ -213,11 +213,11 @@ func initFromComposeFile(name string, composeFile string) error {
 	if err != nil {
 		return errors.Wrap(err, "failed to marshal settings")
 	}
-	err = ioutil.WriteFile(filepath.Join(dirName, "docker-compose.yml"), composeRaw, 0644)
+	err = ioutil.WriteFile(filepath.Join(dirName, internal.ComposeFileName), composeRaw, 0644)
 	if err != nil {
 		return errors.Wrap(err, "failed to write docker-compose.yml")
 	}
-	err = ioutil.WriteFile(filepath.Join(dirName, "settings.yml"), settingsYAML, 0644)
+	err = ioutil.WriteFile(filepath.Join(dirName, internal.SettingsFileName), settingsYAML, 0644)
 	if err != nil {
 		return errors.Wrap(err, "failed to write settings.yml")
 	}
@@ -263,7 +263,7 @@ func writeMetadataFile(name, dirName string, description string, maintainers []s
 	if err := tmpl.Execute(resBuf, meta); err != nil {
 		return errors.Wrap(err, "error generating metadata")
 	}
-	return ioutil.WriteFile(filepath.Join(dirName, "metadata.yml"), resBuf.Bytes(), 0644)
+	return ioutil.WriteFile(filepath.Join(dirName, internal.MetadataFileName), resBuf.Bytes(), 0644)
 }
 
 func newMetadata(name string, description string, maintainers []string) types.AppMetadata {

internal/packager/init_test.go

@@ -32,7 +32,7 @@ func TestInitFromComposeFile(t *testing.T) {
 	envData := "# some comment\nNGINX_VERSION=latest"
 	inputDir := randomName("app_input_")
 	os.Mkdir(inputDir, 0755)
-	ioutil.WriteFile(filepath.Join(inputDir, "docker-compose.yml"), []byte(composeData), 0644)
+	ioutil.WriteFile(filepath.Join(inputDir, internal.ComposeFileName), []byte(composeData), 0644)
 	ioutil.WriteFile(filepath.Join(inputDir, ".env"), []byte(envData), 0644)
 	defer os.RemoveAll(inputDir)
 
@@ -42,14 +42,14 @@ func TestInitFromComposeFile(t *testing.T) {
 	assert.NilError(t, err)
 	defer os.RemoveAll(dirName)
 
-	err = initFromComposeFile(testAppName, filepath.Join(inputDir, "docker-compose.yml"))
+	err = initFromComposeFile(testAppName, filepath.Join(inputDir, internal.ComposeFileName))
 	assert.NilError(t, err)
 
 	manifest := fs.Expected(
 		t,
 		fs.WithMode(0755),
-		fs.WithFile("docker-compose.yml", composeData, fs.WithMode(0644)),
-		fs.WithFile("settings.yml", "NGINX_ARGS: FILL ME\nNGINX_VERSION: latest\n", fs.WithMode(0644)),
+		fs.WithFile(internal.ComposeFileName, composeData, fs.WithMode(0644)),
+		fs.WithFile(internal.SettingsFileName, "NGINX_ARGS: FILL ME\nNGINX_VERSION: latest\n", fs.WithMode(0644)),
 	)
 
 	assert.Assert(t, fs.Equal(dirName, manifest))
@@ -95,7 +95,7 @@ targets:
 
 	manifest := fs.Expected(
 		t,
-		fs.WithFile("metadata.yml", data, fs.WithMode(0644)),
+		fs.WithFile(internal.MetadataFileName, data, fs.WithMode(0644)),
 	)
 	assert.Assert(t, fs.Equal(tmpdir.Path(), manifest))
 }

internal/packager/registry.go

@@ -28,7 +28,7 @@ func Save(appname, namespace, tag string) (string, error) {
 		return "", err
 	}
 	defer cleanup()
-	metaFile := filepath.Join(appname, "metadata.yml")
+	metaFile := filepath.Join(appname, internal.MetadataFileName)
 	metaContent, err := ioutil.ReadFile(metaFile)
 	if err != nil {
 		return "", errors.Wrap(err, "failed to read application metadata")

internal/renderer/helm.go

@@ -173,7 +173,7 @@ func convertTemplates(dict map[interface{}]interface{}) error {
 }
 
 func makeChart(appname, targetDir string) error {
-	metaFile := filepath.Join(appname, "metadata.yml")
+	metaFile := filepath.Join(appname, internal.MetadataFileName)
 	metaContent, err := ioutil.ReadFile(metaFile)
 	if err != nil {
 		return errors.Wrap(err, "failed to read application metadata")
@@ -286,7 +286,7 @@ func Helm(appname string, composeFiles []string, settingsFile []string, env map[
 	if render {
 		return helmRender(appname, targetDir, composeFiles, settingsFile, env)
 	}
-	data, err := ioutil.ReadFile(filepath.Join(appname, "docker-compose.yml"))
+	data, err := ioutil.ReadFile(filepath.Join(appname, internal.ComposeFileName))
 	if err != nil {
 		return errors.Wrap(err, "failed to read application Compose file")
 	}
@@ -304,13 +304,13 @@ func Helm(appname string, composeFiles []string, settingsFile []string, env map[
 // makeValues updates helm values.yaml with used variables from settings and env
 func makeValues(appname, targetDir string, settingsFile []string, env map[string]string, variables []string) error {
 	// merge our variables into Values.yaml
-	sf := []string{filepath.Join(appname, "settings.yml")}
+	sf := []string{filepath.Join(appname, internal.SettingsFileName)}
 	sf = append(sf, settingsFile...)
 	settings, err := loadSettings(sf)
 	if err != nil {
 		return err
 	}
-	metaFile := filepath.Join(appname, "metadata.yml")
+	metaFile := filepath.Join(appname, internal.MetadataFileName)
 	meta := make(map[interface{}]interface{})
 	metaContent, err := ioutil.ReadFile(metaFile)
 	if err != nil {

internal/renderer/inspect.go

@@ -8,14 +8,15 @@ import (
 	"sort"
 	"text/tabwriter"
 
+	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/types"
 	"github.com/pkg/errors"
 	yaml "gopkg.in/yaml.v2"
 )
 
 // Inspect dumps the metadata of an app
 func Inspect(out io.Writer, appname string) error {
-	metaFile := filepath.Join(appname, "metadata.yml")
+	metaFile := filepath.Join(appname, internal.MetadataFileName)
 	metaContent, err := ioutil.ReadFile(metaFile)
 	if err != nil {
 		return errors.Wrap(err, "failed to read application metadata")
@@ -26,7 +27,7 @@ func Inspect(out io.Writer, appname string) error {
 		return err
 	}
 	// extract settings
-	settingsFile := filepath.Join(appname, "settings.yml")
+	settingsFile := filepath.Join(appname, internal.SettingsFileName)
 	settingsContent, err := ioutil.ReadFile(settingsFile)
 	if err != nil {
 		return errors.Wrap(err, "failed to read application settings")

internal/renderer/render.go

@@ -159,15 +159,15 @@ func contains(list []string, needle string) bool {
 // Render renders the Compose file for this app, merging in settings files, other compose files, and env
 func Render(appname string, composeFiles []string, settingsFile []string, env map[string]string) (*composetypes.Config, error) {
 	// prepend the app settings to the argument settings
-	sf := []string{filepath.Join(appname, "settings.yml")}
+	sf := []string{filepath.Join(appname, internal.SettingsFileName)}
 	sf = append(sf, settingsFile...)
 	// load the settings into a struct
 	settings, err := loadSettings(sf)
 	if err != nil {
 		return nil, err
 	}
 	// inject our metadata
-	metaFile := filepath.Join(appname, "metadata.yml")
+	metaFile := filepath.Join(appname, internal.MetadataFileName)
 	meta := make(map[interface{}]interface{})
 	metaContent, err := ioutil.ReadFile(metaFile)
 	if err != nil {
@@ -189,7 +189,7 @@ func Render(appname string, composeFiles []string, settingsFile []string, env ma
 	finalEnv := make(map[string]string)
 	flatten(settings, finalEnv, "")
 	// prepend our app compose file to the list
-	composes := []string{filepath.Join(appname, "docker-compose.yml")}
+	composes := []string{filepath.Join(appname, internal.ComposeFileName)}
 	composes = append(composes, composeFiles...)
 	renderers := strings.Split(internal.Renderers, ",")
 	if r, ok := os.LookupEnv("DOCKERAPP_RENDERERS"); ok {