Enhancement: Support Preflight Validation #501
Conversation
internal/services/azapi_resource.go
Outdated
| requestBody["scope"] = requestPlan.ParentID.ValueString() | ||
| requestBody["resources"] = []map[string]interface{}{resourceBody} | ||
|
|
||
| _, err = client.Action(ctx, "/providers/Microsoft.Resources", "validateResources", "2020-10-01", "POST", requestBody) |
There was a problem hiding this comment.
Please define the request body struct for validateResources API instead of using the generic struct.
There was a problem hiding this comment.
updated. Thanks.
internal/services/azapi_resource.go
Outdated
| @@ -929,6 +938,40 @@ func expandBody(body map[string]interface{}, model AzapiResourceModel) diag.Diag | |||
| return diag.Diagnostics{} | |||
| } | |||
|
|
|||
| func preflightValidation(ctx context.Context, client *clients.ResourceClient, requestPlan *AzapiResourceModel, body map[string]interface{}) error { | |||
There was a problem hiding this comment.
Please use id parse.ResourceId instead of requestPlan *AzapiResourceModel, because the necessary information could be retrieved by the parse.ResourceId.
There was a problem hiding this comment.
updated. Thanks.
internal/services/azapi_resource.go
Outdated
| @@ -502,6 +502,15 @@ func (r *AzapiResource) CreateUpdate(ctx context.Context, requestPlan tfsdk.Plan | |||
| defer locks.UnlockByID(lockId) | |||
| } | |||
|
|
|||
| // preflight validation: currently only supports the subscription scope validation | |||
| if r.ProviderData.Features.EnablePreflight && isNewResource && strings.Contains(strings.ToLower(plan.ParentID.ValueString()), "/subscriptions/") { | |||
There was a problem hiding this comment.
Could we use strings.HasPrefix() here as the /subscriptions/ must always be at the start?
There was a problem hiding this comment.
updated. Thanks.
internal/services/azapi_resource.go
Outdated
| strings.EqualFold(arm.TenantResourceType.String(), resourceType) || | ||
| strings.EqualFold("Microsoft.Management/managementGroups", resourceType) | ||
|
|
||
| return r.ProviderData.Features.EnablePreflight && isNewResource && isSupportedParentID |
There was a problem hiding this comment.
I think r.ProviderData.Features.EnablePreflight && isNewResource should be moved out from this function, because this function is about "whether preflight is supported on a give resource", once this is addressed, this PR should be good to go. Thanks!
internal/services/azapi_resource.go
Outdated
| return nil | ||
| } | ||
|
|
||
| if plan.Name.IsNull() || plan.Name.IsUnknown() { |
There was a problem hiding this comment.
use a random value for name if unknown
internal/services/azapi_resource.go
Outdated
| requestBody.Scope = parentId | ||
|
|
||
| if !plan.Location.IsNull() && !plan.Location.IsUnknown() { | ||
| requestBody.Location = plan.Location.ValueString() |
There was a problem hiding this comment.
if location does not exist, Preflight will skip the validation and return 200 ok without any error.
Related Document:
https://armwiki.azurewebsites.net/api_contracts/preflight.html
Test Results
--- PASS: TestAccGenericResource_defaultParentId (169.21s)
--- PASS: TestAccGenericResource_disablePreflightValidation (173.48s)
--- PASS: TestAccGenericResource_preflightResourceGroupLevelValidation (186.22s)
--- PASS: TestAccGenericResource_ignoreChanges (213.73s)
--- PASS: TestAccGenericResource_basic (255.66s)
--- PASS: TestAccGenericResource_ignoreChangesArray (265.48s)
--- PASS: TestAccGenericResource_completeBody (271.28s)
--- PASS: TestAccGenericResource_defaultsNaming (341.81s)
--- PASS: TestAccGenericResource_requiresImport (150.80s)
--- PASS: TestAccGenericResource_defaultLocation (379.96s)
--- PASS: TestAccGenericResource_defaultsNotApplicable (213.14s)
--- PASS: TestAccGenericResource_complete (214.40s)
--- PASS: TestAccGenericResource_importWithApiVersion (228.25s)
--- PASS: TestAccGenericResource_locks (207.35s)
--- PASS: TestAccGenericResource_subscriptionScope (124.44s)
--- PASS: TestAccGenericResource_nullLocation (611.74s)
--- PASS: TestAccGenericResource_ignoreCasing (345.26s)
--- PASS: TestAccGenericResource_identity (459.51s)
--- PASS: TestAccGenericResource_defaultTags (507.41s)
--- PASS: TestAccGenericResource_invalidVersionUpdate (318.07s)
--- PASS: TestAccGenericResource_dynamicSchema (214.23s)
--- PASS: TestAccGenericResource_deleteLROEndsWithNotFoundError (344.94s)
--- PASS: TestAccGenericResource_secretsInAsterisks (748.64s)
--- PASS: TestAccGenericResource_ignoreMissingProperty (420.70s)
PASS
ok github.com/Azure/terraform-provider-azapi/internal/services 842.574s