feat: dry-run option

Author: psmarcin

cmd/jira-versioner/main.go

@@ -37,6 +37,7 @@ func init() {
 	rootCmd.Flags().StringP("jira-project", "p", "", "Jira project, it has to be ID, example: 10003")
 	rootCmd.Flags().StringP("jira-base-url", "u", "", "Jira service base url, example: https://example.atlassian.net")
 	rootCmd.Flags().StringP("dir", "d", pwd, "Absolute directory path to git repository")
+	rootCmd.Flags().BoolP("dry-run", "", false, "Enable dry run mode")
 	rootCmd.MarkFlagRequired("tag")
 	rootCmd.MarkFlagRequired("jira-email")
 	rootCmd.MarkFlagRequired("jira-token")
@@ -52,6 +53,7 @@ func main() {
 
 func rootFunc(c *cobra.Command, args []string) {
 	log := zap.NewExample().Sugar()
+	dryRun := false
 	defer log.Sync()
 
 	tag := c.Flag("tag").Value.String()
@@ -65,8 +67,23 @@ func rootFunc(c *cobra.Command, args []string) {
 	jiraToken := c.Flag("jira-token").Value.String()
 	jiraProject := c.Flag("jira-project").Value.String()
 	jiraBaseUrl := c.Flag("jira-base-url").Value.String()
+	dryRunRaw := c.Flag("dry-run").Value.String()
+	if dryRunRaw == "true" {
+		dryRun = true
+	}
 	gitDir := c.Flag("dir").Value.String()
-	log.Debugf("[JIRA-VERSIONER] starting with params jira-email: %s, jira-token: %s, jira-project: %s, jira-base-url: %s, dir: %s, tag: %s, jira-version: %s", jiraEmail, jiraToken, jiraProject, jiraBaseUrl, gitDir, tag, version)
+
+	log.Debugf(
+		"[JIRA-VERSIONER] starting with params jira-email: %s, jira-token: %s, jira-project: %s, jira-base-url: %s, dir: %s, tag: %s, jira-version: %s, dry-run: %t",
+		jiraEmail,
+		jiraToken,
+		jiraProject,
+		jiraBaseUrl,
+		gitDir,
+		tag,
+		version,
+		dryRun,
+	)
 	log.Infof("[JIRA-VERSIONER] git directory: %s", gitDir)
 
 	g := git.New(gitDir, log)
@@ -76,7 +93,15 @@ func rootFunc(c *cobra.Command, args []string) {
 		log.Fatalf("[GIT] error while getting tasks since latest commit %+v", err)
 	}
 
-	j, err := jira.New(jiraEmail, jiraToken, jiraProject, jiraBaseUrl, log)
+	var jiraConfig = jira.NewConfig{
+		Username:  jiraEmail,
+		Token:     jiraToken,
+		ProjectID: jiraProject,
+		BaseURL:   jiraBaseUrl,
+		Log:       log,
+		DryRun:    dryRun,
+	}
+	j, err := jira.New(jiraConfig)
 	if err != nil {
 		log.Fatalf("[VERSION] error while connecting to jira server %+v", err)
 	}

pkg/jira/jira.go

@@ -17,6 +17,7 @@ type Jira struct {
 	ProjectID string
 	Version   *jira.Version
 	log       pslog.Logger
+	dryRun    bool
 }
 
 type UpdatePayload struct {
@@ -33,24 +34,34 @@ type IdVersion struct {
 	Id string `json:"id"`
 }
 
-// New creates Jira instance with all required details like email, token, base url
-func New(email, token, projectId, baseUrl string, log pslog.Logger) (Jira, error) {
+type NewConfig struct {
+	Username  string
+	Token     string
+	ProjectID string
+	BaseURL   string
+	Log       pslog.Logger
+	DryRun    bool
+}
+
+// New creates Jira instance with all required details like email, Token, base url
+func New(config NewConfig) (Jira, error) {
 	j := Jira{
-		log: log,
+		log:    config.Log,
+		dryRun: config.DryRun,
 	}
 	tp := jira.BasicAuthTransport{
-		Username: email,
-		Password: token,
+		Username: config.Username,
+		Password: config.Token,
 	}
 
-	client, err := jira.NewClient(tp.Client(), baseUrl)
+	client, err := jira.NewClient(tp.Client(), config.BaseURL)
 	if err != nil {
 		return j, err
 	}
 
 	j.Client = client
 
-	_, err = j.getProject(projectId)
+	_, err = j.getProject(config.ProjectID)
 	if err != nil {
 		return j, err
 	}
@@ -116,12 +127,15 @@ func (j *Jira) CreateVersion(name string) (*jira.Version, error) {
 		// TODO: put task ids into description
 		Description: "",
 	}
-	version, _, err = j.Client.Version.Create(v)
-	if err != nil {
-		return v, err
+
+	if !j.dryRun {
+		v, _, err = j.Client.Version.Create(v)
+		if err != nil {
+			return v, err
+		}
 	}
 
-	j.Version = version
+	j.Version = v
 
 	j.log.Infof("[JIRA] version created %s", j.Version.Name)
 
@@ -142,6 +156,7 @@ func (j Jira) LinkTasksToVersion(taskIds []string) {
 
 // SetIssueVersion makes http request to Jira service to update task with fixed version
 func (j Jira) SetIssueVersion(taskID string) error {
+	var res *jira.Response
 	p := UpdatePayload{
 		Update: UpdateTypePayload{
 			FixVersions: []AddFixedVersion{
@@ -155,9 +170,16 @@ func (j Jira) SetIssueVersion(taskID string) error {
 	}
 
 	j.log.Debugf("[JIRA] setting version %s for task %s", j.Version.Name, taskID)
-	req, _ := j.Client.NewRequest("PUT", "/rest/api/2/issue/"+taskID, p)
+	req, err := j.Client.NewRequest("PUT", "/rest/api/2/issue/"+taskID, p)
+	if err != nil {
+		return errors.Wrapf(err, "can't create Jira request to %s", "/rest/api/2/issue/"+taskID)
+	}
 	req.Header.Add("Content-Type", "application/json;charset=UTF-8")
-	res, err := j.Client.Do(req, nil)
+
+	if !j.dryRun {
+		res, err = j.Client.Do(req, nil)
+	}
+
 	if err != nil {
 		body, readErr := ioutil.ReadAll(res.Body)
 		if readErr != nil {