Corral name manipulation to utils package

Add app name validation function

Signed-off-by: Joffrey F <[email protected]>

Author: shin-

packager/extract.go

@@ -14,7 +14,7 @@ func Extract(appname string) (string, func(), error) {
 	s, err := os.Stat(appname)
 	if err != nil {
 		// try appending our extension
-		appname = appname + ".docker-app"
+		appname = utils.DirNameFromAppName(appname)
 		s, err = os.Stat(appname)
 	}
 	if err != nil {

packager/init.go

@@ -16,7 +16,10 @@ import (
 // Init is the entrypoint initialization function.
 // It generates a new application package based on the provided parameters.
 func Init(name string, composeFiles []string) error {
-	dirName := appDirName(name)
+	if err := utils.ValidateAppName(name); err != nil {
+		return err
+	}
+	dirName := utils.DirnameFromAppName(name)
 	if err := os.Mkdir(dirName, 0755); err != nil {
 		return err
 	}
@@ -50,7 +53,7 @@ Examples of possible values: java, mysql, redis, ruby, postgres, rabbitmq...`)
 		return err
 	}
 
-	dirName := appDirName(name)
+	dirName := utils.DirnameFromAppName(name)
 	if err := utils.CreateFileWithData(path.Join(dirName, "services.yml"), composeData); err != nil {
 		return err
 	}
@@ -60,7 +63,7 @@ Examples of possible values: java, mysql, redis, ruby, postgres, rabbitmq...`)
 func initFromComposeFiles(name string, composeFiles []string) error {
 	log.Println("init from compose")
 
-	dirName := appDirName(name)
+	dirName := utils.DirnameFromAppName(name)
 	composeConfig, err := mergeComposeConfig(composeFiles)
 	if err != nil {
 		return err
@@ -98,10 +101,6 @@ func composeFileFromScratch(services []string) ([]byte, error) {
 	return yaml.Marshal(fileStruct)
 }
 
-func appDirName(name string) string {
-	return fmt.Sprintf("%s.docker-app", name)
-}
-
 func writeMetadataFile(name, dirName string) error {
 	data, err := yaml.Marshal(newMetadata(name))
 	if err != nil {

packager/registry.go

@@ -1,6 +1,8 @@
 package packager
 
 import (
+	"github.com/docker/lunchbox/utils"
+
 	"archive/tar"
 	"fmt"
 	"io"
@@ -13,7 +15,7 @@ import (
 )
 
 func appName(appname string) string {
-	return strings.TrimSuffix(path.Base(appname), ".docker-app")
+	return utils.AppNameFromDir(appname)
 }
 
 // Save saves an app to docker

utils/names.go

@@ -0,0 +1,35 @@
+package utils
+
+import (
+	"fmt"
+	"path"
+	"regexp"
+	"strings"
+)
+
+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(path.Base(dirName), ".docker-app")
+}
+
+// DirNameFromAppName takes an application name and returns the
+// corresponding directory name
+func DirNameFromAppName(appName string) string {
+	return fmt.Sprintf("%s.docker-app", appName)
+}
+
+// ValidateAppName takes an app name and returns an error if it doesn't
+// match the expected format
+func ValidateAppName(appName string) error {
+	if appNameRe.MatchString(appName) {
+		return nil
+	}
+	return fmt.Errorf(
+		"invalid app name: %s ; app names must match the following regexp: %q",
+		appName,
+		appNameRe.String(),
+	)
+}

utils/names_test.go

@@ -0,0 +1,30 @@
+package utils
+
+import (
+	"fmt"
+	"github.com/gotestyourself/gotestyourself/assert"
+	"testing"
+)
+
+func TestValidateAppName(t *testing.T) {
+	validNames := []string{
+		"app", "app1", "my-app", "their_app", "app_01_02_-",
+		"LunchBox", "aPP01", "APP365",
+	}
+
+	invalidNames := []string{
+		"_app", "-app", "01_app", "$$$$$", "app$", "/my/app",
+		"(u|\\|[|-||30><", "Our Fortress Is Burning", "d\nx",
+		"my_\"app\"",
+	}
+
+	for _, name := range validNames {
+		err := ValidateAppName(name)
+		assert.NilError(t, err)
+	}
+
+	for _, name := range invalidNames {
+		err := ValidateAppName(name)
+		assert.ErrorContains(t, err, fmt.Sprintf("invalid app name: %s", name))
+	}
+}