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

Add data sources for Managed Rules for WAF and WAF Regional #10563

Merged
merged 28 commits into from
Aug 3, 2022

Conversation

flosell
Copy link
Contributor

@flosell flosell commented Oct 20, 2019

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" comments, they generate extra noise for pull request followers and do not help prioritize the request

Release note for CHANGELOG:

**New Data Source:** `aws_waf_subscribed_rule_group`
**New Data Source:** `aws_wafregional_subscribed_rule_group` 

Output from acceptance testing

$ AWS_WAF_SUBSCRIBED_RULE_GROUP_NAME="F5 Bot Detection Signatures For AWS WAF" AWS_WAF_SUBSCRIBED_RULE_GROUP_METRIC_NAME=F5BotDetectionSignatures make testacc TEST=./aws TESTARGS='-run=SubscribedRuleGroup_Basic'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=SubscribedRuleGroup_Basic -timeout 120m
=== RUN   TestAccDataSourceAwsWafSubscribedRuleGroup_Basic
=== PAUSE TestAccDataSourceAwsWafSubscribedRuleGroup_Basic
=== RUN   TestAccDataSourceAwsWafRegionalSubscribedRuleGroup_Basic
=== PAUSE TestAccDataSourceAwsWafRegionalSubscribedRuleGroup_Basic
=== CONT  TestAccDataSourceAwsWafSubscribedRuleGroup_Basic
=== CONT  TestAccDataSourceAwsWafRegionalSubscribedRuleGroup_Basic
--- PASS: TestAccDataSourceAwsWafSubscribedRuleGroup_Basic (111.39s)
--- PASS: TestAccDataSourceAwsWafRegionalSubscribedRuleGroup_Basic (112.71s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	112.769s

Notes on acceptance testing:

  • requires manually subscribing to a WAF rule product on the marketplace first and then setting AWS_WAF_SUBSCRIBED_RULE_GROUP_NAME and AWS_WAF_SUBSCRIBED_RULE_GROUP_METRIC_NAME correctly; use aws waf list-subscribed-rule-groups to find what the account is already subscribed to
  • the tests expect name and metric name to be for the same rule group
  • a subscription applies for both WAF and WAF Regional (but use different rule group ids), therefore the same environment variable is used to test both data sources

Closes #12407

@flosell flosell requested a review from a team October 20, 2019 08:10
@ghost ghost added size/XL Managed by automation to categorize the size of a PR. provider Pertains to the provider itself, rather than any interaction with AWS. service/waf Issues and PRs that pertain to the waf service. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. documentation Introduces or discusses updates to documentation. labels Oct 20, 2019
@flosell flosell changed the title D waf subscribed rule group Add data sources for Managed Rules for WAF and WAF Regional Oct 20, 2019
@DrFaust92
Copy link
Collaborator

Closes #12407

@haidaraM
Copy link
Contributor

Looks like this PR is ready to be merged. Any plan to merge it soon :-) ?

@costingalan
Copy link

Any updates here?

@JnMik
Copy link

JnMik commented Jul 24, 2020

Would that allow to use data source for "Managed rule group" created from AWS, not from the marketplace ?

Copy link
Collaborator

@DrFaust92 DrFaust92 left a comment

Choose a reason for hiding this comment

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

small docs change

website/aws.erb Outdated Show resolved Hide resolved
@flosell flosell force-pushed the d-waf-subscribed-rule-group branch from c13006d to 42b9946 Compare July 26, 2020 10:46
@flosell
Copy link
Contributor Author

flosell commented Jul 26, 2020

Fixed small documentation bug (thanks @DrFaust92 for spotting that!), resolved merge conflicts with most recent master and updated to latest linting and standards. Should be ready to merge again

@teamterraform
Copy link

Notification of Recent and Upcoming Changes to Contributions

Thank you for this contribution! There have been a few recent development changes that affect this pull request. We apologize for the inconvenience, especially if there have been long review delays up until now. Please note that this is automated message from an unmonitored account. See the FAQ for additional information on the maintainer team and review prioritization.

