Skip to content

CLOUDP-321083: support description in AtlasDatabaseUser #2357

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

Merged
merged 2 commits into from
May 30, 2025
Merged

CLOUDP-321083: support description in AtlasDatabaseUser #2357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce01028
Upgrade the dbuser service to v20241113001
tvdw-mongodb May 29, 2025
4c13b61
CLOUDP-321083: support 'description' in AtlasDatabaseUser
tvdw-mongodb May 29, 2025
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
4 changes: 4 additions & 0 deletions api/v1/atlasdatabaseuser_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ type AtlasDatabaseUserSpec struct {
// The specified date must be in the future and within one week.
DeleteAfterDate string `json:"deleteAfterDate,omitempty"`

// Description of this database user. Maximum 100 characters.
// +kubebuilder:validation:MaxLength:=100
Description string `json:"description,omitempty"`

// Labels is an array containing key-value pairs that tag and categorize the database user.
// Each key and value has a maximum length of 255 characters.
Labels []common.LabelSpec `json:"labels,omitempty"`
Expand Down
4 changes: 4 additions & 0 deletions config/crd/bases/atlas.mongodb.com_atlasdatabaseusers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ spec:
DeleteAfterDate is a timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the user.
The specified date must be in the future and within one week.
type: string
description:
description: Description of this database user. Maximum 100 characters.
maxLength: 100
type: string
externalProjectRef:
description: |-
"externalProjectRef" holds the parent Atlas project ID.
Expand Down
2 changes: 1 addition & 1 deletion internal/controller/atlasdatabaseuser/databaseuser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func (r *AtlasDatabaseUserReconciler) handleDatabaseUser(ctx *workflow.Context,
if err != nil {
return r.terminate(ctx, atlasDatabaseUser, api.DatabaseUserReadyType, workflow.AtlasAPIAccessNotConfigured, true, err)
}
dbUserService := dbuser.NewAtlasUsers(sdkClientSet.SdkClient20231115008.DatabaseUsersApi)
dbUserService := dbuser.NewAtlasUsers(sdkClientSet.SdkClient20241113001.DatabaseUsersApi)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We will need to run cloud-tests for this change.

deploymentService := deployment.NewAtlasDeployments(sdkClientSet.SdkClient20231115008.ClustersApi, sdkClientSet.SdkClient20231115008.ServerlessInstancesApi, sdkClientSet.SdkClient20231115008.GlobalClustersApi, sdkClientSet.SdkClient20241113001.FlexClustersApi, r.AtlasProvider.IsCloudGov())
atlasProject, err := r.ResolveProject(ctx.Context, sdkClientSet.SdkClient20231115008, atlasDatabaseUser)
if err != nil {
Expand Down
28 changes: 15 additions & 13 deletions internal/controller/atlasdatabaseuser/databaseuser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import (
"go.mongodb.org/atlas-sdk/v20231115008/admin"
"go.mongodb.org/atlas-sdk/v20231115008/mockadmin"
adminv20241113001 "go.mongodb.org/atlas-sdk/v20241113001/admin"
mockadminv20241113001 "go.mongodb.org/atlas-sdk/v20241113001/mockadmin"
"go.uber.org/zap"
"go.uber.org/zap/zaptest"
corev1 "k8s.io/api/core/v1"
Expand Down Expand Up @@ -189,21 +190,21 @@ func TestHandleDatabaseUser(t *testing.T) {
projectAPI.EXPECT().GetProjectExecute(mock.AnythingOfType("admin.GetProjectApiRequest")).
Return(&admin.Group{Id: pointer.MakePtr("project-id")}, nil, nil)

userAPI := mockadmin.NewDatabaseUsersApi(t)
userAPI := mockadminv20241113001.NewDatabaseUsersApi(t)
userAPI.EXPECT().GetDatabaseUser(context.Background(), "project-id", "admin", "user1").
Return(admin.GetDatabaseUserApiRequest{ApiService: userAPI})
Return(adminv20241113001.GetDatabaseUserApiRequest{ApiService: userAPI})
userAPI.EXPECT().GetDatabaseUserExecute(mock.AnythingOfType("admin.GetDatabaseUserApiRequest")).
Return(nil, nil, nil)
userAPI.EXPECT().CreateDatabaseUser(context.Background(), "project-id", mock.AnythingOfType("*admin.CloudDatabaseUser")).
Return(admin.CreateDatabaseUserApiRequest{ApiService: userAPI})
Return(adminv20241113001.CreateDatabaseUserApiRequest{ApiService: userAPI})
userAPI.EXPECT().CreateDatabaseUserExecute(mock.AnythingOfType("admin.CreateDatabaseUserApiRequest")).
Return(&admin.CloudDatabaseUser{}, nil, nil)
Return(&adminv20241113001.CloudDatabaseUser{}, nil, nil)

clusterAPI := mockadmin.NewClustersApi(t)

return &atlas.ClientSet{
SdkClient20231115008: &admin.APIClient{ProjectsApi: projectAPI, ClustersApi: clusterAPI, DatabaseUsersApi: userAPI},
SdkClient20241113001: &adminv20241113001.APIClient{},
SdkClient20231115008: &admin.APIClient{ProjectsApi: projectAPI, ClustersApi: clusterAPI},
SdkClient20241113001: &adminv20241113001.APIClient{DatabaseUsersApi: userAPI},
}, nil
},
},
Expand Down Expand Up @@ -2263,15 +2264,15 @@ func DefaultTestProvider(t *testing.T) *atlasmock.TestProvider {
return false
},
SdkClientSetFunc: func(ctx context.Context, creds *atlas.Credentials, log *zap.SugaredLogger) (*atlas.ClientSet, error) {
userAPI := mockadmin.NewDatabaseUsersApi(t)
userAPI := mockadminv20241113001.NewDatabaseUsersApi(t)
userAPI.EXPECT().GetDatabaseUser(context.Background(), "my-project", "admin", "user1").
Return(admin.GetDatabaseUserApiRequest{ApiService: userAPI})
Return(adminv20241113001.GetDatabaseUserApiRequest{ApiService: userAPI})
userAPI.EXPECT().GetDatabaseUserExecute(mock.AnythingOfType("admin.GetDatabaseUserApiRequest")).
Return(nil, nil, nil)
userAPI.EXPECT().CreateDatabaseUser(context.Background(), "my-project", mock.AnythingOfType("*admin.CloudDatabaseUser")).
Return(admin.CreateDatabaseUserApiRequest{ApiService: userAPI})
Return(adminv20241113001.CreateDatabaseUserApiRequest{ApiService: userAPI})
userAPI.EXPECT().CreateDatabaseUserExecute(mock.AnythingOfType("admin.CreateDatabaseUserApiRequest")).
Return(&admin.CloudDatabaseUser{}, nil, nil)
Return(&adminv20241113001.CloudDatabaseUser{}, nil, nil)

clusterAPI := mockadmin.NewClustersApi(t)

Expand All @@ -2283,11 +2284,12 @@ func DefaultTestProvider(t *testing.T) *atlasmock.TestProvider {

return &atlas.ClientSet{
SdkClient20231115008: &admin.APIClient{
ProjectsApi: projectAPI,
ClustersApi: clusterAPI,
ProjectsApi: projectAPI,
ClustersApi: clusterAPI,
},
SdkClient20241113001: &adminv20241113001.APIClient{
DatabaseUsersApi: userAPI,
},
SdkClient20241113001: &adminv20241113001.APIClient{},
}, nil
},
}
Expand Down
4 changes: 3 additions & 1 deletion internal/translation/dbuser/conversion.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"time"

"github.com/nsf/jsondiff"
"go.mongodb.org/atlas-sdk/v20231115008/admin"
"go.mongodb.org/atlas-sdk/v20241113001/admin"

akov2 "github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1"
"github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1/common"
Expand Down Expand Up @@ -126,6 +126,7 @@ func fromAtlas(dbUser *admin.CloudDatabaseUser) (*User, error) {
AtlasDatabaseUserSpec: &akov2.AtlasDatabaseUserSpec{
DatabaseName: dbUser.DatabaseName,
DeleteAfterDate: dateFromAtlas(dbUser.DeleteAfterDate),
Description: dbUser.GetDescription(),
Labels: labelsFromAtlas(dbUser.Labels),
Roles: rolesFromAtlas(dbUser.GetRoles()),
Scopes: scopes,
Expand Down Expand Up @@ -155,6 +156,7 @@ func toAtlas(au *User) (*admin.CloudDatabaseUser, error) {
X509Type: pointer.MakePtrOrNil(au.X509Type),
AwsIAMType: pointer.MakePtrOrNil(au.AWSIAMType),
GroupId: au.ProjectID,
Description: pointer.MakePtrOrNil(au.Description),
Labels: labelsToAtlas(au.Labels),
Roles: rolesToAtlas(au.Roles),
Scopes: scopesToAtlas(au.Scopes),
Expand Down
2 changes: 1 addition & 1 deletion internal/translation/dbuser/dbuser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import (
"errors"
"fmt"

"go.mongodb.org/atlas-sdk/v20231115008/admin"
"go.mongodb.org/atlas-sdk/v20241113001/admin"

"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/controller/atlas"
)
Expand Down
13 changes: 6 additions & 7 deletions internal/translation/dbuser/dbuser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ import (

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

akov2 "github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1"
"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/pointer"
)

func TestAtlasUsersGet(t *testing.T) {
Expand All @@ -37,7 +36,7 @@ func TestAtlasUsersGet(t *testing.T) {
username := "test-user"

notFoundErr := &admin.GenericOpenAPIError{}
notFoundErr.SetModel(admin.ApiError{ErrorCode: pointer.MakePtr("USERNAME_NOT_FOUND")})
notFoundErr.SetModel(admin.ApiError{ErrorCode: "USERNAME_NOT_FOUND"})

tests := []struct {
name string
Expand Down Expand Up @@ -83,7 +82,7 @@ func TestAtlasUsersGet(t *testing.T) {
admin.GetDatabaseUserApiRequest{ApiService: mockUsersAPI})

internalServerError := &admin.GenericOpenAPIError{}
internalServerError.SetModel(admin.ApiError{ErrorCode: pointer.MakePtr("500")})
internalServerError.SetModel(admin.ApiError{ErrorCode: "500"})
mockUsersAPI.EXPECT().GetDatabaseUserExecute(admin.GetDatabaseUserApiRequest{ApiService: mockUsersAPI}).Return(
nil, &http.Response{StatusCode: http.StatusInternalServerError}, errors.New("some error"))
},
Expand Down Expand Up @@ -112,7 +111,7 @@ func TestAtlasUsersDelete(t *testing.T) {
db := "database"
username := "test-user"
notFoundErr := &admin.GenericOpenAPIError{}
notFoundErr.SetModel(admin.ApiError{ErrorCode: pointer.MakePtr("USER_NOT_FOUND")})
notFoundErr.SetModel(admin.ApiError{ErrorCode: "USER_NOT_FOUND"})
tests := []struct {
name string
setupMock func(mockUsersAPI *mockadmin.DatabaseUsersApi)
Expand Down Expand Up @@ -146,7 +145,7 @@ func TestAtlasUsersDelete(t *testing.T) {
admin.DeleteDatabaseUserApiRequest{ApiService: mockUsersAPI})

internalServerError := &admin.GenericOpenAPIError{}
internalServerError.SetModel(admin.ApiError{ErrorCode: pointer.MakePtr("500")})
internalServerError.SetModel(admin.ApiError{ErrorCode: "500"})
mockUsersAPI.EXPECT().DeleteDatabaseUserExecute(admin.DeleteDatabaseUserApiRequest{ApiService: mockUsersAPI}).
Return(nil, &http.Response{StatusCode: http.StatusInternalServerError}, fmt.Errorf("some error"))
},
Expand Down
2 changes: 1 addition & 1 deletion internal/translation/dbuser/internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.mongodb.org/atlas-sdk/v20231115008/admin"
"go.mongodb.org/atlas-sdk/v20241113001/admin"

akov2 "github.com/mongodb/mongodb-atlas-kubernetes/v2/api/v1"
"github.com/mongodb/mongodb-atlas-kubernetes/v2/internal/pointer"
Expand Down
Loading