Add describe branch command

Author: bzon

README.md

@@ -200,7 +200,7 @@ Contributors are welcomed with love! Please read [CONTRIBUTING.md](./CONTRIBUTIN
 ### Project Repository Branch
 
 * [ ] `get branch [flags]`
-* [ ] `describe branch [branch name] [flags]`
+* [x] `describe branch [branch name] [flags]`
 * [x] `new branch [branch name] [flags]`
 * [x] `delete branch [branch name] [flags]`
 * [ ] `edit branch [branch name] [--protect] [flags]`

cmd/desc_branch.go

@@ -0,0 +1,65 @@
+// Copyright © 2018 github.com/devopsctl authors
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// 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
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+var descBranchCmd = &cobra.Command{
+	Use:               "branch",
+	Aliases:           []string{"b"},
+	Short:             "Describe a branch of a specified project",
+	Example:           "gitlabctl describe master --project=devopsctl/gitlabctl",
+	SilenceErrors:     true,
+	SilenceUsage:      true,
+	DisableAutoGenTag: true,
+	Args:              cobra.ExactArgs(1),
+	PreRunE: func(cmd *cobra.Command, args []string) error {
+		return nil
+	},
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return descBranch(
+			getFlagString(cmd, "project"),
+			args[0],
+			getFlagString(cmd, "out"),
+		)
+	},
+}
+
+func init() {
+	descCmd.AddCommand(descBranchCmd)
+	addProjectFlag(descBranchCmd)
+	verifyMarkFlagRequired(descBranchCmd, "project")
+}
+
+func descBranch(project, branch, out string) error {
+	git, err := newGitlabClient()
+	if err != nil {
+		return err
+	}
+	branchInfo, _, err := git.Branches.GetBranch(project, branch)
+	if err != nil {
+		return err
+	}
+	printBranchOut(out, branchInfo)
+	return nil
+}

cmd/desc_branch_test.go

@@ -0,0 +1,71 @@
+// Copyright © 2018 github.com/devopsctl authors
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// 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
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package cmd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestDescBranchCmd(t *testing.T) {
+	tt := []struct {
+		name     string
+		flagsMap map[string]string
+		args     []string
+		expect   testResult
+	}{
+		{
+			name: "describe project with id 11 master branch",
+			flagsMap: map[string]string{
+				"project": "11",
+			},
+			args:   []string{"master"},
+			expect: pass,
+		},
+		{
+			name: "describing a non existent branch fails",
+			flagsMap: map[string]string{
+				"project": "11",
+			},
+			args:   []string{"release-99"},
+			expect: fail,
+		},
+	}
+
+	for _, tc := range tt {
+		t.Run(tc.name, func(t *testing.T) {
+			execT := execTestCmdFlags{
+				t:        t,
+				cmd:      descBranchCmd,
+				flagsMap: tc.flagsMap,
+				args:     tc.args,
+			}
+			stdout, execResult := execT.executeCommand()
+			require.Equal(t, tc.expect, execResult,
+				printFlagsTable(tc.flagsMap, stdout))
+			if tc.expect == pass {
+				require.Contains(t, stdout, tc.args[0], stdout)
+			}
+		})
+	}
+
+}

docs/gitlabctl_describe.md

@@ -22,6 +22,7 @@ All gitlab resources can be found here https://docs.gitlab.com/ce/api/#resources
 ### SEE ALSO
 
 * [gitlabctl](gitlabctl.md)	 - Gitlab command-line interface
+* [gitlabctl describe branch](gitlabctl_describe_branch.md)	 - Describe a branch of a specified project
 * [gitlabctl describe group](gitlabctl_describe_group.md)	 - Describe a group by specifying the id or group path
 * [gitlabctl describe member](gitlabctl_describe_member.md)	 - Describe a member by specifying the username and source
 * [gitlabctl describe project](gitlabctl_describe_project.md)	 - Describe a project by specifying the id or project path

docs/gitlabctl_describe_branch.md

@@ -0,0 +1,36 @@
+## gitlabctl describe branch
+
+Describe a branch of a specified project
+
+### Synopsis
+
+Describe a branch of a specified project
+
+```
+gitlabctl describe branch [flags]
+```
+
+### Examples
+
+```
+gitlabctl describe master --project=devopsctl/gitlabctl
+```
+
+### Options
+
+```
+  -h, --help             help for branch
+  -p, --project string   The name or ID of the project
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.gitlabctl.yaml)
+  -o, --out string      Print the command output to the desired format. (json, yaml, simple) (default "simple")
+```
+
+### SEE ALSO
+
+* [gitlabctl describe](gitlabctl_describe.md)	 - Describe a gitlab resource
+