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

Allow single character strings in azure_rm_api_management_api Path variable validation #26922

Merged
merged 2 commits into from
Aug 16, 2024

Conversation

Lakshan-Banneheke
Copy link
Contributor

@Lakshan-Banneheke Lakshan-Banneheke commented Aug 3, 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

This is to fix #26921 in azurerm_api_management_api path variable validation.

Previously, a path with a single character string such as "a" was not allowed by the regex.
Analysis: #26921 (comment)

The regex is modified to have ? after [\w-].
In regular expressions, the ? is a quantifier that means "zero or one" of the preceding element. It makes the preceding element optional. Hence, a single character string is allowed.

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.

  • azure_rm_api_management_api - Path variable now allows a string with a single character.

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 #26921

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 this PR @Lakshan-Banneheke. It appears the regex is missing something since now one of the other test cases fail for the APIM API path validation, specifically:

2024-08-07T06:06:00.1584723Z === RUN   TestAzureRMApiManagementApiPath_validation
2024-08-07T06:06:00.1585306Z     api_management_test.go:154: Expected the Api Management Api Path to trigger a validation error for 'api1/'
2024-08-07T06:06:00.1585580Z --- FAIL: TestAzureRMApiManagementApiPath_validation (0.01s)

@Lakshan-Banneheke
Copy link
Contributor Author

Hi @stephybun
Apologies for the oversight. The regex is updated now and the tests are passing. Please check now.

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 @Lakshan-Banneheke LGTM 👍

@stephybun stephybun merged commit c1c46f4 into hashicorp:main Aug 16, 2024
31 checks passed
@github-actions github-actions bot added this to the v3.116.0 milestone Aug 16, 2024
stephybun added a commit that referenced this pull request Aug 16, 2024
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 17, 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.

azurerm_api_management_api path validation restricts single character strings
2 participants