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.

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

[4.0] azurerm_application_gateway - upgrade API version to 2023-11-01 #26776

Merged
merged 5 commits into from
Aug 19, 2024

Conversation

teowa
Copy link
Contributor

@teowa teowa commented Jul 25, 2024

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 comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

context: #25844
https://learn.microsoft.com/en-us/azure/application-gateway/application-gateway-ssl-policy-overview#default-tls-policy
upgrade API version to 2023-11-01, there is breaking change on default SSL policy, so must be done in 4.0

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)

Change Log

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

  • azurerm_application_gateway - upgrade API version to 2023-11-01

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.

Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks for sorting out this upgrade for 4.0 @teowa. Could you take a look at the comments I left in-line regarding the tests? I can see that you've updated the configs to ensure the tests pass, but I think with security defaults changing in this SDK upgrade the test cases should be updated to validate current security standards.

Comment on lines 7468 to 7471
ssl_policy {
policy_type = "Predefined"
policy_name = "AppGwSslPolicy20150501"
}
Copy link
Member

Choose a reason for hiding this comment

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

Can we update the check for this test instead to ensure the API is returning the documented default value AppGwSslPolicy20220101 is being returned

check.That(data.ResourceName).Key("ssl_profile.0.ssl_policy.0.policy_name").HasValue("AppGwSslPolicy20150501"),

Suggested change
ssl_policy {
policy_type = "Predefined"
policy_name = "AppGwSslPolicy20150501"
}

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

Comment on lines 7570 to 7573
ssl_policy {
policy_type = "Predefined"
policy_name = "AppGwSslPolicy20150501"
}
Copy link
Member

Choose a reason for hiding this comment

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

Same here

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

@@ -7662,6 +7672,12 @@ resource "azurerm_application_gateway" "test" {
priority = 10
}

ssl_policy {
policy_type = "Custom"
min_protocol_version = "TLSv1_1"
Copy link
Member

Choose a reason for hiding this comment

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

The minimum protocol version default will now be TLSv1_2 so can we update the checks in the test instead of the config. It's a better practice for the tests to verify that current security standards/defaults are working in the API than to ensure outdated security defaults and practices still work.

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

@teowa
Copy link
Contributor Author

teowa commented Aug 19, 2024

--- PASS: TestAccApplicationGateway_sslProfile (872.15s)
--- PASS: TestAccApplicationGateway_sslProfileWithClientCertificateVerification (939.44s)
PASS
ok      github.com/hashicorp/terraform-provider-azurerm/internal/services/network       939.473s

Copy link
Member

@stephybun stephybun left a comment

Choose a reason for hiding this comment

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

Thanks @teowa LGTM 👍

@stephybun stephybun merged commit 1221ed0 into hashicorp:main Aug 19, 2024
33 of 34 checks passed
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Application gateway fails to deploy with SSL policy set to AppGwSslPolicy20220101 or AppGwSslPolicy20220101S
2 participants