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

Remove ValidateConfig from API token resource to allow dynamic creation #184

Merged
merged 33 commits into from
Jan 9, 2025
Merged

Remove ValidateConfig from API token resource to allow dynamic creation #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
cae0fa2
Remove ValidateConfig from API token resource to allow dynamic creation
vandyliu Jan 8, 2025
5c98328
fix test
vandyliu Jan 8, 2025
082a23c
fix test
vandyliu Jan 8, 2025
d0e5a2c
fix test
vandyliu Jan 8, 2025
026f901
fix test
vandyliu Jan 8, 2025
da4e058
fix test
vandyliu Jan 8, 2025
b848c38
test fix
vandyliu Jan 8, 2025
4a17c44
fix test
vandyliu Jan 8, 2025
59a328b
fix
vandyliu Jan 8, 2025
bb35bbe
remove test
vandyliu Jan 8, 2025
2464df9
test
vandyliu Jan 8, 2025
059d00c
Revert "test"
vandyliu Jan 9, 2025
d375b8e
add back Test invalid role for token type
vandyliu Jan 9, 2025
ca5189c
add invalid orgid test
vandyliu Jan 9, 2025
8fbcaef
fix
vandyliu Jan 9, 2025
ad578f8
add back test for Test invalid role for entity type
vandyliu Jan 9, 2025
ac10ac2
fix
vandyliu Jan 9, 2025
8a8ac07
fic
vandyliu Jan 9, 2025
91f1570
fix
vandyliu Jan 9, 2025
9c81729
400
vandyliu Jan 9, 2025
2d6e424
fix
vandyliu Jan 9, 2025
d400a72
fix
vandyliu Jan 9, 2025
c87373a
try just invalid deployment
vandyliu Jan 9, 2025
aac8e15
fix
vandyliu Jan 9, 2025
2c8b5f9
fix
vandyliu Jan 9, 2025
8c72556
work
vandyliu Jan 9, 2025
82ff6e2
try invalid workspace and invalid dep again
vandyliu Jan 9, 2025
796345a
fix
vandyliu Jan 9, 2025
0b42633
fix
vandyliu Jan 9, 2025
e140a0e
fix test
vandyliu Jan 9, 2025
3e9d1f1
add role validation in create and update
vandyliu Jan 9, 2025
0b51730
go to original test file
vandyliu Jan 9, 2025
2735146
remove wrong words
vandyliu Jan 9, 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
62 changes: 16 additions & 46 deletions internal/provider/resources/resource_api_token.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import (
var _ resource.Resource = &ApiTokenResource{}
var _ resource.ResourceWithImportState = &ApiTokenResource{}
var _ resource.ResourceWithConfigure = &ApiTokenResource{}
var _ resource.ResourceWithValidateConfig = &ApiTokenResource{}

func NewApiTokenResource() resource.Resource {
return &ApiTokenResource{}
Expand Down Expand Up @@ -136,6 +135,13 @@ func (r *ApiTokenResource) Create(
return
}

// Validate roles
diags = r.ValidateApiTokenRoles(data.Type.ValueString(), roles)
if diags != nil {
resp.Diagnostics.Append(diags...)
return
}

// Create the API token request
createApiTokenRequest := iam.CreateApiTokenRequest{
Name: data.Name.ValueString(),
Expand Down Expand Up @@ -349,6 +355,13 @@ func (r *ApiTokenResource) Update(
return
}

// Validate roles
diags = r.ValidateApiTokenRoles(data.Type.ValueString(), roles)
if diags != nil {
resp.Diagnostics.Append(diags...)
return
}

// Update API token roles
updateApiTokenRolesRequest := iam.UpdateApiTokenRolesRequest{
Roles: roles,
Expand Down Expand Up @@ -478,49 +491,6 @@ func (r *ApiTokenResource) ImportState(
resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
}

func (r *ApiTokenResource) ValidateConfig(
vandyliu marked this conversation as resolved.
Show resolved Hide resolved
ctx context.Context,
req resource.ValidateConfigRequest,
resp *resource.ValidateConfigResponse,
) {
var data models.ApiTokenResource

resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
if resp.Diagnostics.HasError() {
return
}

// Convert Terraform set of roles to API token roles
roles, diags := RequestApiTokenRoles(ctx, data.Roles)
if diags.HasError() {
resp.Diagnostics.Append(diags...)
return
}

tokenRole, diags := RequestApiTokenPrimaryRole(roles, data.Type.ValueString())
if diags != nil {
resp.Diagnostics.Append(diags...)
return
}

entityType := data.Type.ValueString()

// Check if the role is valid for the token entity type
if !common.ValidateRoleMatchesEntityType(tokenRole.Role, entityType) {
resp.Diagnostics.AddError(
fmt.Sprintf("Role '%s' is not valid for token type '%s'", tokenRole.Role, entityType),
fmt.Sprintf("Please provide a valid role for the entity type '%s'", entityType),
)
return
}

diags = r.ValidateApiTokenRoles(entityType, roles)
if diags != nil {
resp.Diagnostics.Append(diags...)
return
}
}

func (r *ApiTokenResource) ValidateApiTokenRoles(entityType string, roles []iam.ApiTokenRole) diag.Diagnostics {
var numRolesMatchingEntityType int
var invalidRoleError string
Expand All @@ -547,8 +517,8 @@ func (r *ApiTokenResource) ValidateApiTokenRoles(entityType string, roles []iam.
if !common.ValidateRoleMatchesEntityType(role.Role, string(role.EntityType)) {
return diag.Diagnostics{
diag.NewErrorDiagnostic(
fmt.Sprintf("Role '%s' is not valid for entity type '%s'", role.Role, role.EntityType),
fmt.Sprintf("Please provide a valid role for the entity type '%s'", role.EntityType),
fmt.Sprintf("Role '%s' is not valid for token type '%s'", role.Role, role.EntityType),
fmt.Sprintf("Please provide a valid role for the token type '%s'", role.EntityType),
),
}
}
Expand Down
24 changes: 12 additions & 12 deletions internal/provider/resources/resource_api_token_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ func TestAcc_ResourceOrganizationApiToken(t *testing.T) {
ProtoV6ProviderFactories: astronomerprovider.TestAccProtoV6ProviderFactories,
PreCheck: func() { astronomerprovider.TestAccPreCheck(t) },
CheckDestroy: resource.ComposeTestCheckFunc(
// Check that the organization api token has been removed
// Check that the api token has been removed
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, organization: true, shouldExist: false}),
),
Steps: []resource.TestStep{
Expand Down Expand Up @@ -196,7 +196,7 @@ func TestAcc_ResourceOrganizationApiToken(t *testing.T) {
resource.TestCheckResourceAttr(resourceVar, "roles.2.entity_id", deploymentId),
resource.TestCheckResourceAttr(resourceVar, "roles.2.entity_type", string(iam.DEPLOYMENT)),
resource.TestCheckResourceAttr(resourceVar, "roles.2.role", "DEPLOYMENT_ADMIN"),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, organization: true, shouldExist: true}),
),
},
Expand Down Expand Up @@ -227,7 +227,7 @@ func TestAcc_ResourceOrganizationApiToken(t *testing.T) {
}),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceVar, "description", "new description"),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, organization: true, shouldExist: true}),
),
},
Expand Down Expand Up @@ -310,7 +310,7 @@ func TestAcc_ResourceOrganizationApiToken(t *testing.T) {
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceVar, "type", string(iam.ORGANIZATION)),
resource.TestCheckResourceAttr(resourceVar, "description", utils.TestResourceDescription),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, organization: true, shouldExist: true}),
),
},
Expand Down Expand Up @@ -339,7 +339,7 @@ func TestAcc_ResourceWorkspaceApiToken(t *testing.T) {
ProtoV6ProviderFactories: astronomerprovider.TestAccProtoV6ProviderFactories,
PreCheck: func() { astronomerprovider.TestAccPreCheck(t) },
CheckDestroy: resource.ComposeTestCheckFunc(
// Check that the organization api token has been removed
// Check that the api token has been removed
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, workspace: true, shouldExist: false}),
),
Steps: []resource.TestStep{
Expand Down Expand Up @@ -467,7 +467,7 @@ func TestAcc_ResourceWorkspaceApiToken(t *testing.T) {
resource.TestCheckResourceAttr(resourceVar, "roles.1.entity_id", deploymentId),
resource.TestCheckResourceAttr(resourceVar, "roles.1.entity_type", string(iam.DEPLOYMENT)),
resource.TestCheckResourceAttr(resourceVar, "roles.1.role", "DEPLOYMENT_ADMIN"),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, workspace: true, shouldExist: true}),
),
},
Expand All @@ -493,7 +493,7 @@ func TestAcc_ResourceWorkspaceApiToken(t *testing.T) {
}),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceVar, "description", "new description"),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, workspace: true, shouldExist: true}),
),
},
Expand Down Expand Up @@ -544,7 +544,7 @@ func TestAcc_ResourceWorkspaceApiToken(t *testing.T) {
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceVar, "type", string(iam.WORKSPACE)),
resource.TestCheckResourceAttr(resourceVar, "description", utils.TestResourceDescription),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, workspace: true, shouldExist: true}),
),
},
Expand Down Expand Up @@ -573,7 +573,7 @@ func TestAcc_ResourceDeploymentApiToken(t *testing.T) {
ProtoV6ProviderFactories: astronomerprovider.TestAccProtoV6ProviderFactories,
PreCheck: func() { astronomerprovider.TestAccPreCheck(t) },
CheckDestroy: resource.ComposeTestCheckFunc(
// Check that the organization api token has been removed
// Check that the api token has been removed
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, deployment: true, shouldExist: false}),
),
Steps: []resource.TestStep{
Expand Down Expand Up @@ -668,7 +668,7 @@ func TestAcc_ResourceDeploymentApiToken(t *testing.T) {
resource.TestCheckResourceAttr(resourceVar, "roles.0.entity_id", deploymentId),
resource.TestCheckResourceAttr(resourceVar, "roles.0.entity_type", string(iam.DEPLOYMENT)),
resource.TestCheckResourceAttr(resourceVar, "roles.0.role", "DEPLOYMENT_ADMIN"),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, deployment: true, shouldExist: true}),
),
},
Expand All @@ -689,7 +689,7 @@ func TestAcc_ResourceDeploymentApiToken(t *testing.T) {
}),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceVar, "description", "new description"),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, deployment: true, shouldExist: true}),
),
},
Expand Down Expand Up @@ -736,7 +736,7 @@ func TestAcc_ResourceDeploymentApiToken(t *testing.T) {
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(resourceVar, "type", string(iam.DEPLOYMENT)),
resource.TestCheckResourceAttr(resourceVar, "description", utils.TestResourceDescription),
// Check via API that organization api token exists
// Check via API that api token exists
testAccCheckApiTokenExistence(t, checkApiTokensExistenceInput{name: apiTokenName, deployment: true, shouldExist: true}),
),
},
Expand Down
Loading