Change team_uuid to team in user_team_membership

Author: ottramst

CHANGELOG.md

@@ -1,3 +1,14 @@
+## v0.2.1
+
+BREAKING CHANGES:
+
+* resource/user_team_membership: The `team_uuid` attribute has been renamed to `team` for consistency with other resources
+
+ENHANCEMENTS:
+
+* resource/user_team_membership: Added example files for resource usage and import
+* docs: Updated documentation to reflect the `team` attribute naming
+
 ## v0.2.0
 
 FEATURES:
@@ -11,7 +22,7 @@ BREAKING CHANGES:
 ENHANCEMENTS:
 
 * resource/user_team_membership: Supports full CRUD operations for user team memberships
-* resource/user_team_membership: Supports import using the format `username/team_uuid`
+* resource/user_team_membership: Supports import using the format `username/team`
 * resource/user_team_membership: Works with managed, LDAP, and OIDC users
 * tests: Added acceptance tests for `dependencytrack_user_team_membership` resource using API key authentication
 

docs/resources/user_team_membership.md

@@ -10,16 +10,45 @@ description: |-
 
 Manages a user's membership in a team in Dependency-Track. This resource associates a user with a team.
 
-
+## Example Usage
+
+```terraform
+resource "dependencytrack_team" "developers" {
+  name = "Developers"
+}
+
+resource "dependencytrack_managed_user" "john_doe" {
+  username = "john.doe"
+  fullname = "John Doe"
+  email    = "[email protected]"
+  password = "SecurePassword123!"
+}
+
+resource "dependencytrack_user_team_membership" "john_developers" {
+  username = dependencytrack_managed_user.john_doe.username
+  team     = dependencytrack_team.developers.id
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- `team_uuid` (String) The UUID of the team
+- `team` (String) The UUID of the team
 - `username` (String) The username of the user
 
 ### Read-Only
 
 - `id` (String) The unique identifier in the format `username/team_uuid`
+
+## Import
+
+Import is supported using the following syntax:
+
+The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
+
+```shell
+# User team memberships can be imported using the format: username/team_uuid
+terraform import dependencytrack_user_team_membership.example john.doe/00000000-0000-0000-0000-000000000001
+```

examples/resources/dependencytrack_user_team_membership/import.sh

@@ -0,0 +1,2 @@
+# User team memberships can be imported using the format: username/team_uuid
+terraform import dependencytrack_user_team_membership.example john.doe/00000000-0000-0000-0000-000000000001

examples/resources/dependencytrack_user_team_membership/resource.tf

@@ -0,0 +1,15 @@
+resource "dependencytrack_team" "developers" {
+  name = "Developers"
+}
+
+resource "dependencytrack_managed_user" "john_doe" {
+  username = "john.doe"
+  fullname = "John Doe"
+  email    = "[email protected]"
+  password = "SecurePassword123!"
+}
+
+resource "dependencytrack_user_team_membership" "john_developers" {
+  username = dependencytrack_managed_user.john_doe.username
+  team     = dependencytrack_team.developers.id
+}

internal/provider/user_team_membership_resource.go

@@ -41,7 +41,7 @@ type UserTeamMembershipResource struct {
 type UserTeamMembershipResourceModel struct {
 	ID       types.String `tfsdk:"id"`
 	Username types.String `tfsdk:"username"`
-	TeamUUID types.String `tfsdk:"team_uuid"`
+	Team     types.String `tfsdk:"team"`
 }
 
 // IdentifiableObject represents an object with a UUID field.
@@ -72,7 +72,7 @@ func (r *UserTeamMembershipResource) Schema(ctx context.Context, req resource.Sc
 					stringplanmodifier.RequiresReplace(),
 				},
 			},
-			"team_uuid": schema.StringAttribute{
+			"team": schema.StringAttribute{
 				MarkdownDescription: "The UUID of the team",
 				Required:            true,
 				PlanModifiers: []planmodifier.String{
@@ -118,7 +118,7 @@ func (r *UserTeamMembershipResource) Create(ctx context.Context, req resource.Cr
 	}
 
 	// Parse team UUID
-	teamUUID, err := uuid.Parse(data.TeamUUID.ValueString())
+	teamUUID, err := uuid.Parse(data.Team.ValueString())
 	if err != nil {
 		resp.Diagnostics.AddError("Invalid UUID", fmt.Sprintf("Unable to parse team UUID: %s", err))
 		return
@@ -132,7 +132,7 @@ func (r *UserTeamMembershipResource) Create(ctx context.Context, req resource.Cr
 	}
 
 	// Set the ID as a composite key
-	data.ID = types.StringValue(fmt.Sprintf("%s/%s", data.Username.ValueString(), data.TeamUUID.ValueString()))
+	data.ID = types.StringValue(fmt.Sprintf("%s/%s", data.Username.ValueString(), data.Team.ValueString()))
 
 	tflog.Trace(ctx, "created a user team membership resource")
 
@@ -151,7 +151,7 @@ func (r *UserTeamMembershipResource) Read(ctx context.Context, req resource.Read
 	}
 
 	// Parse team UUID
-	teamUUID, err := uuid.Parse(data.TeamUUID.ValueString())
+	teamUUID, err := uuid.Parse(data.Team.ValueString())
 	if err != nil {
 		resp.Diagnostics.AddError("Invalid UUID", fmt.Sprintf("Unable to parse team UUID: %s", err))
 		return
@@ -184,11 +184,11 @@ func (r *UserTeamMembershipResource) Update(ctx context.Context, req resource.Up
 		return
 	}
 
-	// Since both username and team_uuid require replacement, this should never be called
+	// Since both username and team require replacement, this should never be called
 	// But we'll implement it for completeness
 	resp.Diagnostics.AddError(
 		"Update Not Supported",
-		"Updating a user team membership requires replacing the resource. Both username and team_uuid require replacement.",
+		"Updating a user team membership requires replacing the resource. Both username and team require replacement.",
 	)
 }
 
@@ -203,7 +203,7 @@ func (r *UserTeamMembershipResource) Delete(ctx context.Context, req resource.De
 	}
 
 	// Parse team UUID
-	teamUUID, err := uuid.Parse(data.TeamUUID.ValueString())
+	teamUUID, err := uuid.Parse(data.Team.ValueString())
 	if err != nil {
 		resp.Diagnostics.AddError("Invalid UUID", fmt.Sprintf("Unable to parse team UUID: %s", err))
 		return
@@ -245,7 +245,7 @@ func (r *UserTeamMembershipResource) ImportState(ctx context.Context, req resour
 	// Set the attributes
 	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("id"), req.ID)...)
 	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("username"), username)...)
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("team_uuid"), teamUUID)...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("team"), teamUUID)...)
 }
 
 // Helper methods for API calls

internal/provider/user_team_membership_resource_test.go

@@ -25,7 +25,7 @@ func TestAccUserTeamMembershipResource(t *testing.T) {
 					),
 					statecheck.ExpectKnownValue(
 						"dependencytrack_user_team_membership.test",
-						tfjsonpath.New("team_uuid"),
+						tfjsonpath.New("team"),
 						knownvalue.NotNull(),
 					),
 					statecheck.ExpectKnownValue(
@@ -60,8 +60,8 @@ resource "dependencytrack_managed_user" "test" {
 }
 
 resource "dependencytrack_user_team_membership" "test" {
-  username  = dependencytrack_managed_user.test.username
-  team_uuid = dependencytrack_team.test.id
+  username = dependencytrack_managed_user.test.username
+  team     = dependencytrack_team.test.id
 }
 `
 }
@@ -109,13 +109,13 @@ resource "dependencytrack_managed_user" "test" {
 }
 
 resource "dependencytrack_user_team_membership" "test1" {
-  username  = dependencytrack_managed_user.test.username
-  team_uuid = dependencytrack_team.test1.id
+  username = dependencytrack_managed_user.test.username
+  team     = dependencytrack_team.test1.id
 }
 
 resource "dependencytrack_user_team_membership" "test2" {
-  username  = dependencytrack_managed_user.test.username
-  team_uuid = dependencytrack_team.test2.id
+  username = dependencytrack_managed_user.test.username
+  team     = dependencytrack_team.test2.id
 }
 `
 }
@@ -169,8 +169,8 @@ resource "dependencytrack_managed_user" "test" {
 }
 
 resource "dependencytrack_user_team_membership" "test" {
-  username  = dependencytrack_managed_user.test.username
-  team_uuid = dependencytrack_team.` + teamRef + `.id
+  username = dependencytrack_managed_user.test.username
+  team     = dependencytrack_team.` + teamRef + `.id
 }
 `
 }