[Feature Request] github milestone resource and data source (#470)

* add milestone resource and data source

* fix misspell

* rebase and fix build errors

- update to go-github v32
- use `Owner` instead of `Organization`

* update test suite

Co-authored-by: Jeremy Udit <[email protected]>

github/data_source_github_repository_milestone.go

@@ -0,0 +1,66 @@
+package github
+
+import (
+	"context"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"strconv"
+)
+
+func dataSourceGithubRepositoryMilestone() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceGithubRepositoryMilestoneRead,
+
+		Schema: map[string]*schema.Schema{
+			"owner": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"repository": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"number": {
+				Type:     schema.TypeInt,
+				Required: true,
+			},
+			"description": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"due_date": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"state": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+			"title": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+		},
+	}
+}
+
+func dataSourceGithubRepositoryMilestoneRead(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*Owner).v3client
+	ctx := context.Background()
+
+	owner := d.Get("owner").(string)
+	repoName := d.Get("repository").(string)
+
+	number := d.Get("number").(int)
+	milestone, _, err := conn.Issues.GetMilestone(ctx, owner, repoName, number)
+	if err != nil {
+		return err
+	}
+
+	d.SetId(strconv.FormatInt(milestone.GetID(), 10))
+	d.Set("description", milestone.GetDescription())
+	d.Set("due_date", milestone.GetDueOn().Format(layoutISO))
+	d.Set("state", milestone.GetState())
+	d.Set("title", milestone.GetTitle())
+
+	return nil
+}

github/data_source_github_repository_milestone_test.go

@@ -0,0 +1,74 @@
+package github
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/acctest"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+)
+
+func TestAccGithubRepositoryMilestoneDataSource(t *testing.T) {
+
+	randomID := acctest.RandStringFromCharSet(5, acctest.CharSetAlphaNum)
+
+	t.Run("queries a repository milestone", func(t *testing.T) {
+
+		config := fmt.Sprintf(`
+
+			resource "github_repository" "test" {
+				name      = "tf-acc-test-%s"
+			}
+
+			resource "github_repository_milestone" "test" {
+				owner = split("/", "${github_repository.test.full_name}")[0]
+				repository = github_repository.test.name
+		    title = "v1.0.0"
+		    description = "General Availability"
+		    due_date = "2020-11-22"
+		    state = "closed"
+			}
+
+			data "github_repository_milestone" "test" {
+				owner = github_repository_milestone.test.owner
+				repository = github_repository_milestone.test.repository
+		   	number = github_repository_milestone.test.number
+			}
+
+		`, randomID)
+
+		check := resource.ComposeTestCheckFunc(
+			resource.TestCheckResourceAttr(
+				"github_repository_milestone.test", "state",
+				"closed",
+			),
+		)
+
+		testCase := func(t *testing.T, mode string) {
+			resource.Test(t, resource.TestCase{
+				PreCheck:  func() { skipUnlessMode(t, mode) },
+				Providers: testAccProviders,
+				Steps: []resource.TestStep{
+					{
+						Config: config,
+						Check:  check,
+					},
+				},
+			})
+		}
+
+		t.Run("with an anonymous account", func(t *testing.T) {
+			t.Skip("anonymous account not supported for this operation")
+		})
+
+		t.Run("with an individual account", func(t *testing.T) {
+			testCase(t, individual)
+		})
+
+		t.Run("with an organization account", func(t *testing.T) {
+			testCase(t, organization)
+		})
+
+	})
+}

github/provider.go

