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.

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: project delete function uses correct string representation of id #1733

Merged
merged 5 commits into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
31 changes: 15 additions & 16 deletions internal/service/project/resource_project.go
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ func (r *projectRS) Create(ctx context.Context, req resource.CreateRequest, resp

_, _, err := connV2.TeamsApi.AddAllTeamsToProject(ctx, project.GetId(), NewTeamRoleList(ctx, teams)).Execute()
if err != nil {
errd := deleteProject(ctx, r.Client.AtlasV2, project.Id)
errd := deleteProject(ctx, r.Client.AtlasV2, project.GetId())
Copy link
Member

Choose a reason for hiding this comment

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

can we have a test that fails before this change and passes after?

Copy link
Collaborator Author

@oarbusi oarbusi Dec 11, 2023

Choose a reason for hiding this comment

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

we now have. The call we mock in the test is only mocked with correct projectId, so in case the string has extra quotes, tests fail. See image
Screenshot 2023-12-11 at 11 14 26

Copy link
Member

Choose a reason for hiding this comment

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

great, thx!

if errd != nil {
resp.Diagnostics.AddError("error during project deletion when adding teams", fmt.Sprintf(errorProjectDelete, project.GetId(), err.Error()))
return
Expand All @@ -290,7 +290,7 @@ func (r *projectRS) Create(ctx context.Context, req resource.CreateRequest, resp
}
_, _, err := connV2.ProjectsApi.SetProjectLimit(ctx, limit.Name.ValueString(), project.GetId(), dataFederationLimit).Execute()
if err != nil {
errd := deleteProject(ctx, r.Client.AtlasV2, project.Id)
errd := deleteProject(ctx, r.Client.AtlasV2, project.GetId())
if errd != nil {
resp.Diagnostics.AddError("error during project deletion when adding limits", fmt.Sprintf(errorProjectDelete, project.GetId(), err.Error()))
return
Expand All @@ -304,7 +304,7 @@ func (r *projectRS) Create(ctx context.Context, req resource.CreateRequest, resp
// add settings
projectSettings, _, err := connV2.ProjectsApi.GetProjectSettings(ctx, *project.Id).Execute()
if err != nil {
errd := deleteProject(ctx, r.Client.AtlasV2, project.Id)
errd := deleteProject(ctx, r.Client.AtlasV2, project.GetId())
if errd != nil {
resp.Diagnostics.AddError("error during project deletion when getting project settings", fmt.Sprintf(errorProjectDelete, project.GetId(), err.Error()))
return
Expand Down Expand Up @@ -333,7 +333,7 @@ func (r *projectRS) Create(ctx context.Context, req resource.CreateRequest, resp
}

if _, _, err = connV2.ProjectsApi.UpdateProjectSettings(ctx, project.GetId(), projectSettings).Execute(); err != nil {
errd := deleteProject(ctx, r.Client.AtlasV2, project.Id)
errd := deleteProject(ctx, r.Client.AtlasV2, project.GetId())
if errd != nil {
resp.Diagnostics.AddError("error during project deletion when updating project settings", fmt.Sprintf(errorProjectDelete, project.GetId(), err.Error()))
return
Expand Down Expand Up @@ -494,7 +494,7 @@ func (r *projectRS) Delete(ctx context.Context, req resource.DeleteRequest, resp
}

projectID := project.ID.ValueString()
err := deleteProject(ctx, r.Client.AtlasV2, &projectID)
err := deleteProject(ctx, r.Client.AtlasV2, projectID)

if err != nil {
resp.Diagnostics.AddError("error when destroying resource", fmt.Sprintf(errorProjectDelete, projectID, err.Error()))
Expand Down Expand Up @@ -725,11 +725,11 @@ func UpdateProject(ctx context.Context, client GroupProjectService, projectState
return nil
}

func deleteProject(ctx context.Context, connV2 *admin.APIClient, projectID *string) error {
func deleteProject(ctx context.Context, connV2 *admin.APIClient, projectID string) error {
stateConf := &retry.StateChangeConf{
Pending: []string{projectDependentsStateDeleting, projectDependentsStateRetry},
Target: []string{projectDependentsStateIdle},
Refresh: resourceProjectDependentsDeletingRefreshFunc(ctx, projectID, connV2),
Refresh: ResourceProjectDependentsDeletingRefreshFunc(ctx, projectID, ServiceFromClient(connV2)),
Timeout: 30 * time.Minute,
MinTimeout: 30 * time.Second,
Delay: 0,
Expand All @@ -738,10 +738,10 @@ func deleteProject(ctx context.Context, connV2 *admin.APIClient, projectID *stri
_, err := stateConf.WaitForStateContext(ctx)

if err != nil {
tflog.Info(ctx, fmt.Sprintf("[ERROR] could not determine MongoDB project %s dependents status: %s", *projectID, err.Error()))
tflog.Info(ctx, fmt.Sprintf("[ERROR] could not determine MongoDB project %s dependents status: %s", projectID, err.Error()))
}

_, _, err = connV2.ProjectsApi.DeleteProject(ctx, *projectID).Execute()
_, _, err = connV2.ProjectsApi.DeleteProject(ctx, projectID).Execute()

return err
}
Expand All @@ -755,17 +755,16 @@ Else consider the aggregate dependents idle.
If we get a defined error response, return that right away
Else retry
*/
func resourceProjectDependentsDeletingRefreshFunc(ctx context.Context, projectID *string, connV2 *admin.APIClient) retry.StateRefreshFunc {
func ResourceProjectDependentsDeletingRefreshFunc(ctx context.Context, projectID string, client GroupProjectService) retry.StateRefreshFunc {
return func() (any, string, error) {
nonNullProjectID := conversion.StringPtrNullIfEmpty(projectID)
clusters, _, err := connV2.ClustersApi.ListClusters(ctx, nonNullProjectID.String()).Execute()
clusters, _, listClustersErr := client.ListClusters(ctx, projectID)
dependents := AtlasProjectDependants{AdvancedClusters: clusters}

if _, ok := admin.AsError(err); ok {
return nil, "", err
if _, ok := admin.AsError(listClustersErr); ok {
Copy link
Member

Choose a reason for hiding this comment

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

(this would imply removing redudant if statement below)

Suggested change
if _, ok := admin.AsError(listClustersErr); ok {
if listClustersErr != nil {

curious if we want to unify both error checks, don't see a reason why for ApiError we would return error, while for others SDK error types keep on retrying. Would simply return error for an encountered error.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I didn't want to change this to avoid changing behaviour, but I think it makes sense to unify it.

return nil, "", listClustersErr
}

if err != nil {
if listClustersErr != nil {
return nil, projectDependentsStateRetry, nil
}

Expand All @@ -779,7 +778,7 @@ func resourceProjectDependentsDeletingRefreshFunc(ctx context.Context, projectID
}
}

log.Printf("[DEBUG] status for MongoDB project %s dependents: %s", nonNullProjectID, projectDependentsStateDeleting)
log.Printf("[DEBUG] status for MongoDB project %s dependents: %s", projectID, projectDependentsStateDeleting)

return dependents, projectDependentsStateDeleting, nil
}
Expand Down
62 changes: 61 additions & 1 deletion internal/service/project/resource_project_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ var (
projectStateNameDiff = project.TfProjectRSModel{
Name: diffName,
}
dummyProjectID = "projectId"
dummyProjectID = "6575af27f93c7a6a4b50b239"
)

func TestGetProjectPropsFromAPI(t *testing.T) {
Expand Down Expand Up @@ -418,6 +418,59 @@ func TestUpdateProjectTeams(t *testing.T) {
}
}

func TestResourceProjectDependentsDeletingRefreshFunc(t *testing.T) {
testCases := []struct {
name string
mockResponses ProjectResponse
expectedError bool
}{
{
name: "Error not from the API",
mockResponses: ProjectResponse{
clusterReponse: &admin.PaginatedAdvancedClusterDescription{},
Err: errors.New("Non-API error"),
},
expectedError: false,
},
{
name: "Error from the API",
mockResponses: ProjectResponse{
clusterReponse: &admin.PaginatedAdvancedClusterDescription{},
Err: &admin.GenericOpenAPIError{},
},
expectedError: true,
},
{
name: "Successful API call",
mockResponses: ProjectResponse{
clusterReponse: &admin.PaginatedAdvancedClusterDescription{
TotalCount: conversion.IntPtr(2),
Results: []admin.AdvancedClusterDescription{
{StateName: conversion.StringPtr("IDLE")},
{StateName: conversion.StringPtr("DELETING")},
},
},
Err: nil,
},
expectedError: false,
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
testObject := new(MockProjectService)

testObject.On("ListClusters", mock.Anything, dummyProjectID).Return(tc.mockResponses)

_, _, err := project.ResourceProjectDependentsDeletingRefreshFunc(context.Background(), dummyProjectID, testObject)()

if (err != nil) != tc.expectedError {
t.Errorf("Case %s: Received unexpected error: %v", tc.name, err)
}
})
}
}

func TestAccProjectRSProject_basic(t *testing.T) {
var (
group admin.Group
Expand Down Expand Up @@ -901,10 +954,17 @@ func (a *MockProjectService) AddAllTeamsToProject(ctx context.Context, groupID s
return response.ProjectTeamResp, response.HTTPResponse, response.Err
}

func (a *MockProjectService) ListClusters(ctx context.Context, groupID string) (*admin.PaginatedAdvancedClusterDescription, *http.Response, error) {
args := a.Called(ctx, groupID)
var response = args.Get(0).(ProjectResponse)
return response.clusterReponse, response.HTTPResponse, response.Err
}

type ProjectResponse struct {
ProjectResp *admin.Group
ProjectTeamResp *admin.PaginatedTeamRole
GroupSettingsResponse *admin.GroupSettings
clusterReponse *admin.PaginatedAdvancedClusterDescription
HTTPResponse *http.Response
Err error
LimitResponse admin.DataFederationLimit
Expand Down
5 changes: 5 additions & 0 deletions internal/service/project/service_project.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ type GroupProjectService interface {
RemoveProjectTeam(ctx context.Context, groupID, teamID string) (*http.Response, error)
UpdateTeamRoles(ctx context.Context, groupID, teamID string, teamRole *admin.TeamRole) (*admin.PaginatedTeamRole, *http.Response, error)
AddAllTeamsToProject(ctx context.Context, groupID string, teamRole *[]admin.TeamRole) (*admin.PaginatedTeamRole, *http.Response, error)
ListClusters(ctx context.Context, groupID string) (*admin.PaginatedAdvancedClusterDescription, *http.Response, error)
}

type GroupProjectServiceFromClient struct {
Expand Down Expand Up @@ -60,6 +61,10 @@ func (a *GroupProjectServiceFromClient) AddAllTeamsToProject(ctx context.Context
return a.client.TeamsApi.AddAllTeamsToProject(ctx, groupID, teamRole).Execute()
}

func (a *GroupProjectServiceFromClient) ListClusters(ctx context.Context, groupID string) (*admin.PaginatedAdvancedClusterDescription, *http.Response, error) {
return a.client.ClustersApi.ListClusters(ctx, groupID).Execute()
}

func ServiceFromClient(client *admin.APIClient) GroupProjectService {
return &GroupProjectServiceFromClient{
client: client,
Expand Down