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

consumption - remove 4.0 flag and fix tests #27511

Merged
merged 8 commits into from
Oct 24, 2024
Merged

consumption - remove 4.0 flag and fix tests #27511

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
eb34f96
fix comsumption issue
teowa Sep 26, 2024
35155db
remove forcenew for threshold_type
teowa Sep 26, 2024
4b8157e
terrafmt
teowa Sep 26, 2024
f4153e3
link issue
teowa Sep 27, 2024
0bbc190
Merge branch 'main' of github.com:hashicorp/terraform-provider-azurer…
teowa Oct 21, 2024
28f2fb6
skip delete error on 404
teowa Oct 21, 2024
d95a6b0
remove linked issue
teowa Oct 23, 2024
e13dc70
remove _disappear test and revert skipping 404 in deleting
teowa Oct 24, 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
122 changes: 5 additions & 117 deletions internal/services/consumption/consumption_budget_base.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import (
"github.com/hashicorp/go-azure-helpers/lang/response"
"github.com/hashicorp/go-azure-sdk/resource-manager/consumption/2019-10-01/budgets"
"github.com/hashicorp/terraform-provider-azurerm/helpers/tf"
"github.com/hashicorp/terraform-provider-azurerm/internal/features"
"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
"github.com/hashicorp/terraform-provider-azurerm/internal/services/consumption/validate"
"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
Expand Down Expand Up @@ -153,13 +152,10 @@ func (br consumptionBudgetBaseResource) arguments(fields map[string]*pluginsdk.S
ValidateFunc: validation.IntBetween(0, 1000),
},
// Issue: https://github.com/Azure/azure-rest-api-specs/issues/16240
Copy link
Member

Choose a reason for hiding this comment

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

Looks like this comment should also be removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updated

// Toggling between these two values doesn't work at the moment and also doesn't throw an error
// but it seems unlikely that a user would switch the threshold_type of their budgets frequently
"threshold_type": {
Type: pluginsdk.TypeString,
Optional: true,
Default: string(budgets.ThresholdTypeActual),
ForceNew: true, // TODO: remove this when the above issue is fixed
ValidateFunc: validation.StringInSlice([]string{
string(budgets.ThresholdTypeActual),
"Forecasted",
Expand Down Expand Up @@ -244,82 +240,6 @@ func (br consumptionBudgetBaseResource) arguments(fields map[string]*pluginsdk.S
},
}

if !features.FourPointOhBeta() {
output["filter"].Elem.(*pluginsdk.Resource).Schema["not"] = &pluginsdk.Schema{
Type: pluginsdk.TypeList,
Optional: true,
MaxItems: 1,
Deprecated: "This property has been deprecated as the API no longer supports it and will be removed in version 4.0 of the provider.",
AtLeastOneOf: []string{"filter.0.dimension", "filter.0.tag", "filter.0.not"},
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"dimension": {
Type: pluginsdk.TypeList,
MaxItems: 1,
Optional: true,
ExactlyOneOf: []string{"filter.0.not.0.tag"},
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"name": {
Type: pluginsdk.TypeString,
Required: true,
ValidateFunc: validation.StringInSlice(getDimensionNames(), false),
},
"operator": {
Type: pluginsdk.TypeString,
Optional: true,
Default: "In",
ValidateFunc: validation.StringInSlice([]string{
"In",
}, false),
},
"values": {
Type: pluginsdk.TypeList,
MinItems: 1,
Required: true,
Elem: &pluginsdk.Schema{
Type: pluginsdk.TypeString,
ValidateFunc: validation.StringIsNotEmpty,
},
},
},
},
},
"tag": {
Type: pluginsdk.TypeList,
MaxItems: 1,
Optional: true,
ExactlyOneOf: []string{"filter.0.not.0.dimension"},
Elem: &pluginsdk.Resource{
Schema: map[string]*pluginsdk.Schema{
"name": {
Type: pluginsdk.TypeString,
Required: true,
},
"operator": {
Type: pluginsdk.TypeString,
Optional: true,
Default: "In",
ValidateFunc: validation.StringInSlice([]string{
"In",
}, false),
},
"values": {
Type: pluginsdk.TypeList,
Required: true,
Elem: &pluginsdk.Schema{
Type: pluginsdk.TypeString,
ValidateFunc: validation.StringIsNotEmpty,
},
},
},
},
},
},
},
}
}

