Retrieve issues from both services by MorganEPatch · Pull Request #1 · coreos/issue-sync

MorganEPatch · 2017-07-07T22:30:45Z

Using provided credentials, request a list of GitHub issues updated after a certain time, then the matching list of JIRA issues where they exist. Pair the two lists: for each GitHub issue, if no matching JIRA issue exists, prepare to create it; if an issue exists, prepare to compare the two and update their differences.

Design docs are located at https://docs.google.com/a/coreos.com/document/d/1YjAIqAa-RGC2AZVvlRk1QWbLsJUyt67nIh8lWqKFcK8/edit?usp=sharing.

kans · 2017-07-12T18:52:25Z

+	return nil
+}
+
+type Field struct {


Would you rename this to something more descriptive?

Agreed. Maybe JIRAField?

kans · 2017-07-12T18:58:28Z

+		return err
+	}
+
+	for _, field := range *fields {


What will happen if we don't set ghIDFieldID?

I added checks that these fields exist on the project. Later I can make some of them optional and have the tool recognize that, but for now they're all required. I'll document it in the README when I write that up.

kans · 2017-07-12T18:59:22Z

+	ghIssues, _, err := ghClient.Issues.ListByRepo(ctx, repo[0], repo[1], &github.IssueListByRepoOptions{
+		Since: since,
+		ListOptions: github.ListOptions{
+			PerPage: 100,


Will have to add support for pagination later?

Yes, for now it just operates on the most recent page of results.

kans · 2017-07-12T19:00:39Z

+			if int64(*ghIssue.ID) == id {
+				found = true
+				if err := updateIssue(*ghIssue, jIssue); err != nil {
+					return err


It would probably be better to log this err and keep trucking - (and the same below).

kans · 2017-07-12T20:14:40Z

@LyonesGamer

If you have several more PRs chained after this and don't want to go through rebasing them all multiple times, you could just address the comments in a future PR.

MorganEPatch · 2017-07-12T20:16:46Z

I think it'll be fine; they're all linear, and the comments are mostly small changes so far anyway. They should rebase pretty easily. If there's a comment asking for a big change, I'll probably make it a new PR.

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

 func Execute() {
 	if err := RootCmd.Execute(); err != nil {
-		fmt.Println(err)
+		log.Debugln(err)


Rather than log.Debug followed by os.Exit consider using just log.Fatal. It is more semantic and will appropriately exit the process.

squat · 2017-07-19T16:40:26Z

 	}
 }

+func GetGitHubClient(token string) (*github.Client, error) {


Please document all exported types like this one.

I admit that I should have been documenting all of these as I went, but I did document them all in #11, if that helps.

no, it means that all the PRs until #11 lands are difficult to reason about. Please break up #11 and spread the documentation into each of the previous PRs

squat · 2017-07-19T16:42:12Z

+	// Make a request so we can check that we can connect fine.
+	_, res, err := client.RateLimits(ctx)
+	if err != nil {
+		log.Errorf("Error connecting to GitHub; check your token. Error: %s", err)


It is convention to format errors using %v rather than %s

squat · 2017-07-19T16:42:43Z

+	return client, nil
+}
+
+func GetJIRAClient(username, password, baseURL string) (*jira.Client, error) {


Also document please.

squat · 2017-07-19T16:50:24Z

+	return nil
+}
+
+type JIRAField struct {


Please document this type

squat · 2017-07-19T16:55:01Z

+	return nil
+}
+
+func compareIssues(ghClient github.Client, jiraClient jira.Client) error {


please document this too even though it is not exported. would be nice to know without reading the whole function what this large block of code is trying to accomplish

squat · 2017-07-19T16:57:30Z

+}
+
+func updateIssue(ghIssue github.Issue, jIssue jira.Issue) error {
+	log.Debugf("Updating JIRA issue %s with GitHub issue %d", jIssue.ID, *ghIssue.ID)


these are currently just placeholders?

Yeah, they're just to help show that compareIssues is working until the function bodies are added in future PRs.

squat · 2017-07-19T17:01:15Z

+		return err
+	}
+
+	f, err := os.OpenFile(rootCmdCfg.ConfigFileUsed(), os.O_RDWR|os.O_TRUNC|os.O_CREATE, 0751)


why 751? the config is not executable. 644 sounds more appropriate.

Oops. You're right. I got my permission values mixed up.

squat · 2017-07-19T17:04:20Z

 	rootCmdFile     string
 	rootCmdCfg      *viper.Viper
+
+	since               time.Time // The earliest GitHub issue updates we want to retrieve


In general we try to have as few global variables as possible. Why are all of these floating around vs being collected in a config?

Also, by convention we document types and variables by commenting above the variable: https://blog.golang.org/godoc-documenting-go-code

squat · 2017-07-19T17:09:46Z


 var (
-	log             *logrus.Logger
+	log             *logrus.Entry


Why not logrus.Logger?

Entry is a logger with fields attached, such as the app name that's attached in newLogger().

Yes I understand that theyre different, what I am asking is why did you change? not a big deal. we typically do not use Entry in other projects but it doesn't at all that it is wrong

Using an Entry is how it was done in https://github.com/sym3tri/hookz, which is what I was told to use as a template for this project.

squat · 2017-07-19T17:12:21Z

Overall looks ok, Most troubling is the use of lots of global variables rather than collecting all the configuration.

At this point, all GitHub issues are retrieved, all of their matching JIRA issues are retrieved, and the two are matched in preparation to either create or update the JIRA issues.

Outdated review; the issues have been fixed and approved by another member

MorganEPatch self-assigned this Jul 7, 2017

MorganEPatch changed the title ~~[WIP] Base synchronizing functionality~~ [WIP] Retrieve issues from both services Jul 7, 2017

MorganEPatch changed the title ~~[WIP] Retrieve issues from both services~~ Retrieve issues from both services Jul 7, 2017

MorganEPatch mentioned this pull request Jul 10, 2017

Create JIRA issues from unmatched GitHub issues #2

Merged

MorganEPatch requested review from kans and removed request for kans July 11, 2017 23:24

kans previously requested changes Jul 12, 2017

View reviewed changes

squat suggested changes Jul 19, 2017

View reviewed changes

squat approved these changes Jul 20, 2017

View reviewed changes

synchronize command: Add structure to connect and compare

e357810

At this point, all GitHub issues are retrieved, all of their matching JIRA issues are retrieved, and the two are matched in preparation to either create or update the JIRA issues.

MorganEPatch merged commit b77ece9 into coreos:master Jul 20, 2017

reapazor mentioned this pull request Jan 10, 2018

Issue with JIRA Cloud (Kanban) #28

Open

Conversation

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

Uh oh!

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!

kans commented Jul 12, 2017

Uh oh!

MorganEPatch commented Jul 12, 2017

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!

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!

MorganEPatch Jul 19, 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 19, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MorganEPatch commented Jul 7, 2017 •

edited

Loading

MorganEPatch Jul 19, 2017 •

edited

Loading