`azurerm_frontdoor` - expose support for `cache_duration` and `cache_query_parameters` fields #12831

heoelri · 2021-08-03T18:30:14Z

This PR extends the azurerm_frontdoor resource with some additional caching capabilities.

cache_query_parameters (new) is a comma-separated list of query parameters
cache_duration (new) contains the caching duration (iso 8601)
cache_query_parameter_strip_directive can now also be set to StripAllExcept

The Azure Front Door API version was updated from 2020-01-01 to 2020-05-01 to support the newly added capabilities.

github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/frontdoor/validate is now imported as azValidate (aligned with other resources like servicebus) to avoid conflicts with github.com/terraform-providers/terraform-provider-azurerm/azurerm/helpers/validate (needed for some ISO8601 validation).

The two new parameters have been added to the documentation and location was dropped from the example and the details do now contain the information that this parameter has been deprecated.

This is my first "code" PR and i've some issues with the tests. make acctests fails:

=== CONT  TestAccFrontDoor_EnableDisableCache
    testcase.go:88: Step 1/5 error: Error running apply: exit status 1

        Error: creating Front Door "acctest-FD-210803200548354949" (Resource Group "acctestRG-frontdoor-210803200548354949"): frontdoor.FrontDoorsClient#CreateOrUpdate: Failure sending request: StatusCode=0 -- Original Error: Code="BadRequest" Message="Invalid cache duration format specified. Cache duration conforms to the following format: `PnYnMnDTnHnMnS` as specified by the ISO 8601 standard."

          with azurerm_frontdoor.test,
          on terraform_plugin_test.tf line 18, in resource "azurerm_frontdoor" "test":
          18: resource "azurerm_frontdoor" "test" {

--- FAIL: TestAccFrontDoor_EnableDisableCache (215.29s)

The module itself works like a charm:

~ forwarding_configuration {
    + cache_duration                        = "P6M"
    ~ cache_enabled                         = false -> true
    ~ cache_query_parameter_strip_directive = "StripAll" -> "StripAllExcept"
    + cache_query_parameters                = "width,height"
      # (3 unchanged attributes hidden)
  }

It would be great if someone can take a look and help me to get this through.

…/heoelri/terraform-provider-azurerm into feature/extend-frontdoor-caching

WodansSon

@heoelri, thank you so much for this PR. I have left one minor comment requesting the addition of validation checks in the frontDoorCustomizeDiff, but other than that this LGTM! 🚀

azurerm/internal/services/frontdoor/frontdoor_resource.go

heoelri · 2021-08-04T15:43:51Z

I was able to solve the issues with the acctests mentioned in my first comment in this PR.

All FrontDoor_* tests (including the new one) are now successful.

==> Checking that code complies with gofmt requirements...
==> Checking that Custom Timeouts are used...
==> Checking that acceptance test packages are used...
TF_ACC=1 go test -v ./azurerm/internal/services/frontdoor -run=TestAccFrontDoor_* -timeout 60m -ldflags="-X=github.com/terraform-providers/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccFrontDoorCustomHttpsConfiguration_CustomHttps
=== PAUSE TestAccFrontDoorCustomHttpsConfiguration_CustomHttps
=== RUN   TestAccFrontDoorCustomHttpsConfiguration_DisabledWithConfigurationBlock
=== PAUSE TestAccFrontDoorCustomHttpsConfiguration_DisabledWithConfigurationBlock
=== RUN   TestAccFrontDoorCustomHttpsConfiguration_EnabledWithoutConfigurationBlock
=== PAUSE TestAccFrontDoorCustomHttpsConfiguration_EnabledWithoutConfigurationBlock
=== RUN   TestAccFrontDoorCustomHttpsConfiguration_EnabledFrontdoorExtraAttributes
=== PAUSE TestAccFrontDoorCustomHttpsConfiguration_EnabledFrontdoorExtraAttributes
=== RUN   TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatest
=== PAUSE TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatest
=== RUN   TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatestMissingAttributes
=== PAUSE TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatestMissingAttributes
=== RUN   TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultMissingAttributes
=== PAUSE TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultMissingAttributes
=== RUN   TestAccFrontDoorFirewallPolicy_basic
=== PAUSE TestAccFrontDoorFirewallPolicy_basic
=== RUN   TestAccFrontDoorFirewallPolicy_requiresImport
=== PAUSE TestAccFrontDoorFirewallPolicy_requiresImport
=== RUN   TestAccFrontDoorFirewallPolicy_update
=== PAUSE TestAccFrontDoorFirewallPolicy_update
=== RUN   TestAccFrontDoorFirewallPolicy_complete
=== PAUSE TestAccFrontDoorFirewallPolicy_complete
=== RUN   TestAccFrontDoor_basic
=== PAUSE TestAccFrontDoor_basic
=== RUN   TestAccFrontDoor_global
=== PAUSE TestAccFrontDoor_global
=== RUN   TestAccFrontDoor_requiresImport
=== PAUSE TestAccFrontDoor_requiresImport
=== RUN   TestAccFrontDoor_update
=== PAUSE TestAccFrontDoor_update
=== RUN   TestAccFrontDoor_multiplePools
=== PAUSE TestAccFrontDoor_multiplePools
=== RUN   TestAccFrontDoor_complete
=== PAUSE TestAccFrontDoor_complete
=== RUN   TestAccFrontDoor_waf
=== PAUSE TestAccFrontDoor_waf
=== RUN   TestAccFrontDoor_EnableDisableCache
=== PAUSE TestAccFrontDoor_EnableDisableCache
=== CONT  TestAccFrontDoorCustomHttpsConfiguration_CustomHttps
=== CONT  TestAccFrontDoor_basic
=== CONT  TestAccFrontDoor_waf
=== CONT  TestAccFrontDoor_complete
=== CONT  TestAccFrontDoor_EnableDisableCache
=== CONT  TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultMissingAttributes
=== CONT  TestAccFrontDoorFirewallPolicy_complete
=== CONT  TestAccFrontDoor_multiplePools
--- PASS: TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultMissingAttributes (288.13s)
=== CONT  TestAccFrontDoorFirewallPolicy_update
--- PASS: TestAccFrontDoorFirewallPolicy_complete (320.24s)
=== CONT  TestAccFrontDoorFirewallPolicy_requiresImport
--- PASS: TestAccFrontDoor_complete (390.92s)
=== CONT  TestAccFrontDoorFirewallPolicy_basic
--- PASS: TestAccFrontDoor_multiplePools (391.03s)
=== CONT  TestAccFrontDoor_update
--- PASS: TestAccFrontDoor_waf (455.60s)
=== CONT  TestAccFrontDoor_requiresImport
--- PASS: TestAccFrontDoor_basic (613.44s)
=== CONT  TestAccFrontDoorCustomHttpsConfiguration_EnabledFrontdoorExtraAttributes
--- PASS: TestAccFrontDoorFirewallPolicy_requiresImport (298.46s)
=== CONT  TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatestMissingAttributes
--- PASS: TestAccFrontDoorFirewallPolicy_basic (276.16s)
=== CONT  TestAccFrontDoor_global
--- PASS: TestAccFrontDoorFirewallPolicy_update (546.48s)
=== CONT  TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatest
--- PASS: TestAccFrontDoorCustomHttpsConfiguration_EnabledFrontdoorExtraAttributes (287.56s)
=== CONT  TestAccFrontDoorCustomHttpsConfiguration_EnabledWithoutConfigurationBlock
--- PASS: TestAccFrontDoor_requiresImport (445.71s)
=== CONT  TestAccFrontDoorCustomHttpsConfiguration_DisabledWithConfigurationBlock
--- PASS: TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatestMissingAttributes (289.03s)
--- PASS: TestAccFrontDoor_EnableDisableCache (997.34s)
--- PASS: TestAccFrontDoor_global (370.06s)
--- PASS: TestAccFrontDoorCustomHttpsConfiguration_EnabledKeyVaultLatest (256.37s)
--- PASS: TestAccFrontDoorCustomHttpsConfiguration_EnabledWithoutConfigurationBlock (238.84s)
--- PASS: TestAccFrontDoorCustomHttpsConfiguration_DisabledWithConfigurationBlock (238.73s)
--- PASS: TestAccFrontDoor_update (1358.36s)
--- PASS: TestAccFrontDoorCustomHttpsConfiguration_CustomHttps (1765.48s)
PASS
ok      github.com/terraform-providers/terraform-provider-azurerm/azurerm/internal/services/frontdoor   1765.522s

[pull] master from terraform-providers:master

# Conflicts: # azurerm/internal/services/frontdoor/client/client.go # azurerm/internal/services/frontdoor/customizediff.go # azurerm/internal/services/frontdoor/frontdoor_custom_https_configuration.go # azurerm/internal/services/frontdoor/frontdoor_custom_https_configuration_resource.go # azurerm/internal/services/frontdoor/frontdoor_firewall_policy_resource.go # azurerm/internal/services/frontdoor/frontdoor_resource.go # azurerm/internal/services/frontdoor/frontdoor_resource_test.go # azurerm/internal/services/frontdoor/helper.go

[pull] main from terraform-providers:main

[pull] main from hashicorp:main

…azurerm

WodansSon

@heoelri, thanks for pushing those changes. This LGTM! 🚀

katbyte

aside from one comment LGTM

katbyte · 2021-08-12T04:28:38Z

website/docs/r/frontdoor.html.markdown

-* `cache_query_parameter_strip_directive` - (Optional) Defines cache behaviour in relation to query string parameters. Valid options are `StripAll` or `StripNone`. Defaults to `StripAll`.
+* `cache_query_parameter_strip_directive` - (Optional) Defines cache behaviour in relation to query string parameters. Valid options are `StripAll`, `StripAllExcept`, `StripOnly` or `StripNone`. Defaults to `StripAll`.
+
+* `cache_query_parameters` - (Optional) Specify query parameters (comma separated). Works only in combination with `cache_query_parameter_strip_directive` set to `StripAllExcept` or `StripOnly`.


should this be an array of values rather then a string?

@katbyte thank you, that's a good idea. In Front Door's models.go has QueryParameters the type *string that's why i've started as a string. But i agree that it's a much better idea to use an array here. I've made some changes to make query_parameters an array now.

katbyte

(hit wrong button)

Making the `query_parameters` parameter an array

update feature/extend-frontdoor-caching branch from main

user made suggested changes

WodansSon · 2021-08-13T06:05:44Z

@heoelri, thanks for pushing those changes. We have one test failure, if you can get that fixed up we can get this merged! 🚀

=== RUN   TestAccFrontDoor_EnableDisableCache
=== PAUSE TestAccFrontDoor_EnableDisableCache
=== CONT  TestAccFrontDoor_EnableDisableCache
testcase.go:88: Step 4/5 error: Check failed: Check 5/6 error: azurerm_frontdoor.test: Attribute 'routing_rule.0.forwarding_configuration.0.cache_query_parameters' not found
--- FAIL: TestAccFrontDoor_EnableDisableCache (366.73s)
FAIL

heoelri · 2021-08-13T07:47:01Z

@heoelri, thanks for pushing those changes. We have one test failure, if you can get that fixed up we can get this merged! 🚀

=== RUN   TestAccFrontDoor_EnableDisableCache
=== PAUSE TestAccFrontDoor_EnableDisableCache
=== CONT  TestAccFrontDoor_EnableDisableCache
testcase.go:88: Step 4/5 error: Check failed: Check 5/6 error: azurerm_frontdoor.test: Attribute 'routing_rule.0.forwarding_configuration.0.cache_query_parameters' not found
--- FAIL: TestAccFrontDoor_EnableDisableCache (366.73s)
FAIL

Thank you very much for your help @WodansSon. The test was still looking for a string in cache_query_parameters instead of an array. I've updated the frontdoor_resource_test.go file as suggested.

==> Checking that code complies with gofmt requirements...
==> Checking that Custom Timeouts are used...
==> Checking that acceptance test packages are used...
TF_ACC=1 go test -v ./internal/services/frontdoor -run=TestAccFrontDoor_EnableDisableCache -timeout 60m -ldflags="-X=github.com/hashicorp/terraform-provider-azurerm/version.ProviderVersion=acc"
=== RUN   TestAccFrontDoor_EnableDisableCache
=== PAUSE TestAccFrontDoor_EnableDisableCache
=== CONT  TestAccFrontDoor_EnableDisableCache
--- PASS: TestAccFrontDoor_EnableDisableCache (489.44s)

WodansSon · 2021-08-13T08:23:55Z

@heoelri, thanks for pushing those changes again! LGTM and all the tests pass now! 🚀

github-actions · 2021-08-20T06:01:19Z

This functionality has been released in v2.73.0 of the Terraform Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

github-actions · 2021-09-20T02:08:07Z

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.

heoelri added 8 commits August 3, 2021 12:23

initial set of changes

80553f7

push initial set of changes

0e0aa5c

fix test

fea2d12

add missing validate

2e0a517

smaller modifications and fixes

b60d851

smaller fixes

e06eaa8

update docs

dc1ca94

modified test

39d96ef

github-actions bot added dependencies documentation size/XL labels Aug 3, 2021

heoelri and others added 3 commits August 3, 2021 20:31

Update .gitignore

618ba76

fix ineffectual assignment

6a51a37

Merge branch 'feature/extend-frontdoor-caching' of https://github.com…

fe5c45e

…/heoelri/terraform-provider-azurerm into feature/extend-frontdoor-caching

sebader mentioned this pull request Aug 3, 2021

Support for setting Azure Front Door cache duration #11508

Closed

small improvement

b8dc177

WodansSon requested changes Aug 4, 2021

View reviewed changes

azurerm/internal/services/frontdoor/frontdoor_resource.go Outdated Show resolved Hide resolved

WodansSon added service/frontdoor enhancement labels Aug 4, 2021

heoelri added 5 commits August 4, 2021 13:31

add customizediff tests as requested

57ca166

added checks as requested

286102b

gofmt and docs fix

996197f

fix for cacheDuration to fix failing acctest

b1fcc48

fix test definition

654bcef

heoelri marked this pull request as ready for review August 4, 2021 13:12

Merge pull request #10 from terraform-providers/master

4c4db9a

[pull] master from terraform-providers:master

heoelri requested a review from WodansSon August 6, 2021 06:18

heoelri and others added 2 commits August 6, 2021 09:43

Merge pull request #11 from terraform-providers/master

b06c491

[pull] master from terraform-providers:master

heoelri and others added 5 commits August 6, 2021 11:23

fix broken dependency

e7d00b4

Merge pull request #16 from hashicorp/main

a3767b2

[pull] main from terraform-providers:main

Merge pull request #17 from hashicorp/main

01a486d

[pull] main from hashicorp:main

Merge branch 'main' of https://github.com/heoelri/terraform-provider-…

62ab76b

…azurerm

Merge branch 'main' into feature/extend-frontdoor-caching

627f6e8

WodansSon approved these changes Aug 12, 2021

View reviewed changes

katbyte approved these changes Aug 12, 2021

View reviewed changes

katbyte added this to the v2.72.0 milestone Aug 12, 2021

katbyte previously requested changes Aug 12, 2021

View reviewed changes

katbyte modified the milestones: v2.72.0, v2.73.0 Aug 12, 2021

heoelri and others added 6 commits August 12, 2021 11:17

update

cdcd34c

updates

708e66a

changes

535a904

Merge pull request #18 from heoelri/feature/query-param-array

98832d0

Making the `query_parameters` parameter an array

Merge pull request #19 from hashicorp/main

6de86ad

update feature/extend-frontdoor-caching branch from main

terrafmt

e4b8da1

updating the tests

7ee46bd

WodansSon changed the title ~~Enhance Azure Front Door caching with cache_duration and cache_query_parameters~~ azurerm_frontdoor - expose support for cache_duration and cache_query_parameters fields Aug 13, 2021

WodansSon merged commit fa4c788 into hashicorp:main Aug 13, 2021

WodansSon added a commit that referenced this pull request Aug 13, 2021

updating to include #12831

6fdf083

EpicWink mentioned this pull request Aug 24, 2021

azurerm_frontdoor plan crash after upgrade to 2.73.0 #13077

Closed

github-actions bot locked as resolved and limited conversation to collaborators Sep 20, 2021

heoelri deleted the feature/extend-frontdoor-caching branch October 26, 2021 07:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`azurerm_frontdoor` - expose support for `cache_duration` and `cache_query_parameters` fields #12831

`azurerm_frontdoor` - expose support for `cache_duration` and `cache_query_parameters` fields #12831

heoelri commented Aug 3, 2021

WodansSon left a comment

heoelri commented Aug 4, 2021

WodansSon left a comment

katbyte left a comment

katbyte Aug 12, 2021

heoelri Aug 12, 2021 •

edited

Loading

katbyte left a comment

WodansSon commented Aug 13, 2021

heoelri commented Aug 13, 2021

WodansSon commented Aug 13, 2021

github-actions bot commented Aug 20, 2021

github-actions bot commented Sep 20, 2021

azurerm_frontdoor - expose support for cache_duration and cache_query_parameters fields #12831

azurerm_frontdoor - expose support for cache_duration and cache_query_parameters fields #12831

Conversation

heoelri commented Aug 3, 2021

WodansSon left a comment

Choose a reason for hiding this comment

heoelri commented Aug 4, 2021

WodansSon left a comment

Choose a reason for hiding this comment

katbyte left a comment

Choose a reason for hiding this comment

katbyte Aug 12, 2021

Choose a reason for hiding this comment

heoelri Aug 12, 2021 • edited Loading

Choose a reason for hiding this comment

katbyte left a comment

Choose a reason for hiding this comment

WodansSon commented Aug 13, 2021

heoelri commented Aug 13, 2021

WodansSon commented Aug 13, 2021

github-actions bot commented Aug 20, 2021

github-actions bot commented Sep 20, 2021

`azurerm_frontdoor` - expose support for `cache_duration` and `cache_query_parameters` fields #12831

`azurerm_frontdoor` - expose support for `cache_duration` and `cache_query_parameters` fields #12831

heoelri Aug 12, 2021 •

edited

Loading