Allow hyphens and underscores in metric_name in wafregional_* resourc…

[Y-Tian]

…es fix #12080

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Relates #12080

Release note for CHANGELOG:

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccXXX'

...

I am unable to run the acceptance tests, due to finances.

[ewbankkit]

@Y-Tian Thanks for diving into this.
If I run an acceptance test and set the metric_name attribute to a value with an underscore then the underlying AWS API returns an exception:

% make testacc TEST=./aws TESTARGS='-run=TestAccAWSWafRegionalRateBasedRule_basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAWSWafRegionalRateBasedRule_basic -timeout 120m
=== RUN   TestAccAWSWafRegionalRateBasedRule_basic
=== PAUSE TestAccAWSWafRegionalRateBasedRule_basic
=== CONT  TestAccAWSWafRegionalRateBasedRule_basic
--- FAIL: TestAccAWSWafRegionalRateBasedRule_basic (20.92s)
    testing.go:654: Step 0 error: errors during apply:
        
        Error: Error creating WAF Regional Rate Based Rule (): WAFDisallowedNameException: The specified name is not permitted.
        
          on /var/folders/cs/yqdfp44s6hz9pmy2_g8qpmvm0000gq/T/tf-test502958926/main.tf line 11:
          (source code not available)
        
        
FAIL
FAIL	github.com/terraform-providers/terraform-provider-aws/aws	22.128s
FAIL
make: *** [testacc] Error 1

See the discussion in #12080 for details.

What would be useful would be to update the validateWafMetricName function to check all the constraints on the metric_name attribute:

The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action."

and to use it for the aws_wafregional_rule and aws_wafregional_web_acl resources.
You could use the approach suggested in #8424 and do something like

var validateWafMetricName = validation.All(
	validation.StringLenBetween(1, 128),
	validation.StringMatch(regexp.MustCompile(`^[0-9A-Za-z]+$`), "must contain only alphanumeric characters"),
	StringNotInSlice([]string{"ALL", "Default_Action"}, false), // To implement :)
)

This can be unit tested via make test.

[bflad]

Hi @Y-Tian 👋 Thank you for submitting this. Since we haven't heard back from you about the feedback provided above, we are going to opt to close this for now. If you wish to implement the suggestions, please submit a new pull request and we'll be happy to re-review. 👍

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!