community.aws feat(module/vpc-cagw): Add Carrier Gateway modules

feat(module/vpc-cagw): Add Carrier Gateway modules

Open mtulio opened this issue 1 year ago • 19 comments

SUMMARY

New modules to manage VPC Carrear Gateways.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

modules (new):

ec2_carrier_gateway
ec2_carrier_gateway_info

ADDITIONAL INFORMATION

$ ansible localhost -m ec2_vpc_cagw_info
localhost | SUCCESS => {
    "carrier_gateways": [
        {
            "carrier_gateway_id": "cagw-037df45cae5362d59",
            "tags": {
                "Name": "test1-54dsl-vpc-cagw"
            },
            "vpc_id": "vpc-069cabb60c7e7fc6d"
        }
    ],
    "changed": false
}

$ ansible localhost -m ec2_carrier_gateway -a "state=absent vpc_id=vpc-069cabb60c7e7fc6d carrier_gateway_id=cagw-037df45cae5362d59"
localhost | CHANGED => {
    "changed": true
}


$ ansible localhost -m ec2_carrier_gateway_info
localhost | SUCCESS => {
    "carrier_gateways": [],
    "changed": false
}


$ ansible localhost -m ec2_carrier_gateway-a "vpc_id=vpc-069cabb60c7e7fc6d"
localhost | CHANGED => {
    "carrier_gateway_id": "cagw-095f998ebdcb5ef86",
    "changed": true,
    "tags": {},
    "vpc_id": "vpc-069cabb60c7e7fc6d"
}
$ ansible localhost -m ec2_carrier_gateway_info
localhost | SUCCESS => {
    "carrier_gateways": [
        {
            "carrier_gateway_id": "cagw-095f998ebdcb5ef86",
            "tags": {},
            "vpc_id": "vpc-069cabb60c7e7fc6d"
        }
    ],
    "changed": false
}

Jul 13 '22 04:07 mtulio

cc @jillr @markuman @s-hertel @tremble click here for bot help

Jul 13 '22 04:07 ansibullbot

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

Jul 13 '22 04:07 github-actions[bot]

Build failed.

Jul 13 '22 05:07 softwarefactory-project-zuul[bot]

Hi @tremble ,

Thanks for your quick review and feedback!

It looks like you've copied the framework from an existing module (which is fine) however you've pulled in some cruft which we probably want to avoid. We're slowly cleaning things up, so please understand that we might ask you to change things that you copied from other modules.

Yes, those plugins were based on the Internet Gateway plugins (amazon.aws.ec2_vpc_igw*), which is similar Carrier Gateways, but the module is also quite old. I am also quite new in ansible module development, thanks for your suggestions and feel free to request any change, even through it is to refact based on newer modules. :)

For net-new modules we generally require integration tests. These integration tests are just Ansible playbooks and can be found in tests/integration/targets/ the ec2_vpc_vgw tests are probably a good example to start with. Just copy them over to tests/integration/targets/<module_name> and update the aliases file to include the _info module.

Perfect, I will work on it.

I suspect it'll take a little while to get the tests to work in CI due to the need to enable a Wavelength AZ (which has other side effects), so I'd suggest adding unsupported to the aliases file, which means they can be run manually outside of the main CI, but we need to do some work to get them running in CI.

We have some more info about this in our dev guidelines: https://github.com/ansible-collections/amazon.aws/blob/main/docs/docsite/rst/dev_guidelines.rst#integration-tests-for-aws-modules

ACK. Let me write the tests and see if we can get more insights about it, but having a better handler for the exception when there are no Wavelength zone group enabled it seems to be something nice to have on the module.

Jul 13 '22 13:07 mtulio

A better handler for the exception when there are no Wavelength zone group enabled it seems to be something nice to have on the module.

We have two helpers "is_boto3_error_code" and "is_boto3_error_message" which will probably assist here:

try:
  client.create_carrier_gateway(...)
except is_boto3_error_message("You must be opted into a wavelength zone to create a carrier gateway.") as e:
  module.fail_json(msg="You must be opted into a wavelength zone to create a carrier gateway")

