Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Adds pagination in mongodbatlas_team resource & data source #2919

Merged
merged 11 commits into from
Dec 27, 2024
Merged

fix: Adds pagination in mongodbatlas_team resource & data source #2919

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
59e635a
update to use AllPages
maastha Dec 20, 2024
6af76f5
minor
maastha Dec 20, 2024
827d93b
changelog
maastha Dec 20, 2024
22fd4f6
update resource
maastha Dec 20, 2024
5c56753
undo
maastha Dec 20, 2024
489f55c
min
maastha Dec 24, 2024
5ad54f3
min
maastha Dec 24, 2024
aad2f70
minor
maastha Dec 24, 2024
2e6a222
changelog
maastha Dec 24, 2024
1bc70a3
Merge branch 'master' into CLOUDP-289122-teams-ds
maastha Dec 24, 2024
040f973
minor
maastha Dec 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changelog/2919.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```release-note:bug
data-source/mongodbatlas_team: Fixes pagination logic when retrieved users of a team
```

```release-note:bug
resource/mongodbatlas_team: Fixes pagination logic when retrieved users of a team
```
20 changes: 14 additions & 6 deletions internal/service/team/data_source_team.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,17 @@ import (
"context"
"errors"
"fmt"
"net/http"

"go.mongodb.org/atlas-sdk/v20241113003/admin"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"

"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/constant"
"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/dsschema"
"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"

"go.mongodb.org/atlas-sdk/v20241113003/admin"
)

func DataSource() *schema.Resource {
Expand Down Expand Up @@ -77,21 +80,26 @@ func dataSourceRead(ctx context.Context, d *schema.ResourceData, meta any) diag.
}

if err := d.Set("team_id", team.GetId()); err != nil {
return diag.FromErr(fmt.Errorf(errorTeamSetting, "name", d.Id(), err))
return diag.FromErr(fmt.Errorf(errorTeamSetting, "team_id", d.Id(), err))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice spotted

}

if err := d.Set("name", team.GetName()); err != nil {
return diag.FromErr(fmt.Errorf(errorTeamSetting, "name", d.Id(), err))
}

users, _, err := connV2.TeamsApi.ListTeamUsers(ctx, orgID, team.GetId()).Execute()
teamUsers, err := dsschema.AllPages(ctx, func(ctx context.Context, pageNum int) (dsschema.PaginateResponse[admin.CloudAppUser], *http.Response, error) {
request := connV2.TeamsApi.ListTeamUsers(ctx, orgID, team.GetId())
request = request.PageNum(pageNum)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you have to provide itemsPerPage?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, not required

return request.Execute()
})

if err != nil {
return diag.FromErr(fmt.Errorf(errorTeamRead, err))
}

