Extending aws_s3_bucket_info module #260

zeten30 · 2020-10-12T14:24:06Z

SUMMARY

Adding a new functionality to the module.

ability to filter retrieved bucket list by specifying bucket name or matching string. New options: name:, name_filter:
retrieve additional bucket facts/configuration by specifying bucket_facts: sub-options (see ansible-doc)
adding integration test for the module

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

aws_s3_bucket_info

ADDITIONAL INFORMATION

Example of extended bucket information

{  
  "buckets": [
  {
        "bucket_location": {
            "LocationConstraint": "us-east-1"
        },
        "bucket_request_payment": {
            "Payer": "BucketOwner"
        },
        "bucket_tagging": {},
        "creation_date": "2020-10-12T14:00:42+00:00",
        "name": "testing-bucket",
        "public_access_block": {}
    }
  ]
}

zeten30 · 2020-10-13T05:48:18Z

@tremble @jillr please take a look. Thanks in advance.

ansibullbot · 2020-11-16T18:23:11Z

cc @hyperized @s-hertel @wimnat
click here for bot help

zeten30 · 2020-11-18T10:14:27Z

Not sure about future release number (1.2.2 or 1.3.0?).

Changelog snippet??

v1.3.0
======

Major Changes
-------------

- aws_s3_bucket_info - new module options ``name:``, ``name_filter``, ``bucket_facts`` and ``transform_location

# aws_s3_bucket_info.py
  version_added: 1.?.?

I assume 1.3.0.

tremble · 2020-11-18T11:07:11Z

https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to

