Merge pull request #593 from tommyknows/project-membership

timofurrer · web-flow · commit 348b9495ab0b · 2022-07-26T16:39:23.000+02:00
Add new data source gitlab_project_membership
diff --git a/docs/data-sources/project_membership.md b/docs/data-sources/project_membership.md
@@ -0,0 +1,69 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "gitlab_project_membership Data Source - terraform-provider-gitlab"
+subcategory: ""
+description: |-
+  The gitlab_project_membership data source allows to list and filter all members of a project specified by either its id or full path.
+  -> Note exactly one of projectid or fullpath must be provided.
+  Upstream API: GitLab REST API docs https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project
+---
+
+# gitlab_project_membership (Data Source)
+
+The `gitlab_project_membership` data source allows to list and filter all members of a project specified by either its id or full path.
+
+-> **Note** exactly one of project_id or full_path must be provided.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project)
+
+## Example Usage
+
+```terraform
+# By project's ID
+data "gitlab_project_membership" "example" {
+  project_id = 123
+}
+
+# By project's full path
+data "gitlab_project_membership" "example" {
+  full_path = "foo/bar"
+}
+
+# Get members of a project including all members
+# through ancestor groups
+data "gitlab_project_membership" "example" {
+  project_id = 123
+  inherited  = true
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `full_path` (String) The full path of the project.
+- `inherited` (Boolean) Return all project members including members through ancestor groups
+- `project_id` (Number) The ID of the project.
+- `query` (String) A query string to search for members
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `members` (List of Object) The list of project members. (see [below for nested schema](#nestedatt--members))
+
+<a id="nestedatt--members"></a>
+### Nested Schema for `members`
+
+Read-Only:
+
+- `access_level` (String)
+- `avatar_url` (String)
+- `expires_at` (String)
+- `id` (Number)
+- `name` (String)
+- `state` (String)
+- `username` (String)
+- `web_url` (String)
+
+
diff --git a/examples/data-sources/gitlab_project_membership/data-source.tf b/examples/data-sources/gitlab_project_membership/data-source.tf
@@ -0,0 +1,16 @@
+# By project's ID
+data "gitlab_project_membership" "example" {
+  project_id = 123
+}
+
+# By project's full path
+data "gitlab_project_membership" "example" {
+  full_path = "foo/bar"
+}
+
+# Get members of a project including all members
+# through ancestor groups
+data "gitlab_project_membership" "example" {
+  project_id = 123
+  inherited  = true
+}
diff --git a/internal/provider/data_source_gitlab_group_membership.go b/internal/provider/data_source_gitlab_group_membership.go
@@ -22,22 +22,18 @@ var _ = registerDataSource("gitlab_group_membership", func() *schema.Resource {
 		ReadContext: dataSourceGitlabGroupMembershipRead,
 		Schema: map[string]*schema.Schema{
 			"group_id": {
-				Description: "The ID of the group.",
-				Type:        schema.TypeInt,
-				Computed:    true,
-				Optional:    true,
-				ConflictsWith: []string{
-					"full_path",
-				},
+				Description:  "The ID of the group.",
+				Type:         schema.TypeInt,
+				Computed:     true,
+				Optional:     true,
+				ExactlyOneOf: []string{"group_id", "full_path"},
 			},
 			"full_path": {
-				Description: "The full path of the group.",
-				Type:        schema.TypeString,
-				Computed:    true,
-				Optional:    true,
-				ConflictsWith: []string{
-					"group_id",
-				},
+				Description:  "The full path of the group.",
+				Type:         schema.TypeString,
+				Computed:     true,
+				Optional:     true,
+				ExactlyOneOf: []string{"group_id", "full_path"},
 			},
 			"access_level": {
 				Description:      "Only return members with the desired access level. Acceptable values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`.",
