cloudwatchlogs_log_group: Add check_mode support (ansible-collections…

…#1373) cloudwatchlogs_log_group: Add check_mode support SUMMARY Add check_mode support to cloudwatchlogs_log_group. ISSUE TYPE Feature Pull Request COMPONENT NAME cloudwatchlogs_log_group Reviewed-by: Alina Buzachis <None> This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections@6a85335
abikouo · Sep 21, 2022 · 68ca0a8 · 68ca0a8
1 parent 28eb5c0
commit 68ca0a8
Show file tree

Hide file tree

Showing 3 changed files with 174 additions and 91 deletions.
diff --git a/plugins/modules/cloudwatchlogs_log_group.py b/plugins/modules/cloudwatchlogs_log_group.py
@@ -148,6 +148,9 @@ def create_log_group(client, log_group_name, kms_key_id, tags, retention, module
     if tags:
         request['tags'] = tags
 
+    if module.check_mode:
+        module.exit_json(changed=True, msg="Would have created log group if not in check_mode.")
+
     try:
         client.create_log_group(**request)
     except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
@@ -180,13 +183,19 @@ def input_retention_policy(client, log_group_name, retention, module):
 
 
 def delete_retention_policy(client, log_group_name, module):
+    if module.check_mode:
+        return True
+
     try:
         client.delete_retention_policy(logGroupName=log_group_name)
     except (botocore.exceptions.ClientError, botocore.exceptions.BotoCoreError) as e:
         module.fail_json_aws(e, msg="Unable to delete retention policy for log group {0}".format(log_group_name))
 
 
 def delete_log_group(client, log_group_name, module):
+    if module.check_mode:
+        module.exit_json(changed=True, msg="Would have deleted log group if not in check_mode.")
+
     try:
         client.delete_log_group(logGroupName=log_group_name)
     except is_boto3_error_code('ResourceNotFoundException'):
@@ -265,7 +274,7 @@ def main():
     )
 
     mutually_exclusive = [['retention', 'purge_retention_policy'], ['purge_retention_policy', 'overwrite']]
-    module = AnsibleAWSModule(argument_spec=argument_spec, mutually_exclusive=mutually_exclusive)
+    module = AnsibleAWSModule(supports_check_mode=True, argument_spec=argument_spec, mutually_exclusive=mutually_exclusive)
 
     try:
         logs = module.client('logs')

diff --git a/tests/integration/targets/cloudwatchlogs_log_group/tasks/main.yml b/tests/integration/targets/cloudwatchlogs_log_group/tasks/main.yml
@@ -7,6 +7,23 @@
       region: "{{ aws_region }}"
 
   block:
+  - name: create cloudwatch log group for integration test (check_mode)
+    cloudwatchlogs_log_group:
+      state: present
+      log_group_name: '{{ log_group_name }}'
+      retention: 1
+      tags:
+        CamelCase: Value
+        snake_case: value
+    check_mode: true
+    register: result
+
+  - assert:
+      that:
+        - result is changed
+        - '"log_groups" not in result'
+        - '"logs:CreateLogGroup" not in result.resource_actions'
+
   - name: create cloudwatch log group for integration test
     cloudwatchlogs_log_group:
       state: present
@@ -42,6 +59,20 @@
     vars:
       log_group: '{{ result.log_groups[0] }}'
 
+  - name: create cloudwatch log group for integration test (check_mode - idempotent)
+    cloudwatchlogs_log_group:
+      state: present
+      log_group_name: '{{ log_group_name }}'
+      retention: 1
+    check_mode: true
+    register: result
+
+  - assert:
+      that:
+      - result is not changed
+      - '"log_groups" in result'
+      - result.log_groups | length == 1
+
   - name: create cloudwatch log group for integration test (idempotent)
     cloudwatchlogs_log_group:
       state: present
@@ -88,6 +119,18 @@
 
   - include_tasks: 'tags.yml'
 
+  - name: delete cloudwatch log group for integration test (check_mode)
+    cloudwatchlogs_log_group:
+      state: absent
+      log_group_name: '{{ log_group_name }}'
+    check_mode: true
+    register: result
+
+  - assert:
+      that:
+      - result is changed
+      - '"logs:DeleteLogGroup" not in result.resource_actions'
+
   - name: delete cloudwatch log group for integration test
     cloudwatchlogs_log_group:
       state: absent
@@ -98,6 +141,18 @@
       that:
       - result is changed
 
+  - name: delete cloudwatch log group for integration test (check_mode - idempotent)
+    cloudwatchlogs_log_group:
+      state: absent
+      log_group_name: '{{ log_group_name }}'
+    check_mode: true
+    register: result
+
+  - assert:
+      that:
+      - result is not changed
+      - '"logs:DeleteLogGroup" not in result.resource_actions'
+
   - name: delete cloudwatch log group for integration test (idempotent)
     cloudwatchlogs_log_group:
       state: absent

diff --git a/tests/integration/targets/cloudwatchlogs_log_group/tasks/tags.yml b/tests/integration/targets/cloudwatchlogs_log_group/tasks/tags.yml
@@ -34,16 +34,19 @@
       log_group_name: '{{ log_group_name }}'
   block:
 
-#  - name: test adding tags to cloudwatchlogs_log_group (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: '{{ first_tags }}'
-#      purge_tags: True
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is changed
+  - name: test adding tags to cloudwatchlogs_log_group (check_mode)
+    cloudwatchlogs_log_group:
+      tags: '{{ first_tags }}'
+      purge_tags: True
+    check_mode: true
+    register: update_result
+
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is changed
+      - '"logs:UntagLogGroup" not in update_result'
+      - '"logs:TagLogGroup" not in update_result'
 
   - name: test adding tags to cloudwatchlogs_log_group
     cloudwatchlogs_log_group:
@@ -56,16 +59,19 @@
       - update_result is changed
       - update_result.log_groups[0].tags == first_tags
 
-#  - name: test adding tags to cloudwatchlogs_log_group - idempotency (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: '{{ first_tags }}'
-#      purge_tags: True
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is not changed
+  - name: test adding tags to cloudwatchlogs_log_group - idempotency (check mode)
+    cloudwatchlogs_log_group:
+      tags: '{{ first_tags }}'
+      purge_tags: True
+    check_mode: true
+    register: update_result
+
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is not changed
+      - '"logs:UntagLogGroup" not in update_result'
+      - '"logs:TagLogGroup" not in update_result'
 
   - name: test adding tags to cloudwatchlogs_log_group - idempotency
     cloudwatchlogs_log_group:
@@ -80,16 +86,19 @@
 
   ###
 
-#  - name: test updating tags with purge on cloudwatchlogs_log_group (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: '{{ second_tags }}'
-#      purge_tags: True
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is changed
+  - name: test updating tags with purge on cloudwatchlogs_log_group (check mode)
+    cloudwatchlogs_log_group:
+      tags: '{{ second_tags }}'
+      purge_tags: True
+    check_mode: true
+    register: update_result
+
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is changed
+      - '"logs:UntagLogGroup" not in update_result'
+      - '"logs:TagLogGroup" not in update_result'
 
   - name: test updating tags with purge on cloudwatchlogs_log_group
     cloudwatchlogs_log_group:
@@ -102,16 +111,19 @@
       - update_result is changed
       - update_result.log_groups[0].tags == second_tags
 
-#  - name: test updating tags with purge on cloudwatchlogs_log_group - idempotency (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: '{{ second_tags }}'
-#      purge_tags: True
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is not changed
+  - name: test updating tags with purge on cloudwatchlogs_log_group - idempotency (check mode)
+    cloudwatchlogs_log_group:
+      tags: '{{ second_tags }}'
+      purge_tags: True
+    check_mode: true
+    register: update_result
+
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is not changed
+      - '"logs:UntagLogGroup" not in update_result'
+      - '"logs:TagLogGroup" not in update_result'
 
   - name: test updating tags with purge on cloudwatchlogs_log_group - idempotency
     cloudwatchlogs_log_group:
@@ -126,16 +138,19 @@
 
   ###
 
-#  - name: test updating tags without purge on cloudwatchlogs_log_group (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: '{{ third_tags }}'
-#      purge_tags: False
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is changed
+  - name: test updating tags without purge on cloudwatchlogs_log_group (check mode)
+    cloudwatchlogs_log_group:
+      tags: '{{ third_tags }}'
+      purge_tags: False
+    check_mode: true
+    register: update_result
+
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is changed
+      - '"logs:UntagLogGroup" not in update_result'
+      - '"logs:TagLogGroup" not in update_result'
 
   - name: test updating tags without purge on cloudwatchlogs_log_group
     cloudwatchlogs_log_group:
@@ -148,16 +163,19 @@
       - update_result is changed
       - update_result.log_groups[0].tags == final_tags
 
-#  - name: test updating tags without purge on cloudwatchlogs_log_group - idempotency (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: '{{ third_tags }}'
-#      purge_tags: False
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is not changed
+  - name: test updating tags without purge on cloudwatchlogs_log_group - idempotency (check mode)
+    cloudwatchlogs_log_group:
+      tags: '{{ third_tags }}'
+      purge_tags: False
+    check_mode: true
+    register: update_result
+
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is not changed
+      - '"logs:UntagLogGroup" not in update_result'
+      - '"logs:TagLogGroup" not in update_result'
 
   - name: test updating tags without purge on cloudwatchlogs_log_group - idempotency
     cloudwatchlogs_log_group:
@@ -183,16 +201,16 @@
 
   ###
 
-#  - name: test no tags param cloudwatchlogs_log_group (check mode)
-#    cloudwatchlogs_log_group: {}
-#    register: update_result
-#    check_mode: yes
-#  - name: assert no change
-#    assert:
-#      that:
-#      - update_result is not changed
-#      - update_result.log_groups[0].tags == final_tags
-#
+  - name: test no tags param cloudwatchlogs_log_group (check mode)
+    cloudwatchlogs_log_group: {}
+    check_mode: true
+    register: update_result
+
+  - name: assert no change
+    assert:
+      that:
+      - update_result is not changed
+      - update_result.log_groups[0].tags == final_tags
 
   - name: test no tags param cloudwatchlogs_log_group
     cloudwatchlogs_log_group: {}
@@ -205,16 +223,17 @@
 
   ###
 
-#  - name: test removing tags from cloudwatchlogs_log_group (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: {}
-#      purge_tags: True
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is changed
+  - name: test removing tags from cloudwatchlogs_log_group (check mode)
+    cloudwatchlogs_log_group:
+      tags: {}
+      purge_tags: True
+    check_mode: true
+    register: update_result
+
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is changed
 
   - name: test removing tags from cloudwatchlogs_log_group
     cloudwatchlogs_log_group:
@@ -227,16 +246,16 @@
       - update_result is changed
       - update_result.log_groups[0].tags == {}
 
-#  - name: test removing tags from cloudwatchlogs_log_group - idempotency (check mode)
-#    cloudwatchlogs_log_group:
-#      tags: {}
-#      purge_tags: True
-#    register: update_result
-#    check_mode: yes
-#  - name: assert that update succeeded
-#    assert:
-#      that:
-#      - update_result is not changed
+  - name: test removing tags from cloudwatchlogs_log_group - idempotency (check mode)
+    cloudwatchlogs_log_group:
+      tags: {}
+      purge_tags: True
+    check_mode: true
+    register: update_result
+  - name: assert that update succeeded
+    assert:
+      that:
+      - update_result is not changed
 
   - name: test removing tags from cloudwatchlogs_log_group - idempotency
     cloudwatchlogs_log_group: