[PR #964/c6906a3f backport] [5.0.0] fix incomplete enforce_count() return values #1389
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fix incomplete enforce_count() return values SUMMARY This is the Ansible way. Since a call to enforce_count() requires that a call to find_instances() has already been made, the information required to populate the instances return key is already held by the variable existing_matches. There are zero use cases where it makes sense not to output this information; if I want exactly one such instance and an existing instance matches the filter, I definitely always want to know its details. Fixes ansible-collections#963, ansible-collections#859 ISSUE TYPE Bugfix Pull Request COMPONENT NAME ec2_instance ADDITIONAL INFORMATION See linked issues. Before: { "changed": false, "invocation": { "module_args": { "availability_zone": null, "aws_access_key": null, "aws_ca_bundle": null, "aws_config": null, "aws_secret_key": null, "count": null, "cpu_credit_specification": null, "cpu_options": null, "debug_botocore_endpoint_logs": false, "detailed_monitoring": false, "ebs_optimized": true, "ec2_url": null, "exact_count": 1, "filters": { "tag:Name": "something", "tag:env": "prod" }, "image": null, "image_id": "REDACTED", "instance_ids": [], "instance_initiated_shutdown_behavior": null, "instance_role": "REDACTED", "instance_type": "m5.2xlarge", "key_name": "REDACTED", "launch_template": null, "metadata_options": null, "name": null, "network": { "source_dest_check": true }, "placement_group": null, "profile": null, "purge_tags": false, "region": "us-west-2", "security_group": null, "security_groups": [ "default" ], "security_token": null, "state": "present", "tags": { "Name": "something", "env": "prod", }, "tenancy": null, "termination_protection": null, "tower_callback": null, "user_data": "REDACTED", "validate_certs": true, "volumes": [ { "device_name": "/dev/sda1", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 20, "volume_type": "gp3" } }, { "device_name": "/dev/xvdo", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 20, "volume_type": "gp3" } }, { "device_name": "/dev/xvdp", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 10, "volume_type": "gp3" } }, { "device_name": "/dev/xvdi", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 100, "volume_type": "gp3" } } ], "vpc_subnet_id": "REDACTED", "wait": true, "wait_timeout": 300 } }, "msg": "1 instances already running, nothing to do." } After: { "changed": false, "instance_ids": [ "REDACTED" ], "instances": [ { "ami_launch_index": 0, "architecture": "x86_64", "block_device_mappings": [ { "device_name": "/dev/sda1", "ebs": { "attach_time": "2022-08-10T19:50:24+00:00", "delete_on_termination": true, "status": "attached", "volume_id": "REDACTED" } }, { "device_name": "/dev/xvdo", "ebs": { "attach_time": "2022-08-10T19:50:24+00:00", "delete_on_termination": true, "status": "attached", "volume_id": "REDACTED" } }, { "device_name": "/dev/xvdp", "ebs": { "attach_time": "2022-08-10T19:50:24+00:00", "delete_on_termination": true, "status": "attached", "volume_id": "REDACTED" } }, { "device_name": "/dev/xvdi", "ebs": { "attach_time": "2022-08-10T19:50:24+00:00", "delete_on_termination": true, "status": "attached", "volume_id": "REDACTED" } } ], "capacity_reservation_specification": { "capacity_reservation_preference": "open" }, "client_token": "REDACTED", "cpu_options": { "core_count": 4, "threads_per_core": 2 }, "ebs_optimized": true, "ena_support": true, "enclave_options": { "enabled": false }, "hibernation_options": { "configured": false }, "hypervisor": "xen", "iam_instance_profile": { "arn": "REDACTED", "id": "REDACTED" }, "image_id": "REDACTED", "instance_id": "REDACTED", "instance_type": "m5.2xlarge", "key_name": "REDACTED", "launch_time": "2022-08-10T19:50:23+00:00", "maintenance_options": { "auto_recovery": "default" }, "metadata_options": { "http_endpoint": "enabled", "http_protocol_ipv6": "disabled", "http_put_response_hop_limit": 1, "http_tokens": "optional", "instance_metadata_tags": "disabled", "state": "applied" }, "monitoring": { "state": "disabled" }, "network_interfaces": [ { "attachment": { "attach_time": "2022-08-10T19:50:23+00:00", "attachment_id": "REDACTED", "delete_on_termination": true, "device_index": 0, "network_card_index": 0, "status": "attached" }, "description": "", "groups": [ { "group_id": "REDACTED", "group_name": "REDACTED" } ], "interface_type": "interface", "ipv6_addresses": [], "mac_address": "REDACTED", "network_interface_id": "REDACTED", "owner_id": "REDACTED", "private_dns_name": "REDACTED", "private_ip_address": "REDACTED", "private_ip_addresses": [ { "primary": true, "private_dns_name": "REDACTED", "private_ip_address": "REDACTED" } ], "source_dest_check": true, "status": "in-use", "subnet_id": "REDACTED", "vpc_id": "REDACTED" } ], "placement": { "availability_zone": "us-west-2a", "group_name": "", "tenancy": "default" }, "platform_details": "Linux/UNIX", "private_dns_name": "REDACTED", "private_dns_name_options": { "enable_resource_name_dns_a_record": false, "enable_resource_name_dns_aaaa_record": false, "hostname_type": "ip-name" }, "private_ip_address": "REDACTED", "product_codes": [], "public_dns_name": "", "root_device_name": "/dev/sda1", "root_device_type": "ebs", "security_groups": [ { "group_id": "REDACTED", "group_name": "REDACTED" } ], "source_dest_check": true, "state": { "code": 16, "name": "running" }, "state_transition_reason": "", "subnet_id": "REDACTED", "tags": { "Name": "something", "env": "prod", }, "usage_operation": "RunInstances", "usage_operation_update_time": "2022-08-10T19:50:23+00:00", "virtualization_type": "hvm", "vpc_id": "REDACTED" } ], "invocation": { "module_args": { "availability_zone": null, "aws_access_key": null, "aws_ca_bundle": null, "aws_config": null, "aws_secret_key": null, "count": null, "cpu_credit_specification": null, "cpu_options": null, "debug_botocore_endpoint_logs": false, "detailed_monitoring": false, "ebs_optimized": true, "ec2_url": null, "exact_count": 1, "filters": { "tag:Name": "something", "tag:env": "prod" }, "image": null, "image_id": "REDACTED", "instance_ids": [], "instance_initiated_shutdown_behavior": null, "instance_role": "REDACTED", "instance_type": "m5.2xlarge", "key_name": "REDACTED", "launch_template": null, "metadata_options": null, "name": null, "network": { "source_dest_check": true }, "placement_group": null, "profile": null, "purge_tags": false, "region": "us-west-2", "security_group": null, "security_groups": [ "default" ], "security_token": null, "state": "present", "tags": { "Name": "something", "env": "prod", }, "tenancy": null, "termination_protection": null, "tower_callback": null, "user_data": "REDACTED", "validate_certs": true, "volumes": [ { "device_name": "/dev/sda1", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 20, "volume_type": "gp3" } }, { "device_name": "/dev/xvdo", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 20, "volume_type": "gp3" } }, { "device_name": "/dev/xvdp", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 10, "volume_type": "gp3" } }, { "device_name": "/dev/xvdi", "ebs": { "delete_on_termination": true, "encrypted": true, "volume_size": 100, "volume_type": "gp3" } } ], "vpc_subnet_id": "REDACTED", "wait": true, "wait_timeout": 300 } }, "msg": "1 instances already running, nothing to do." } Reviewed-by: Alina Buzachis Reviewed-by: Mark Chappell
Docs Build 📝Thank you for contribution!✨ This PR has been merged and your docs changes will be incorporated when they are next published. |
|
recheck |
|
recheck |
|
Test failures appear to be flakes, and inconsistently hitting different tests |
reparepo
pushed a commit
to reparepo/amazon.aws
that referenced
this pull request
Mar 17, 2023
route53_info - enable max_items tests SUMMARY Enables the tests from ansible-collections#1384 ISSUE TYPE Feature Pull Request COMPONENT NAME route53_info ADDITIONAL INFORMATION This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections/community.aws@7427a0d
abikouo
pushed a commit
to abikouo/amazon.aws
that referenced
this pull request
Oct 24, 2023
route53_info - enable max_items tests SUMMARY Enables the tests from ansible-collections#1384 ISSUE TYPE Feature Pull Request COMPONENT NAME route53_info ADDITIONAL INFORMATION
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
This is the Ansible way.
Since a call to enforce_count() requires that a call to find_instances() has already been made, the information required to populate the instances return key is already held by the variable existing_matches. There are zero use cases where it makes sense not to output this information; if I want exactly one such instance and an existing instance matches the filter, I definitely always want to know its details.
Fixes #963, #859
ISSUE TYPE
Bugfix Pull Request
COMPONENT NAME
ec2_instance
==== ADDITIONAL INFORMATION
See linked issues.
Before:
{
"changed": false,
"invocation": {
"module_args": {
"availability_zone": null,
"aws_access_key": null,
"aws_ca_bundle": null,
"aws_config": null,
"aws_secret_key": null,
"count": null,
"cpu_credit_specification": null,
"cpu_options": null,
"debug_botocore_endpoint_logs": false,
"detailed_monitoring": false,
"ebs_optimized": true,
"ec2_url": null,
"exact_count": 1,
"filters": {
"tag:Name": "something",
"tag:env": "prod"
},
"image": null,
"image_id": "REDACTED",
"instance_ids": [],
"instance_initiated_shutdown_behavior": null,
"instance_role": "REDACTED",
"instance_type": "m5.2xlarge",
"key_name": "REDACTED",
"launch_template": null,
"metadata_options": null,
"name": null,
"network": {
"source_dest_check": true
},
"placement_group": null,
"profile": null,
"purge_tags": false,
"region": "us-west-2",
"security_group": null,
"security_groups": [
"default"
],
"security_token": null,
"state": "present",
"tags": {
"Name": "something",
"env": "prod",
},
"tenancy": null,
"termination_protection": null,
"tower_callback": null,
"user_data": "REDACTED",
"validate_certs": true,
"volumes": [
{
"device_name": "/dev/sda1",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 20,
"volume_type": "gp3"
}
},
{
"device_name": "/dev/xvdo",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 20,
"volume_type": "gp3"
}
},
{
"device_name": "/dev/xvdp",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 10,
"volume_type": "gp3"
}
},
{
"device_name": "/dev/xvdi",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 100,
"volume_type": "gp3"
}
}
],
"vpc_subnet_id": "REDACTED",
"wait": true,
"wait_timeout": 300
}
},
"msg": "1 instances already running, nothing to do."
}
After:
{
"changed": false,
"instance_ids": [
"REDACTED"
],
"instances": [
{
"ami_launch_index": 0,
"architecture": "x86_64",
"block_device_mappings": [
{
"device_name": "/dev/sda1",
"ebs": {
"attach_time": "2022-08-10T19:50:24+00:00",
"delete_on_termination": true,
"status": "attached",
"volume_id": "REDACTED"
}
},
{
"device_name": "/dev/xvdo",
"ebs": {
"attach_time": "2022-08-10T19:50:24+00:00",
"delete_on_termination": true,
"status": "attached",
"volume_id": "REDACTED"
}
},
{
"device_name": "/dev/xvdp",
"ebs": {
"attach_time": "2022-08-10T19:50:24+00:00",
"delete_on_termination": true,
"status": "attached",
"volume_id": "REDACTED"
}
},
{
"device_name": "/dev/xvdi",
"ebs": {
"attach_time": "2022-08-10T19:50:24+00:00",
"delete_on_termination": true,
"status": "attached",
"volume_id": "REDACTED"
}
}
],
"capacity_reservation_specification": {
"capacity_reservation_preference": "open"
},
"client_token": "REDACTED",
"cpu_options": {
"core_count": 4,
"threads_per_core": 2
},
"ebs_optimized": true,
"ena_support": true,
"enclave_options": {
"enabled": false
},
"hibernation_options": {
"configured": false
},
"hypervisor": "xen",
"iam_instance_profile": {
"arn": "REDACTED",
"id": "REDACTED"
},
"image_id": "REDACTED",
"instance_id": "REDACTED",
"instance_type": "m5.2xlarge",
"key_name": "REDACTED",
"launch_time": "2022-08-10T19:50:23+00:00",
"maintenance_options": {
"auto_recovery": "default"
},
"metadata_options": {
"http_endpoint": "enabled",
"http_protocol_ipv6": "disabled",
"http_put_response_hop_limit": 1,
"http_tokens": "optional",
"instance_metadata_tags": "disabled",
"state": "applied"
},
"monitoring": {
"state": "disabled"
},
"network_interfaces": [
{
"attachment": {
"attach_time": "2022-08-10T19:50:23+00:00",
"attachment_id": "REDACTED",
"delete_on_termination": true,
"device_index": 0,
"network_card_index": 0,
"status": "attached"
},
"description": "",
"groups": [
{
"group_id": "REDACTED",
"group_name": "REDACTED"
}
],
"interface_type": "interface",
"ipv6_addresses": [],
"mac_address": "REDACTED",
"network_interface_id": "REDACTED",
"owner_id": "REDACTED",
"private_dns_name": "REDACTED",
"private_ip_address": "REDACTED",
"private_ip_addresses": [
{
"primary": true,
"private_dns_name": "REDACTED",
"private_ip_address": "REDACTED"
}
],
"source_dest_check": true,
"status": "in-use",
"subnet_id": "REDACTED",
"vpc_id": "REDACTED"
}
],
"placement": {
"availability_zone": "us-west-2a",
"group_name": "",
"tenancy": "default"
},
"platform_details": "Linux/UNIX",
"private_dns_name": "REDACTED",
"private_dns_name_options": {
"enable_resource_name_dns_a_record": false,
"enable_resource_name_dns_aaaa_record": false,
"hostname_type": "ip-name"
},
"private_ip_address": "REDACTED",
"product_codes": [],
"public_dns_name": "",
"root_device_name": "/dev/sda1",
"root_device_type": "ebs",
"security_groups": [
{
"group_id": "REDACTED",
"group_name": "REDACTED"
}
],
"source_dest_check": true,
"state": {
"code": 16,
"name": "running"
},
"state_transition_reason": "",
"subnet_id": "REDACTED",
"tags": {
"Name": "something",
"env": "prod",
},
"usage_operation": "RunInstances",
"usage_operation_update_time": "2022-08-10T19:50:23+00:00",
"virtualization_type": "hvm",
"vpc_id": "REDACTED"
}
],
"invocation": {
"module_args": {
"availability_zone": null,
"aws_access_key": null,
"aws_ca_bundle": null,
"aws_config": null,
"aws_secret_key": null,
"count": null,
"cpu_credit_specification": null,
"cpu_options": null,
"debug_botocore_endpoint_logs": false,
"detailed_monitoring": false,
"ebs_optimized": true,
"ec2_url": null,
"exact_count": 1,
"filters": {
"tag:Name": "something",
"tag:env": "prod"
},
"image": null,
"image_id": "REDACTED",
"instance_ids": [],
"instance_initiated_shutdown_behavior": null,
"instance_role": "REDACTED",
"instance_type": "m5.2xlarge",
"key_name": "REDACTED",
"launch_template": null,
"metadata_options": null,
"name": null,
"network": {
"source_dest_check": true
},
"placement_group": null,
"profile": null,
"purge_tags": false,
"region": "us-west-2",
"security_group": null,
"security_groups": [
"default"
],
"security_token": null,
"state": "present",
"tags": {
"Name": "something",
"env": "prod",
},
"tenancy": null,
"termination_protection": null,
"tower_callback": null,
"user_data": "REDACTED",
"validate_certs": true,
"volumes": [
{
"device_name": "/dev/sda1",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 20,
"volume_type": "gp3"
}
},
{
"device_name": "/dev/xvdo",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 20,
"volume_type": "gp3"
}
},
{
"device_name": "/dev/xvdp",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 10,
"volume_type": "gp3"
}
},
{
"device_name": "/dev/xvdi",
"ebs": {
"delete_on_termination": true,
"encrypted": true,
"volume_size": 100,
"volume_type": "gp3"
}
}
],
"vpc_subnet_id": "REDACTED",
"wait": true,
"wait_timeout": 300
}
},
"msg": "1 instances already running, nothing to do."
}
Reviewed-by: Alina Buzachis
Reviewed-by: Mark Chappell