Add new resource github_team_members to allow authoritative team mana…

…gement (integrations#975) * Add new resource github_team_memberships to allow authorative team management * Fix typo in test * Add docs and rename resource to github_team_members * Apply suggestions from code review Co-authored-by: Jeremy Udit <jcudit@github.com> * Rework tests * Update documentation * Apply suggestions from code review Co-authored-by: Jeremy Udit <jcudit@github.com> Co-authored-by: Jeremy Udit <jcudit@github.com>
kfcampbell · Feb 3, 2022 · cec5ceb · cec5ceb
1 parent f1f98ba
commit cec5ceb
Show file tree

Hide file tree

Showing 6 changed files with 564 additions and 0 deletions.
diff --git a/github/provider.go b/github/provider.go
@@ -111,6 +111,7 @@ func Provider() terraform.ResourceProvider {
 			"github_repository_webhook":                       resourceGithubRepositoryWebhook(),
 			"github_repository":                               resourceGithubRepository(),
 			"github_team_membership":                          resourceGithubTeamMembership(),
+			"github_team_members":                             resourceGithubTeamMembers(),
 			"github_team_repository":                          resourceGithubTeamRepository(),
 			"github_team_sync_group_mapping":                  resourceGithubTeamSyncGroupMapping(),
 			"github_team":                                     resourceGithubTeam(),

diff --git a/github/resource_github_team_members.go b/github/resource_github_team_members.go
@@ -0,0 +1,268 @@
+package github
+
+import (
+	"context"
+	"log"
+	"reflect"
+	"strconv"
+
+	"github.com/google/go-github/v39/github"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+)
+
+type MemberChange struct {
+	Old, New map[string]interface{}
+}
+
+func resourceGithubTeamMembers() *schema.Resource {
+
+	return &schema.Resource{
+		Create: resourceGithubTeamMembersCreate,
+		Read:   resourceGithubTeamMembersRead,
+		Update: resourceGithubTeamMembersUpdate,
+		Delete: resourceGithubTeamMembersDelete,
+		Importer: &schema.ResourceImporter{
+			State: schema.ImportStatePassthrough,
+		},
+
+		Schema: map[string]*schema.Schema{
+			"team_id": {
+				Type:         schema.TypeString,
+				Required:     true,
+				ForceNew:     true,
+				ValidateFunc: validateTeamIDFunc,
+			},
+			"members": {
+				Type:     schema.TypeSet,
+				Required: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"username": {
+							Type:             schema.TypeString,
+							Required:         true,
+							DiffSuppressFunc: caseInsensitive(),
+						},
+						"role": {
+							Type:         schema.TypeString,
+							Optional:     true,
+							Default:      "member",
+							ValidateFunc: validateValueFunc([]string{"member", "maintainer"}),
+						},
+					},
+				},
+			},
+			"etag": {
+				Type:     schema.TypeString,
+				Computed: true,
+			},
+		},
+	}
+}
+
+func resourceGithubTeamMembersCreate(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*Owner).v3client
+	orgId := meta.(*Owner).id
+
+	teamIdString := d.Get("team_id").(string)
+	teamId, err := strconv.ParseInt(teamIdString, 10, 64)
+	if err != nil {
+		return unconvertibleIdErr(teamIdString, err)
+	}
+	ctx := context.Background()
+
+	members := d.Get("members").(*schema.Set)
+	for _, mMap := range members.List() {
+		memb := mMap.(map[string]interface{})
+		username := memb["username"].(string)
+		role := memb["role"].(string)
+
+		log.Printf("[DEBUG] Creating team membership: %s/%s (%s)", teamIdString, username, role)
+		_, _, err = client.Teams.AddTeamMembershipByID(ctx,
+			orgId,
+			teamId,
+			username,
+			&github.TeamAddTeamMembershipOptions{
+				Role: role,
+			},
+		)
+		if err != nil {
+			return err
+		}
+	}
+
+	d.SetId(teamIdString)
+
+	return resourceGithubTeamMembersRead(d, meta)
+}
+
+func resourceGithubTeamMembersUpdate(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*Owner).v3client
+	orgId := meta.(*Owner).id
+
+	teamIdString := d.Get("team_id").(string)
+	teamId, err := strconv.ParseInt(teamIdString, 10, 64)
+	if err != nil {
+		return unconvertibleIdErr(teamIdString, err)
+	}
+	ctx := context.Background()
+
+	o, n := d.GetChange("members")
+	vals := make(map[string]*MemberChange)
+	for _, raw := range o.(*schema.Set).List() {
+		obj := raw.(map[string]interface{})
+		k := obj["username"].(string)
+		vals[k] = &MemberChange{Old: obj}
+	}
+	for _, raw := range n.(*schema.Set).List() {
+		obj := raw.(map[string]interface{})
+		k := obj["username"].(string)
+		if _, ok := vals[k]; !ok {
+			vals[k] = &MemberChange{}
+		}
+		vals[k].New = obj
+	}
+
+	for username, change := range vals {
+		var create, delete bool
+
+		switch {
+		// create a new one if old is nil
+		case change.Old == nil:
+			create = true
+		// delete existing if new is nil
+		case change.New == nil:
+			delete = true
+			// no change
+		case reflect.DeepEqual(change.Old, change.New):
+			continue
+			// recreate - role changed
+		default:
+			delete = true
+			create = true
+		}
+
+		if delete {
+			log.Printf("[DEBUG] Deleting team membership: %s/%s", teamIdString, username)
+
+			_, err = client.Teams.RemoveTeamMembershipByID(ctx, orgId, teamId, username)
+			if err != nil {
+				return err
+			}
+
+			continue
+		}
+
+		if create {
+			role := change.New["role"].(string)
+
+			log.Printf("[DEBUG] Creating team membership: %s/%s (%s)", teamIdString, username, role)
+			_, _, err = client.Teams.AddTeamMembershipByID(ctx,
+				orgId,
+				teamId,
+				username,
+				&github.TeamAddTeamMembershipOptions{
+					Role: role,
+				},
+			)
+			if err != nil {
+				return err
+			}
+			continue
+		}
+
+		// no change
+		if reflect.DeepEqual(change.Old, change.New) {
+			continue
+		}
+	}
+
+	d.SetId(teamIdString)
+
+	return resourceGithubTeamMembersRead(d, meta)
+}
+
+func resourceGithubTeamMembersRead(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*Owner).v3client
+	orgId := meta.(*Owner).id
+	teamIdString := d.Get("team_id").(string)
+
+	teamId, err := strconv.ParseInt(teamIdString, 10, 64)
+	if err != nil {
+		return unconvertibleIdErr(teamIdString, err)
+	}
+
+	// We intentionally set these early to allow reconciliation
+	// from an upstream bug which emptied team_id in state
+	// See https://github.com/integrations/terraform-provider-github/issues/323
+	d.Set("team_id", teamIdString)
+
+	ctx := context.WithValue(context.Background(), ctxId, d.Id())
+	if !d.IsNewResource() {
+		ctx = context.WithValue(ctx, ctxEtag, d.Get("etag").(string))
+	}
+
+	// List members & maintainers as list 'all' drops role information
+	log.Printf("[DEBUG] Reading team members: %s", teamIdString)
+	members, resp1, err := client.Teams.ListTeamMembersByID(ctx, orgId, teamId, &github.TeamListTeamMembersOptions{Role: "member"})
+	if err != nil {
+		return err
+	}
+
+	log.Printf("[DEBUG] Reading team maintainers: %s", teamIdString)
+	maintainers, resp2, err := client.Teams.ListTeamMembersByID(ctx, orgId, teamId, &github.TeamListTeamMembersOptions{Role: "maintainer"})
+	if err != nil {
+		return err
+	}
+
+	teamMembersAndMaintainers := make([]interface{}, len(members)+len(maintainers))
+	// Add all members to the list
+	for i, member := range members {
+		teamMembersAndMaintainers[i] = map[string]interface{}{
+			"username": member.Login,
+			"role":     "member",
+		}
+	}
+	// Add all maintainers to the list
+	for i, member := range maintainers {
+		teamMembersAndMaintainers[i+len(members)] = map[string]interface{}{
+			"username": member.Login,
+			"role":     "maintainer",
+		}
+	}
+
+	if err := d.Set("members", teamMembersAndMaintainers); err != nil {
+		return err
+	}
+
+	// Combine etag of both requests
+	d.Set("etag", buildTwoPartID(resp1.Header.Get("ETag"), resp2.Header.Get("ETag")))
+
+	return nil
+}
+
+func resourceGithubTeamMembersDelete(d *schema.ResourceData, meta interface{}) error {
+	client := meta.(*Owner).v3client
+	orgId := meta.(*Owner).id
+	teamIdString := d.Get("team_id").(string)
+	teamId, err := strconv.ParseInt(teamIdString, 10, 64)
+	if err != nil {
+		return unconvertibleIdErr(teamIdString, err)
+	}
+
+	members := d.Get("members").(*schema.Set)
+	ctx := context.WithValue(context.Background(), ctxId, d.Id())
+
+	for _, member := range members.List() {
+		mem := member.(map[string]interface{})
+		username := mem["username"].(string)
+
+		log.Printf("[DEBUG] Deleting team membership: %s/%s", teamIdString, username)
+
+		_, err = client.Teams.RemoveTeamMembershipByID(ctx, orgId, teamId, username)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}