Remove utils and constants packages

vdemeester · vdemeester · commit 2db47dbee900 · 2018-06-08T21:06:34.000+02:00
Those packages don't have meaniful names, moved them into `internal`
for now (I feel this is the right place for them at the moment)
`io.CreateFileWithData` already exists in the standard library :
`io.WriteFile`

Signed-off-by: Vincent Demeester &lt;vincent@sbr.pm&gt;
diff --git a/cmd/docker-app/deploy.go b/cmd/docker-app/deploy.go
@@ -8,7 +8,6 @@ import (
 	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/app/internal/renderer"
-	"github.com/docker/app/internal/utils"
 	"github.com/docker/cli/cli"
 	"github.com/docker/cli/cli/command"
 	"github.com/docker/cli/cli/command/stack/kubernetes"
@@ -83,7 +82,7 @@ func runDeploy(appname string, opts deployOptions) error {
 	})
 	stackName := opts.deployStackName
 	if stackName == "" {
-		stackName = utils.AppNameFromDir(appname)
+		stackName = internal.AppNameFromDir(appname)
 	}
 	if deployOrchestrator == "swarm" {
 		ctx := context.Background()
diff --git a/e2e/binary_test.go b/e2e/binary_test.go
@@ -13,7 +13,8 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/docker/app/internal/utils"
+	"github.com/docker/app/internal"
+
 	"gotest.tools/assert"
 	"gotest.tools/fs"
 	"gotest.tools/golden"
@@ -224,7 +225,7 @@ targets:
 	defer os.RemoveAll(inputDir)
 
 	testAppName := "app_test"
-	dirName := utils.DirNameFromAppName(testAppName)
+	dirName := internal.DirNameFromAppName(testAppName)
 	defer os.RemoveAll(dirName)
 
 	args := []string{
diff --git a/internal/constants/constants.go b/internal/constants/constants.go
diff --git a/internal/image/image.go b/internal/image/image.go
@@ -6,9 +6,9 @@ import (
 	"os/exec"
 	"path/filepath"
 
+	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/app/internal/renderer"
-	"github.com/docker/app/internal/utils"
 )
 
 func contains(list []string, needle string) bool {
@@ -48,7 +48,7 @@ func Add(appname string, services []string, composeFiles []string, settingsFile
 	s, err := os.Stat(oappname)
 	if err != nil {
 		// try appending our extension
-		oappname = utils.DirNameFromAppName(oappname)
+		oappname = internal.DirNameFromAppName(oappname)
 		s, err = os.Stat(oappname)
 	}
 	if err != nil {
diff --git a/internal/names.go b/internal/names.go
@@ -1,29 +1,32 @@
-package utils
+package internal
 
 import (
 	"fmt"
 	"path/filepath"
 	"regexp"
 	"strings"
+)
 
-	"github.com/docker/app/internal/constants"
+const (
+	// AppExtension is the extension used by an application
+	AppExtension = ".dockerapp"
 )
 
 var appNameRe, _ = regexp.Compile("^[a-zA-Z][a-zA-Z0-9_-]+$")
 
 // AppNameFromDir takes a path to an app directory and returns
 // the application's name
 func AppNameFromDir(dirName string) string {
-	return strings.TrimSuffix(filepath.Base(dirName), constants.AppExtension)
+	return strings.TrimSuffix(filepath.Base(dirName), AppExtension)
 }
 
 // DirNameFromAppName takes an application name and returns the
 // corresponding directory name
 func DirNameFromAppName(appName string) string {
-	if strings.HasSuffix(appName, constants.AppExtension) {
+	if strings.HasSuffix(appName, AppExtension) {
 		return appName
 	}
-	return appName + constants.AppExtension
+	return appName + AppExtension
 }
 
 // ValidateAppName takes an app name and returns an error if it doesn't
diff --git a/internal/names_test.go b/internal/names_test.go
@@ -1,4 +1,4 @@
-package utils
+package internal
 
 import (
 	"fmt"
diff --git a/internal/packager/extract.go b/internal/packager/extract.go
@@ -10,8 +10,7 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/docker/app/internal/constants"
-	"github.com/docker/app/internal/utils"
+	"github.com/docker/app/internal"
 	"github.com/pkg/errors"
 )
 
@@ -25,7 +24,7 @@ func findApp() (string, error) {
 	if err != nil {
 		return "", errors.Wrap(err, "cannot resolve current working directory")
 	}
-	if strings.HasSuffix(cwd, constants.AppExtension) {
+	if strings.HasSuffix(cwd, internal.AppExtension) {
 		return cwd, nil
 	}
 	content, err := ioutil.ReadDir(cwd)
@@ -34,7 +33,7 @@ func findApp() (string, error) {
 	}
 	hit := ""
 	for _, c := range content {
-		if strings.HasSuffix(c.Name(), constants.AppExtension) {
+		if strings.HasSuffix(c.Name(), internal.AppExtension) {
 			if hit != "" {
 				return "", fmt.Errorf("multiple applications found in current directory, specify the application name on the command line")
 			}
@@ -53,15 +52,15 @@ func extractImage(appname string) (string, func(), error) {
 	if strings.Contains(appname, ":") {
 		nametag := strings.Split(appname, ":")
 		if len(nametag) == 3 || strings.Contains(nametag[1], "/") {
-			nametag[1] = utils.DirNameFromAppName(nametag[1])
+			nametag[1] = internal.DirNameFromAppName(nametag[1])
 			appname = filepath.Base(nametag[1])
 		} else {
-			nametag[0] = utils.DirNameFromAppName(nametag[0])
+			nametag[0] = internal.DirNameFromAppName(nametag[0])
 			appname = filepath.Base(nametag[0])
 		}
 		imagename = strings.Join(nametag, ":")
 	} else {
-		imagename = utils.DirNameFromAppName(appname)
+		imagename = internal.DirNameFromAppName(appname)
 		appname = filepath.Base(imagename)
 	}
 	tempDir, err := ioutil.TempDir("", "dockerapp")
@@ -109,7 +108,7 @@ func Extract(appname string) (string, func(), error) {
 	s, err := os.Stat(appname)
 	if err != nil {
 		// try appending our extension
-		appname = utils.DirNameFromAppName(appname)
+		appname = internal.DirNameFromAppName(appname)
 		s, err = os.Stat(appname)
 	}
 	if err != nil {
diff --git a/internal/packager/init.go b/internal/packager/init.go
@@ -10,8 +10,8 @@ import (
 	"strings"
 	"text/template"
 
+	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/types"
-	"github.com/docker/app/internal/utils"
 	"github.com/pkg/errors"
 	log "github.com/sirupsen/logrus"
 	"gopkg.in/yaml.v2"
@@ -26,10 +26,10 @@ func prependToFile(filename, text string) {
 // 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, singleFile bool) error {
-	if err := utils.ValidateAppName(name); err != nil {
+	if err := internal.ValidateAppName(name); err != nil {
 		return err
 	}
-	dirName := utils.DirNameFromAppName(name)
+	dirName := internal.DirNameFromAppName(name)
 	if err := os.Mkdir(dirName, 0755); err != nil {
 		return errors.Wrap(err, "failed to create application directory")
 	}
@@ -80,11 +80,12 @@ func initFromScratch(name string) error {
 		return err
 	}
 
-	dirName := utils.DirNameFromAppName(name)
-	if err := utils.CreateFileWithData(filepath.Join(dirName, "docker-compose.yml"), composeData); err != nil {
+	dirName := internal.DirNameFromAppName(name)
+
+	if err := ioutil.WriteFile(filepath.Join(dirName, "docker-compose.yml"), composeData, 0644); err != nil {
 		return err
 	}
-	return utils.CreateFileWithData(filepath.Join(dirName, "settings.yml"), []byte{'\n'})
+	return ioutil.WriteFile(filepath.Join(dirName, "settings.yml"), []byte{'\n'}, 0644)
 }
 
 func parseEnv(env string, target map[string]string) {
@@ -180,7 +181,7 @@ func ExtractVariables(composeRaw string) ([]string, error) {
 func initFromComposeFile(name string, composeFile string) error {
 	log.Debug("init from compose")
 
-	dirName := utils.DirNameFromAppName(name)
+	dirName := internal.DirNameFromAppName(name)
 	composeRaw, err := ioutil.ReadFile(composeFile)
 	if err != nil {
 		return errors.Wrap(err, "failed to read compose file")
diff --git a/internal/packager/init_test.go b/internal/packager/init_test.go
@@ -8,7 +8,8 @@ import (
 	"path/filepath"
 	"testing"
 
-	"github.com/docker/app/internal/utils"
+	"github.com/docker/app/internal"
+
 	"gotest.tools/assert"
 	"gotest.tools/fs"
 )
@@ -36,7 +37,7 @@ func TestInitFromComposeFile(t *testing.T) {
 	defer os.RemoveAll(inputDir)
 
 	testAppName := randomName("app_")
-	dirName := utils.DirNameFromAppName(testAppName)
+	dirName := internal.DirNameFromAppName(testAppName)
 	err := os.Mkdir(dirName, 0755)
 	assert.NilError(t, err)
 	defer os.RemoveAll(dirName)
@@ -56,7 +57,7 @@ func TestInitFromComposeFile(t *testing.T) {
 
 func TestInitFromInvalidComposeFile(t *testing.T) {
 	testAppName := randomName("app_")
-	dirName := utils.DirNameFromAppName(testAppName)
+	dirName := internal.DirNameFromAppName(testAppName)
 	err := os.Mkdir(dirName, 0755)
 	assert.NilError(t, err)
 	defer os.RemoveAll(dirName)
diff --git a/internal/packager/packing.go b/internal/packager/packing.go
@@ -8,8 +8,8 @@ import (
 	"os"
 	"path/filepath"
 
-	"github.com/docker/app/internal/constants"
-	"github.com/docker/app/internal/utils"
+	"github.com/docker/app/internal"
+
 	"golang.org/x/crypto/ssh/terminal"
 )
 
@@ -99,7 +99,7 @@ func Unpack(appname, targetDir string) error {
 	s, err := os.Stat(appname)
 	if err != nil {
 		// try appending our extension
-		appname = utils.DirNameFromAppName(appname)
+		appname = internal.DirNameFromAppName(appname)
 		s, err = os.Stat(appname)
 	}
 	if err != nil {
@@ -108,7 +108,7 @@ func Unpack(appname, targetDir string) error {
 	if s.IsDir() {
 		return fmt.Errorf("app already extracted")
 	}
-	out := filepath.Join(targetDir, utils.AppNameFromDir(appname)+constants.AppExtension)
+	out := filepath.Join(targetDir, internal.AppNameFromDir(appname)+internal.AppExtension)
 	err = os.Mkdir(out, 0755)
 	if err != nil {
 		return err
diff --git a/internal/packager/registry.go b/internal/packager/registry.go
@@ -11,15 +11,14 @@ import (
 	"path/filepath"
 	"strings"
 
-	"github.com/docker/app/internal/constants"
+	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/types"
-	"github.com/docker/app/internal/utils"
 	"github.com/pkg/errors"
 	yaml "gopkg.in/yaml.v2"
 )
 
 func appName(appname string) string {
-	return utils.AppNameFromDir(appname)
+	return internal.AppNameFromDir(appname)
 }
 
 // Save saves an app to docker and returns the image name.
@@ -64,7 +63,7 @@ COPY / /
 		return "", errors.Wrapf(err, "cannot create file %s", di)
 	}
 	defer os.Remove(di)
-	imageName := prefix + appName(appname) + constants.AppExtension + ":" + tag
+	imageName := prefix + appName(appname) + internal.AppExtension + ":" + tag
 	args := []string{"build", "-t", imageName, "-f", df, appname}
 	cmd := exec.Command("docker", args...)
 	cmd.Stdout = ioutil.Discard
@@ -107,7 +106,7 @@ func Load(repotag string, outputDir string) error {
 			if len(repoComps) == 3 || (len(repoComps) == 2 && strings.Contains(repoComps[1], "/")) {
 				repo = repoComps[1]
 			}
-			err = ioutil.WriteFile(filepath.Join(outputDir, utils.DirNameFromAppName(filepath.Base(repo))), data, 0644)
+			err = ioutil.WriteFile(filepath.Join(outputDir, internal.DirNameFromAppName(filepath.Base(repo))), data, 0644)
 			return errors.Wrap(err, "error writing output file")
 		}
 	}
diff --git a/internal/renderer/helm.go b/internal/renderer/helm.go
@@ -8,12 +8,12 @@ import (
 	"regexp"
 	"strings"
 
+	"github.com/docker/app/internal"
 	"github.com/docker/app/internal/packager"
 	"github.com/docker/app/internal/templateconversion"
 	"github.com/docker/app/internal/templateloader"
 	"github.com/docker/app/internal/templatev1beta2"
 	"github.com/docker/app/internal/types"
-	"github.com/docker/app/internal/utils"
 	conversion "github.com/docker/cli/cli/command/stack/kubernetes"
 	"github.com/docker/cli/cli/compose/loader"
 	"github.com/docker/cli/kubernetes/compose/v1beta2"
@@ -219,7 +219,7 @@ func helmRender(appname string, targetDir string, composeFiles []string, setting
 			APIVersion: "v1beta2",
 		},
 		ObjectMeta: metav1.ObjectMeta{
-			Name: utils.AppNameFromDir(appname),
+			Name: internal.AppNameFromDir(appname),
 		},
 		Spec: stackSpec,
 	}
@@ -248,7 +248,7 @@ func makeStack(appname string, targetDir string, data []byte) error {
 			APIVersion: "v1beta2",
 		},
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      utils.AppNameFromDir(appname),
+			Name:      internal.AppNameFromDir(appname),
 			Namespace: "default", // FIXME
 		},
 		Spec: stackSpec,
@@ -280,7 +280,7 @@ func Helm(appname string, composeFiles []string, settingsFile []string, env map[
 		return err
 	}
 	defer cleanup()
-	targetDir := utils.AppNameFromDir(appname) + ".chart"
+	targetDir := internal.AppNameFromDir(appname) + ".chart"
 	if err := os.Mkdir(targetDir, 0755); err != nil && !os.IsExist(err) {
 		return errors.Wrap(err, "failed to create Chart directory")
 	}
diff --git a/internal/utils/io.go b/internal/utils/io.go
diff --git a/internal/utils/io_test.go b/internal/utils/io_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package utils`
	`1`	`+package internal`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"fmt"`