Rename ACM modules (#1263)

Rename ACM modules SUMMARY In line with what I understood to be the consensus on ansible-collections/amazon.aws#881 and ansible-collections/amazon.aws#610 Rename aws_acm to acm_certificate Rename aws_acm_info to acm_certificate_info ISSUE TYPE Feature Pull Request COMPONENT NAME aws_acm aws_acm_info acm_certificate acm_certificate_info ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]>
ansible-collections · Jun 25, 2022 · ba08f90 · ba08f90
1 parent 9a6f651
commit ba08f90
Show file tree

Hide file tree

Showing 13 changed files with 36 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -32,8 +32,8 @@ Name | Description
 ### Modules
 Name | Description
 --- | ---
-[community.aws.aws_acm](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_acm_module.rst)|Upload and delete certificates in the AWS Certificate Manager service
-[community.aws.aws_acm_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_acm_info_module.rst)|Retrieve certificate information from AWS Certificate Manager service
+[community.aws.acm_certificate](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.acm_certificate_module.rst)|Upload and delete certificates in the AWS Certificate Manager service
+[community.aws.acm_certificate_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.acm_certificate_info_module.rst)|Retrieve certificate information from AWS Certificate Manager service
 [community.aws.aws_api_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_api_gateway_module.rst)|Manage AWS API Gateway APIs
 [community.aws.aws_api_gateway_domain](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_api_gateway_domain_module.rst)|Manage AWS API Gateway custom domains
 [community.aws.aws_application_scaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_application_scaling_policy_module.rst)|Manage Application Auto Scaling Scaling Policies

diff --git a/changelogs/fragments/1263-acm_certificate.yml b/changelogs/fragments/1263-acm_certificate.yml
@@ -0,0 +1,3 @@
+minor_changes:
+- aws_acm - the ``aws_acm`` module has been renamed to ``acm_certificate``, ``aws_acm`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1263).
+- aws_acm_info - the ``aws_acm_info`` module has been renamed to ``acm_certificate_info``, ``aws_acm_info`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1263).
diff --git a/docs/community.aws.aws_acm_info_module.rst → ...unity.aws.acm_certificate_info_module.rst b/docs/community.aws.aws_acm_info_module.rst → ...unity.aws.acm_certificate_info_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_acm_info_module:
+.. _community.aws.acm_certificate_info_module:
 
 
-**************************
-community.aws.aws_acm_info
-**************************
+**********************************
+community.aws.acm_certificate_info
+**********************************
 
 **Retrieve certificate information from AWS Certificate Manager service**
 
@@ -17,7 +17,7 @@ Version added: 1.0.0
 
 Synopsis
 --------
-- Retrieve information for ACM certificates
+- Retrieve information for ACM certificates.
 - Note that this will not return information about uploaded keys of size 4096 bits, due to a limitation of the ACM API.
 
 
@@ -157,7 +157,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>The domain name of an ACM certificate to limit the search to</div>
+                        <div>The domain name of an ACM certificate to limit the search to.</div>
                         <div style="font-size: small; color: darkgreen"><br/>aliases: name</div>
                 </td>
             </tr>
@@ -249,7 +249,7 @@ Parameters
                         </ul>
                 </td>
                 <td>
-                        <div>Status to filter the certificate results</div>
+                        <div>Status to filter the certificate results.</div>
                 </td>
             </tr>
             <tr>

diff --git a/docs/community.aws.aws_acm_module.rst → .../community.aws.acm_certificate_module.rst b/docs/community.aws.aws_acm_module.rst → .../community.aws.acm_certificate_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_acm_module:
+.. _community.aws.acm_certificate_module:
 
 
-*********************
-community.aws.aws_acm
-*********************
+*****************************
+community.aws.acm_certificate
+*****************************
 
 **Upload and delete certificates in the AWS Certificate Manager service**
 

diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -1,6 +1,8 @@
 requires_ansible: '>=2.9.10'
 action_groups:
   aws:
+  - acm_certificate
+  - acm_certificate_info
   - aws_acm
   - aws_acm_info
   - aws_api_gateway