If you are unable to complete these updates, please leave a comment for the community and maintainers so someone can potentially continue the work. The maintainers will encourage other contributors to use the existing contribution as the base for additional changes as appropriate. Otherwise, contributions that do not receive updated code or comments from the original contributor may be closed in the future so the maintainers can focus on active items.

For the most up to date information about Terraform AWS Provider development, see the Contributing Guide. Additional technical debt changes can be tracked with the technical-debt label on issues.

As part of updating a pull request with these changes, the most current unit testing and linting will run. These may report issues that were not previously reported.

Action Required: Terraform 0.12 Syntax

Reference: #8950
Reference: #14417

Version 3 and later of the Terraform AWS Provider, which all existing contributions would potentially be added, only supports Terraform 0.12 and later. Certain syntax elements of Terraform 0.11 and earlier show deprecation warnings during runs with Terraform 0.12. Documentation and test configurations, such as those including deprecated string interpolations (some_attribute = "${aws_service_thing.example.id}") should be updated to the newer syntax (some_attribute = aws_service_thing.example.id). Contribution testing will automatically fail on older syntax in the near future. Please see the referenced issues for additional information.

Action Required: Terraform Plugin SDK Version 2

Reference: #14551

The Terraform AWS Provider has been upgraded to the latest version of the Terraform Plugin SDK. Generally, most changes to contributions should only involve updating Go import paths in source code files. Please see the referenced issue for additional information.

Action Required: Removal of website/aws.erb File

Reference: #14712

Any changes to the website/aws.erb file are no longer necessary and should be removed from this contribution to prevent merge issues in the near future when the file is removed from the repository. Please see the referenced issue for additional information.

Upcoming Change of Git Branch Naming

Reference: #14292

Development environments will need their upstream Git branch updated from master to main in the near future. Please see the referenced issue for additional information and scheduling.

Upcoming Change of GitHub Organization

Reference: #14715

This repository will be migrating from https://github.com/terraform-providers/terraform-provider-aws to https://github.com/hashicorp/terraform-provider-aws. No practitioner or developer action is anticipated and most GitHub functionality will automatically redirect to the new location. Go import paths including terraform-providers can remain for now. Please see the referenced issue for additional information and scheduling.

Base automatically changed from master to main January 23, 2021 00:56
@breathingdust breathingdust requested a review from a team as a code owner January 23, 2021 00:56
@zhelding
Copy link
Contributor

Pull request #21306 has significantly refactored the AWS Provider codebase. As a result, most PRs opened prior to the refactor now have merge conflicts that must be resolved before proceeding.

Specifically, PR #21306 relocated the code for all AWS resources and data sources from a single aws directory to a large number of separate directories in internal/service, each corresponding to a particular AWS service. This separation of code has also allowed for us to simplify the names of underlying functions -- while still avoiding namespace collisions.

We recognize that many pull requests have been open for some time without yet being addressed by our maintainers. Therefore, we want to make it clear that resolving these conflicts in no way affects the prioritization of a particular pull request. Once a pull request has been prioritized for review, the necessary changes will be made by a maintainer -- either directly or in collaboration with the pull request author.

For a more complete description of this refactor, including examples of how old filepaths and function names correspond to their new counterparts: please refer to issue #20000.

For a quick guide on how to amend your pull request to resolve the merge conflicts resulting from this refactor and bring it in line with our new code patterns: please refer to our Service Package Refactor Pull Request Guide.

@breathingdust
Copy link
Member

Hi all 👋 Just letting you know that this is issue is featured on this quarters roadmap. If a PR exists to close the issue a maintainer will review and either make changes directly, or work with the original author to get the contribution merged. If you have written a PR to resolve the issue please ensure the "Allow edits from maintainers" box is checked. Thanks for your patience and we are looking forward to getting this merged soon!

