Create comments in JIRA after create and update #6

MorganEPatch · 2017-07-11T23:22:24Z

This PR builds on #4, and is thus blocked on it.

This PR adds the createComments() function, which adds any new comments on a given GitHub issue to the to given JIRA issue, and updates existing issues if they've been edited on GitHub. Currently, the comment is made by the user under which the tool is running.

squat

This looks good overall, however, the updateComment, createComment etc functions must be broken out into a new file, preferably in a new package. this file in unwieldy and contains code that is not relevant to cmd handling

squat · 2017-07-19T17:34:14Z

cmd/root.go

+	}
+
+	ctx := context.Background()
+	repo := strings.Split(rootCmdCfg.GetString("repo-name"), "/")


you do this same parsing in multiple places. repo should be a field on a config object so it can be reused.

squat · 2017-07-19T17:47:39Z

cmd/root.go

+		return err
+	}
+
+	res, err := jClient.Do(req, nil) // Response should be 204 No Content


if it should be 204, why not confirm it by comparing to http.StatusNoContent?

squat · 2017-07-19T17:48:58Z

cmd/root.go

+	res, err := jClient.Do(req, nil) // Response should be 204 No Content
+	if err != nil {
+		log.Errorf("Error updating comment: %s", err)
+		body, _ := ioutil.ReadAll(res.Body)


do not ignore the error returned by ReadAll; handle it as necessary

squat · 2017-07-19T17:49:05Z

cmd/root.go

+		return err
+	} else if err = jira.CheckResponse(res.Response); err != nil {
+		log.Errorf("Error updating comment: %s", err)
+		body, _ := ioutil.ReadAll(res.Body)


squat · 2017-07-19T17:50:56Z

cmd/root.go

+	jComment, res, err := jClient.Issue.AddComment(jIssue.ID, jComment)
+	if err != nil {
+		log.Errorf("Error creating JIRA comment on issue %s. Error: %s", jIssue.Key, err)
+		body, _ := ioutil.ReadAll(res.Body)


squat

almost there

squat · 2017-07-20T22:04:16Z

cmd/root.go

-				if err := updateIssue(*ghIssue, jIssue, jiraClient); err != nil {
-					log.Errorf("Error updating issue %s. Error: %v", jIssue.Key, err)
+				if err := updateIssue(*ghIssue, jIssue, ghClient, jiraClient); err != nil {
+					log.Errorf("Error updating issue %s. Error: %s", jIssue.Key, err)


could you format the error with %v

squat · 2017-07-20T22:06:01Z

cmd/root.go

+		Direction: "asc",
+	})
+	if err != nil {
+		log.Errorf("Error retrieving GitHub comments for issue #%d. Error: %s.", *ghIssue.Number, err)


squat · 2017-07-20T22:07:19Z

cmd/root.go

+
+	user, _, err := ghClient.Users.Get(context.Background(), *ghComment.User.Login)
+	if err != nil {
+		log.Errorf("Error retrieving GitHub user %s. Error: %s", *ghComment.User.Login, err)


same formatting change here.

squat · 2017-07-20T22:11:37Z

cmd/root.go

+		log.Errorf("Error retrieving GitHub user %s. Error: %s", *ghComment.User.Login, err)
+	}
+	body := fmt.Sprintf("Comment (ID %d) from GitHub user %s", *ghComment.ID, user.GetLogin())
+	if user.GetName() != "" {


To simplify this a little bit, how about making the only bit that is conditioned on GetName() != "" be the part that actually appends the username:

if user.GetName() != "" { body - fmt.Sprintf("%s (%s)", body, user.GetName()) } body = fmt.Sprintf( "%s at %s:\n\n%s", body, ghComment.CreatedAt.Format(commentDateFormat), *ghComment.Body, )

This cleans up the logic, de-dupes the code and shortens everything a little.

squat · 2017-07-20T22:12:48Z

cmd/root.go

+		Body: body,
+	}
+
+	req, err := jClient.NewRequest("PUT", fmt.Sprintf("rest/api/2/issue/%s/comment/%s", jIssue.Key, jComment.ID), request)


please add a TODO

TODO(LyonesGamer): abstract this into its own method

squat · 2017-07-20T22:15:13Z

cmd/root.go

+
+	jComment, res, err := jClient.Issue.AddComment(jIssue.ID, jComment)
+	if err != nil {
+		log.Errorf("Error creating JIRA comment on issue %s. Error: %s", jIssue.Key, err)


squat · 2017-07-20T22:20:25Z

cmd/root.go

+			}
+			found = true
+
+			updateComment(*ghComment, jComment, jIssue, ghClient, jClient)


if you have 20 Jira comments and you find the GitHub comment on the first 1, you will loop over the remaining 19 comments. Instead, you should break after updateComment.

squat · 2017-07-20T22:33:35Z

cmd/root.go

+	var comments []jira.Comment
+	if issue.Fields.Comments == nil {
+		log.Debugf("JIRA issue %s has no comments.", jIssue.Key)
+		comments = make([]jira.Comment, 0)


you do not need to call make on the slice; in fact, you are allocating an array that will never be used. if you need to append elements to the slice, the built-in append function will lazily allocate and re-allocate a backing array for the slice as needed.

squat · 2017-07-20T22:35:52Z

cmd/root.go

 	"time"

+	"regexp"
+


there should not be any newlines between these stdlibs

squat · 2017-07-20T22:36:07Z

cmd/root.go

+	"strconv"
+
+	"net/http"
+


this newline separating stdlib and remote imports is good

squat · 2017-07-20T23:31:30Z

cmd/root.go

+	var comments []jira.Comment
+	if issue.Fields.Comments == nil {
+		log.Debugf("JIRA issue %s has no comments.", jIssue.Key)
+		comments = nil


you should delete this line entirely; it is not needed

Oops. Yep, that's a holdover from C programming, and the assumption that var comments []jira.Comment will leave comments uninitialized and unusable.

squat · 2017-07-20T23:34:07Z

Thanks for making those changes. Thoughts on: #6 (comment)?

squat · 2017-07-20T23:42:25Z

@LyonesGamer one last thing: #6 (comment)

MorganEPatch · 2017-07-20T23:45:42Z

Oops. Can't believe I missed that one.

MorganEPatch · 2017-07-20T23:47:02Z

@squat 👍

squat

Just gave it one last look and I found two last things that slipped through. Once these are done, lets squash and merge.

squat · 2017-07-20T23:50:38Z

cmd/root.go

+		if err != nil {
+			log.Errorf("Error updating JIRA issue %s: %v", jIssue.Key, err)
+			defer res.Body.Close()
+			body, _ := ioutil.ReadAll(res.Body)


Just realized this one slipped through the cracks

I hate it when I accidentally revert a fix I've already made... 😞

squat · 2017-07-20T23:50:55Z

cmd/root.go

-		log.Errorf("Error creating JIRA issue: %s", err)
+		log.Errorf("Error creating JIRA issue: %v", err)
 		defer res.Body.Close()
 		body, _ := ioutil.ReadAll(res.Body)


And this one too

This PR adds the createComments, createComment, and updateComment functions, which add any new comments from a GitHub issue to a JIRA issue, and updates existing ones if they've been edited. The comments are created by the user running the tool; a header will be created to track metadata.

MorganEPatch · 2017-07-20T23:58:05Z

@squat Fixed, squashed, and ready to merge!

squat · 2017-07-20T23:59:29Z

MorganEPatch self-assigned this Jul 11, 2017

MorganEPatch mentioned this pull request Jul 17, 2017

Create a README #8

Merged

squat suggested changes Jul 19, 2017

View reviewed changes

squat suggested changes Jul 20, 2017

View reviewed changes

squat reviewed Jul 20, 2017

View reviewed changes

squat suggested changes Jul 20, 2017

View reviewed changes

squat approved these changes Jul 20, 2017

View reviewed changes

MorganEPatch merged commit 99678ca into coreos:master Jul 20, 2017

Create comments in JIRA after create and update #6

Create comments in JIRA after create and update #6

Conversation

MorganEPatch commented Jul 11, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

squat left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

squat left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

squat Jul 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

squat commented Jul 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

squat commented Jul 20, 2017

Uh oh!

MorganEPatch commented Jul 20, 2017

Uh oh!

MorganEPatch commented Jul 20, 2017

Uh oh!

squat left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MorganEPatch commented Jul 20, 2017

Uh oh!

squat commented Jul 20, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MorganEPatch commented Jul 11, 2017 •

edited

Loading

squat Jul 20, 2017 •

edited

Loading

squat commented Jul 20, 2017 •

edited

Loading