Updated Changelog

Prefer transition names which match exactly

.travis.yml

@@ -6,10 +6,7 @@ go:
 matrix:
     fast_finish: true
 
-before_install:
-    - go get github.com/golang/lint/golint
- 
 script:
-    - go vet -x ./...
-    - $HOME/gopath/bin/golint ./...
+    - make vet
+    - make lint
     - make

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.1.7 - 2016-08-24
+
+* Prefer transition names which match exactly [Don Brower] [[e40f9c1](https://github.com/Netflix-Skunkworks/go-jira/commit/e40f9c1)]
+* update tempates to make them more readable with space trimming added to go-1.6 [Cory Bennett] [[693b3e4](https://github.com/Netflix-Skunkworks/go-jira/commit/693b3e4)]
+
+## 0.1.6 - 2016-08-21
+
+* make "worklogs" command print output through template allow "add worklog" command to open edit template [Cory Bennett] [[cc3fbee](https://github.com/Netflix-Skunkworks/go-jira/commit/cc3fbee)]
+* remove extra newline at end of worklogs template [Cory Bennett] [[d08ef15](https://github.com/Netflix-Skunkworks/go-jira/commit/d08ef15)]
+* adding worklog related templates [Cory Bennett] [[ab1cd27](https://github.com/Netflix-Skunkworks/go-jira/commit/ab1cd27)]
+
 ## 0.1.5 - 2016-08-21
 
 * update for golint [Cory Bennett] [[5a4e17c](https://github.com/Netflix-Skunkworks/go-jira/commit/5a4e17c)]

Makefile

@@ -56,6 +56,17 @@ src/%:
 	test -L $@ || ln -sf '$(GOPATH)' $@
 	go get -v $* $*/main
 
+vet:
+	@go vet .
+	@go vet ./data
+	@go vet ./main
+
+lint:
+	@go get github.com/golang/lint/golint
+	@./bin/golint .
+	@./bin/golint ./data
+	@./bin/golint ./main
+
 cross-setup:
 	for p in $(PLATFORMS); do \
         echo Building for $$p"; \

cli.go

@@ -443,6 +443,16 @@ func (c *Cli) SaveData(data interface{}) error {
 	return nil
 }
 
+// ViewIssueWorkLogs gets the worklog data for the given issue
+func (c *Cli) ViewIssueWorkLogs(issue string) (interface{}, error) {
+	uri := fmt.Sprintf("%s/rest/api/2/issue/%s/worklog", c.endpoint, issue)
+	data, err := responseToJSON(c.get(uri))
+	if err != nil {
+		return nil, err
+	}
+	return data, nil
+}
+
 // ViewIssue will return the details for the given issue id
 func (c *Cli) ViewIssue(issue string) (interface{}, error) {
 	uri := fmt.Sprintf("%s/rest/api/2/issue/%s", c.endpoint, issue)

commands.go

@@ -114,6 +114,68 @@ func (c *Cli) CmdView(issue string) error {
 	return runTemplate(c.getTemplate("view"), data, nil)
 }
 
+// CmdWorklogs will get worklog data for given issue and sent to the "worklogs" template
+func (c *Cli) CmdWorklogs(issue string) error {
+	log.Debugf("worklogs called")
+	c.Browse(issue)
+	data, err := c.ViewIssueWorkLogs(issue)
+	if err != nil {
+		return err
+	}
+	return runTemplate(c.getTemplate("worklogs"), data, nil)
+}
+
+// CmdWorklog will attempt to add (action=add) a worklog to the given issue.
+// It will spawn the editor (unless --noedit isused) and post edited YAML
+// content as JSON to the worklog endpoint
+func (c *Cli) CmdWorklog(action string, issue string) error {
+	log.Debugf("%s worklog called", action)
+	c.Browse(issue)
+	if action == "add" {
+		uri := fmt.Sprintf("%s/rest/api/2/issue/%s/worklog", c.endpoint, issue)
+
+		worklogData := map[string]interface{}{
+			"issue": issue,
+			"comment": c.opts["comment"],
+		}
+
+		if v, ok := c.opts["time-spent"].(string); ok {
+			worklogData["timeSpent"] = v
+		}
+
+		return c.editTemplate(
+			c.getTemplate("worklog"),
+			fmt.Sprintf("%s-worklog-", issue),
+			worklogData,
+			func(json string) error {
+				if c.getOptBool("dryrun", false) {
+					log.Debugf("POST: %s", json)
+					log.Debugf("Dryrun mode, skipping POST")
+					return nil
+				}
+				resp, err := c.post(uri, json)
+				if err != nil {
+					return err
+				}
+				
+				if resp.StatusCode == 201 {
+					c.Browse(issue)
+					if !c.opts["quiet"].(bool) {
+						fmt.Printf("OK %s %s/browse/%s\n", issue, c.endpoint, issue)
+					}
+					return nil
+				}
+				logBuffer := bytes.NewBuffer(make([]byte, 0))
+				resp.Write(logBuffer)
+				err = fmt.Errorf("Unexpected Response From POST")
+				log.Errorf("%s:\n%s", err, logBuffer)
+				return err
+			},
+		)
+	}
+	return nil
+}
+
 // CmdEdit will populate "edit" template with issue data and issue "editmeta" data.
 // Then will parse yaml template and submit data to jira.
 func (c *Cli) CmdEdit(issue string) error {
@@ -604,6 +666,9 @@ func (c *Cli) CmdTransition(issue string, trans string) error {
 			transName = name
 			transID = id
 			transMeta = transition.(map[string]interface{})
+			if strings.ToLower(name) == strings.ToLower(trans) {
+				break
+			}
 		}
 	}
 	if transID == "" {

main/main.go

@@ -56,6 +56,8 @@ func main() {
 Usage:
   jira (ls|list) <Query Options> 
   jira view ISSUE
+  jira worklog ISSUE
+  jira add worklog ISSUE <Worklog Options>
   jira edit [--noedit] <Edit Options> [ISSUE | <Query Options>]
   jira create [--noedit] [-p PROJECT] <Create Options>
   jira DUPLICATE dups ISSUE
@@ -125,6 +127,10 @@ Create Options:
   -m --comment=COMMENT      Comment message for transition
   -o --override=KEY=VAL     Set custom key/value pairs
 
+Worklog Options:
+  -T --time-spent=TIMESPENT Time spent working on issue
+  -m --comment=COMMENT      Comment message for worklog
+
 Command Options:
   -d --directory=DIR        Directory to export templates to (default: %s)
 `, user, defaultQueryFields, defaultMaxResults, defaultSort, user, fmt.Sprintf("%s/.jira.d/templates", home))
@@ -177,6 +183,8 @@ Command Options:
 		"req":              "request",
 		"request":          "request",
 		"vote":             "vote",
+		"worklog":          "worklog",
+		"addworklog":       "addworklog",
 	}
 
 	defaults := map[string]interface{}{
@@ -229,6 +237,7 @@ Command Options:
 		"d|dir|directory=s":     setopt,
 		"M|method=s":            setopt,
 		"S|saveFile=s":          setopt,
+		"T|time-spent=s":        setopt,
 		"Q|quiet":               setopt,
 		"down":                  setopt,
 	})
@@ -482,6 +491,15 @@ Command Options:
 	case "view":
 		requireArgs(1)
 		err = c.CmdView(args[0])
+	case "worklog":
+		if len(args) > 0 && args[0] == "add" {
+			setEditing(true)
+			requireArgs(2)
+			err = c.CmdWorklog(args[0], args[1])
+		} else {
+			requireArgs(1)
+			err = c.CmdWorklogs(args[0])
+		}
 	case "vote":
 		requireArgs(1)
 		if val, ok := opts["down"]; ok {

t/100basic.t

@@ -4,15 +4,15 @@ cd $(dirname $0)
 jira="../jira --project BASIC"
 export JIRA_LOG_FORMAT="%{level:-5s} %{message}"
 
-PLAN 84
-
-# cleanup from previous failed test executions
-($jira ls | awk -F: '{print $1}' | while read issue; do ../jira done $issue; done) | sed 's/^/# CLEANUP: /g'
+PLAN 86
 
 # reset login
 RUNS $jira logout
 echo "gojira123" | RUNS $jira login
 
+# cleanup from previous failed test executions
+($jira ls | awk -F: '{print $1}' | while read issue; do ../jira done $issue; done) | sed 's/^/# CLEANUP: /g'
+
 ###############################################################################
 ## Create an issue
 ###############################################################################
@@ -52,6 +52,19 @@ DIFF <<EOF
 $(printf %-12s $issue:) summary
 EOF
 
+###############################################################################
+## List all issues, using the table template
+###############################################################################
+
+RUNS $jira ls --template table
+DIFF <<EOF
++----------------+---------------------------------------------------------+--------------+--------------+------------+--------------+--------------+
+| Issue          | Summary                                                 | Priority     | Status       | Age        | Reporter     | Assignee     |
++----------------+---------------------------------------------------------+--------------+--------------+------------+--------------+--------------+
+| $(printf %-14s $issue) | summary                                                 | Medium       | To Do        | a minute   | gojira       | gojira       |
++----------------+---------------------------------------------------------+--------------+--------------+------------+--------------+--------------+
+EOF
+
 ###############################################################################
 ## Try to close the issue, bug Basic projects do not allow that state
 ###############################################################################

t/110basic-worklog.t

@@ -0,0 +1,43 @@
+#!/bin/bash
+eval "$(curl -q -s https://raw.githubusercontent.com/coryb/osht/master/osht.sh)"
+cd $(dirname $0)
+jira="../jira --project BASIC"
+export JIRA_LOG_FORMAT="%{level:-5s} %{message}"
+
+PLAN 8
+
+# reset login
+RUNS $jira logout
+echo "gojira123" | RUNS $jira login
+
+# cleanup from previous failed test executions
+($jira ls | awk -F: '{print $1}' | while read issue; do ../jira done $issue; done) | sed 's/^/# CLEANUP: /g'
+
+###############################################################################
+## Create an issue
+###############################################################################
+RUNS $jira create -o summary=summary -o description=description --noedit --saveFile issue.props
+issue=$(awk '/issue/{print $2}' issue.props)
+
+DIFF <<EOF
+OK $issue http://localhost:8080/browse/$issue
+EOF
+
+###############################################################################
+## Add a worklog to an issue
+###############################################################################
+RUNS $jira add worklog $issue --comment "work is hard" --time-spent "1h 12m" --noedit
+DIFF <<EOF
+OK $issue http://localhost:8080/browse/$issue
+EOF
+
+###############################################################################
+## Verify worklog got added to issue
+###############################################################################
+RUNS $jira worklog $issue
+DIFF <<EOF
+- # gojira, a minute ago
+  comment: work is hard
+  timeSpent: 1h 12m
+
+EOF

templates.go

@@ -18,6 +18,8 @@ var allTemplates = map[string]string{
 	"comment":        defaultCommentTemplate,
 	"transition":     defaultTransitionTemplate,
 	"request":        defaultDebugTemplate,
+	"worklog":        defaultWorklogTemplate,
+	"worklogs":       defaultWorklogsTemplate,
 }
 
 const defaultDebugTemplate = "{{ . | toJson}}\n"
@@ -27,34 +29,59 @@ const defaultListTemplate = "{{ range .issues }}{{ .key | append \":\" | printf
 const defaultTableTemplate = `+{{ "-" | rep 16 }}+{{ "-" | rep 57 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+{{ "-" | rep 12 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+
 | {{ "Issue" | printf "%-14s" }} | {{ "Summary" | printf "%-55s" }} | {{ "Priority" | printf "%-12s" }} | {{ "Status" | printf "%-12s" }} | {{ "Age" | printf "%-10s" }} | {{ "Reporter" | printf "%-12s" }} | {{ "Assignee" | printf "%-12s" }} |
 +{{ "-" | rep 16 }}+{{ "-" | rep 57 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+{{ "-" | rep 12 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+
-{{ range .issues }}| {{ .key | printf "%-14s"}} | {{ .fields.summary | abbrev 55 | printf "%-55s" }} | {{.fields.priority.name | printf "%-12s" }} | {{.fields.status.name | printf "%-12s" }} | {{.fields.created | age | printf "%-10s" }} | {{if .fields.reporter}}{{ .fields.reporter.name | printf "%-12s"}}{{else}}<unassigned>{{end}} | {{if .fields.assignee }}{{.fields.assignee.name | printf "%-12s" }}{{else}}<unassigned>{{end}} |
-{{ end }}+{{ "-" | rep 16 }}+{{ "-" | rep 57 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+{{ "-" | rep 12 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+
+{{ range .issues -}}
+  | {{ .key | printf "%-14s"}} | {{ .fields.summary | abbrev 55 | printf "%-55s" }} | {{.fields.priority.name | printf "%-12s" }} | {{.fields.status.name | printf "%-12s" }} | {{.fields.created | age | printf "%-10s" }} | {{if .fields.reporter}}{{ .fields.reporter.name | printf "%-12s"}}{{else}}<unassigned>{{end}} | {{if .fields.assignee }}{{.fields.assignee.name | printf "%-12s" }}{{else}}<unassigned> {{end}} |
+{{ end -}}
++{{ "-" | rep 16 }}+{{ "-" | rep 57 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+{{ "-" | rep 12 }}+{{ "-" | rep 14 }}+{{ "-" | rep 14 }}+
 `
 
-const defaultViewTemplate = `issue: {{ .key }}{{if .fields.created}}
-created: {{ .fields.created | age }} ago{{end}}{{if .fields.status}}
-status: {{ .fields.status.name }}{{end}}
+const defaultViewTemplate = `{{/* view template */ -}}
+issue: {{ .key }}
+{{if .fields.created -}}
+created: {{ .fields.created | age }} ago
+{{end -}}
+{{if .fields.status -}}
+status: {{ .fields.status.name }}
+{{end -}}
 summary: {{ .fields.summary }}
-project: {{ .fields.project.key }}{{if .fields.components}}
-components: {{ range .fields.components }}{{ .name }} {{end}}{{end}}{{if .fields.issuetype}}
-issuetype: {{ .fields.issuetype.name }}{{end}}{{if .fields.assignee}}
-assignee: {{ .fields.assignee.name }}{{end}}
-reporter: {{ if .fields.reporter }}{{ .fields.reporter.name }}{{end}}{{if .fields.customfield_10110}}
-watchers: {{ range .fields.customfield_10110 }}{{ .name }} {{end}}{{end}}{{if .fields.issuelinks}}
+project: {{ .fields.project.key }}
+{{if .fields.components -}}
+components: {{ range .fields.components }}{{ .name }} {{end}}
+{{end -}}
+{{if .fields.issuetype -}}
+issuetype: {{ .fields.issuetype.name }}
+{{end -}}
+{{if .fields.assignee -}}
+assignee: {{ .fields.assignee.name }}
+{{end -}}
+reporter: {{ if .fields.reporter }}{{ .fields.reporter.name }}{{end}}
+{{if .fields.customfield_10110 -}}
+watchers: {{ range .fields.customfield_10110 }}{{ .name }} {{end}}
+{{end -}}
+{{if .fields.issuelinks -}}
 blockers: {{ range .fields.issuelinks }}{{if .outwardIssue}}{{ .outwardIssue.key }}[{{.outwardIssue.fields.status.name}}]{{end}}{{end}}
-depends: {{ range .fields.issuelinks }}{{if .inwardIssue}}{{ .inwardIssue.key }}[{{.inwardIssue.fields.status.name}}]{{end}}{{end}}{{end}}{{if .fields.priority}}
-priority: {{ .fields.priority.name }}{{end}}{{if .fields.votes}}
-votes: {{ .fields.votes.votes}}{{end}}{{if .fields.labels}}
-labels: {{ join ", " .fields.labels }}{{end}}
+depends: {{ range .fields.issuelinks }}{{if .inwardIssue}}{{ .inwardIssue.key }}[{{.inwardIssue.fields.status.name}}]{{end}}{{end}}
+{{end -}}
+{{if .fields.priority -}}
+priority: {{ .fields.priority.name }}
+{{end -}}
+{{if .fields.votes -}}
+votes: {{ .fields.votes.votes}}
+{{end -}}
+{{if .fields.labels -}}
+labels: {{ join ", " .fields.labels }}
+{{end -}}
 description: |
-  {{ or .fields.description "" | indent 2 }}{{if .fields.comment.comments}}
-
+  {{ or .fields.description "" | indent 2 }}
+{{if .fields.comment.comments}}
 comments:
 {{ range .fields.comment.comments }}  - | # {{.author.name}}, {{.created | age}} ago
     {{ or .body "" | indent 4}}
-{{end}}{{end}}
+{{end}}
+{{end -}}
 `
-const defaultEditTemplate = `# issue: {{ .key }}
+const defaultEditTemplate = `{{/* edit template */ -}}
+# issue: {{ .key }}
 update:
   comment:
     - add: 
@@ -67,8 +94,8 @@ fields:
     - name: {{ .name }}{{end}}{{end}}
   assignee:
     name: {{ if .overrides.assignee }}{{.overrides.assignee}}{{else}}{{if .fields.assignee }}{{ .fields.assignee.name }}{{end}}{{end}}
-#	reporter:
-#	  name: {{ if .overrides.reporter }}{{ .overrides.reporter }}{{else if .fields.reporter}}{{ .fields.reporter.name }}{{end}}
+  reporter:
+    name: {{ if .overrides.reporter }}{{ .overrides.reporter }}{{else if .fields.reporter}}{{ .fields.reporter.name }}{{end}}
   # watchers
   customfield_10110: {{ range .fields.customfield_10110 }}
     - name: {{ .name }}{{end}}{{if .overrides.watcher}}
@@ -91,7 +118,8 @@ const defaultComponentsTemplate = `{{ range . }}{{.id }}: {{.name}}
 const defaultIssuetypesTemplate = `{{ range .projects }}{{ range .issuetypes }}{{color "+bh"}}{{.name | append ":" | printf "%-13s" }}{{color "reset"}} {{.description}}
 {{end}}{{end}}`
 
-const defaultCreateTemplate = `fields:
+const defaultCreateTemplate = `{{/* create template */ -}}
+fields:
   project:
     key: {{ or .overrides.project "" }}
   issuetype:
@@ -116,37 +144,77 @@ const defaultCommentTemplate = `body: |~
   {{ or .overrides.comment "" | indent 2 }}
 `
 
-const defaultTransitionTemplate = `update:
+const defaultTransitionTemplate = `{{/* transition template */ -}}
+update:
   comment:
     - add: 
         body: |~
           {{ or .overrides.comment "" | indent 10 }}
-fields:{{if .meta.fields.assignee}}
+fields:
+{{- if .meta.fields.assignee}}
   assignee:
-    name: {{if .overrides.assignee}}{{.overrides.assignee}}{{else}}{{if .fields.assignee}}{{.fields.assignee.name}}{{end}}{{end}}{{end}}{{if .meta.fields.components}}
+    name: {{if .overrides.assignee}}{{.overrides.assignee}}{{else}}{{if .fields.assignee}}{{.fields.assignee.name}}{{end}}{{end}}
+{{- end -}}
+{{if .meta.fields.components}}
   components: # Values: {{ range .meta.fields.components.allowedValues }}{{.name}}, {{end}}{{if .overrides.components }}{{ range (split "," .overrides.components)}}
     - name: {{.}}{{end}}{{else}}{{ range .fields.components }}
-    - name: {{ .name }}{{end}}{{end}}{{end}}{{if .meta.fields.description}}
-  description: {{or .overrides.description .fields.description }}{{end}}{{if .meta.fields.fixVersions}}{{if .meta.fields.fixVersions.allowedValues}}
+    - name: {{ .name }}{{end}}{{end}}
+{{- end -}}
+{{if .meta.fields.description}}
+  description: {{or .overrides.description .fields.description }}
+{{- end -}}
+{{if .meta.fields.fixVersions -}}
+  {{if .meta.fields.fixVersions.allowedValues}}
   fixVersions: # Values: {{ range .meta.fields.fixVersions.allowedValues }}{{.name}}, {{end}}{{if .overrides.fixVersions}}{{ range (split "," .overrides.fixVersions)}}
     - name: {{.}}{{end}}{{else}}{{range .fields.fixVersions}}
-    - name: {{.}}{{end}}{{end}}{{end}}{{end}}{{if .meta.fields.issuetype}}
+    - name: {{.}}{{end}}{{end}}
+  {{- end -}}
+{{- end -}}
+{{if .meta.fields.issuetype}}
   issuetype: # Values: {{ range .meta.fields.issuetype.allowedValues }}{{.name}}, {{end}}
-    name: {{if .overrides.issuetype}}{{.overrides.issuetype}}{{else}}{{if .fields.issuetype}}{{.fields.issuetype.name}}{{end}}{{end}}{{end}}{{if .meta.fields.labels}}
+    name: {{if .overrides.issuetype}}{{.overrides.issuetype}}{{else}}{{if .fields.issuetype}}{{.fields.issuetype.name}}{{end}}{{end}}
+{{- end -}}
+{{if .meta.fields.labels}}
   labels: {{range .fields.labels}}
     - {{.}}{{end}}{{if .overrides.labels}}{{range (split "," .overrides.labels)}}
-    - {{.}}{{end}}{{end}}{{end}}{{if .meta.fields.priority}}
+    - {{.}}{{end}}{{end}}
+{{- end -}}
+{{if .meta.fields.priority}}
   priority: # Values: {{ range .meta.fields.priority.allowedValues }}{{.name}}, {{end}}
-    name: {{ or .overrides.priority "unassigned" }}{{end}}{{if .meta.fields.reporter}}
+    name: {{ or .overrides.priority "unassigned" }}
+{{- end -}}
+{{if .meta.fields.reporter}}
   reporter:
-    name: {{if .overrides.reporter}}{{.overrides.reporter}}{{else}}{{if .fields.reporter}}{{.fields.reporter.name}}{{end}}{{end}}{{end}}{{if .meta.fields.resolution}}
+    name: {{if .overrides.reporter}}{{.overrides.reporter}}{{else}}{{if .fields.reporter}}{{.fields.reporter.name}}{{end}}{{end}}
+{{- end -}}
+{{if .meta.fields.resolution}}
   resolution: # Values: {{ range .meta.fields.resolution.allowedValues }}{{.name}}, {{end}}
-    name: {{if .overrides.resolution}}{{.overrides.resolution}}{{else if .fields.resolution}}{{.fields.resolution.name}}{{else}}{{or .overrides.defaultResolution "Fixed"}}{{end}}{{end}}{{if .meta.fields.summary}}
-  summary: {{or .overrides.summary .fields.summary}}{{end}}{{if .meta.fields.versions.allowedValues}}
+    name: {{if .overrides.resolution}}{{.overrides.resolution}}{{else if .fields.resolution}}{{.fields.resolution.name}}{{else}}{{or .overrides.defaultResolution "Fixed"}}{{end}}
+{{- end -}}
+{{if .meta.fields.summary}}
+  summary: {{or .overrides.summary .fields.summary}}
+{{- end -}}
+{{if .meta.fields.versions.allowedValues}}
   versions: # Values: {{ range .meta.fields.versions.allowedValues }}{{.name}}, {{end}}{{if .overrides.versions}}{{ range (split "," .overrides.versions)}}
     - name: {{.}}{{end}}{{else}}{{range .fields.versions}}
-    - name: {{.}}{{end}}{{end}}{{end}}
+    - name: {{.}}{{end}}{{end}}
+{{- end}}
 transition:
   id: {{ .transition.id }}
   name: {{ .transition.name }}
 `
+
+const defaultWorklogTemplate = `{{/* worklog template */ -}}
+# issue: {{ .issue }}
+comment: |~
+  {{ or .comment "" }}
+timeSpent: {{ or .timeSpent "" }}
+started:
+`
+
+const defaultWorklogsTemplate = `{{/* worklogs template */ -}}
+{{ range .worklogs }}- # {{.author.name}}, {{.created | age}} ago
+  comment: {{ or .comment "" }}
+  timeSpent: {{ .timeSpent }}
+
+{{end}}`