close #247 web command for jira

Author: groenborg

.gitconfig

@@ -2,6 +2,7 @@
 remote                 = origin
 service                = github
 integration-branch     = master
-issue-url              = https://api.github.com
+issue-api              = https://api.github.com
+issue-web              = https://github.com
 delivery-branch-prefix = ready
 

cmd/config.go

@@ -28,11 +28,6 @@ Default configuration:
     service = jira
     issue_url = https://my.jira.instance.com
     delivery_branch_prefix = ready
-
-
-
-
-
 `,
 	Run: func(cmd *cobra.Command, args []string) {
 		cmd.Help()

cmd/web.go

@@ -3,41 +3,39 @@ package cmd
 import (
 	"fmt"
 
-	"os"
-	"strconv"
-
-	"github.com/praqma/git-phlow/phlow"
 	"github.com/spf13/cobra"
 
 	"github.com/praqma/git-phlow/cmd/cmdperm"
 	"github.com/praqma/git-phlow/ui"
+	"github.com/praqma/git-phlow/options"
+	"github.com/praqma/git-phlow/phlow"
 )
 
 // webCmd represents the web command
 var webCmd = &cobra.Command{
 	Use:   "web [issue]",
-	Short: "open your issues on github",
+	Short: "open your issues in the browser",
 	Long: fmt.Sprintf(`
