init: Add options to set description and maintainers.

Signed-off-by: Matthieu Nottale <[email protected]>

Author: Matthieu Nottale

cmd/init.go

@@ -8,20 +8,24 @@ import (
 
 // initCmd represents the init command
 var initCmd = &cobra.Command{
-	Use:   "init <app-name> [-c <compose-file>]",
+	Use:   "init <app-name> [-c <compose-file>] [-d <description>] [-m name:email ...]",
 	Short: "Initialize an app package in the current working directory",
 	Long: `This command initializes a new app package. If the -c option is used, or
 if a file named docker-compose.yml is found in the current directory, this file
 and the associated .env file if found will be used as the base for this application.`,
 	Args: cli.ExactArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
-		return packager.Init(args[0], composeFile)
+		return packager.Init(args[0], initComposeFile, initDescription, initMaintainers)
 	},
 }
 
-var composeFile string
+var initComposeFile string
+var initDescription string
+var initMaintainers []string
 
 func init() {
 	rootCmd.AddCommand(initCmd)
-	initCmd.Flags().StringVarP(&composeFile, "compose-file", "c", "", "Initial Compose file (optional)")
+	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)")
 }

e2e/binary_test.go

@@ -117,6 +117,18 @@ func TestInitBinary(t *testing.T) {
   nginx:
     image: nginx:${NGINX_VERSION}
     command: nginx $NGINX_ARGS
+`
+	meta := `version: 0.1.0
+name: app_test
+description: my cool app
+maintainers:
+- name: bob
+  email: ""
+- name: joe
+  email: [email protected]
+targets:
+  swarm: true
+  kubernetes: true
 `
 	envData := "# some comment\nNGINX_VERSION=latest"
 	inputDir := randomName("app_input_")
@@ -125,7 +137,7 @@ func TestInitBinary(t *testing.T) {
 	ioutil.WriteFile(filepath.Join(inputDir, ".env"), []byte(envData), 0644)
 	defer os.RemoveAll(inputDir)
 
-	testAppName := randomName("app_")
+	testAppName := "app_test"
 	dirName := utils.DirNameFromAppName(testAppName)
 	defer os.RemoveAll(dirName)
 
@@ -134,19 +146,21 @@ func TestInitBinary(t *testing.T) {
 		testAppName,
 		"-c",
 		filepath.Join(inputDir, "docker-compose.yml"),
+		"-d",
+		"my cool app",
+		"-m", "bob",
+		"-m", "joe:[email protected]",
 	}
 	cmd := exec.Command(dockerApp, args...)
 	output, err := cmd.CombinedOutput()
 	if err != nil {
 		fmt.Println(output)
 	}
 	assert.NilError(t, err)
-	meta, err := ioutil.ReadFile(filepath.Join(dirName, "metadata.yml"))
-	assert.NilError(t, err)
 	manifest := fs.Expected(
 		t,
 		fs.WithMode(0755),
-		fs.WithFile("metadata.yml", string(meta), fs.WithMode(0644)), // too many variables, cheating
+		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)),
 	)

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) error {
+func Init(name string, composeFile string, description string, maintainers []string) error {
 	if err := utils.ValidateAppName(name); err != nil {
 		return err
 	}
@@ -31,7 +31,7 @@ func Init(name string, composeFile string) error {
 			os.RemoveAll(dirName)
 		}
 	}()
-	if err = writeMetadataFile(name, dirName); err != nil {
+	if err = writeMetadataFile(name, dirName, description, maintainers); err != nil {
 		return err
 	}
 
@@ -199,28 +199,41 @@ func composeFileFromScratch() ([]byte, error) {
 	return yaml.Marshal(fileStruct)
 }
 
-func writeMetadataFile(name, dirName string) error {
-	data, err := yaml.Marshal(newMetadata(name))
+func writeMetadataFile(name, dirName string, description string, maintainers []string) error {
+	data, err := yaml.Marshal(newMetadata(name, description, maintainers))
 	if err != nil {
 		return err
 	}
 	return utils.CreateFileWithData(filepath.Join(dirName, "metadata.yml"), data)
 }
 
-func newMetadata(name string) types.AppMetadata {
-	var userName string
+func newMetadata(name string, description string, maintainers []string) types.AppMetadata {
 	target := types.ApplicationTarget{
 		Swarm:      true,
 		Kubernetes: true,
 	}
-	userData, _ := user.Current()
-	if userData != nil {
-		userName = userData.Username
-	}
-	return types.AppMetadata{
+	res := types.AppMetadata{
 		Version:     "0.1.0",
 		Targets:     target,
 		Name:        name,
-		Maintainers: []types.Maintainer{{Name: userName}},
+		Description: description,
+	}
+	if len(maintainers) == 0 {
+		var userName string
+		userData, _ := user.Current()
+		if userData != nil {
+			userName = userData.Username
+		}
+		res.Maintainers = []types.Maintainer{{Name: userName}}
+	} else {
+		for _, m := range maintainers {
+			ne := strings.Split(m, ":")
+			email := ""
+			if len(ne) > 1 {
+				email = ne[1]
+			}
+			res.Maintainers = append(res.Maintainers, types.Maintainer{Name: ne[0], Email: email})
+		}
 	}
+	return res
 }

packager/init_test.go

@@ -72,10 +72,10 @@ func TestWriteMetadataFile(t *testing.T) {
 	tmpdir := fs.NewDir(t, appName)
 	defer tmpdir.Remove()
 
-	err := writeMetadataFile(appName, tmpdir.Path())
+	err := writeMetadataFile(appName, tmpdir.Path(), "", nil)
 	assert.NilError(t, err)
 
-	data, err := yaml.Marshal(newMetadata(appName))
+	data, err := yaml.Marshal(newMetadata(appName, "", nil))
 	assert.NilError(t, err)
 
 	manifest := fs.Expected(