minor_changes:
- aws_s3_bucket_info - new module options ``name:``, ``name_filter``, ``bucket_facts`` and ``transform_location`` (https://github.com/ansible-collections/community.aws/pull/260).

I've been using 1.3.0 although it's possible they'll technically land in 1.2.x

zeten30 · 2020-11-18T15:02:55Z

I hope it's all good now. @tremble thank you.

tremble · 2020-11-19T09:45:42Z

We generally transform the TagSet object into simple tags using boto3_tag_list_to_ansible_dict this is much easier for folks to consume.

zeten30 · 2020-11-19T13:55:22Z

We generally transform the TagSet object into simple tags using boto3_tag_list_to_ansible_dict this is much easier for folks to consume.

Sure, no problem. b04699a

zeten30 · 2020-11-19T14:10:50Z

"bucket_request_payment": {
"Payer": "BucketOwner"
},
"bucket_tagging": {
  "facts": "defined",
  "integration": "verified"
},
"bucket_website": {},
"creation_date": "2020-11-19T13:49:58+00:00",

ansibullbot · 2020-11-19T19:32:57Z

@zeten30 this PR contains the following merge commits:

0c238c5

Please rebase your branch to remove these commits.

click here for bot help

zeten30 · 2020-12-10T07:08:59Z

@tremble @jillr Hi, any blockers here? Thank you.

zeten30 · 2021-01-06T09:48:58Z

@tremble @jillr Are we ready to merge now? Thanks in advance.

markuman · 2021-01-11T21:30:51Z

I will review tomorrow. But you need to rebase with upstream main branch. https://docs.ansible.com/ansible/latest/dev_guide/developing_rebasing.html

- fix wording and typos in DOCUMENTATION - complete rewrite of RETURN

plugins/modules/aws_s3_bucket_info.py

zeten30 · 2021-02-09T11:33:17Z

@tremble I've fixed the RETURN part. Shippable is ok:)

changelogs/changelog.yaml

tremble · 2021-03-14T12:10:36Z

Shippable's passing. Let's get this merged.

* WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Sync with upstream + .gitignore VSCode * Extending integration test * Adding version_added to new module options * Prepare 1.3.0 changelog * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Adjusting changelogs/changelog.yaml * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Prepare 1.3.0 changelog * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Adjusting changelogs/changelog.yaml * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Merging requested PR changes ansible-collections#1 Co-authored-by: Mark Chappell <[email protected]> * Bump version_added 1.3.0->1.4.0 Co-authored-by: Mark Chappell <[email protected]> * Fix module docstring Co-authored-by: Mark Chappell <[email protected]> * Fixing changelog * Code cleanup * Update integration tests * Add S3 bucket location check to integration test * Documentation update - fix wording and typos in DOCUMENTATION - complete rewrite of RETURN * Update plugins/modules/aws_s3_bucket_info.py * Update plugins/modules/aws_s3_bucket_info.py * Fixing RETURN indentation * Fixing missing type: in RETURN * Revert changes to changelogs/changelog.yaml * Revert changes to changelogs/changelog.yaml Co-authored-by: Mark Chappell <[email protected]>

* WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Sync with upstream + .gitignore VSCode * Extending integration test * Adding version_added to new module options * Prepare 1.3.0 changelog * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Adjusting changelogs/changelog.yaml * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Prepare 1.3.0 changelog * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Adjusting changelogs/changelog.yaml * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Merging requested PR changes #1 Co-authored-by: Mark Chappell <[email protected]> * Bump version_added 1.3.0->1.4.0 Co-authored-by: Mark Chappell <[email protected]> * Fix module docstring Co-authored-by: Mark Chappell <[email protected]> * Fixing changelog * Code cleanup * Update integration tests * Add S3 bucket location check to integration test * Documentation update - fix wording and typos in DOCUMENTATION - complete rewrite of RETURN * Update plugins/modules/aws_s3_bucket_info.py * Update plugins/modules/aws_s3_bucket_info.py * Fixing RETURN indentation * Fixing missing type: in RETURN * Revert changes to changelogs/changelog.yaml * Revert changes to changelogs/changelog.yaml Co-authored-by: Mark Chappell <[email protected]>

* WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Sync with upstream + .gitignore VSCode * Extending integration test * Adding version_added to new module options * Prepare 1.3.0 changelog * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Adjusting changelogs/changelog.yaml * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Prepare 1.3.0 changelog * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Adjusting changelogs/changelog.yaml * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * WIP - adding new functionality to aws_s3_bucket_info module * Fixing exceptions adding integration tests * Code linting - shippable * Fixing option type * Fixing RETURN / Shippable * Extending integration test * Adding version_added to new module options * Use boto3_tag_list_to_ansible_dict for bucket tags * Fixing integration test (delete buckets) * Adjust integration test (python 2.7) * fix integratiuon test -2 * Merging requested PR changes ansible-collections#1 Co-authored-by: Mark Chappell <[email protected]> * Bump version_added 1.3.0->1.4.0 Co-authored-by: Mark Chappell <[email protected]> * Fix module docstring Co-authored-by: Mark Chappell <[email protected]> * Fixing changelog * Code cleanup * Update integration tests * Add S3 bucket location check to integration test * Documentation update - fix wording and typos in DOCUMENTATION - complete rewrite of RETURN * Update plugins/modules/aws_s3_bucket_info.py * Update plugins/modules/aws_s3_bucket_info.py * Fixing RETURN indentation * Fixing missing type: in RETURN * Revert changes to changelogs/changelog.yaml * Revert changes to changelogs/changelog.yaml Co-authored-by: Mark Chappell <[email protected]>

…nsible-collections#260) Since ansible/ansible #73162 this is being validated, and we're not allowing the FQCN path to the plugin. Add that to choices.

zeten30 mentioned this pull request Oct 12, 2020

Provide support for AWS S3 Public Access Blocking ansible-collections/amazon.aws#144

Closed

ansibullbot added affects_2.10 community_review feature This issue/PR relates to a feature request has_issue integration tests/integration module module needs_triage plugins plugin (any type) stale_ci CI is older than 7 days, rerun before merging tests tests labels Nov 16, 2020

zeten30 force-pushed the extending-aws_s3_bucket_info branch from be6c366 to 7662924 Compare November 20, 2020 09:53

zeten30 added 4 commits February 2, 2021 09:53

Fixing changelog

72acae9

Code cleanup

bc9653f

Update integration tests

9c3e670

Add S3 bucket location check to integration test

22ea4fc

zeten30 force-pushed the extending-aws_s3_bucket_info branch from 5e2231d to 22ea4fc Compare February 2, 2021 08:53

Documentation update

dec9b05

- fix wording and typos in DOCUMENTATION - complete rewrite of RETURN

zeten30 requested a review from tremble February 2, 2021 13:31

tremble reviewed Feb 3, 2021

View reviewed changes

plugins/modules/aws_s3_bucket_info.py Outdated Show resolved Hide resolved

Update plugins/modules/aws_s3_bucket_info.py

2f6f32e

tremble reviewed Feb 3, 2021

View reviewed changes

plugins/modules/aws_s3_bucket_info.py Outdated Show resolved Hide resolved

Update plugins/modules/aws_s3_bucket_info.py

2020254

zeten30 requested a review from tremble February 9, 2021 09:16

zeten30 added 2 commits February 9, 2021 10:29

Fixing RETURN indentation

9bbc1ab

Fixing missing type: in RETURN

3c62309

ansibullbot added the community_review label Feb 9, 2021

tremble reviewed Feb 9, 2021

View reviewed changes

changelogs/changelog.yaml Outdated Show resolved Hide resolved

Revert changes to changelogs/changelog.yaml

f83b88b

tremble reviewed Feb 9, 2021

View reviewed changes

changelogs/changelog.yaml Outdated Show resolved Hide resolved

Revert changes to changelogs/changelog.yaml

9ab066c

ansibullbot removed the community_review label Feb 9, 2021

tremble approved these changes Feb 9, 2021

View reviewed changes

ansibullbot added the community_review label Feb 9, 2021

tremble merged commit d24d8f1 into ansible-collections:main Mar 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extending aws_s3_bucket_info module #260

Extending aws_s3_bucket_info module #260

zeten30 commented Oct 12, 2020

zeten30 commented Oct 13, 2020

ansibullbot commented Nov 16, 2020

zeten30 commented Nov 18, 2020

tremble commented Nov 18, 2020

zeten30 commented Nov 18, 2020

tremble commented Nov 19, 2020

zeten30 commented Nov 19, 2020

zeten30 commented Nov 19, 2020

ansibullbot commented Nov 19, 2020

zeten30 commented Dec 10, 2020

zeten30 commented Jan 6, 2021

markuman commented Jan 11, 2021

zeten30 commented Feb 9, 2021

tremble commented Mar 14, 2021

Extending aws_s3_bucket_info module #260

Extending aws_s3_bucket_info module #260

Conversation

zeten30 commented Oct 12, 2020

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

zeten30 commented Oct 13, 2020

ansibullbot commented Nov 16, 2020

zeten30 commented Nov 18, 2020

tremble commented Nov 18, 2020

zeten30 commented Nov 18, 2020

tremble commented Nov 19, 2020

zeten30 commented Nov 19, 2020

zeten30 commented Nov 19, 2020

ansibullbot commented Nov 19, 2020

zeten30 commented Dec 10, 2020

zeten30 commented Jan 6, 2021

markuman commented Jan 11, 2021

zeten30 commented Feb 9, 2021

tremble commented Mar 14, 2021