From aecdfd397ee7e96d7f2b40e3da2cbd24b7bc3f94 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 5 Aug 2019 21:47:35 +0200 Subject: [PATCH] ecs_taskdefinition_facts: rename to ecs_taskdefinition_info (#60023) * Rename ecs_taskdefinition_facts to ecs_taskdefinition_info. --- .github/BOTMETA.yml | 2 +- changelogs/fragments/60023-aws-facts-info.yaml | 2 ++ .../docsite/rst/porting_guides/porting_guide_2.9.rst | 1 + lib/ansible/config/module_defaults.yml | 2 -- .../cloud/amazon/_ecs_taskdefinition_facts.py | 1 + ...efinition_facts.py => ecs_taskdefinition_info.py} | 7 +++++-- test/integration/targets/ecs_cluster/aliases | 2 +- .../targets/ecs_cluster/tasks/full_test.yml | 12 ++++++------ test/sanity/ignore.txt | 2 +- 9 files changed, 18 insertions(+), 13 deletions(-) create mode 100644 changelogs/fragments/60023-aws-facts-info.yaml create mode 120000 lib/ansible/modules/cloud/amazon/_ecs_taskdefinition_facts.py rename lib/ansible/modules/cloud/amazon/{ecs_taskdefinition_facts.py => ecs_taskdefinition_info.py} (97%) diff --git a/.github/BOTMETA.yml b/.github/BOTMETA.yml index a1076bdefe2..ae2f4005476 100644 --- a/.github/BOTMETA.yml +++ b/.github/BOTMETA.yml @@ -85,7 +85,7 @@ files: $modules/cloud/amazon/ecs_service_facts.py: willthames $modules/cloud/amazon/ecs_task.py: willthames $modules/cloud/amazon/ecs_taskdefinition.py: willthames - $modules/cloud/amazon/ecs_taskdefinition_facts.py: willthames + $modules/cloud/amazon/ecs_taskdefinition_info.py: willthames $modules/cloud/amazon/elasticache.py: alachaum $modules/cloud/amazon/elb_target_group_info.py: willthames $modules/cloud/amazon/iam.py: $team_ansible diff --git a/changelogs/fragments/60023-aws-facts-info.yaml b/changelogs/fragments/60023-aws-facts-info.yaml new file mode 100644 index 00000000000..b81b531584f --- /dev/null +++ b/changelogs/fragments/60023-aws-facts-info.yaml @@ -0,0 +1,2 @@ +minor_changes: +- The ``ecs_taskdefinition_facts`` module has been renamed to ``ecs_taskdefinition_info``. diff --git a/docs/docsite/rst/porting_guides/porting_guide_2.9.rst b/docs/docsite/rst/porting_guides/porting_guide_2.9.rst index c6e977270a4..3b8f883a221 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_2.9.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_2.9.rst @@ -138,6 +138,7 @@ Noteworthy module changes * The ``ec2_vpc_subnet_facts`` module was renamed to :ref:`ec2_vpc_subnet_info `. * The ``ec2_vpc_vgw_facts`` module was renamed to :ref:`ec2_vpc_vgw_info `. * The ``ec2_vpc_vpn_facts`` module was renamed to :ref:`ec2_vpc_vpn_info `. +* The ``ecs_taskdefinition_facts`` module was renamed to :ref:`ecs_taskdefinition_info `. * The ``elasticache_facts`` module was renamed to :ref:`elasticache_info `. * The ``elb_application_lb_facts`` module was renamed to :ref:`elb_application_lb_info `. * The ``elb_classic_lb_facts`` module was renamed to :ref:`elb_classic_lb_info `. diff --git a/lib/ansible/config/module_defaults.yml b/lib/ansible/config/module_defaults.yml index 9f7d7d1d3d3..a0ccac6fdf5 100644 --- a/lib/ansible/config/module_defaults.yml +++ b/lib/ansible/config/module_defaults.yml @@ -260,8 +260,6 @@ groupings: - aws ecs_taskdefinition: - aws - ecs_taskdefinition_facts: - - aws ecs_taskdefinition_info: - aws efs: diff --git a/lib/ansible/modules/cloud/amazon/_ecs_taskdefinition_facts.py b/lib/ansible/modules/cloud/amazon/_ecs_taskdefinition_facts.py new file mode 120000 index 00000000000..0eb6f10b8ff --- /dev/null +++ b/lib/ansible/modules/cloud/amazon/_ecs_taskdefinition_facts.py @@ -0,0 +1 @@ +ecs_taskdefinition_info.py \ No newline at end of file diff --git a/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py b/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_info.py similarity index 97% rename from lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py rename to lib/ansible/modules/cloud/amazon/ecs_taskdefinition_info.py index f08ceb80374..a4f5f8c6165 100644 --- a/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py +++ b/lib/ansible/modules/cloud/amazon/ecs_taskdefinition_info.py @@ -12,11 +12,12 @@ ANSIBLE_METADATA = {'metadata_version': '1.1', DOCUMENTATION = ''' --- -module: ecs_taskdefinition_facts +module: ecs_taskdefinition_info short_description: describe a task definition in ecs notes: - for details of the parameters and returns see U(http://boto3.readthedocs.io/en/latest/reference/services/ecs.html#ECS.Client.describe_task_definition) + - This module was called C(ecs_taskdefinition_facts) before Ansible 2.9. The usage did not change. description: - Describes a task definition in ecs. version_added: "2.5" @@ -38,7 +39,7 @@ extends_documentation_fragment: EXAMPLES = ''' # Note: These examples do not set authentication details, see the AWS Guide for details. -- ecs_taskdefinition_facts: +- ecs_taskdefinition_info: task_definition: test-td ''' @@ -316,6 +317,8 @@ def main(): )) module = AnsibleAWSModule(argument_spec=argument_spec, supports_check_mode=True) + if module._name == 'ecs_taskdefinition_facts': + module.deprecate("The 'ecs_taskdefinition_facts' module has been renamed to 'ecs_taskdefinition_info'", version='2.13') region, ec2_url, aws_connect_kwargs = get_aws_connection_info(module, boto3=True) ecs = boto3_conn(module, conn_type='client', resource='ecs', diff --git a/test/integration/targets/ecs_cluster/aliases b/test/integration/targets/ecs_cluster/aliases index 4ca31efa7a6..53a712479e9 100644 --- a/test/integration/targets/ecs_cluster/aliases +++ b/test/integration/targets/ecs_cluster/aliases @@ -2,5 +2,5 @@ cloud/aws ecs_service_facts ecs_task ecs_taskdefinition -ecs_taskdefinition_facts +ecs_taskdefinition_info unsupported diff --git a/test/integration/targets/ecs_cluster/tasks/full_test.yml b/test/integration/targets/ecs_cluster/tasks/full_test.yml index 6b454dd5abb..afd70875b09 100644 --- a/test/integration/targets/ecs_cluster/tasks/full_test.yml +++ b/test/integration/targets/ecs_cluster/tasks/full_test.yml @@ -219,7 +219,7 @@ ignore_errors: yes - name: obtain ECS task definition facts - ecs_taskdefinition_facts: + ecs_taskdefinition_info: task_definition: "{{ ecs_task_name }}:{{ ecs_task_definition.taskdefinition.revision }}" <<: *aws_connection_info @@ -392,15 +392,15 @@ register: ecs_task_definition_vpc_with_host_port - name: obtain ECS task definition facts - ecs_taskdefinition_facts: + ecs_taskdefinition_info: task_definition: "{{ ecs_task_name }}-vpc:{{ ecs_task_definition_vpc_with_host_port.taskdefinition.revision }}" <<: *aws_connection_info - register: ecs_taskdefinition_facts + register: ecs_taskdefinition_info - name: assert that network mode is awsvpc assert: that: - - "ecs_taskdefinition_facts.network_mode == 'awsvpc'" + - "ecs_taskdefinition_info.network_mode == 'awsvpc'" - name: pause to allow service to scale down pause: @@ -626,7 +626,7 @@ - "'networkConfiguration' in ecs_service_facts.ansible_facts.services[0]" - name: attempt to get facts from missing task definition - ecs_taskdefinition_facts: + ecs_taskdefinition_info: task_definition: "{{ ecs_task_name }}-vpc:{{ ecs_task_definition.taskdefinition.revision + 1}}" <<: *aws_connection_info @@ -699,7 +699,7 @@ register: ecs_fargate_task_definition - name: obtain ECS task definition facts - ecs_taskdefinition_facts: + ecs_taskdefinition_info: task_definition: "{{ ecs_task_name }}-vpc:{{ ecs_fargate_task_definition.taskdefinition.revision }}" <<: *aws_connection_info diff --git a/test/sanity/ignore.txt b/test/sanity/ignore.txt index 47b90930057..c2a69aa620f 100644 --- a/test/sanity/ignore.txt +++ b/test/sanity/ignore.txt @@ -900,7 +900,7 @@ lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py future-import-boilerplate lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py metaclass-boilerplate lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py validate-modules:E337 lib/ansible/modules/cloud/amazon/ecs_taskdefinition.py validate-modules:E338 -lib/ansible/modules/cloud/amazon/ecs_taskdefinition_facts.py validate-modules:E337 +lib/ansible/modules/cloud/amazon/ecs_taskdefinition_info.py validate-modules:E337 lib/ansible/modules/cloud/amazon/efs.py pylint:blacklisted-name lib/ansible/modules/cloud/amazon/efs.py validate-modules:E337 lib/ansible/modules/cloud/amazon/efs_facts.py pylint:blacklisted-name