@@ -154,7 +150,7 @@ func dataSourceGitlabGroupMembershipRead(ctx context.Context, d *schema.Resource
 	d.Set("group_id", group.ID)
 	d.Set("full_path", group.FullPath)
 
-	d.Set("members", flattenGitlabMembers(d, allGms)) // lintignore: XR004 // TODO: Resolve this tfproviderlint issue
+	d.Set("members", flattenGitlabGroupMembers(d, allGms)) // lintignore: XR004 // TODO: Resolve this tfproviderlint issue
 
 	var optionsHash strings.Builder
 	optionsHash.WriteString(strconv.Itoa(group.ID))
@@ -169,7 +165,7 @@ func dataSourceGitlabGroupMembershipRead(ctx context.Context, d *schema.Resource
 	return nil
 }
 
-func flattenGitlabMembers(d *schema.ResourceData, members []*gitlab.GroupMember) []interface{} {
+func flattenGitlabGroupMembers(d *schema.ResourceData, members []*gitlab.GroupMember) []interface{} {
 	membersList := []interface{}{}
 
 	var filterAccessLevel gitlab.AccessLevelValue = gitlab.NoPermissions
diff --git a/internal/provider/data_source_gitlab_group_membership_test.go b/internal/provider/data_source_gitlab_group_membership_test.go
@@ -11,7 +11,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 )
 
-func TestAccDataSourceGitlabMembership_basic(t *testing.T) {
+func TestAccDataSourceGitlabGroupMembership_basic(t *testing.T) {
 	rInt := acctest.RandInt()
 
 	resource.ParallelTest(t, resource.TestCase{
@@ -46,7 +46,7 @@ func TestAccDataSourceGitlabMembership_basic(t *testing.T) {
 	})
 }
 
-func TestAccDataSourceGitlabMembership_pagination(t *testing.T) {
+func TestAccDataSourceGitlabGroupMembership_pagination(t *testing.T) {
 	userCount := 21
 
 	group := testAccCreateGroups(t, 1)[0]
diff --git a/internal/provider/data_source_gitlab_project_membership.go b/internal/provider/data_source_gitlab_project_membership.go
@@ -0,0 +1,198 @@
+package provider
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"strconv"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/xanzy/go-gitlab"
+)
+
+var _ = registerDataSource("gitlab_project_membership", func() *schema.Resource {
+	return &schema.Resource{
+		Description: `The ` + "`gitlab_project_membership`" + ` data source allows to list and filter all members of a project specified by either its id or full path.
+
+-> **Note** exactly one of project_id or full_path must be provided.
+
+**Upstream API**: [GitLab REST API docs](https://docs.gitlab.com/ee/api/members.html#list-all-members-of-a-group-or-project)`,
+		ReadContext: dataSourceGitlabProjectMembershipRead,
+		Schema: map[string]*schema.Schema{
+			"project_id": {
+				Description:  "The ID of the project.",
+				Type:         schema.TypeInt,
+				Computed:     true,
+				Optional:     true,
+				ExactlyOneOf: []string{"project_id", "full_path"},
+			},
+			"full_path": {
+				Description:  "The full path of the project.",
+				Type:         schema.TypeString,
+				Computed:     true,
+				Optional:     true,
+				ExactlyOneOf: []string{"project_id", "full_path"},
+			},
+			"query": {
+				Description: "A query string to search for members",
+				Type:        schema.TypeString,
+				Optional:    true,
+			},
+			"inherited": {
+				Description: "Return all project members including members through ancestor groups",
+				Type:        schema.TypeBool,
+				Optional:    true,
+			},
+			"members": {
+				Description: "The list of project members.",
+				Type:        schema.TypeList,
+				Computed:    true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"id": {
+							Description: "The unique id assigned to the user by the gitlab server.",
+							Type:        schema.TypeInt,
+							Computed:    true,
+						},
+						"username": {
+							Description: "The username of the user.",
+							Type:        schema.TypeString,
+							Computed:    true,
+						},
+						"name": {
+							Description: "The name of the user.",
+							Type:        schema.TypeString,
+							Computed:    true,
+						},
+						"state": {
+							Description: "Whether the user is active or blocked.",
+							Type:        schema.TypeString,
+							Computed:    true,
+						},
+						"avatar_url": {
+							Description: "The avatar URL of the user.",
+							Type:        schema.TypeString,
+							Computed:    true,
+						},
+						"web_url": {
+							Description: "User's website URL.",
+							Type:        schema.TypeString,
+							Computed:    true,
+						},
+						"access_level": {
+							Description: "The level of access to the group.",
+							Type:        schema.TypeString,
+							Computed:    true,
+						},
+						"expires_at": {
+							Description: "Expiration date for the group membership.",
+							Type:        schema.TypeString,
+							Computed:    true,
+						},
+					},
+				},
+			},
+		},
+	}
+})
+
+func dataSourceGitlabProjectMembershipRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	client := meta.(*gitlab.Client)
+
+	var project *gitlab.Project
+	var err error
+
+	log.Printf("[INFO] Reading Gitlab project")
+
+	var pid interface{}
+	if v, ok := d.GetOk("project_id"); ok {
+		pid = v.(int)
+	} else if v, ok := d.GetOk("full_path"); ok {
+		pid = v.(string)
+	} else {
+		return diag.Errorf("one and only one of project_id or full_path must be set. This is a provider bug, please report upstream at https://github.com/gitlabhq/terraform-provider-gitlab/issues")
+	}
+
+	// Get project to have both, the `project_id` and `full_path` for setting the state.
+	project, _, err = client.Projects.GetProject(pid, nil)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	var query *string
+	if q, ok := d.GetOk("query"); ok {
+		s := q.(string)
+		query = &s
+	}
+
+	log.Printf("[INFO] Reading Gitlab project memberships")
+
+	// Get project memberships
+	listOptions := &gitlab.ListProjectMembersOptions{
+		Query: query,
+		ListOptions: gitlab.ListOptions{
+			PerPage: 20,
+			Page:    1,
+		},
+	}
+
+	listMembers := client.ProjectMembers.ListProjectMembers
+	if inherited, ok := d.GetOk("inherited"); ok && inherited.(bool) {
+		listMembers = client.ProjectMembers.ListAllProjectMembers
+	}
+
+	var allPMs []*gitlab.ProjectMember
+	for listOptions.Page != 0 {
+		pms, resp, err := listMembers(project.ID, listOptions, gitlab.WithContext(ctx))
+		if err != nil {
+			return diag.FromErr(err)
+		}
+
+		allPMs = append(allPMs, pms...)
+		listOptions.Page = resp.NextPage
+	}
+
+	var optionsHash strings.Builder
+	optionsHash.WriteString(strconv.Itoa(project.ID))
+
+	if data, ok := d.GetOk("query"); ok {
+		optionsHash.WriteString(data.(string))
+	}
+
+	id := schema.HashString(optionsHash.String())
+	d.SetId(fmt.Sprintf("%d", id))
+
+	d.Set("project_id", project.ID)
+	d.Set("full_path", project.PathWithNamespace)
+
+	if err := d.Set("members", flattenGitlabProjectMembers(d, allPMs)); err != nil {
+		return diag.FromErr(err)
+	}
+
+	return nil
+}
+
+func flattenGitlabProjectMembers(d *schema.ResourceData, members []*gitlab.ProjectMember) []interface{} {
+	membersList := make([]interface{}, 0, len(members))
+	for _, member := range members {
+		values := map[string]interface{}{
+			"id":           member.ID,
+			"username":     member.Username,
+			"name":         member.Name,
+			"state":        member.State,
+			"avatar_url":   member.AvatarURL,
+			"web_url":      member.WebURL,
+			"access_level": accessLevelValueToName[gitlab.AccessLevelValue(member.AccessLevel)],
+		}
+
+		if member.ExpiresAt != nil {
+			values["expires_at"] = member.ExpiresAt.String()
+		}
+
+		membersList = append(membersList, values)
+	}
+
+	return membersList
+}
diff --git a/internal/provider/data_source_gitlab_project_membership_test.go b/internal/provider/data_source_gitlab_project_membership_test.go

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"`
`12`	`12`	`)`
`13`	`13`
`14`		`-func TestAccDataSourceGitlabMembership_basic(t *testing.T) {`
	`14`	`+func TestAccDataSourceGitlabGroupMembership_basic(t *testing.T) {`
`15`	`15`	`rInt := acctest.RandInt()`
`16`	`16`
`17`	`17`	`resource.ParallelTest(t, resource.TestCase{`
`@@ -46,7 +46,7 @@ func TestAccDataSourceGitlabMembership_basic(t *testing.T) {`
`46`	`46`	`})`
`47`	`47`	`}`
`48`	`48`
`49`		`-func TestAccDataSourceGitlabMembership_pagination(t *testing.T) {`
	`49`	`+func TestAccDataSourceGitlabGroupMembership_pagination(t *testing.T) {`
`50`	`50`	`userCount := 21`
`51`	`51`
`52`	`52`	`group := testAccCreateGroups(t, 1)[0]`