Refactored image{,_info} modules

Code of the image module has been refactored partially only.
It will have to be completed in a follow up patch.

Change-Id: Id2360163117db9639a0af502ab44e02cae5cebaa

ci/roles/image/tasks/main.yml

@@ -1,317 +1,331 @@
 ---
-- name: Ensure image does not exist before tests
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: absent
-     name: ansible_image
+- name: Test images
+  block:
+    - name: List all images
+      openstack.cloud.image_info:
+        cloud: "{{ cloud }}"
+      register: images
 
-- name: Create a test image file
-  shell: mktemp
-  register: tmp_file
+    - name: Assert existence of CirrOS image
+      assert:
+        that:
+          - images.images | length > 0
 
-- name: Fill test image file to 1MB
-  shell: truncate -s 1048576 {{ tmp_file.stdout }}
+    - name: Ensure clean environment
+      ansible.builtin.set_fact:
+        tmp_file: !!null
 
-- name: ensure mock kernel and ramdisk images (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: "{{ item }}"
-     filename: "{{ tmp_file.stdout }}"
-     disk_format: raw
-  loop:
-    - cirros-vmlinuz
-    - cirros-initrd
+    - name: Create a test image file
+      ansible.builtin.tempfile:
+      register: tmp_file
 
-- name: Create raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     filename: "{{ tmp_file.stdout }}"
-     is_protected: true
-     disk_format: raw
-     tags:
-       - test
-       - ansible
-  register: returned_image
+    - name: Fill test image file to 1MB
+      community.general.filesize:
+        path: '{{ tmp_file.path }}'
+        size: 1M
 
-- debug:
-    var: returned_image
+    - name: Ensure mock kernel and ramdisk images (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: "{{ item }}"
+         filename: "{{ tmp_file.path }}"
+         disk_format: raw
+      loop:
+        - cirros-vmlinuz
+        - cirros-initrd
 
-- name: Assert changed
-  assert:
-    that: returned_image is changed
+    - name: Create raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         filename: "{{ tmp_file.path }}"
+         is_protected: true
+         disk_format: raw
+         tags:
+           - test
+           - ansible
+      register: image
 
-- name: Assert fields
-  assert:
-    that:
-      - item in returned_image.image
-  loop: "{{ expected_fields }}"
+    - name: Assert changed
+      assert:
+        that:
+          - image is changed
 
-- name: Get details of created image
-  openstack.cloud.image_info:
-    cloud: "{{ cloud }}"
-    image: ansible_image
-  register: image_info_result
+    - name: Assert return values of image module
+      assert:
+        that:
+          - image is changed
+          - image.image.name == 'ansible_image'
+          # allow new fields to be introduced but prevent fields from being removed
+          - expected_fields|difference(image.image.keys())|length == 0
 
-- name: Verify image info
-  assert:
-    that:
-      - image_info_result.images[0].name == "ansible_image"
-      - image_info_result.images[0].tags | sort == ['test', 'ansible'] | sort
+    - name: Get details of created image
+      openstack.cloud.image_info:
+        cloud: "{{ cloud }}"
+        image: ansible_image
+      register: images
 
-- name: Create raw image again (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     filename: "{{ tmp_file.stdout }}"
-     is_protected: true
-     disk_format: raw
-     tags:
-       - test
-       - ansible
-  register: returned_image
+    - name: Assert return values of image_info module
+      assert:
+        that:
+          - images.images | length > 0
+          - images.images.0.name == "ansible_image"
+          - images.images.0.tags | sort == ['test', 'ansible'] | sort
+          # allow new fields to be introduced but prevent fields from being removed
+          - expected_fields|difference(images.images.0.keys())|length == 0
 
-- name: Assert not changed
-  assert:
-    that: returned_image is not changed
+    - name: Create raw image again (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         filename: "{{ tmp_file.path }}"
+         is_protected: true
+         disk_format: raw
+         tags:
+           - test
+           - ansible
+      register: image
 
-- name: Assert fields
-  assert:
-    that:
-      - item in returned_image.image
-  loop: "{{ expected_fields }}"
+    - name: Assert not changed
+      assert:
+        that:
+          - image is not changed
 
-- name: Update is_protected on raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     is_protected: false
-  register: returned_image
+    - name: Update is_protected on raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         is_protected: false
+      register: image
 
-- name: Assert changed
-  assert:
-    that:
-      - returned_image is changed
-      - returned_image.image.is_protected == false
+    - name: Assert changed
+      assert:
+        that:
+          - image is changed
+          - image.image.is_protected == false
 
-- name: Assert changed
-  assert:
-    that:
-      - returned_image is changed
+    - name: Assert changed
+      assert:
+        that:
+          - image is changed
 
-- name: Update visibility on raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     is_public: false
-  register: returned_image
+    - name: Update visibility on raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         is_public: false
+      register: image
 
-- name: Assert changed
-  assert:
-    that:
-      - returned_image.image.visibility == 'private'
+    - name: Assert changed
+      assert:
+        that:
+          - image.image.visibility == 'private'
 
-- name: Update again visibility on raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     is_public: true
-  register: returned_image
+    - name: Update again visibility on raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         is_public: true
+      register: image
 
-- name: Assert changed
-  assert:
-    that:
-      - returned_image is changed
-      - returned_image.image.visibility == 'public'
+    - name: Assert changed
+      assert:
+        that:
+          - image is changed
+          - image.image.visibility == 'public'
 
-- name: Define visibility on raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     visibility: shared
-  register: returned_image
+    - name: Define visibility on raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         visibility: shared
+      register: image
 
-- name: Assert changed
-  assert:
-    that:
-      - returned_image is changed
-      - returned_image.image.visibility == 'shared'
+    - name: Assert changed
+      assert:
+        that:
+          - image is changed
+          - image.image.visibility == 'shared'
 
-- name: Rename raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     id: "{{ returned_image.id }}"
-     name: 'ansible_image-changed'
-  register: returned_image
+    - name: Rename raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         id: "{{ image.image.id }}"
+         name: 'ansible_image-changed'
+      register: image
 
-- name: Assert changed
-  assert:
-    that:
-      - returned_image is changed
-      - returned_image.image.name == 'ansible_image-changed'
+    - name: Assert changed
+      assert:
+        that:
+          - image is changed
+          - image.image.name == 'ansible_image-changed'
 
-- name: Rename back raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     id: "{{ returned_image.id }}"
-     name: ansible_image
-  register: returned_image
+    - name: Rename back raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         id: "{{ image.image.id }}"
+         name: ansible_image
+      register: image
 
-- name: Delete raw image (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: absent
-     name: ansible_image
-  register: returned_image
+    - name: Delete raw image (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: absent
+         name: ansible_image
+      register: image
 
-- name: assert image changed
-  assert:
-    that: returned_image is changed
+    - name: assert image changed
+      assert:
+        that:
+          - image is changed
 
-- name: Delete raw image again (defaults)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: absent
-     name: ansible_image
-  register: returned_image
+    - name: Delete raw image again (defaults)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: absent
+         name: ansible_image
+      register: image
 
-- name: assert image not changed
-  assert:
-    that: returned_image is not changed
+    - name: assert image not changed
+      assert:
+        that:
+          - image is not changed
 
-- name: Create raw image (complex)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     filename: "{{ tmp_file.stdout }}"
-     disk_format: raw
-     is_public: True
-     min_disk: 10
-     min_ram: 1024
-     # TODO(rcastillo): upload cirros-vmlinuz, cirros-initrd in test setup
-     kernel: cirros-vmlinuz
-     ramdisk: cirros-initrd
-     properties:
-        cpu_arch: x86_64
-        distro: ubuntu
-  register: returned_image
+    - name: Create raw image (complex)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         filename: "{{ tmp_file.path }}"
+         disk_format: raw
+         is_public: True
+         min_disk: 10
+         min_ram: 1024
+         # TODO(rcastillo): upload cirros-vmlinuz, cirros-initrd in test setup
+         kernel: cirros-vmlinuz
+         ramdisk: cirros-initrd
+         properties:
+            cpu_arch: x86_64
+            distro: ubuntu
+      register: image
 
-- name: Assert visibility
-  assert:
-     that: returned_image.image.visibility == 'public'
+    - name: Assert visibility
+      assert:
+         that:
+          - image.image.visibility == 'public'
 
-- name: Assert fields
-  assert:
-    that:
-      - item in returned_image.image
-  loop: "{{ expected_fields }}"
+    - name: Delete raw image (complex)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: absent
+         name: ansible_image
 
-- name: Delete raw image (complex)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: absent
-     name: ansible_image
+    - name: Try to get details of deleted image
+      openstack.cloud.image_info:
+        cloud: "{{ cloud }}"
+        image: ansible_image
+      register: images
 
-- name: Try to get details of deleted image
-  openstack.cloud.image_info:
-    cloud: "{{ cloud }}"
-    image: ansible_image
-  register: deleted_image_info_result
+    - name: Verify image is deleted
+      assert:
+        that:
+          - images.images | length == 0
 
-- name: Verify image is deleted
-  assert:
-    that:
-      - not deleted_image_info_result.images
+    - name: Create owner project
+      openstack.cloud.project:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_project
+         description: Project owning test image
+         domain: default
+         is_enabled: True
+      register: project
 
-- name: Create owner project
-  openstack.cloud.project:
-     cloud: "{{ cloud }}"
-     state: present
-     name: image_owner_project
-     description: Project owning test image
-     domain: default
-     is_enabled: True
-  register: owner_project
+    - name: Create raw image (owner by project name)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         filename: "{{ tmp_file.path }}"
+         disk_format: raw
+         tags:
+           - test
+           - ansible
+         project: ansible_project
+      register: image
 
-- name: Create raw image (owner by project name)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     filename: "{{ tmp_file.stdout }}"
-     disk_format: raw
-     tags:
-       - test
-       - ansible
-     project: image_owner_project
-  register: returned_image
+    - name: Get details of created image (owner by project name)
+      openstack.cloud.image_info:
+        cloud: "{{ cloud }}"
+        image: ansible_image
+      register: images
 
-- name: Get details of created image (owner by project name)
-  openstack.cloud.image_info:
-    cloud: "{{ cloud }}"
-    image: ansible_image
-  register: image_info_result
+    - name: Verify image owner (owner by project name)
+      assert:
+        that:
+          - images.images.0.owner == project.project.id
 
-- name: Verify image owner (owner by project name)
-  assert:
-    that:
-      - image_info_result.images[0].owner == owner_project.project.id
+    - name: Delete raw image (owner by project name)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: absent
+         name: ansible_image
 
-- name: Delete raw image (owner by project name)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: absent
-     name: ansible_image
+    - name: Create raw image (owner by project name and domain name)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: present
+         name: ansible_image
+         filename: "{{ tmp_file.path }}"
+         disk_format: raw
+         tags:
+           - test
+           - ansible
+         project: ansible_project
+         project_domain: default
+      register: image
 
-- name: Create raw image (owner by project name and domain name)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: present
-     name: ansible_image
-     filename: "{{ tmp_file.stdout }}"
-     disk_format: raw
-     tags:
-       - test
-       - ansible
-     project: image_owner_project
-     project_domain: default
-  register: returned_image
+    - name: Get details of created image (owner by project name and domain name)
+      openstack.cloud.image_info:
+        cloud: "{{ cloud }}"
+        image: ansible_image
+      register: images
 
-- name: Get details of created image (owner by project name and domain name)
-  openstack.cloud.image_info:
-    cloud: "{{ cloud }}"
-    image: ansible_image
-  register: image_info_result
+    - name: Verify image owner (owner by project name and domain name)
+      assert:
+        that:
+          - images.images.0.owner == project.project.id
 
-- name: Verify image owner (owner by project name and domain name)
-  assert:
-    that:
-      - image_info_result.images[0].owner == owner_project.project.id
+    - name: Delete raw image (owner by project name and domain name)
+      openstack.cloud.image:
+         cloud: "{{ cloud }}"
+         state: absent
+         name: ansible_image
 
-- name: Delete raw image (owner by project name and domain name)
-  openstack.cloud.image:
-     cloud: "{{ cloud }}"
-     state: absent
-     name: ansible_image
+    - name: Delete owner project
+      openstack.cloud.project:
+         cloud: "{{ cloud }}"
+         state: absent
+         name: ansible_project
+         domain: default
 
-- name: Delete owner project
-  openstack.cloud.project:
-     cloud: "{{ cloud }}"
-     state: absent
-     name: image_owner_project
-     domain: default
+    - name: Delete test image file
+      file:
+         name: "{{ tmp_file.path }}"
+         state: absent
 
-- name: Delete test image file
-  file:
-     name: "{{ tmp_file.stdout }}"
-     state: absent
+  always:
+    - name: Remove temporary image file
+      ansible.builtin.file:
+        path: "{{ tmp_file.path }}"
+        state: absent
+      when: tmp_file is defined and 'path' in tmp_file

ci/roles/image_info/defaults/main.yml

@@ -1,65 +0,0 @@
-expected_fields:
-  - architecture
-  - checksum
-  - container_format
-  - created_at
-  - direct_url
-  - disk_format
-  - file
-  - has_auto_disk_config
-  - hash_algo
-  - hash_value
-  - hw_cpu_cores
-  - hw_cpu_policy
-  - hw_cpu_sockets
-  - hw_cpu_thread_policy
-  - hw_cpu_threads
-  - hw_disk_bus
-  - hw_machine_type
-  - hw_qemu_guest_agent
-  - hw_rng_model
-  - hw_scsi_model
-  - hw_serial_port_count
-  - hw_video_model
-  - hw_video_ram
-  - hw_vif_model
-  - hw_watchdog_action
-  - hypervisor_type
-  - id
-  - instance_type_rxtx_factor
-  - instance_uuid
-  - is_hidden
-  - is_hw_boot_menu_enabled
-  - is_hw_vif_multiqueue_enabled
-  - is_protected
-  - kernel_id
-  - locations
-  - metadata
-  - min_disk
-  - min_ram
-  - name
-  - needs_config_drive
-  - needs_secure_boot
-  - os_admin_user
-  - os_command_line
-  - os_distro
-  - os_require_quiesce
-  - os_shutdown_timeout
-  - os_type
-  - os_version
-  - owner
-  - owner_id
-  - properties
-  - ramdisk_id
-  - schema
-  - size
-  - status
-  - store
-  - tags
-  - updated_at
-  - url
-  - virtual_size
-  - visibility
-  - vm_mode
-  - vmware_adaptertype
-  - vmware_ostype

ci/roles/image_info/tasks/main.yml

@@ -1,11 +0,0 @@
----
-- name: List all images  # This will list at least the default cirros image of devstack
-  openstack.cloud.image_info:
-    cloud: "{{ cloud }}"
-  register: image_list_result
-
-- name: Assert fields
-  assert:
-    that:
-      - item in image_list_result.images.0.keys()
-  loop: "{{ expected_fields }}"

ci/run-collection.yml

@@ -26,7 +26,6 @@
     - { role: identity_role, tags: identity_role }
     - { role: identity_role_info, tags: identity_role_info }
     - { role: image, tags: image }
-    - { role: image_info, tags: image_info }
     - { role: keypair, tags: keypair }
     - { role: keystone_domain, tags: keystone_domain }
     - role: keystone_idp