Finish up project_user and project_group resources

CHANGELOG.md

@@ -1,11 +1,16 @@
-## 1.4.0 (not yet released)
+## 1.4.0 (March 4, 2024)
 
 FEATURES:
 
 * **New Resource:** `project_user` - Separate resource to manage project memberships for users.
 * **New Resource:** `project_group` - Separate resource to project project memberships for groups.
-* resource/project: Add `cd ..` attribute to toggle if `project` resource should use its `member` or not to manage project users. Should be set to `true` when using in conjunction with `project_user` resource.
-* resource/project: Add `use_project_group_resource` attribute to toggle if `project` resource should use its `group` or not to manage project users. Should be set to `true` when using in conjunction with `project_group` resource.
+* resource/project: Add `use_project_user_resource` attribute to toggle if `project` resource should use its `member` or not to manage project users. Should be set to `false` to continue using existing `member` attribute.
+* resource/project: Add `use_project_group_resource` attribute to toggle if `project` resource should use its `group` or not to manage project users. Should be set to `false` to continue using existing `group` attribute.
+* resource/project: Switch default value for `use_project_role_resource` attribute to `true` so new provider practioners won't need to explicity set this attribute to use `project_role` resource.
+
+Issue: [#83](https://github.com/jfrog/terraform-provider-project/issues/83), [#98](https://github.com/jfrog/terraform-provider-project/issues/98)
+
+PR: [#101](https://github.com/jfrog/terraform-provider-project/pull/101)
 
 ## 1.3.5 (Feburary 9, 2024)
 

pkg/project/membership_test.go

@@ -42,6 +42,8 @@ func TestAccProject_membership(t *testing.T) {
  index_resources = true
  }
 
+ use_project_user_resource = false
+
  member {
  name = "{{ .username1 }}"
  roles = ["{{ .developeRole }}"]
@@ -60,6 +62,8 @@ func TestAccProject_membership(t *testing.T) {
  index_resources = true
  }
 
+ use_project_user_resource = false
+
  member {
  name = "{{ .username1 }}"
  roles = ["{{ .developeRole }}", "{{ .contributorRole }}"]
@@ -82,6 +86,8 @@ func TestAccProject_membership(t *testing.T) {
  manage_resources = true
  index_resources = true
  }
+
+ use_project_user_resource = false
  }
  `, params)
 
@@ -177,6 +183,8 @@ func TestAccProject_group(t *testing.T) {
  index_resources = true
  }
 
+ use_project_group_resource = false
+
  group {
  name = "{{ .group1 }}"
  roles = ["{{ .developeRole }}"]
@@ -195,6 +203,8 @@ func TestAccProject_group(t *testing.T) {
  index_resources = true
  }
 
+ use_project_group_resource = false
+
  group {
  name = "{{ .group1 }}"
  roles = ["{{ .developeRole }}", "{{ .contributorRole }}"]
@@ -217,6 +227,8 @@ func TestAccProject_group(t *testing.T) {
  manage_resources = true
  index_resources = true
  }
+
+ use_project_group_resource = false
  }
  `, params)
 

pkg/project/repo.go

@@ -99,7 +99,7 @@ var updateRepos = func(ctx context.Context, projectKey string, terraformRepoKeys
  return nil, fmt.Errorf("failed to add repos for project: %s", addErr)
  }
 
- deleteErr := deleteRepos(ctx, projectKey, repoKeysToBeDeleted, m)
+ deleteErr := deleteRepos(ctx, repoKeysToBeDeleted, m)
  if deleteErr != nil {
  return nil, fmt.Errorf("failed to delete repos for project: %s", deleteErr)
  }
@@ -139,7 +139,7 @@ var addRepo = func(ctx context.Context, projectKey string, repoKey RepoKey, req
  return err
 }
 
-var deleteRepos = func(ctx context.Context, projectKey string, repoKeys []RepoKey, m interface{}) error {
+var deleteRepos = func(ctx context.Context, repoKeys []RepoKey, m interface{}) error {
  tflog.Debug(ctx, fmt.Sprintf("deleteRepos: %s", repoKeys))
 
  req := m.(util.ProvderMetadata).Client.R().
@@ -148,7 +148,7 @@ var deleteRepos = func(ctx context.Context, projectKey string, repoKeys []RepoKe
  AddRetryCondition(retryOnSpecificMsgBody("Web server is returning an unknown error"))
 
  for _, repoKey := range repoKeys {
- err := deleteRepo(ctx, projectKey, repoKey, req)
+ err := deleteRepo(ctx, repoKey, req)
  if err != nil {
  return fmt.Errorf("failed to delete repo %s: %s", repoKey, err)
  }
@@ -157,7 +157,7 @@ var deleteRepos = func(ctx context.Context, projectKey string, repoKeys []RepoKe
  return nil
 }
 
-var deleteRepo = func(ctx context.Context, projectKey string, repoKey RepoKey, req *resty.Request) error {
+var deleteRepo = func(ctx context.Context, repoKey RepoKey, req *resty.Request) error {
  tflog.Debug(ctx, fmt.Sprintf("deleteRepo: %s", repoKey))
 
  type Error struct {

pkg/project/resource_project.go

@@ -266,8 +266,8 @@ func projectResource() *schema.Resource {
  "use_project_role_resource": {
  Type: schema.TypeBool,
  Optional: true,
- Default: false,
- Description: "When set to true, this resource will ignore the `roles` attributes and allow roles to be managed by `project_role` resource instead. Default to false.",
+ Default: true,
+ Description: "When set to true, this resource will ignore the `roles` attributes and allow roles to be managed by `project_role` resource instead. Default to `true`.",
  },
  },
  )
@@ -297,6 +297,12 @@ func projectResource() *schema.Resource {
  Description: "Member of the project. Element has one to one mapping with the [JFrog Project Users API](https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API#ArtifactoryRESTAPI-UpdateUserinProject).",
  Deprecated: "Replaced by `project_user` resource. This should not be used in combination with `project_user` resource. Use `use_project_user_resource` attribute to control which resource manages project roles.",
  },
+ "use_project_user_resource": {
+ Type: schema.TypeBool,
+ Optional: true,
+ Default: true,
+ Description: "When set to true, this resource will ignore the `member` attributes and allow users to be managed by `project_user` resource instead. Default to `true`.",
+ },
  "group": {
  Type: schema.TypeSet,
  Optional: true,
@@ -319,17 +325,11 @@ func projectResource() *schema.Resource {
  Description: "Project group. Element has one to one mapping with the [JFrog Project Groups API](https://www.jfrog.com/confluence/display/JFROG/Artifactory+REST+API#ArtifactoryRESTAPI-UpdateGroupinProject)",
  Deprecated: "Replaced by `project_group` resource. This should not be used in combination with `project_group` resource. Use `use_project_group_resource` attribute to control which resource manages project roles.",
  },
- "use_project_user_resource": {
- Type: schema.TypeBool,
- Optional: true,
- Default: false,
- Description: "When set to true, this resource will ignore the `member` attributes and allow users to be managed by `project_user` resource instead. Default to false.",
- },
  "use_project_group_resource": {
  Type: schema.TypeBool,
  Optional: true,
- Default: false,
- Description: "When set to true, this resource will ignore the `group` attributes and allow users to be managed by `project_group` resource instead. Default to false.",
+ Default: true,
+ Description: "When set to true, this resource will ignore the `group` attributes and allow users to be managed by `project_group` resource instead. Default to `true`.",
  },
  },
  )
@@ -466,7 +466,9 @@ func projectResource() *schema.Resource {
  return diag.FromErr(err)
  }
 
- _, err = m.(util.ProvderMetadata).Client.R().SetBody(project).Post(projectsUrl)
+ _, err = m.(util.ProvderMetadata).Client.R().
+ SetBody(project).
+ Post(projectsUrl)
  if err != nil {
  return diag.FromErr(err)
  }
@@ -534,7 +536,7 @@ func projectResource() *schema.Resource {
  }
  }
 
- useProjectUserResource := data.Get("use_project_role_resource").(bool)
+ useProjectUserResource := data.Get("use_project_user_resource").(bool)
  if !useProjectUserResource {
  _, err = updateMembers(ctx, data.Id(), usersMembershipType, users, m)
  if err != nil {
@@ -567,7 +569,7 @@ func projectResource() *schema.Resource {
  return diag.FromErr(err)
  }
 
- deleteErr := deleteRepos(ctx, data.Id(), repos, m)
+ deleteErr := deleteRepos(ctx, repos, m)
  if deleteErr != nil {
  return diag.FromErr(fmt.Errorf("failed to delete repos for project: %s", deleteErr))
  }
@@ -607,16 +609,16 @@ func projectResource() *schema.Resource {
  }
 
  var resourceStateUpgradeV1 = func(ctx context.Context, rawState map[string]any, meta any) (map[string]any, error) {
- // set use_project_role_resource to true for existing state so the resource will continue
- // using `roles` attribute until explicitly set to false
- rawState["use_project_role_resource"] = true
+ // set use_project_role_resource to false for existing state so the resource will continue
+ // using `roles` attribute until explicitly set to true
+ rawState["use_project_role_resource"] = false
  return rawState, nil
  }
 
  var resourceStateUpgradeV2 = func(ctx context.Context, rawState map[string]any, meta any) (map[string]any, error) {
  // like in v1 where the project_role was introduced, just for project_user and project_group
- rawState["use_project_user_resource"] = true
- rawState["use_project_group_resource"] = true
+ rawState["use_project_user_resource"] = false
+ rawState["use_project_group_resource"] = false
  return rawState, nil
  }
 

pkg/project/resource_project_group.go

@@ -14,6 +14,16 @@ import (
 
 const projectGroupsUrl = "access/api/v1/projects/{projectKey}/groups/{name}"
 
+type ProjectGroup struct {
+ ProjectKey string `json:"-"`
+ Name string `json:"name"`
+ Roles []string `json:"roles"`
+}
+
+func (m ProjectGroup) Id() string {
+ return fmt.Sprintf(`%s:%s`, m.ProjectKey, m.Name)
+}
+
 func projectGroupResource() *schema.Resource {
  var projectGroupSchema = map[string]*schema.Schema{
  "project_key": {
@@ -26,6 +36,7 @@ func projectGroupResource() *schema.Resource {
  "name": {
  Type: schema.TypeString,
  Required: true,
+ ForceNew: true,
  ValidateDiagFunc: validation.ToDiagFunc(validation.StringIsNotEmpty),
  Description: "The name of an artifactory group.",
  },
@@ -37,6 +48,28 @@ func projectGroupResource() *schema.Resource {
  },
  }
 
+ var unpackProjectGroup = func(d *schema.ResourceData) ProjectGroup {
+ return ProjectGroup{
+ ProjectKey: d.Get("project_key").(string),
+ Name: d.Get("name").(string),
+ Roles: util.CastToStringArr(d.Get("roles").(*schema.Set).List()),
+ }
+ }
+
+ var packProjectGroup = func(_ context.Context, data *schema.ResourceData, m ProjectGroup) diag.Diagnostics {
+ setValue := util.MkLens(data)
+
+ setValue("name", m.Name)
+ setValue("project_key", m.ProjectKey)
+ errors := setValue("roles", m.Roles)
+
+ if len(errors) > 0 {
+ return diag.Errorf("failed to pack project member %q", errors)
+ }
+
+ return nil
+ }
+
  var readProjectGroup = func(ctx context.Context, data *schema.ResourceData, m interface{}) diag.Diagnostics {
  projectGroup := unpackProjectGroup(data)
  var loadedProjectGroup ProjectGroup

pkg/project/resource_project_group_test.go

@@ -43,9 +43,7 @@ func TestAccProjectGroup(t *testing.T) {
  block_deployments_on_limit = true
  email_notification = false
 
- lifecycle {
- ignore_changes = ["member"]
- }
+ use_project_group_resource = true
  }
 
  resource "project_group" "{{ .group }}" {
@@ -72,6 +70,12 @@ func TestAccProjectGroup(t *testing.T) {
  return verifyProjectUser(group, projectKey, request)
  }),
  ProviderFactories: testAccProviders(),
+ ExternalProviders: map[string]resource.ExternalProvider{
+ "artifactory": {
+ Source: "jfrog/artifactory",
+ VersionConstraint: "10.1.4",
+ },
+ },
  Steps: []resource.TestStep{
  {
  Config: config,

pkg/project/resource_project_role.go

@@ -111,7 +111,7 @@ func projectRoleResource() *schema.Resource {
  },
  }
 
- var packRole = func(ctx context.Context, data *schema.ResourceData, role Role, projectKey string) diag.Diagnostics {
+ var packRole = func(_ context.Context, data *schema.ResourceData, role Role, projectKey string) diag.Diagnostics {
  setValue := util.MkLens(data)
 
  setValue("name", role.Name)

pkg/project/resource_project_role_test.go

@@ -24,7 +24,6 @@ func TestAccProjectRole_full(t *testing.T) {
  manage_resources = true
  index_resources = true
  }
- use_project_role_resource = true
  }
 
  resource "project_role" "{{ .name }}" {
@@ -107,6 +106,8 @@ func TestAccProjectRole_conflict_with_project(t *testing.T) {
  manage_resources = true
  index_resources = true
  }
+
+ use_project_role_resource = false
  }
 
  resource "project_role" "{{ .name }}" {