@@ -54,6 +54,7 @@ func Provider() terraform.ResourceProvider {
 			"github_repository_collaborator":     resourceGithubRepositoryCollaborator(),
 			"github_repository_deploy_key":       resourceGithubRepositoryDeployKey(),
 			"github_repository_file":             resourceGithubRepositoryFile(),
+			"github_repository_milestone":        resourceGithubRepositoryMilestone(),
 			"github_repository_project":          resourceGithubRepositoryProject(),
 			"github_repository_webhook":          resourceGithubRepositoryWebhook(),
 			"github_repository":                  resourceGithubRepository(),
@@ -77,6 +78,7 @@ func Provider() terraform.ResourceProvider {
 			"github_release":                       dataSourceGithubRelease(),
 			"github_repositories":                  dataSourceGithubRepositories(),
 			"github_repository":                    dataSourceGithubRepository(),
+			"github_repository_milestone":          dataSourceGithubRepositoryMilestone(),
 			"github_team":                          dataSourceGithubTeam(),
 			"github_user":                          dataSourceGithubUser(),
 		},

github/resource_github_repository_milestone.go

@@ -0,0 +1,233 @@
+package github
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"net/http"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/google/go-github/v32/github"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/validation"
+)
+
+func resourceGithubRepositoryMilestone() *schema.Resource {
+	return &schema.Resource{
+		Create: resourceGithubRepositoryMilestoneCreate,
+		Read:   resourceGithubRepositoryMilestoneRead,
+		Update: resourceGithubRepositoryMilestoneUpdate,
+		Delete: resourceGithubRepositoryMilestoneDelete,
+		Importer: &schema.ResourceImporter{
+			State: func(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
+				parts := strings.Split(d.Id(), "/")
+				if len(parts) != 3 || parts[0] == "" || parts[1] == "" || parts[2] == "" {
+					return nil, fmt.Errorf("Invalid ID format, must be provided as OWNER/REPOSITORY/NUMBER")
+				}
+				d.Set("owner", parts[0])
+				d.Set("repository", parts[1])
+				number, err := strconv.Atoi(parts[2])
+				if err != nil {
+					return nil, err
+				}
+				d.Set("number", number)
+				d.SetId(fmt.Sprintf("%s/%s/%d", parts[0], parts[1], number))
+
+				return []*schema.ResourceData{d}, nil
+			},
+		},
+
+		Schema: map[string]*schema.Schema{
+			"title": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"owner": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"repository": {
+				Type:     schema.TypeString,
+				Required: true,
+			},
+			"description": {
+				Type:     schema.TypeString,
+				Optional: true,
+			},
+			"due_date": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "in yyyy-mm-dd format",
+			},
+			"state": {
+				Type:     schema.TypeString,
+				Optional: true,
+				ValidateFunc: validation.StringInSlice([]string{
+					"open", "closed",
+				}, true),
+				Default: "open",
+			},
+			"number": {
+				Type:     schema.TypeInt,
+				Computed: true,
+			},
+		},
+	}
+}
+
+const (
+	layoutISO = "2006-01-02"
+)
+
+func resourceGithubRepositoryMilestoneCreate(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*Owner).v3client
+	ctx := context.Background()
+	owner := d.Get("owner").(string)
+	repoName := d.Get("repository").(string)
+
+	milestone := &github.Milestone{
+		Title: github.String(d.Get("title").(string)),
+	}
+
+	if v, ok := d.GetOk("description"); ok && len(v.(string)) > 0 {
+		milestone.Description = github.String(v.(string))
+	}
+	if v, ok := d.GetOk("due_date"); ok && len(v.(string)) > 0 {
+		dueDate, err := time.Parse(layoutISO, v.(string))
+		if err != nil {
+			return err
+		}
+		date := time.Date(dueDate.Year(), dueDate.Month(), dueDate.Day(), 23, 39, 0, 0, time.UTC)
+		milestone.DueOn = &date
+	}
+	if v, ok := d.GetOk("state"); ok && len(v.(string)) > 0 {
+		milestone.State = github.String(v.(string))
+	}
+
+	log.Printf("[DEBUG] Creating milestone for repository: %s/%s", owner, repoName)
+	milestone, _, err := conn.Issues.CreateMilestone(ctx, owner, repoName, milestone)
+	if err != nil {
+		return err
+	}
+
+	d.SetId(fmt.Sprintf("%s/%s/%d", owner, repoName, milestone.GetNumber()))
+
+	return resourceGithubRepositoryMilestoneRead(d, meta)
+}
+
+func resourceGithubRepositoryMilestoneRead(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*Owner).v3client
+	ctx := context.WithValue(context.Background(), ctxId, d.Id())
+
+	owner := d.Get("owner").(string)
+	repoName := d.Get("repository").(string)
+	number, err := parseMilestoneNumber(d.Id())
+	if err != nil {
+		return err
+	}
+
+	log.Printf("[DEBUG] Reading milestone for repository: %s/%s", owner, repoName)
+	milestone, _, err := conn.Issues.GetMilestone(ctx, owner, repoName, number)
+	if err != nil {
+		if ghErr, ok := err.(*github.ErrorResponse); ok {
+			if ghErr.Response.StatusCode == http.StatusNotModified {
+				return nil
+			}
+			if ghErr.Response.StatusCode == http.StatusNotFound {
+				log.Printf("[WARN] Removing milestone for %s/%s from state because it no longer exists in GitHub",
+					owner, repoName)
+				d.SetId("")
+				return nil
+			}
+		}
+		return err
+	}
+
+	d.Set("title", milestone.GetTitle())
+	d.Set("description", milestone.GetDescription())
+	d.Set("number", milestone.GetNumber())
+	d.Set("state", milestone.GetState())
+	if dueOn := milestone.GetDueOn(); !dueOn.IsZero() {
+		d.Set("due_date", milestone.GetDueOn().Format(layoutISO))
+	}
+
+	return nil
+}
+
+func resourceGithubRepositoryMilestoneUpdate(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*Owner).v3client
+	ctx := context.WithValue(context.Background(), ctxId, d.Id())
+	owner := d.Get("owner").(string)
+	repoName := d.Get("repository").(string)
+	number, err := parseMilestoneNumber(d.Id())
+	if err != nil {
+		return err
+	}
+
+	milestone := &github.Milestone{}
+	if d.HasChanges("title") {
+		_, n := d.GetChange("title")
+		milestone.Title = github.String(n.(string))
+	}
+
+	if d.HasChanges("description") {
+		_, n := d.GetChange("description")
+		milestone.Description = github.String(n.(string))
+	}
+
+	if d.HasChanges("due_date") {
+		_, n := d.GetChange("due_date")
+		dueDate, err := time.Parse(layoutISO, n.(string))
+		if err != nil {
+			return err
+		}
+		date := time.Date(dueDate.Year(), dueDate.Month(), dueDate.Day(), 7, 0, 0, 0, time.UTC)
+		milestone.DueOn = &date
+	}
+
+	if d.HasChanges("state") {
+		_, n := d.GetChange("state")
+		milestone.State = github.String(n.(string))
+	}
+
+	log.Printf("[DEBUG] Updating milestone for repository: %s/%s", owner, repoName)
+	_, _, err = conn.Issues.EditMilestone(ctx, owner, repoName, number, milestone)
+	if err != nil {
+		return err
+	}
+
+	return resourceGithubRepositoryMilestoneRead(d, meta)
+}
+
+func resourceGithubRepositoryMilestoneDelete(d *schema.ResourceData, meta interface{}) error {
+	conn := meta.(*Owner).v3client
+	ctx := context.WithValue(context.Background(), ctxId, d.Id())
+	owner := d.Get("owner").(string)
+	repoName := d.Get("repository").(string)
+	number, err := parseMilestoneNumber(d.Id())
+	if err != nil {
+		return err
+	}
+
+	log.Printf("[DEBUG] Deleting milestone for repository: %s/%s", owner, repoName)
+	_, err = conn.Issues.DeleteMilestone(ctx, owner, repoName, number)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func parseMilestoneNumber(id string) (int, error) {
+	parts := strings.Split(id, "/")
+	if len(parts) != 3 {
+		return -1, fmt.Errorf("ID not properly formatted: %s", id)
+	}
+	number, err := strconv.Atoi(parts[2])
+	if err != nil {
+		return -1, err
+	}
+	return number, nil
+}