@@ -200,6 +202,12 @@ action_groups:
   - wafv2_web_acl_info
 plugin_routing:
   modules:
+    aws_acm:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.acm_certificate
+    aws_acm_info:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.acm_certificate_info
     ec2_elb:
       redirect: community.aws.elb_instance
     ec2_instance:

diff --git a/plugins/modules/aws_acm.py → plugins/modules/acm_certificate.py b/plugins/modules/aws_acm.py → plugins/modules/acm_certificate.py
@@ -27,7 +27,7 @@
 
 DOCUMENTATION = r'''
 ---
-module: aws_acm
+module: acm_certificate
 short_description: Upload and delete certificates in the AWS Certificate Manager service
 version_added: 1.0.0
 description:
@@ -74,6 +74,8 @@
   - >
     Note that this may not work properly with keys of size 4096 bits, due to a
     limitation of the ACM API.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_acm).
+    The usage did not change.
 options:
   certificate:
     description:
@@ -176,7 +178,6 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags.deprecated_purge
-
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/aws_acm_info.py → plugins/modules/acm_certificate_info.py b/plugins/modules/aws_acm_info.py → plugins/modules/acm_certificate_info.py
@@ -7,12 +7,14 @@
 
 
 DOCUMENTATION = r'''
-module: aws_acm_info
+module: acm_certificate_info
 short_description: Retrieve certificate information from AWS Certificate Manager service
 version_added: 1.0.0
 description:
-  - Retrieve information for ACM certificates
+  - Retrieve information for ACM certificates.
   - Note that this will not return information about uploaded keys of size 4096 bits, due to a limitation of the ACM API.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_acm_info).
+    The usage did not change.
 options:
   certificate_arn:
     description:
@@ -24,13 +26,13 @@
     type: str
   domain_name:
     description:
-      - The domain name of an ACM certificate to limit the search to
+      - The domain name of an ACM certificate to limit the search to.
     aliases:
       - name
     type: str
   statuses:
     description:
-      - Status to filter the certificate results
+      - Status to filter the certificate results.
     choices: ['PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED']
     type: list
     elements: str

diff --git a/tests/integration/targets/aws_acm/aliases → ...tegration/targets/acm_certificate/aliases b/tests/integration/targets/aws_acm/aliases → ...tegration/targets/acm_certificate/aliases
@@ -3,4 +3,4 @@
 
 cloud/aws
 
-aws_acm_info
+acm_certificate_info
diff --git a/...gration/targets/aws_acm/defaults/main.yml → ...targets/acm_certificate/defaults/main.yml b/...gration/targets/aws_acm/defaults/main.yml → ...targets/acm_certificate/defaults/main.yml
diff --git a/...integration/targets/aws_acm/meta/main.yml → ...ion/targets/acm_certificate/meta/main.yml b/...integration/targets/aws_acm/meta/main.yml → ...ion/targets/acm_certificate/meta/main.yml
diff --git a/...n/targets/aws_acm/tasks/full_acm_test.yml → ...s/acm_certificate/tasks/full_acm_test.yml b/...n/targets/aws_acm/tasks/full_acm_test.yml → ...s/acm_certificate/tasks/full_acm_test.yml
diff --git a/...ntegration/targets/aws_acm/tasks/main.yml → ...on/targets/acm_certificate/tasks/main.yml b/...ntegration/targets/aws_acm/tasks/main.yml → ...on/targets/acm_certificate/tasks/main.yml
diff --git a/tests/unit/plugins/modules/test_aws_acm.py → ...t/plugins/modules/test_acm_certificate.py b/tests/unit/plugins/modules/test_aws_acm.py → ...t/plugins/modules/test_acm_certificate.py
@@ -20,8 +20,8 @@
 
 from pprint import pprint
 
-from ansible_collections.community.aws.plugins.modules.aws_acm import chain_compare
-from ansible_collections.community.aws.plugins.modules.aws_acm import pem_chain_split
+from ansible_collections.community.aws.plugins.modules.acm_certificate import chain_compare
+from ansible_collections.community.aws.plugins.modules.acm_certificate import pem_chain_split
 from ansible.module_utils._text import to_text