New resource: azurerm_container_registry_cache_rule

[npk-amperon]

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

Continues the stalled work over in #24040 to add support for caching in ACR by adding both an associated resource and data source.

Note that adding the Credential Set resource (see here) is beyond the scope of this PR. That said, this PR includes support for passing them in by ID into the resource, though the acceptance tests don't include them. I think this is acceptable, as I plan to open a PR soon to add support for Credential Sets as well.

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_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)

Closes #21258

Note

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

[stephybun]

Many thanks for adding this as a typed resource @npk-amperon. I made a first pass through and there are a couple of things missing for this to be complete. Once you've addressed the suggestions and comments we can take another look through!

[npk-amperon]

Ok @stephybun -- I've made updates according to your feedback and rerun the tests locally. Let me know if anything else needs updated.

[stephybun]

Thanks @npk-amperon. There are some more minor improvements that can be made, once those are addressed I'll run the tests and then this should be good to go!

[npk-amperon]

Alrighty @stephybun , addressed the latest round of comments--thanks again for taking the time to review. One thing I did notice is that we're seeing some golangci-lint failures that look like so:

container_registry_cache_rule_resource.go:236:4: SA4009(related information): assignment to ctx (staticcheck)

Since the context is being passed into these functions as an argument, do we need to reinitialize it within the function?

[stephybun]

Thanks @npk-amperon. We don't need to initialise the context in the CRUD methods, you can remove all instances that the linter is complaining about. Also would you mind rebasing your PR on top of main? That will fix the vendor dependencies check and will allow us to run the tests.

[npk-amperon]

Okay @stephybun , rebased and fixed the lint issues

[stephybun]

Thanks @npk-amperon. We can also remove the call to cancel in the methods since this is done implicitly. Once those are removed this should be good to go!

[npk-amperon]

Ah I see, okay @stephybun your suggestions are committed so we should be good to go. Thanks again for the feedback!

[npk-amperon]

Ah, looks like I missed an unused import after your recommended changes--fixed.

[stephybun]

@npk-amperon can you also run make fmt to format the code

[stephybun]

Fantastic @npk-amperon! LGTM 🎉

[JoachimHansEDDI]

@npk-amperon

Works like a charm. Big THANKS

[mtraynham]

@npk-amperon, is there already a PR for adding the missing resource azurerm_container_registry_credential_set that was mentioned in the description?

Note that adding the Credential Set resource (see here) is beyond the scope of this PR. That said, this PR includes support for passing them in by ID into the resource, though the acceptance tests don't include them. I think this is acceptable, as I plan to open a PR soon to add support for Credential Sets as well.