azurerm_kubernetes_cluster - support for the cost_analysis_enabled property

[ms-henglu]

fixes #23982

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevent documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

The failed tests are not related to this change.

=== RUN   TestAccKubernetesCluster_costAnalysisEnabled
=== PAUSE TestAccKubernetesCluster_costAnalysisEnabled
=== CONT  TestAccKubernetesCluster_costAnalysisEnabled
--- PASS: TestAccKubernetesCluster_costAnalysisEnabled (1387.34s)
PASS

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

• azurerm_resource - support for the thing1 property [GH-00000]

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Fixes #0000

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

[stephybun]

Thanks @ms-henglu. Overall this looks fine, please take a look at the two suggestions left in-line. This should be good to go once they're resolved.

[stephybun]

Thanks for being thorough with the tests here @ms-henglu, but I think we consolidate these into one test by toggling from true -> false -> true. This way we're testing the initial creation of a resource with cost analysis enabled, and then that we can toggle this. I don't think it's necessary to explicitly test the default value false at creation since every other test where we're not specifying cost_analysis_enabled will be checking this.

Suggested change

	func TestAccKubernetesCluster_costAnalysisEnabled(t *testing.T) {
	data := acceptance.BuildTestData(t, "azurerm_kubernetes_cluster", "test")
	r := KubernetesClusterResource{}
	data.ResourceTest(t, r, []acceptance.TestStep{
	{
	Config: r.costAnalysisEnabled(data, true),
	Check: acceptance.ComposeTestCheckFunc(
	check.That(data.ResourceName).ExistsInAzure(r),
	),
	},
	data.ImportStep(),
	})
	}
	func TestAccKubernetesCluster_costAnalysis(t *testing.T) {
	data := acceptance.BuildTestData(t, "azurerm_kubernetes_cluster", "test")
	r := KubernetesClusterResource{}
	data.ResourceTest(t, r, []acceptance.TestStep{
	{
	Config: r.costAnalysisEnabled(data, false),
	Check: acceptance.ComposeTestCheckFunc(
	check.That(data.ResourceName).ExistsInAzure(r),
	),
	},
	data.ImportStep(),
	{
	Config: r.costAnalysisEnabled(data, true),
	Check: acceptance.ComposeTestCheckFunc(
	check.That(data.ResourceName).ExistsInAzure(r),
	),
	},
	data.ImportStep(),
	{
	Config: r.costAnalysisEnabled(data, false),
	Check: acceptance.ComposeTestCheckFunc(
	check.That(data.ResourceName).ExistsInAzure(r),
	),
	},
	data.ImportStep(),
	})
	}
	func TestAccKubernetesCluster_costAnalysis(t *testing.T) {
	data := acceptance.BuildTestData(t, "azurerm_kubernetes_cluster", "test")
	r := KubernetesClusterResource{}
	data.ResourceTest(t, r, []acceptance.TestStep{
	{
	Config: r.costAnalysisEnabled(data, true),
	Check: acceptance.ComposeTestCheckFunc(
	check.That(data.ResourceName).ExistsInAzure(r),
	),
	},
	data.ImportStep(),
	{
	Config: r.costAnalysisEnabled(data, false),
	Check: acceptance.ComposeTestCheckFunc(
	check.That(data.ResourceName).ExistsInAzure(r),
	),
	},
	data.ImportStep(),
	{
	Config: r.costAnalysisEnabled(data, true),
	Check: acceptance.ComposeTestCheckFunc(
	check.That(data.ResourceName).ExistsInAzure(r),
	),
	},
	data.ImportStep(),
	})
	}

[stephybun]

The sku_tier must be set to Standard or Premium to enable this feature.

Can we add this validation into the code as well?

[ms-henglu]

Thanks @stephybun for the code review. I've updated this Pr as suggested. Please take another look, thanks!

[stephybun]

We have a test failure:

------- Stdout: -------
=== RUN   TestAccKubernetesCluster_costAnalysis
=== PAUSE TestAccKubernetesCluster_costAnalysis
=== CONT  TestAccKubernetesCluster_costAnalysis
   testcase.go:113: Step 3/6 error: After applying this test step, the plan was not empty.
       stdout:
       Terraform used the selected providers to generate the following execution
       plan. Resource actions are indicated with the following symbols:
         ~ update in-place
       Terraform will perform the following actions:
         # azurerm_kubernetes_cluster.test will be updated in-place
         ~ resource "azurerm_kubernetes_cluster" "test" {
             ~ cost_analysis_enabled               = true -> false
               id                                  = "/subscriptions/*******/resourceGroups/acctestRG-aks-240530064851694058/providers/Microsoft.ContainerService/managedClusters/acctestaks240530064851694058"
               name                                = "acctestaks240530064851694058"
               tags                                = {}
               # (27 unchanged attributes hidden)
               # (4 unchanged blocks hidden)
           }
       Plan: 0 to add, 1 to change, 0 to destroy.
--- FAIL: TestAccKubernetesCluster_costAnalysis (759.53s)
FAIL```

[ms-henglu]

Thanks @stephybun , I've fixed the typo:

=== RUN   TestAccKubernetesCluster_costAnalysis
=== PAUSE TestAccKubernetesCluster_costAnalysis
=== CONT  TestAccKubernetesCluster_costAnalysis
--- PASS: TestAccKubernetesCluster_costAnalysis (1362.21s)
PASS

[stephybun]

Thanks @ms-henglu LGTM 👍

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.