usernames := []string{}
for i := range users.GetResults() {
usernames = append(usernames, users.GetResults()[i].GetUsername())
for i := range teamUsers {
usernames = append(usernames, teamUsers[i].GetUsername())
}

if err := d.Set("usernames", usernames); err != nil {
Expand Down
23 changes: 18 additions & 5 deletions internal/service/team/resource_team.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,16 @@ import (
"strings"
"time"

"go.mongodb.org/atlas-sdk/v20241113003/admin"

"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"

"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/constant"
"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/conversion"
"github.com/mongodb/terraform-provider-mongodbatlas/internal/common/dsschema"
"github.com/mongodb/terraform-provider-mongodbatlas/internal/config"
"go.mongodb.org/atlas-sdk/v20241113003/admin"
)

const (
Expand Down Expand Up @@ -114,14 +117,19 @@ func resourceRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Di
return diag.FromErr(fmt.Errorf(errorTeamSetting, "team_id", teamID, err))
}

users, _, err := connV2.TeamsApi.ListTeamUsers(ctx, orgID, teamID).Execute()
teamUsers, err := dsschema.AllPages(ctx, func(ctx context.Context, pageNum int) (dsschema.PaginateResponse[admin.CloudAppUser], *http.Response, error) {
request := connV2.TeamsApi.ListTeamUsers(ctx, orgID, team.GetId())
request = request.PageNum(pageNum)
return request.Execute()
})

if err != nil {
return diag.FromErr(fmt.Errorf(errorTeamRead, err))
}

usernames := []string{}
for i := range users.GetResults() {
usernames = append(usernames, users.GetResults()[i].GetUsername())
for i := range teamUsers {
usernames = append(usernames, teamUsers[i].GetUsername())
}

if err := d.Set("usernames", usernames); err != nil {
Expand All @@ -148,7 +156,12 @@ func resourceUpdate(ctx context.Context, d *schema.ResourceData, meta any) diag.
}

if d.HasChange("usernames") {
existingUsers, _, err := connV2.TeamsApi.ListTeamUsers(ctx, orgID, teamID).Execute()
existingUsers, err := dsschema.AllPages(ctx, func(ctx context.Context, pageNum int) (dsschema.PaginateResponse[admin.CloudAppUser], *http.Response, error) {
request := connV2.TeamsApi.ListTeamUsers(ctx, orgID, teamID)
request = request.PageNum(pageNum)
return request.Execute()
})

if err != nil {
return diag.FromErr(fmt.Errorf(errorTeamRead, err))
}
Expand Down
4 changes: 2 additions & 2 deletions internal/service/team/update_user.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ import (
"go.mongodb.org/atlas-sdk/v20241113003/admin"
)

func UpdateTeamUsers(teamsAPI admin.TeamsApi, usersAPI admin.MongoDBCloudUsersApi, existingTeamUsers *admin.PaginatedAppUser, newUsernames []string, orgID, teamID string) error {
func UpdateTeamUsers(teamsAPI admin.TeamsApi, usersAPI admin.MongoDBCloudUsersApi, existingTeamUsers []admin.CloudAppUser, newUsernames []string, orgID, teamID string) error {
validNewUsers, err := ValidateUsernames(usersAPI, newUsernames)
if err != nil {
return err
}
usersToAdd, usersToRemove, err := GetChangesForTeamUsers(existingTeamUsers.GetResults(), validNewUsers)
usersToAdd, usersToRemove, err := GetChangesForTeamUsers(existingTeamUsers, validNewUsers)
if err != nil {
return err
}
Expand Down
12 changes: 7 additions & 5 deletions internal/service/team/update_user_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ import (
"errors"
"testing"

"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/team"
"go.mongodb.org/atlas-sdk/v20241113003/admin"
"go.mongodb.org/atlas-sdk/v20241113003/mockadmin"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/require"
"go.mongodb.org/atlas-sdk/v20241113003/admin"
"go.mongodb.org/atlas-sdk/v20241113003/mockadmin"

"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/team"
)

func TestGetChangesForTeamUsers(t *testing.T) {
Expand Down Expand Up @@ -96,7 +98,7 @@ func TestUpdateTeamUsers(t *testing.T) {
mockUsersApi.EXPECT().GetUserByUsername(mock.Anything, invaliduser1).Return(admin.GetUserByUsernameApiRequest{ApiService: mockUsersApi})
mockUsersApi.EXPECT().GetUserByUsernameExecute(mock.Anything).Return(nil, nil, errors.New("invalid username"))
},
existingTeamUsers: nil,
existingTeamUsers: &admin.PaginatedAppUser{Results: nil},
usernames: []string{invaliduser1},
expectError: require.Error,
},
Expand Down Expand Up @@ -153,7 +155,7 @@ func TestUpdateTeamUsers(t *testing.T) {
mockTeamsAPI := mockadmin.NewTeamsApi(t)
mockUsersAPI := mockadmin.NewMongoDBCloudUsersApi(t)
testCase.mockFuncExpectations(mockTeamsAPI, mockUsersAPI)
testCase.expectError(t, team.UpdateTeamUsers(mockTeamsAPI, mockUsersAPI, testCase.existingTeamUsers, testCase.usernames, "orgID", "teamID"))
testCase.expectError(t, team.UpdateTeamUsers(mockTeamsAPI, mockUsersAPI, testCase.existingTeamUsers.GetResults(), testCase.usernames, "orgID", "teamID"))
})
}
}
Loading