Similarly:

try:
  client.create_carrier_gateway(...)
except is_boto3_error_code("UnsupportedOperation") as e:
  module.fail_json_aws(e, msg="Creating a Carrier Gateway is not supported with your current configuration.")

Jul 13 '22 14:07 tremble

Build failed.

Jul 13 '22 16:07 softwarefactory-project-zuul[bot]

Build failed.

Jul 14 '22 20:07 softwarefactory-project-zuul[bot]

Build failed.

Jul 19 '22 03:07 softwarefactory-project-zuul[bot]

Build failed.

Jul 19 '22 03:07 softwarefactory-project-zuul[bot]

Build failed.

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 4m 03s :heavy_check_mark: build-ansible-collection SUCCESS in 5m 10s :x: ansible-test-sanity-docker-devel FAILURE in 7m 34s (non-voting) :x: ansible-test-sanity-docker-milestone FAILURE in 7m 26s :x: ansible-test-sanity-docker-stable-2.12 FAILURE in 8m 39s :x: ansible-test-sanity-docker-stable-2.13 FAILURE in 8m 27s :heavy_check_mark: ansible-test-units-community-aws-python38 SUCCESS in 6m 31s :heavy_check_mark: ansible-test-units-community-aws-python39 SUCCESS in 5m 32s :heavy_check_mark: ansible-test-splitter SUCCESS in 2m 29s :heavy_check_mark: integration-community.aws-1 SUCCESS in 5m 06s :warning: integration-community.aws-2 SKIPPED :warning: integration-community.aws-3 SKIPPED :warning: integration-community.aws-4 SKIPPED :warning: integration-community.aws-5 SKIPPED :warning: integration-community.aws-6 SKIPPED :warning: integration-community.aws-7 SKIPPED :warning: integration-community.aws-8 SKIPPED :warning: integration-community.aws-9 SKIPPED :warning: integration-community.aws-10 SKIPPED :warning: integration-community.aws-11 SKIPPED :warning: integration-community.aws-12 SKIPPED :warning: integration-community.aws-13 SKIPPED

Jul 19 '22 04:07 softwarefactory-project-zuul[bot]

Build succeeded.

Jul 29 '22 15:07 softwarefactory-project-zuul[bot]

Build failed.

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 4m 30s :heavy_check_mark: build-ansible-collection SUCCESS in 5m 34s :x: ansible-test-sanity-docker-devel FAILURE in 9m 13s (non-voting) :x: ansible-test-sanity-docker-milestone FAILURE in 9m 41s :x: ansible-test-sanity-docker-stable-2.12 FAILURE in 9m 12s :x: ansible-test-sanity-docker-stable-2.13 FAILURE in 9m 46s :heavy_check_mark: ansible-test-units-community-aws-python38 SUCCESS in 5m 39s :heavy_check_mark: ansible-test-units-community-aws-python39 SUCCESS in 5m 36s :heavy_check_mark: ansible-test-splitter SUCCESS in 2m 34s :heavy_check_mark: integration-community.aws-1 SUCCESS in 5m 13s :warning: integration-community.aws-2 SKIPPED :warning: integration-community.aws-3 SKIPPED :warning: integration-community.aws-4 SKIPPED :warning: integration-community.aws-5 SKIPPED :warning: integration-community.aws-6 SKIPPED :warning: integration-community.aws-7 SKIPPED :warning: integration-community.aws-8 SKIPPED :warning: integration-community.aws-9 SKIPPED :warning: integration-community.aws-10 SKIPPED :warning: integration-community.aws-11 SKIPPED :warning: integration-community.aws-12 SKIPPED :warning: integration-community.aws-13 SKIPPED

Jul 29 '22 15:07 softwarefactory-project-zuul[bot]

A better handler for the exception when there are no Wavelength zone group enabled it seems to be something nice to have on the module.

We have two helpers "is_boto3_error_code" and "is_boto3_error_message" which will probably assist here:
try:
  client.create_carrier_gateway(...)