@zhelding zhelding self-assigned this Jul 27, 2022
@github-actions github-actions bot added the service/wafregional Issues and PRs that pertain to the wafregional service. label Jul 27, 2022
@zhelding
Copy link
Contributor

zhelding commented Aug 2, 2022

Acceptance tests passing on latest commit 6787fc1:

❯ make testacc TESTS=TestAccWAFSubscribedRuleGroupDataSource PKG=waf                  
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/waf/... -v -count 1 -parallel 20 -run='TestAccWAFSubscribedRuleGroupDataSource'  -timeout 180m
=== RUN   TestAccWAFSubscribedRuleGroupDataSource_basic
=== PAUSE TestAccWAFSubscribedRuleGroupDataSource_basic
=== CONT  TestAccWAFSubscribedRuleGroupDataSource_basic
--- PASS: TestAccWAFSubscribedRuleGroupDataSource_basic (29.30s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/waf        29.335s

❯ make testacc TESTS=TestAccWAFRegionalSubscribedRuleGroupDataSource PKG=wafregional
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/wafregional/... -v -count 1 -parallel 20 -run='TestAccWAFRegionalSubscribedRuleGroupDataSource'  -timeout 180m
=== RUN   TestAccWAFRegionalSubscribedRuleGroupDataSource_basic
=== PAUSE TestAccWAFRegionalSubscribedRuleGroupDataSource_basic
=== CONT  TestAccWAFRegionalSubscribedRuleGroupDataSource_basic
--- PASS: TestAccWAFRegionalSubscribedRuleGroupDataSource_basic (33.98s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/wafregional        34.087s

Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccWAFSubscribedRuleGroupDataSource_' PKG=waf ACCTEST_PARALLELISM=2
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/waf/... -v -count 1 -parallel 2  -run=TestAccWAFSubscribedRuleGroupDataSource_ -timeout 180m
=== RUN   TestAccWAFSubscribedRuleGroupDataSource_basic
    subscribed_rule_group_test.go:16: Environment variable WAF_SUBSCRIBED_RULE_GROUP_NAME is not set
--- SKIP: TestAccWAFSubscribedRuleGroupDataSource_basic (0.00s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/waf	7.296s
% make testacc TESTARGS='-run=TestAccWAFRegionalSubscribedRuleGroupDataSource_' PKG=wafregional ACCTEST_PARALLELISM=2
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/wafregional/... -v -count 1 -parallel 2  -run=TestAccWAFRegionalSubscribedRuleGroupDataSource_ -timeout 180m
=== RUN   TestAccWAFRegionalSubscribedRuleGroupDataSource_basic
    subscribed_rule_group_test.go:16: Environment variable WAF_SUBSCRIBED_RULE_GROUP_NAME is not set
--- SKIP: TestAccWAFRegionalSubscribedRuleGroupDataSource_basic (0.00s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/wafregional	5.221s

@zhelding
Copy link
Contributor

zhelding commented Aug 3, 2022

Thanks so much for your contribution @flosell! Finally getting this merged 🎉

@zhelding zhelding merged commit a9aea59 into hashicorp:main Aug 3, 2022
@github-actions github-actions bot added this to the v4.25.0 milestone Aug 3, 2022
ewbankkit added a commit that referenced this pull request Aug 3, 2022
@ewbankkit ewbankkit added the new-data-source Introduces a new data source. label Aug 3, 2022
@github-actions
Copy link

github-actions bot commented Aug 4, 2022

This functionality has been released in v4.25.0 of the Terraform AWS 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
Copy link

github-actions bot commented Sep 4, 2022

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 issues.
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 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. new-data-source Introduces a new data source. provider Pertains to the provider itself, rather than any interaction with AWS. service/waf Issues and PRs that pertain to the waf service. service/wafregional Issues and PRs that pertain to the wafregional service. size/XL Managed by automation to categorize the size of a PR. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New Data Source: WAF Subscribed rule group
9 participants