Merge pull request #187 from jfrog/GH-169-add-group-member-resource

Add platform_group_members resource
jfrog · Jan 3, 2025 · e520a9a · e520a9a
2 parents 93552d9 + d5398ea
commit e520a9a
Show file tree

Hide file tree

Showing 14 changed files with 680 additions and 86 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+## 2.2.0 (January 3, 2025). Tested on Artifactory 7.98.12 with Terraform 1.10.3 and OpenTofu 1.8.8
+
+FEATURES:
+
+**New Resource:**
+
+* `platform_group_members` - Resource to manage group membership. Issue: [#169](https://github.com/jfrog/terraform-provider-platform/issues/169) PR: [#187](https://github.com/jfrog/terraform-provider-platform/pull/187)
+
+IMPROVEMENTS:
+
+* resource/platform_group: Add `use_group_members_resource` attribute to control if the resource uses `members` attribute or not. Issue: [#169](https://github.com/jfrog/terraform-provider-platform/issues/169) PR: [#187](https://github.com/jfrog/terraform-provider-platform/pull/187)
+
 ## 2.1.0 (December 20, 2024). Tested on Artifactory 7.98.11 with Terraform 1.10.3 and OpenTofu 1.8.7
 
 FEATURES:

diff --git a/README.md b/README.md
@@ -14,11 +14,11 @@ terraform {
   required_providers {
     artifactory = {
       source  = "registry.terraform.io/jfrog/artifactory"
-      version = "9.9.0"
+      version = "12.7.1"
     }
     platform = {
       source  = "registry.terraform.io/jfrog/platform"
-      version = "1.0.0"
+      version = "2.2.0"
     }
   }
 }
@@ -104,7 +104,7 @@ See the [contribution guide](CONTRIBUTIONS.md).
 
 ## License
 
-Copyright (c) 2024 JFrog.
+Copyright (c) 2025 JFrog.
 
 Apache 2.0 licensed, see [LICENSE][LICENSE] file.
 

diff --git a/docs/index.md b/docs/index.md
@@ -31,11 +31,11 @@ terraform {
   required_providers {
     artifactory = {
       source  = "jfrog/artifactory"
-      version = "10.5.1"
+      version = "12.7.1"
     }
     platform = {
       source  = "jfrog/platform"
-      version = "1.6.0"
+      version = "2.2.0"
     }
   }
 }

diff --git a/docs/resources/group.md b/docs/resources/group.md
@@ -38,7 +38,8 @@ resource "platform_group" "my-group" {
 - `auto_join` (Boolean) When this parameter is set, any new users defined in the system are automatically assigned to this group.
 - `description` (String) A description for the group.
 - `external_id` (String) New external group ID used to configure the corresponding group in Azure AD.
-- `members` (Set of String) List of users assigned to the group.
+- `members` (Set of String, Deprecated) List of users assigned to the group.
+- `use_group_members_resource` (Boolean) When set to `true`, this resource will ignore the `members` attributes and allow memberships to be managed by `platform_group_members` resource instead. Default value is `true`.
 
 ### Read-Only
 

diff --git a/docs/resources/group_members.md b/docs/resources/group_members.md
@@ -0,0 +1,38 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "platform_group_members Resource - terraform-provider-platform"
+subcategory: ""
+description: |-
+  Provides a resource to manage group membership. See JFrog documentation https://jfrog.com/help/r/jfrog-platform-administration-documentation/assign-users-to-groups for more details.
+---
+
+# platform_group_members (Resource)
+
+Provides a resource to manage group membership. See [JFrog documentation](https://jfrog.com/help/r/jfrog-platform-administration-documentation/assign-users-to-groups) for more details.
+
+## Example Usage
+
+```terraform
+resource "platform_group" "my-group" {
+  name = "my-group"
+  description = "My group"
+  external_id = "My Azure ID"
+  auto_join = true
+  admin_privileges = false
+}
+
+resource "platform_group_members" "my-group-members" {
+  name    = platform_group.my-group.name
+  members = [
+    "admin"
+  ]
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `members` (Set of String) List of users assigned to the group.
+- `name` (String) Name of the group.
diff --git a/examples/example.tf b/examples/example.tf
@@ -2,11 +2,11 @@ terraform {
   required_providers {
     artifactory = {
       source  = "jfrog/artifactory"
-      version = "10.5.1"
+      version = "12.7.1"
     }
     platform = {
       source  = "jfrog/platform"
-      version = "1.6.0"
+      version = "2.2.0"
     }
   }
 }

diff --git a/examples/resources/platform_group_members/resource.tf b/examples/resources/platform_group_members/resource.tf
@@ -0,0 +1,14 @@
+resource "platform_group" "my-group" {
+  name = "my-group"
+  description = "My group"
+  external_id = "My Azure ID"
+  auto_join = true
+  admin_privileges = false
+}
+
+resource "platform_group_members" "my-group-members" {
+  name    = platform_group.my-group.name
+  members = [
+    "admin"
+  ]
+}
diff --git a/pkg/platform/provider.go b/pkg/platform/provider.go
@@ -43,6 +43,7 @@ func (p *PlatformProvider) Resources(ctx context.Context) []func() resource.Reso
 		NewLicenseResource,
 		NewGlobalRoleResource,
 		NewGroupResource,
+		NewGroupMembersResource,
 		NewHTTPSSOSettingsResource,
 		NewOIDCConfigurationResource,
 		NewOIDCIdentityMappingResource,

diff --git a/pkg/platform/resource_aws_iam_role_test.go b/pkg/platform/resource_aws_iam_role_test.go
@@ -17,7 +17,7 @@ func TestAccAWSIAMRole_full(t *testing.T) {
 
 	id, _, _ := testutil.MkNames("test-user-upgrade-", "artifactory_managed_user")
 	username := fmt.Sprintf("dummy_user%d", id)
-	email := fmt.Sprintf(username + "@test.com")
+	email := username + "@test.com"
 
 	temp := `
 	resource "artifactory_managed_user" "{{ .username }}" {