except is_boto3_error_message("You must be opted into a wavelength zone to create a carrier gateway.") as e:
  module.fail_json(msg="You must be opted into a wavelength zone to create a carrier gateway")
Similarly:
try:
  client.create_carrier_gateway(...)
except is_boto3_error_code("UnsupportedOperation") as e:
  module.fail_json_aws(e, msg="Creating a Carrier Gateway is not supported with your current configuration.")

Error handling implemented when the WL has not opted in on the Region :

TASK [mtulio.okd_installer.cloud_network : AWS | CAGW create] *********************************************************************************************************************************
fatal: [localhost]: FAILED! => {"changed": false, "msg": "You must be opted into a wavelength zone to create a carrier gateway"}

Jul 29 '22 16:07 mtulio

@tremble I believe I covered the points mentioned in the last review. Could you please take a look?

Jul 29 '22 16:07 mtulio

Build succeeded.

Jul 29 '22 16:07 softwarefactory-project-zuul[bot]

@markuman @s-hertel @tremble ptal?

Aug 12 '22 23:08 mtulio

just some missing check_mode tests, otherwise LGTM

Aug 19 '22 10:08 markuman

just some missing check_mode tests, otherwise LGTM

Thanks for the feedback. check_mode=true were added. Let's see the CI results.

Oct 08 '22 04:10 mtulio

Build succeeded.

Oct 08 '22 04:10 softwarefactory-project-zuul[bot]

recheck

Nov 15 '22 12:11 markuman

Build succeeded.

Nov 15 '22 12:11 softwarefactory-project-zuul[bot]

Build failed.

Dec 28 '22 20:12 softwarefactory-project-zuul[bot]

Build failed.

Dec 28 '22 21:12 softwarefactory-project-zuul[bot]

recheck

Dec 29 '22 03:12 mtulio

Build failed.

Dec 29 '22 03:12 softwarefactory-project-zuul[bot]

Build failed.

Dec 29 '22 04:12 softwarefactory-project-zuul[bot]

Hey @tremble! I am not sure if the failing tests are directly related to this change. Would you mind taking a look to try to take the final review on this PR? Thanks! =]

Dec 29 '22 05:12 mtulio

recheck

Mar 30 '23 04:03 markuman

Build succeeded. https://ansible.softwarefactory-project.io/zuul/buildset/c15c9ff6e2f04c388ed16fd87f8ad44a

:heavy_check_mark: ansible-galaxy-importer SUCCESS in 4m 26s :heavy_check_mark: build-ansible-collection SUCCESS in 12m 43s :x: ansible-test-sanity-docker-devel FAILURE in 11m 25s (non-voting) :heavy_check_mark: ansible-test-sanity-docker-milestone SUCCESS in 11m 15s (non-voting) :heavy_check_mark: ansible-test-sanity-docker-stable-2.12 SUCCESS in 11m 35s :heavy_check_mark: ansible-test-sanity-docker-stable-2.13 SUCCESS in 11m 28s :heavy_check_mark: ansible-test-sanity-docker-stable-2.14 SUCCESS in 11m 06s :heavy_check_mark: ansible-test-units-amazon-aws-python36 SUCCESS in 6m 40s :heavy_check_mark: ansible-test-units-amazon-aws-python38 SUCCESS in 7m 16s :heavy_check_mark: ansible-test-units-amazon-aws-python39 SUCCESS in 5m 41s :heavy_check_mark: ansible-test-units-amazon-aws-python310 SUCCESS in 9m 17s :heavy_check_mark: ansible-test-changelog SUCCESS in 4m 36s :heavy_check_mark: ansible-test-splitter SUCCESS in 4m 48s :heavy_check_mark: integration-community.aws-1 SUCCESS in 7m 07s Skipped 21 jobs

Mar 30 '23 05:03 softwarefactory-project-zuul[bot]

recheck

Mar 30 '23 05:03 markuman

community.aws community.aws copied to clipboard

feat(module/vpc-cagw): Add Carrier Gateway modules

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Docs Build 📝

community.aws
community.aws copied to clipboard