-%s opens a GitHub issue or GitHub issue list based on it's arguments.
+%s opens an issue in your default browser
+
+The command uses a targetet configuration to figure out where you have your issues hosted e.g. Github or jira.
+Use the 'issue-web' field in the configuration to point to the url of the issue management system.
+
+The command can take an argument of the issue you want to use.
 If no argument is given, it tries to find the issue of the currently checked out branch, if that fails it simply opens the GitHub issue list in your default browser.
 `, ui.Format.Bold("web")),
 	PreRun: func(cmd *cobra.Command, args []string) {
 		cmdperm.RequiredCurDirRepository()
 	},
 	Run: func(cmd *cobra.Command, args []string) {
-		if len(args) > 0 {
-			if val, err := strconv.Atoi(args[0]); err == nil {
-				phlow.Web(val)
-			} else {
-				fmt.Println("Argument must be a number")
-				os.Exit(0)
-			}
-		} else {
-			phlow.Web(-1)
-		}
+
+		phlow.WebCaller(args)
+
 	},
 }
 
 func init() {
 	RootCmd.AddCommand(webCmd)
+
+	webCmd.Flags().StringVarP(&options.GlobalFlagTarget, "target", "t", "", "the name of the INI block in your .phlow files")
 }

phlow/auth.go

@@ -40,7 +40,7 @@ func Auth(INIBlock string, authorization plugins.Authorization, authentication p
 
 	if token != "" && user != "" {
 		fmt.Printf("Checking token validity for %s... \n", service)
-		isAuthenticated, err := authentication(conf.IssueURL, user, token)
+		isAuthenticated, err := authentication(conf.IssueApi, user, token)
 		if !isAuthenticated {
 			fmt.Println("Token test expected HTTP code 200 but received " + err.Error())
 			if ReadInput("Delete local token and reauthenticate? (y/n): ", os.Stdin) == "y" {
@@ -63,7 +63,7 @@ func Auth(INIBlock string, authorization plugins.Authorization, authentication p
 	//Read user input password
 	password := ReadPassword("password: ")
 
-	token, err = authorization(conf.IssueURL, username, password)
+	token, err = authorization(conf.IssueApi, username, password)
 	if err != nil {
 		fmt.Println()
 		fmt.Println(err)

phlow/web.go

@@ -2,55 +2,106 @@ package phlow
 
 import (
 	"fmt"
-	"os"
-
 	"github.com/praqma/git-phlow/executor"
 	"github.com/praqma/git-phlow/githandler"
-	"github.com/praqma/git-phlow/plugins"
 	"github.com/praqma/git-phlow/setting"
+	"github.com/praqma/git-phlow/options"
+	"runtime"
+	"github.com/praqma/git-phlow/plugins"
 )
 
-//Web ...
-//opens the browser on the current or specified issue
-func Web(userIssue int) {
+//WebCaller ...
+//Executes command to web
+func WebCaller(args []string) {
+	conf := setting.NewProjectStg(options.GlobalFlagTarget)
+
+	var issue = ""
+	if len(args) > 0 {
+		issue = args[0]
+	}
+
+	if conf.Service == "github" {
+		OpenGitHub(issue, conf, plugins.IssueFromBranchName, executor.RunCommand)
+		return
+	}
+
+	if conf.Service == "jira" {
+		OpenJira(issue, conf, plugins.KeyFromBranchName, executor.RunCommand)
+		return
+	}
+
+}
+
+//OpenJira ...
+//try to display jira configuration
+func OpenJira(issue string, conf *setting.ProjectSetting, extractor plugins.IssueExtractor, runner executor.Runner) {
 	git := githandler.Git{Run: executor.RunGit}
-	conf := setting.NewProjectStg("default")
 
-	var issueListURL = "https://github.com/%s/%s/issues"
-	var issueInfoURL = "https://github.com/%s/%s/issues/%d"
+	branch, err := git.Branch()
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+	branchInfo := githandler.AsList(branch)
 
-	//Get organisation and repository for repository
-	remote, err := git.LSRemote("--get-url", conf.Remote)
+	if issue != "" {
+		LaunchBrowser(conf.IssueWeb+"/browse/"+issue, runner)
+		return
+	}
+
+	//No issues to get, just open the browser with the code.. For good measure
+	key, err := extractor(branchInfo.Current)
 	if err != nil {
 		fmt.Println(err)
+		LaunchBrowser(conf.IssueWeb, runner)
 		return
 	}
+	LaunchBrowser(conf.IssueWeb+"/browse/"+key, runner)
+}
+
+//OpenGitHub ...
+//Try to display github issues
+func OpenGitHub(issue string, conf *setting.ProjectSetting, extractor plugins.IssueExtractor, runner executor.Runner) {
+	git := githandler.Git{Run: executor.RunGit}
 
 	branch, err := git.Branch()
 	if err != nil {
 		fmt.Println(err)
 		return
 	}
+
 	branchInfo := githandler.AsList(branch)
+
+	remote, err := git.LSRemote("--get-url", conf.Remote)
+	if err != nil {
+		fmt.Println(err)
+		return
+	}
+
 	orgAndRepo := githandler.OrgAndRepo(remote)
 
-	branchIssue := plugins.IssueFromBranchName(branchInfo.Current)
+	ext := "/" + orgAndRepo.Organisation + "/" + orgAndRepo.Repository
 
-	if userIssue != -1 {
-		issueInfoURL = fmt.Sprintf(issueInfoURL, orgAndRepo.Organisation, orgAndRepo.Repository, userIssue)
-		_, err := executor.RunCommand("open", issueInfoURL)
-		if err != nil {
-			fmt.Println(err)
-		}
-		os.Exit(0)
+	if issue != "" {
+		LaunchBrowser(conf.IssueWeb+ext+"/issues/"+issue, runner)
+		return
 	}
 
-	if branchIssue != "-1" {
-		issueInfoURL = fmt.Sprintf(issueInfoURL, orgAndRepo.Organisation, orgAndRepo.Repository, branchIssue)
-		executor.RunCommand("open", issueInfoURL)
-		os.Exit(0)
+	//No issues to get, just open the browser with the code.. For good measure
+	key, err := extractor(branchInfo.Current)
+	if err != nil {
+		fmt.Println(err)
+		LaunchBrowser(conf.IssueWeb+ext, runner)
+		return
 	}
+	LaunchBrowser(conf.IssueWeb+ext+"/issues/"+key, runner)
+}
+
+func LaunchBrowser(link string, run executor.Runner) {
 
-	issueListURL = fmt.Sprintf(issueListURL, orgAndRepo.Organisation, orgAndRepo.Repository)
-	executor.RunCommand("open", issueListURL)
+	if runtime.GOOS == "windows" {
+		run("explorer", link)
+		return
+	}
+	run("open", link)
 }

phlow/workon.go

@@ -109,20 +109,20 @@ func UpdateJIRAIssue(key string, conf *setting.ProjectSetting) (string, error) {
 	user, _ := git.Config("--get", "phlow.jirauser")
 	token, _ := git.Config("--get", "phlow.jiratoken")
 
-	issue, err := plugins.GetJiraIssue(conf.IssueURL, key, user, token)
+	issue, err := plugins.GetJiraIssue(conf.IssueApi, key, user, token)
 	if err != nil {
 		return "", err
 	}
 
 	var transitionErr error
-	assignErr := plugins.AssignUser(conf.IssueURL, key, user, token)
+	assignErr := plugins.AssignUser(conf.IssueApi, key, user, token)
 
 	//Get transition
-	transition, err := plugins.GetTransitions(conf.IssueURL, key, user, token)
+	transition, err := plugins.GetTransitions(conf.IssueApi, key, user, token)
 	if err == nil {
 		for _, tran := range transition.Transitions {
 			if tran.To.StatusCategory.Name == "In Progress" {
-				transitionErr = plugins.DoTransition(conf.IssueURL, key, user, token, tran.ID)
+				transitionErr = plugins.DoTransition(conf.IssueApi, key, user, token, tran.ID)
 
 				break
 			}
@@ -163,17 +163,17 @@ func UpdateGithubIssue(issue string, conf *setting.ProjectSetting) (string, erro
 
 	oap := githandler.OrgAndRepo(remote)
 
-	issueOb, err := plugins.GetIssueGitHub(conf.IssueURL, oap.Organisation, oap.Repository, issue, token)
+	issueOb, err := plugins.GetIssueGitHub(conf.IssueApi, oap.Organisation, oap.Repository, issue, token)
 	if err != nil {
 		fmt.Println(err)
 		os.Exit(0)
 	}
 
-	if err := plugins.SetAssigneeGitHub(conf.IssueURL, oap.Organisation, oap.Repository, token, issue, user); err != nil {
+	if err := plugins.SetAssigneeGitHub(conf.IssueApi, oap.Organisation, oap.Repository, token, issue, user); err != nil {
 		fmt.Println(err)
 	}
 
-	if _, err := plugins.SetLabelGitHub(conf.IssueURL, oap.Organisation, oap.Repository, token, plugins.PhlowLabels["Status - in progress"].Title, issue); err != nil {
+	if _, err := plugins.SetLabelGitHub(conf.IssueApi, oap.Organisation, oap.Repository, token, plugins.PhlowLabels["Status - in progress"].Title, issue); err != nil {
 		fmt.Println(err)
 	}
 

plugins/plugin.go

@@ -1,9 +1,10 @@
 package plugins
 
 import (
-	"bytes"
 	"regexp"
 	"strings"
+	"strconv"
+	"github.com/go-errors/errors"
 )
 
 //PhlowLabels ...
@@ -61,18 +62,34 @@ func BranchNameFromIssue(issue string, name string) string {
 	return issue + "-" + result
 }
 
+
+
+type IssueExtractor func(branch string) (string, error)
+
+
 //IssueFromBranchName ...
-//Extracts the issue number from the branch name
-func IssueFromBranchName(branch string) string {
-	return strings.Split(branch, "-")[0]
+//Extracts github issue from the branch name. Will error if no issue ID is identified
+func IssueFromBranchName(branch string) (string, error) {
+	arr := strings.Split(branch, "-")
+	_, err := strconv.Atoi(arr[0])
+	if err != nil {
+		return "", errors.New("Could not extract github issue ID from branch")
+	}
+	return arr[0], nil
 }
 
-//efficientConcatString
-//Concatenate strings in an effective way
-func efficientConcatString(args ...string) string {
-	buffer := bytes.Buffer{}
-	for _, str := range args {
-		buffer.WriteString(str)
+//KeyFromBranchName ...
+//Extracts a Jira key from a branch name. Will error if no key is identified
+func KeyFromBranchName(branch string) (string, error) {
+	parts := strings.Split(branch, "-")
+	//Jira issues must have 3 parts PRJ-123-NAME
+	if len(parts) < 3 {
+		return "", errors.New("Could not get Jira Key from branch name")
+	}
+
+	if _, err := strconv.Atoi(parts[0]); err != nil && len(parts) > 1 {
+		return parts[0] + "-" + parts[1], nil
 	}
-	return buffer.String()
+	return "", errors.New("could not get Jira key from branch name")
+
 }