ec2_ami: Add check_mode support to ec2_ami (ansible-collections#516)

ec2_ami: Add check_mode support to ec2_ami SUMMARY Add check_mode support to ec2_ami. ISSUE TYPE Feature Pull Request COMPONENT NAME ec2_ami Reviewed-by: Mark Chappell <None> Reviewed-by: Alina Buzachis <None> Reviewed-by: None <None>
alinabuzachis · Oct 1, 2021 · 836dbde · 836dbde
1 parent 33e21ad
commit 836dbde
Show file tree

Hide file tree

Showing 3 changed files with 163 additions and 7 deletions.
diff --git a/changelogs/fragments/516-ec2_ami_add_check_mode_support.yml b/changelogs/fragments/516-ec2_ami_add_check_mode_support.yml
@@ -0,0 +1,3 @@
+minor_changes:
+  - ec2_ami - add check_mode support
+    (https://github.com/ansible-collections/amazon.aws/pull/516).
diff --git a/plugins/modules/ec2_ami.py b/plugins/modules/ec2_ami.py
@@ -450,6 +450,13 @@ def create_image(module, connection):
     ramdisk_id = module.params.get('ramdisk_id')
     sriov_net_support = module.params.get('sriov_net_support')
 
+    if module.check_mode:
+        image = connection.describe_images(Filters=[{'Name': 'name', 'Values': [str(name)]}])
+        if not image['Images']:
+            module.exit_json(changed=True, msg='Would have created a AMI if not in check mode.')
+        else:
+            module.exit_json(changed=False, msg='Error registering image: AMI name is already in use by another AMI')
+
     try:
         params = {
             'Name': name,
@@ -564,6 +571,8 @@ def deregister_image(module, connection):
 
     # When trying to re-deregister an already deregistered image it doesn't raise an exception, it just returns an object without image attributes.
     if 'ImageId' in image:
+        if module.check_mode:
+            module.exit_json(changed=True, msg='Would have deregistered AMI if not in check mode.')
         try:
             connection.deregister_image(aws_retry=True, ImageId=image_id)
         except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
@@ -622,9 +631,10 @@ def update_image(module, connection, image_id):
 
         if to_add or to_remove:
             try:
-                connection.modify_image_attribute(aws_retry=True,
-                                                  ImageId=image_id, Attribute='launchPermission',
-                                                  LaunchPermission=dict(Add=to_add, Remove=to_remove))
+                if not module.check_mode:
+                    connection.modify_image_attribute(aws_retry=True,
+                                                      ImageId=image_id, Attribute='launchPermission',
+                                                      LaunchPermission=dict(Add=to_add, Remove=to_remove))
                 changed = True
             except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
                 module.fail_json_aws(e, msg="Error updating launch permissions of image %s" % image_id)
@@ -636,27 +646,32 @@ def update_image(module, connection, image_id):
 
         if tags_to_remove:
             try:
-                connection.delete_tags(aws_retry=True, Resources=[image_id], Tags=[dict(Key=tagkey) for tagkey in tags_to_remove])
+                if not module.check_mode:
+                    connection.delete_tags(aws_retry=True, Resources=[image_id], Tags=[dict(Key=tagkey) for tagkey in tags_to_remove])
                 changed = True
             except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
                 module.fail_json_aws(e, msg="Error updating tags")
 
         if tags_to_add:
             try:
-                connection.create_tags(aws_retry=True, Resources=[image_id], Tags=ansible_dict_to_boto3_tag_list(tags_to_add))
+                if not module.check_mode:
+                    connection.create_tags(aws_retry=True, Resources=[image_id], Tags=ansible_dict_to_boto3_tag_list(tags_to_add))
                 changed = True
             except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
                 module.fail_json_aws(e, msg="Error updating tags")
 
     description = module.params.get('description')
     if description and description != image['Description']:
         try:
-            connection.modify_image_attribute(aws_retry=True, Attribute='Description ', ImageId=image_id, Description=dict(Value=description))
+            if not module.check_mode:
+                connection.modify_image_attribute(aws_retry=True, Attribute='Description ', ImageId=image_id, Description=dict(Value=description))
             changed = True
         except (botocore.exceptions.BotoCoreError, botocore.exceptions.ClientError) as e:
             module.fail_json_aws(e, msg="Error setting description for image %s" % image_id)
 
     if changed:
+        if module.check_mode:
+            module.exit_json(changed=True, msg='Would have updated AMI if not in check mode.')
         module.exit_json(msg="AMI updated.", changed=True,
                          **get_ami_info(get_image_by_id(module, connection, image_id)))
     else:
@@ -749,7 +764,8 @@ def main():
         argument_spec=argument_spec,
         required_if=[
             ['state', 'absent', ['image_id']],
-        ]
+        ],
+        supports_check_mode=True,
     )
 
     # Using a required_one_of=[['name', 'image_id']] overrides the message that should be provided by

diff --git a/tests/integration/targets/ec2_ami/tasks/main.yml b/tests/integration/targets/ec2_ami/tasks/main.yml
@@ -87,6 +87,24 @@
 
     # ============================================================
 
+    - name: create an image from the instance (check mode)
+      ec2_ami:
+        instance_id: '{{ setup_instance.instance_ids[0] }}'
+        state: present
+        name: '{{ ec2_ami_name }}_ami'
+        description: '{{ ec2_ami_description }}'
+        tags:
+          Name: '{{ ec2_ami_name }}_ami'
+        wait: yes
+        root_device_name: '{{ ec2_ami_root_disk }}'
+      check_mode: true
+      register: check_mode_result
+
+    - name: assert that check_mode result is changed
+      assert:
+        that:
+          - check_mode_result is changed
+
     - name: create an image from the instance
       ec2_ami:
         instance_id: '{{ setup_instance.instance_ids[0] }}'
@@ -124,6 +142,28 @@
 
     # ============================================================
 
+    - name: create an image from the instance with attached devices with no_device true (check mode)
+      ec2_ami:
+        name: '{{ ec2_ami_name }}_no_device_true_ami'
+        instance_id: '{{ setup_instance.instance_ids[0] }}'
+        device_mapping:
+          - device_name: /dev/sda1
+            volume_size: 10
+            delete_on_termination: true
+            volume_type: gp2
+          - device_name: /dev/sdf
+            no_device: yes
+        state: present
+        wait: yes
+        root_device_name: '{{ ec2_ami_root_disk }}'
+      check_mode: true
+      register: check_mode_result
+
+    - name: assert that check_mode result is changed
+      assert:
+        that:
+          - check_mode_result is changed
+
     - name: create an image from the instance with attached devices with no_device true
       ec2_ami:
         name: '{{ ec2_ami_name }}_no_device_true_ami'
@@ -250,6 +290,26 @@
     # e2_ami_info filtering tests ends
     # ============================================================
 
+    - name: delete the image (check mode)
+      ec2_ami:
+        instance_id: '{{ setup_instance.instance_ids[0] }}'
+        state: absent
+        delete_snapshot: yes
+        name: '{{ ec2_ami_name }}_ami'
+        description: '{{ ec2_ami_description }}'
+        image_id: '{{ result.image_id }}'
+        tags:
+          Name: '{{ ec2_ami_name }}_ami'
+        wait: yes
+      ignore_errors: true
+      check_mode: true
+      register: check_mode_result
+
+    - name: assert that check_mode result is changed
+      assert:
+        that:
+          - check_mode_result is changed
+
     - name: delete the image
       ec2_ami:
         instance_id: '{{ setup_instance.instance_ids[0] }}'
@@ -319,6 +379,31 @@
 
     # ============================================================
 
+    - name: test default launch permissions idempotence (check mode)
+      ec2_ami:
+        description: '{{ ec2_ami_description }}'
+        state: present
+        name: '{{ ec2_ami_name }}_ami'
+        tags:
+          Name: '{{ ec2_ami_name }}_ami'
+        root_device_name: '{{ ec2_ami_root_disk }}'
+        image_id: '{{ result.image_id }}'
+        launch_permissions:
+          user_ids: []
+        device_mapping:
+          - device_name: '{{ ec2_ami_root_disk }}'
+            volume_type: gp2
+            size: 8
+            delete_on_termination: true
+            snapshot_id: '{{ setup_snapshot.snapshot_id }}'
+      check_mode: true
+      register: check_mode_result
+
+    - name: assert that check_mode result is not changed
+      assert:
+        that:
+          - check_mode_result is not changed
+
     - name: test default launch permissions idempotence
       ec2_ami:
         description: '{{ ec2_ami_description }}'
@@ -381,6 +466,23 @@
 
     # ============================================================
 
+    - name: update AMI launch permissions (check mode)
+      ec2_ami:
+        state: present
+        image_id: '{{ result.image_id }}'
+        description: '{{ ec2_ami_description }}'
+        tags:
+          Name: '{{ ec2_ami_name }}_ami'
+        launch_permissions:
+          group_names: ['all']
+      check_mode: true
+      register: check_mode_result
+
+    - name: assert that check_mode result is changed
+      assert:
+        that:
+          - check_mode_result is changed
+
     - name: update AMI launch permissions
       ec2_ami:
         state: present
@@ -399,6 +501,24 @@
 
     # ============================================================
 
+    - name: modify the AMI description (check mode)
+      ec2_ami:
+        state: present
+        image_id: '{{ result.image_id }}'
+        name: '{{ ec2_ami_name }}_ami'
+        description: '{{ ec2_ami_description }}CHANGED'
+        tags:
+          Name: '{{ ec2_ami_name }}_ami'
+        launch_permissions:
+          group_names: ['all']
+      check_mode: true
+      register: check_mode_result
+
+    - name: assert that check_mode result is changed
+      assert:
+        that:
+          - check_mode_result is changed
+
     - name: modify the AMI description
       ec2_ami:
         state: present
@@ -465,6 +585,23 @@
         that:
           - "snapshot_result.snapshots[0].snapshot_id == ec2_ami_snapshot"
 
+    - name: delete ami for a second time (check mode)
+      ec2_ami:
+        instance_id: '{{ setup_instance.instance_ids[0] }}'
+        state: absent
+        name: '{{ ec2_ami_name }}_ami'
+        image_id: '{{ ec2_ami_image_id }}'
+        tags:
+          Name: '{{ ec2_ami_name }}_ami'
+        wait: yes
+      check_mode: true
+      register: check_mode_result
+
+    - name: assert that check_mode result is not changed
+      assert:
+        that:
+          - check_mode_result is not changed
+
     - name: delete ami for a second time
       ec2_ami:
         instance_id: '{{ setup_instance.instance_ids[0] }}'