Uh oh!
There was an error while loading. Please reload this page.
Create a configuration object - #13
Conversation
squat
left a comment
There was a problem hiding this comment.
Overall looks good, @LyonesGamer! This is a much needed restructuring. Please re-arrange the remaining functions and then we can merge this.
| // API. | ||
| func createComment(ghComment github.IssueComment, jIssue jira.Issue, ghClient github.Client, jClient jira.Client) error { | ||
| u, _, err := makeGHRequest(func() (interface{}, *github.Response, error) { | ||
| func createComment(config lib.Config, ghComment github.IssueComment, jIssue jira.Issue, ghClient github.Client, jClient jira.Client) error { |
There was a problem hiding this comment.
all of these functions that are not directly concerned with configuring and launching the command should be outside of this file and package. this function should be in lib.
| // updateComment compares the body of a GitHub comment with the body (minus header) | ||
| // of the JIRA comment, and updates the JIRA comment if necessary. | ||
| func updateComment(ghComment github.IssueComment, jComment jira.Comment, jIssue jira.Issue, ghClient github.Client, jClient jira.Client) error { | ||
| func updateComment(config lib.Config, ghComment github.IssueComment, jComment jira.Comment, jIssue jira.Issue, ghClient github.Client, jClient jira.Client) error { |
There was a problem hiding this comment.
same: all of these functions that are not directly concerned with configuring and launching the command should be outside of this file and package. this function should be in lib.
| // matches each one to a comment in `existing`. If it finds a match, it calls | ||
| // updateComment; if it doesn't, it calls createComment. | ||
| func createComments(ghIssue github.Issue, jIssue jira.Issue, existing []jira.Comment, ghClient github.Client, jClient jira.Client) error { | ||
| func createComments(config lib.Config, ghIssue github.Issue, jIssue jira.Issue, existing []jira.Comment, ghClient github.Client, jClient jira.Client) error { |
There was a problem hiding this comment.
same: all of these functions that are not directly concerned with configuring and launching the command should be outside of this file and package. this function should be in lib.
| // createIssue generates a JIRA issue from the various fields on the given GitHub issue, then | ||
| // sends it to the JIRA API. | ||
| func createIssue(issue github.Issue, ghClient github.Client, jClient jira.Client) error { | ||
| func createIssue(config lib.Config, issue github.Issue, ghClient github.Client, jClient jira.Client) error { |
There was a problem hiding this comment.
same: all of these functions that are not directly concerned with configuring and launching the command should be outside of this file and package. this function should be in lib.
| // differ, the differing fields of the JIRA issue are updated to match the GitHub | ||
| // issue. | ||
| func updateIssue(ghIssue github.Issue, jIssue jira.Issue, ghClient github.Client, jClient jira.Client) error { | ||
| func updateIssue(config lib.Config, ghIssue github.Issue, jIssue jira.Issue, ghClient github.Client, jClient jira.Client) error { |
There was a problem hiding this comment.
same: all of these functions that are not directly concerned with configuring and launching the command should be outside of this file and package. this function should be in lib.
| // then matches each one. If a JIRA issue already exists for a given GitHub issue, | ||
| // it calls updateIssue; if no JIRA issue already exists, it calls createIssue. | ||
| func compareIssues(ghClient github.Client, jiraClient jira.Client) error { | ||
| func compareIssues(config lib.Config, ghClient github.Client, jiraClient jira.Client) error { |
There was a problem hiding this comment.
all of these functions that are not directly concerned with configuring and launching the command should be outside of this file and package. this function should be in lib.
| // then makes an API request to confirm that the service is running and the auth token | ||
| // is valid | ||
| func getGitHubClient(token string) (*github.Client, error) { | ||
| func getGitHubClient(config lib.Config) (*github.Client, error) { |
There was a problem hiding this comment.
this should be part of the the clients file. lib should know how to create a new github client given a config.
There was a problem hiding this comment.
This should have been moved to the clients file. Some weird issue must have happened during rebasing or something...
| // | ||
| // The validity of the client and its authentication are not checked here. One way | ||
| // to check them would be to call config.LoadJIRAConfig() after this function. | ||
| func getJIRAClient(config lib.Config) (*jira.Client, error) { |
There was a problem hiding this comment.
this should be part of the the clients file. lib should know how to create a new jira client given a config.
MorganEPatch
commented
Aug 7, 2017
squat
left a comment
There was a problem hiding this comment.
This repo is starting to look much better. Just a few small comments.
| // GetGitHubClient initializes a GitHub API client with an OAuth client for authentication, | ||
| // then makes an API request to confirm that the service is running and the auth token | ||
| // is valid |
| // Execute provides a single function to run the root command and handle errors. | ||
| func Execute() { | ||
| // Create a temporary logger that we can use if an error occurs before the real one is instantiated |
| found := false | ||
| for _, jIssue := range jiraIssues { | ||
| id, _ := jIssue.Fields.Unknowns.Int(fmt.Sprintf("customfield_%s", ghIDFieldID)) | ||
| id, _ := jIssue.Fields.Unknowns.Int(config.GetFieldKey(lib.GitHubID)) |
There was a problem hiding this comment.
It's suppressing the error that the issue doesn't have the GitHub ID set; that can't happen since we filtered it by the GitHub ID. I'll add an error handler though, I suppose weird API errors are never unheard of.
| lastUpdate string | ||
| } | ||
| // Config is the root configuration object the application creates |
| // Config is the root configuration object the application creates | ||
| type Config struct { | ||
| // cmdFile is the file Viper is using for its configuration (default $HOME/.issue-sync.json) |
There was a problem hiding this comment.
make all of these comments full sentences please
| // NewConfig creates a new, immutable configuration object. This object | ||
| // holds the Viper configuration and the logger, and is validated. The | ||
| // JIRA configuration is not yet initialized |
MorganEPatch
commented
Aug 7, 2017
@squat Fixed. |
Create a new Config object which represents the current application configuration. It stores both the viper configuration and computed configuration values such as the custom field IDs. Also, move API client related functions into a new lib file to make them accessible to the whole application without circular imports.
Depends on #11.
Move the configuration out of global variables and into a configuration object. Also begin moving other utility functions into lib/.