// Consumption Budgets for Management Groups have a different notification schema,
// here we override the notification schema in the base resource
for k, v := range fields {
Expand Down Expand Up @@ -384,7 +304,7 @@ func (br consumptionBudgetBaseResource) readFunc(scopeFieldName string) sdk.Reso
}

metadata.ResourceData.Set("name", id.BudgetName)
//lintignore:R001
// lintignore:R001
metadata.ResourceData.Set(scopeFieldName, id.Scope)

if model := resp.Model; model != nil {
Expand Down Expand Up @@ -418,8 +338,10 @@ func (br consumptionBudgetBaseResource) deleteFunc() sdk.ResourceFunc {
return err
}

if _, err = client.Delete(ctx, *id); err != nil {
return fmt.Errorf("deleting %s: %+v", *id, err)
if resp, err := client.Delete(ctx, *id); err != nil {
if !response.WasNotFound(resp.HttpResponse) {
return fmt.Errorf("deleting %s: %+v", *id, err)
}
Copy link
Member

Choose a reason for hiding this comment

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

We don't usually need to specifically check for a 404 when deleting. If the resource is disappearing before we're able to delete it then that would imply we're not marking this as gone in the read or something is going wrong before we're calling the delete.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually this is to fix the below TestAccConsumptionBudgetResourceGroup_disappears failure, the testcase tries to perform post-test destroy even the resource has been deleted and seems SDK will fire error if delete returns 404. There are many other _disappears testcase but it won't fail if API returns 204 for deleting an non-existing resource. Or should we remove the below testcase?

------- Stdout: -------
=== RUN   TestAccConsumptionBudgetResourceGroup_disappears
=== PAUSE TestAccConsumptionBudgetResourceGroup_disappears
=== CONT  TestAccConsumptionBudgetResourceGroup_disappears
    testcase.go:173: Error running post-test destroy, there may be dangling resources: exit status 1
        Error: deleting Scoped Budget (Scope: "/subscriptions/*******/resourceGroups/acctestRG-241023001722601091"
        Budget Name: "acctestconsumptionbudgetresourcegroup-241023001722601091"): unexpected status 404 (404 Not Found) with error: 404: No budget found matching budgetName: acctestconsumptionbudgetresourcegroup-241023001722601091, under storageScope: EntityType = Subscription, EntityId = *******, ChildScope = EntityType = ResourceGroup, EntityId = acctestRG-241023001722601091, ChildScope = , MetaData =  , MetaData =   (Request ID: 669a79c6-e268-4a25-bed9-78f2cc7d54ab)

Copy link
Member

Choose a reason for hiding this comment

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

These _disappears test cases are an old pattern that we don't really test for in the provider anymore. I believe @jackofallops has begun removing instances of these in the provider, so this test case should be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That makes sense!

}

return nil
Expand Down Expand Up @@ -700,22 +622,6 @@ func expandConsumptionBudgetFilter(i []interface{}) *budgets.BudgetFilter {

filter := budgets.BudgetFilter{}

if !features.FourPointOhBeta() {
notBlock := input["not"].([]interface{})
if len(notBlock) != 0 && notBlock[0] != nil {
not := notBlock[0].(map[string]interface{})

tags := expandConsumptionBudgetFilterTag(not["tag"].([]interface{}))
dimensions := expandConsumptionBudgetFilterDimensions(not["dimension"].([]interface{}))

if len(dimensions) != 0 {
filter.Not = &dimensions[0]
} else if len(tags) != 0 {
filter.Not = &tags[0]
}
}
}

tags := expandConsumptionBudgetFilterTag(input["tag"].(*pluginsdk.Set).List())
dimensions := expandConsumptionBudgetFilterDimensions(input["dimension"].(*pluginsdk.Set).List())

Expand Down Expand Up @@ -756,24 +662,6 @@ func flattenConsumptionBudgetFilter(input *budgets.BudgetFilter) []interface{} {

filterBlock := make(map[string]interface{})

if !features.FourPointOhBeta() {
notBlock := make(map[string]interface{})

if input.Not != nil {
if input.Not.Dimensions != nil {
notBlock["dimension"] = []interface{}{flattenConsumptionBudgetComparisonExpression(input.Not.Dimensions)}
}

if input.Not.Tags != nil {
notBlock["tag"] = []interface{}{flattenConsumptionBudgetComparisonExpression(input.Not.Tags)}
}

if len(notBlock) != 0 {
filterBlock["not"] = []interface{}{notBlock}
}
}
}

if input.And != nil {
for _, v := range *input.And {
if v.Dimensions != nil {
Expand Down
4 changes: 0 additions & 4 deletions internal/services/consumption/consumption_budget_management_group_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,10 @@ func (r ManagementGroupConsumptionBudget) Arguments() map[string]*pluginsdk.Sche
Required: true,
ValidateFunc: validation.IntBetween(0, 1000),
},
// Issue: https://github.com/Azure/azure-rest-api-specs/issues/16240
// Toggling between these two values doesn't work at the moment and also doesn't throw an error
// but it seems unlikely that a user would switch the threshold_type of their budgets frequently
"threshold_type": {
Type: pluginsdk.TypeString,
Optional: true,
Default: string(budgets.ThresholdTypeActual),
ForceNew: true, // TODO: remove this when the above issue is fixed
ValidateFunc: validation.StringInSlice([]string{
string(budgets.ThresholdTypeActual),
"Forecasted",
Expand Down
10 changes: 4 additions & 6 deletions internal/services/consumption/consumption_budget_resource_group_resource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,12 +404,10 @@ resource "azurerm_consumption_budget_resource_group" "test" {
}

notification {
enabled = true
threshold = 90.0
operator = "EqualTo"
// We don't update the value of threshold_type because toggling between the two seems to be broken
// See the comment on threshold_type in the schema for more details
threshold_type = "Forecasted"
enabled = true
threshold = 90.0
operator = "EqualTo"
threshold_type = "Actual"
stephybun marked this conversation as resolved.
Show resolved Hide resolved

contact_emails = [
"[email protected]",
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/consumption_budget_management_group.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ A `notification` block supports the following:

* `contact_emails` - (Required) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

* `threshold_type` - (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are `Actual` and `Forecasted`. Default is `Actual`. Changing this forces a new resource to be created.
* `threshold_type` - (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are `Actual` and `Forecasted`. Default is `Actual`.

* `enabled` - (Optional) Should the notification be enabled? Defaults to `true`.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/consumption_budget_resource_group.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ A `notification` block supports the following:

* `threshold` - (Required) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

* `threshold_type` - (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are `Actual` and `Forecasted`. Default is `Actual`. Changing this forces a new resource to be created.
* `threshold_type` - (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are `Actual` and `Forecasted`. Default is `Actual`.

* `contact_emails` - (Optional) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/consumption_budget_subscription.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ A `notification` block supports the following:

* `threshold` - (Required) Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000.

* `threshold_type` - (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are `Actual` and `Forecasted`. Default is `Actual`. Changing this forces a new resource to be created.
* `threshold_type` - (Optional) The type of threshold for the notification. This determines whether the notification is triggered by forecasted costs or actual costs. The allowed values are `Actual` and `Forecasted`. Default is `Actual`.

* `contact_emails` - (Optional) Specifies a list of email addresses to send the budget notification to when the threshold is exceeded.

Expand Down
Loading