new_branch: change the command pattern and refactor flag assigment

Author: bzon

cmd/flags_assigners.go

@@ -9,7 +9,6 @@
 //
 // The above copyright notice and this permission notice shall be included in
 // all copies or substantial portions of the Software.
-//
 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -628,13 +627,3 @@ func assignAddSSHKeyOptions(cmd *cobra.Command) (*gitlab.AddSSHKeyOptions, error
 	opts.Key = gitlab.String(string(b))
 	return opts, nil
 }
-
-// assignCreateBranchOptions assigns the flags' values to gitlab.AddSSHKeyOptions fields.
-// If a flag's default value is not changed by the caller,
-// it's value will not be assigned to the associated gitlab.AddSSHKeyOptions field.
-func assignCreateBranchOptions(cmd *cobra.Command) *gitlab.CreateBranchOptions {
-	opts := new(gitlab.CreateBranchOptions)
-	opts.Branch = gitlab.String(getFlagString(cmd, "name"))
-	opts.Ref = gitlab.String(getFlagString(cmd, "ref"))
-	return opts
-}

cmd/flags_definers.go

@@ -129,16 +129,8 @@ func addGetProjectsFlags(cmd *cobra.Command) {
 		"Limit by enabled merge requests feature")
 }
 
-func addNewBranchFlags(cmd *cobra.Command) {
-	addBranchName(cmd)
-	cmd.Flags().StringP("ref", "r", "",
-		"The branch name or commit SHA to create branch from")
-	verifyMarkFlagRequired(cmd, "ref")
-}
-
-func addBranchName(cmd *cobra.Command) {
-	cmd.Flags().StringP("name", "n", "", "The name of the branch")
-	verifyMarkFlagRequired(cmd, "name")
+func addProjectFlag(cmd *cobra.Command) {
+	cmd.Flags().StringP("project", "p", "", "The name or ID of the project")
 }
 
 // addNewGroupFlags add the required flags for creating a new group

cmd/new_branch.go

@@ -25,10 +25,11 @@ import (
 )
 
 var newBranchCmd = &cobra.Command{
-	Use:           "branch",
-	Aliases:       []string{"b"},
-	Short:         "Create a new branch for a specified project",
-	Example:       `gitlabctl new branch project23 --name=release-x --ref=master`,
+	Use:     "branch",
+	Aliases: []string{"b"},
+	Short:   "Create a new branch for a specified project",
+	Example: `# create a develop branch from master branch for project groupx/myapp
+gitlabctl new branch develop --project=groupx/myapp --ref=master`,
 	SilenceErrors: true,
 	SilenceUsage:  true,
 	Args:          cobra.ExactArgs(1),
@@ -39,16 +40,22 @@ var newBranchCmd = &cobra.Command{
 
 func init() {
 	newCmd.AddCommand(newBranchCmd)
-	addNewBranchFlags(newBranchCmd)
+	addProjectFlag(newBranchCmd)
+	verifyMarkFlagRequired(newBranchCmd, "project")
+	newBranchCmd.Flags().StringP("ref", "r", "",
+		"The branch name or commit SHA to create branch from")
+	verifyMarkFlagRequired(newBranchCmd, "ref")
 }
 
-func runNewBranch(cmd *cobra.Command, project string) error {
-	opts := assignCreateBranchOptions(cmd)
-	branch, err := newBranch(project, opts)
+func runNewBranch(cmd *cobra.Command, branch string) error {
+	opts := new(gitlab.CreateBranchOptions)
+	opts.Ref = gitlab.String(getFlagString(cmd, "ref"))
+	opts.Branch = gitlab.String(branch)
+	createdBranch, err := newBranch(getFlagString(cmd, "project"), opts)
 	if err != nil {
 		return err
 	}
-	printBranchOut(cmd, branch)
+	printBranchOut(cmd, createdBranch)
 	return nil
 }
 

cmd/new_branch_test.go

@@ -37,15 +37,15 @@ func TestNewBranch(t *testing.T) {
 		{
 			name: "create a new branch",
 			flagsMap: map[string]string{
-				"name": "release-1",
-				"ref":  "master",
+				"project": "Group2/project12",
+				"ref":     "master",
 			},
-			args:   []string{"Group2/project12"},
+			args:   []string{"release-x"},
 			expect: pass,
 		},
 		{
 			name:   "flags must be required",
-			args:   []string{"Group2/project12"},
+			args:   []string{"master"},
 			expect: fail,
 		},
 	}