[TF-6330] add org membership ID attr to tfe_organization_membership (#997)

add attr to tfe_organization_membership datasource

Author: laurenolivia

.github/pull_request_template.md

@@ -4,9 +4,8 @@ _Describe why you're making this change._
 
 _Remember to:_
 
-- _Update the [Change Log](https://github.com/hashicorp/terraform-provider-tfe/blob/main/docs/changelog-process.md)_
-
-- _Update the [Documentation](https://github.com/hashicorp/terraform-provider-tfe/blob/main/docs/changelog-process.md#updating-the-documentation)_
+- [ ] _Update the [Change Log](https://github.com/hashicorp/terraform-provider-tfe/blob/main/docs/changelog-process.md)_
+- [ ] _Update the [Documentation](https://github.com/hashicorp/terraform-provider-tfe/blob/main/docs/changelog-process.md#updating-the-documentation)_
 
 ## Testing plan
 

.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
   pull_request:
 
 concurrency:
-  group: ${{ github.ref }}
+  group: ${{ github.head_ref || github.ref }}
   cancel-in-progress: true
 
 jobs:

CHANGELOG.md

@@ -1,8 +1,10 @@
 ## Unreleased
 
 FEATURES:
+* `d/tfe_organization_membership`: Add `organization_membership_id` attribute, by @laurenolivia [997](https://github.com/hashicorp/terraform-provider-tfe/pull/997)
 * `d/tfe_variable_set`: Add `project_ids` attribute, by @Netra2104 [994](https://github.com/hashicorp/terraform-provider-tfe/pull/994)
 * **New Data Source**: `d/tfe_teams` is a new data source to return names and IDs of Teams in an Organization, by @isaacmcollins [992](https://github.com/hashicorp/terraform-provider-tfe/pull/992)
+
 ## v0.48.0 (August 7, 2023)
 
 BUG FIXES:

tfe/data_source_organization_membership.go

@@ -35,6 +35,13 @@ func dataSourceTFEOrganizationMembership() *schema.Resource {
 				Type:     schema.TypeString,
 				Computed: true,
 			},
+
+			"organization_membership_id": {
+				Type:         schema.TypeString,
+				Optional:     true,
+				Computed:     true,
+				AtLeastOneOf: []string{"email", "username"},
+			},
 		},
 	}
 }
@@ -45,17 +52,23 @@ func dataSourceTFEOrganizationMembershipRead(d *schema.ResourceData, meta interf
 	// Get the user email and organization.
 	email := d.Get("email").(string)
 	username := d.Get("username").(string)
+	orgMemberID := d.Get("organization_membership_id").(string)
 
 	organization, err := config.schemaOrDefaultOrganization(d)
 	if err != nil {
 		return err
 	}
 
-	orgMember, err := fetchOrganizationMemberByNameOrEmail(context.Background(), config.Client, organization, username, email)
-	if err != nil {
-		return fmt.Errorf("could not find organization membership for organization %s: %w", organization, err)
+	if orgMemberID == "" {
+		orgMember, err := fetchOrganizationMemberByNameOrEmail(context.Background(), config.Client, organization, username, email)
+		if err != nil {
+			return fmt.Errorf("could not find organization membership for organization %s: %w", organization, err)
+		}
+
+		d.SetId(orgMember.ID)
+	} else {
+		d.SetId(orgMemberID)
 	}
 
-	d.SetId(orgMember.ID)
 	return resourceTFEOrganizationMembershipRead(d, meta)
 }

tfe/data_source_organization_membership_test.go

@@ -34,6 +34,18 @@ func TestAccTFEOrganizationMembershipDataSource_basic(t *testing.T) {
 					resource.TestCheckResourceAttrSet("data.tfe_organization_membership.foobar", "user_id"),
 				),
 			},
+			{
+				Config: testAccTFEOrganizationMembershipDataSourceConfigWithOrgMemberID(rInt),
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr(
+						"data.tfe_organization_membership.foobar", "email", "[email protected]"),
+					resource.TestCheckResourceAttr(
+						"data.tfe_organization_membership.foobar", "username", ""),
+					resource.TestCheckResourceAttr(
+						"data.tfe_organization_membership.foobar", "organization", orgName),
+					resource.TestCheckResourceAttrSet("data.tfe_organization_membership.foobar", "user_id"),
+				),
+			},
 		},
 	})
 }
@@ -82,7 +94,7 @@ func TestAccTFEOrganizationMembershipDataSource_missingParams(t *testing.T) {
 		Steps: []resource.TestStep{
 			{
 				Config:      testAccTFEOrganizationMembershipDataSourceMissingParams(rInt),
-				ExpectError: regexp.MustCompile("you must specify a username or email"),
+				ExpectError: regexp.MustCompile("`email,organization_membership_id,username` must be specified"),
 			},
 		},
 	})
@@ -130,3 +142,21 @@ data "tfe_organization_membership" "foobar" {
   organization = tfe_organization.foobar.name
 }`, rInt)
 }
+
+func testAccTFEOrganizationMembershipDataSourceConfigWithOrgMemberID(rInt int) string {
+	return fmt.Sprintf(`
+resource "tfe_organization" "foobar" {
+  name  = "tst-terraform-%d"
+  email = "[email protected]"
+}
+
+resource "tfe_organization_membership" "foobar" {
+  email        = "[email protected]"
+  organization = tfe_organization.foobar.id
+}
+
+data "tfe_organization_membership" "foobar" {
+  organization 								= tfe_organization.foobar.name
+  organization_membership_id  = tfe_organization_membership.foobar.id
+}`, rInt)
+}

website/docs/d/organization_membership.html.markdown

@@ -28,22 +28,32 @@ data "tfe_organization_membership" "test" {
 
 ### Fetch by username
 
-```
+```hcl
 data "tfe_organization_membership" "test" {
   organization  = "my-org-name"
   username = "my-username"
 }
 ```
 
+### Fetch by organization membership ID
+
+```hcl
+data "tfe_organization_membership" "test" {
+  organization  = "my-org-name"
+  organization_membership_id = "ou-xxxxxxxxxxx"
+}
+```
+
 ## Argument Reference
 
 The following arguments are supported:
 
-* `organization` - (Required) Name of the organization.
+* `organization` - (Optional) Name of the organization.
 * `email` - (Optional) Email of the user.
 * `username` - (Optional) The username of the user.
+* `organization_membership_id` - (Optional) ID belonging to the organziation membership.
 
-~> **NOTE:** While `email` and `username` are optional arguments, one or the other is required.
+~> **NOTE:** While `email` and `username` are optional arguments, one or the other is required if `organization_membership_id` argument is not provided.
 
 ## Attributes Reference