Merge pull request #17 from timflannagan1/unit-tests

Add various integration tests

Author: timflannagan

library/find_unused_disk.py

@@ -19,6 +19,11 @@
     description: Sets the maximum number of unused disks to return.
     default: 10
     type: int
+
+    option-name: min_size
+    description: Specifies the minimum disk size to return an unused disk.
+    default: 0
+    type: str
 '''
 
 EXAMPLES = '''
@@ -27,7 +32,9 @@
   tasks:
     - name: run module
       find_unused_disk:
+        min_size: '10g'
       register: testout
+
     - name: dump test output
       debug:
         msg: '{{ testout }}'
@@ -57,6 +64,7 @@
 
 from ansible.module_utils.basic import AnsibleModule
 from ansible.module_utils import facts
+from ansible.module_utils.size import Size
 
 
 def no_signature(run_command, disk_path):
@@ -83,7 +91,8 @@ def can_open(disk_path):
 def run_module():
     """Create the module"""
     module_args = dict(
-        max_return=dict(type='int', required=False, default=10)
+        max_return=dict(type='int', required=False, default=10),
+        min_size=dict(type='str', required=False, default=0)
     )
 
     result = dict(
@@ -98,17 +107,27 @@ def run_module():
 
     ansible_facts = facts.ansible_facts(module)
     run_command = module.run_command
+
     for disk in ansible_facts['devices'].keys():
         # If partition table exists but contains no partitions -> no partitions.
         no_partitions = not bool(ansible_facts['devices'][disk]['partitions'])
 
+        ansible_disk_size = ansible_facts['devices'][disk]['size'].lower().replace('gb', 'g').replace('mb', 'm')
+        disk_size = Size(ansible_disk_size)
+        min_disk_size = Size(module.params['min_size'])
+
         if no_partitions and no_signature(run_command, '/dev/' + disk) and no_holders(disk) and can_open('/dev/' + disk):
-            result['disks'].append(disk)
+            if min_disk_size.bytes <= disk_size.bytes:
+                result['disks'].append(disk)
+
             if len(result['disks']) >= module.params['max_return']:
                 break
 
     if not result['disks']:
         result['disks'] = "Unable to find unused disk"
+    else:
+        result['disks'].sort()
+
     module.exit_json(**result)
 
 

tasks/fs-default.yml

@@ -9,6 +9,11 @@
       state: present
   - set_fact:
       xfsprogs_installed: true
+  rescue:
+    - debug:
+        msg:
+          - "Failed to install the xfsprogs package. Check if the Scalable File System add-on is enabled."
+          - "See: https://access.redhat.com/discussions/2051373"
   when: "volume.fs_type == 'xfs' and ['xfsprogs'] is not subset(ansible_facts.packages.keys()) \
          and xfsprogs_installed is undefined and not ansible_check_mode \
          and ((pool is defined and pool.state in 'present') or volume.state in 'present')"
@@ -45,6 +50,12 @@
   when: volume._wipe and volume._orig_mount_point
   changed_when: false
 
+- name: Check if we can use the force parameter in wipefs
+  set_fact:
+      volume: "{{ volume|combine({'fs_destroy_options': '-a'}) }}"
+  when: (ansible_distribution == 'CentOS' and ansible_distribution_major_version == '6') or
+        (ansible_distribution == 'RedHat' and ansible_distribution_major_version == '6')
+
 - name: Remove file system as needed
   command: wipefs {{ volume.fs_destroy_options }} {{ volume._device }}
   when: volume._wipe or volume._remove and device_status.stat.exists and not ansible_check_mode

tasks/main.yml

@@ -3,6 +3,14 @@
   package_facts:
     manager: "auto"
 
+- name: define an empty list of pools to be used in testing
+  set_fact:
+    _storage_pools_list: []
+
+- name: define an empty list of volumes to be used in testing
+  set_fact:
+    _storage_volumes_list: []
+
 - name: manage pools
   include_tasks: pool-{{ storage_backend }}.yml
   loop: "{{ storage_pools }}"

tasks/mount-default.yml

@@ -44,4 +44,8 @@
 
 - name: tell systemd to refresh its view of /etc/fstab
   command: systemctl daemon-reload
-  when: mount_info is defined and mount_info.changed
+  when:
+    - mount_info is defined
+    - mount_info.changed
+    - (ansible_distribution == 'CentOS' and ansible_distribution_major_version != '6') or
+      (ansible_distribution == 'RedHat' and ansible_distribution_major_version != '6')

tasks/pool-default.yml

@@ -41,6 +41,10 @@
     pool: "{{ pool|combine({'_preexist': pool.name in ansible_facts.lvm.vgs}) }}"
   when: ansible_facts.lvm is defined and pool.type == "lvm"
 
+- name: Add the finished pool to a list of pools
+  set_fact:
+    _storage_pools_list: "{{ _storage_pools_list + [pool] }}"
+
 #
 # XXX This is only going to remove fstab entries etc. for volumes explicitly listed.
 #

tasks/volume-default.yml

@@ -99,6 +99,19 @@
                                             'state': volume.state}) }}"
   when: volume.type == "partition"
 
+- name: Use the ext4 file system when distribution is RHEL 6 (and xfs was not specified)
+  set_fact:
+    volume: "{{ volume|combine({'fs_type': 'ext4'}) }}"
+  when:
+    - raw_volume.fs_type is undefined
+    - ansible_distribution == 'RedHat'
+    - ansible_distribution_major_version == '6'
+
+- name: Append volume state info to storage_volumes_list
+  set_fact:
+    _storage_volumes_list: "{{ _storage_volumes_list + [volume] }}"
+  when: volume.type == 'partition' or volume.type == 'disk'
+
 - name: Manage the Specified Volume
   include_tasks: "{{ layer }}-{{ storage_backend }}.yml"
   loop: "{{ volume_layers if volume._create else volume_layers[::-1] }}"

tests/.fmf/version

@@ -0,0 +1 @@
+1

tests/get_unused_disk.yml

@@ -0,0 +1,20 @@
+---
+- name: Find unused disks in the system
+  find_unused_disk:
+    min_size: "{{ min_size | default(omit) }}"
+  register: unused_disks_return
+
+- set_fact:
+    unused_disks: "{{ unused_disks_return.disks }}"
+  when: "'Unable to find unused disk' not in unused_disks_return.disks"
+
+- block:
+    - name: Exit playbook when there's no unused disks in the system
+      debug:
+        msg: "Unable to find unused disks. Exiting playbook."
+    - meta: end_play
+  when: unused_disks is undefined
+
+- name: Print unused disks
+  debug:
+    var: unused_disks

tests/inventory

@@ -0,0 +1,5 @@
+standard-inventory-qcow2:
+  qemu:
+    drive:
+      - size: 10737418240
+      - size: 10737418240

tests/provision.fmf

@@ -0,0 +1,27 @@
+---
+- name: Read the /etc/fstab file for volume existence
+  command: cat /etc/fstab
+  register: fstab_buffer
+  changed_when: false
+
+- name: Verify the volumes listed in storage_pools were correctly managed
+  include_tasks: "{{ current_pool.state is search('absent') | bool | ternary('test-volumes-absent-helper.yml', 'test-volumes-present-helper.yml') }}"
+  loop: "{{ _storage_pools_list }}"
+  loop_control:
+    loop_var: current_pool
+  when: _storage_pools_list is defined and _storage_pools_list | length > 0
+
+- block:
+  - name: Verify the volumes listed in current_volumes were correctly managed
+    assert:
+      that:
+        - "{{ current_volume.mount_point in fstab_buffer.stdout if current_volume.state in 'present' \
+              else current_volume.mount_point not in fstab_buffer.stdout }}"
+        - "{{ ansible_mounts|selectattr('device', 'equalto', current_volume._device)|list|length==1 \
+              if current_volume.state in 'present' else  \
+              ansible_mounts|selectattr('device', 'equalto', current_volume._device)|list|length==0 }}"
+      msg: "The storage volume {{ current_volume.name }} was incorrectly managed."
+    loop: "{{ _storage_volumes_list }}"
+    loop_control:
+      loop_var: current_volume
+  when: _storage_volumes_list is defined and _storage_volumes_list | length > 0

tests/test-verify-volumes.yml

@@ -0,0 +1,10 @@
+---
+- name: Make sure all volumes in pool.volumes are absent
+  assert:
+    that:
+      - current_volume.mount_point not in fstab_buffer.stdout
+      - "{{ ansible_mounts|selectattr('device', 'equalto', current_volume.name)|list|length == 0 }}"
+    msg: "The pool volume {{ current_volume.name }} was incorrectly managed."
+  loop: "{{ current_pool.volumes }}"
+  loop_control:
+    loop_var: current_volume

tests/test-volumes-absent-helper.yml

@@ -0,0 +1,21 @@
+---
+- name: Ensure all lvm volumes were correctly managed in /etc/fstab and ansible_mounts.
+  assert:
+    that:
+      - "{{ ansible_mounts|selectattr('device', 'equalto', current_volume.name)|list|length==1
+            if current_volume.state is defined and current_volume.state in 'present' else
+            ansible_mounts|selectattr('device', 'equalto', current_volume.name)|list|length==0
+         }}"
+
+      - "{{ (ansible_mounts|selectattr('device', 'equalto', current_volume.name)|map(attribute='mount')
+            == current_volume.mount_point) if current_volume.state is defined and current_volume.state in 'present'
+            else true
+        }}"
+        
+      - "{{ current_volume.mount_point not in fstab_buffer.stdout if
+            (current_volume.state is defined and current_volume.state in 'absent')
+            else current_volume.mount_point in fstab_buffer.stdout }}"
+    msg: "The volume {{ current_volume.name }} was incorrectly managed in /etc/fstab."
+  loop: "{{ current_pool.volumes }}"
+  loop_control:
+    loop_var: current_volume

tests/test-volumes-present-helper.yml

@@ -0,0 +1,41 @@
+---
+- hosts: all
+  become: true
+  tags: ['never', 'expfail']
+  vars:
+    mount_location: '/opt/test'
+    volume_size: '5g'
+    fs_type_after: "{{ 'ext3' if (ansible_distribution == 'RedHat' and ansible_distribution_major_version == '6') else 'ext4' }}"
+
+  tasks:
+    - include_role:
+        name: storage
+
+    - include_tasks: get_unused_disk.yml
+      vars:
+        min_size: "{{ volume_size }}"
+
+    - name: Create a disk device with the default file system type
+      include_role:
+        name: storage
+      vars:
+        storage_volumes:
+          - name: test1
+            type: disk
+            mount_point: "{{ mount_location }}"
+            disks: "{{ unused_disks[0] }}"
+
+    - include_tasks: verify-role-results.yml
+
+    - name: Change the disk device file system type to "{{ fs_type_after }}"
+      include_role:
+        name: storage
+      vars:
+        storage_volumes:
+          - name: test1
+            type: disk
+            mount_point: "{{ mount_location }}"
+            fs_type: "{{ fs_type_after }}"
+            disks: "{{ unused_disks[0] }}"
+
+    - include_tasks: verify-role-results.yml

tests/tests_change_disk_fs.yml

@@ -0,0 +1,40 @@
+---
+- hosts: all
+  become: true
+  tags: ['never', 'expfail']
+  vars:
+    mount_location_before: '/opt/test1'
+    mount_location_after: '/opt/test2'
+    volume_size: '5g'
+
+  tasks:
+    - include_role:
+        name: storage
+
+    - include_tasks: get_unused_disk.yml
+      vars:
+        min_size: "{{ volume_size }}"
+
+    - name: Create a disk device mounted at "{{ mount_location_before }}"
+      include_role:
+        name: storage
+      vars:
+        storage_volumes:
+          - name: test1
+            type: disk
+            mount_point: "{{ mount_location_before }}"
+            disks: "{{ unused_disks[0] }}"
+
+    - include_tasks: verify-role-results.yml
+
+    - name: Change the disk device mount location to "{{ mount_location_after }}"
+      include_role:
+        name: storage
+      vars:
+        storage_volumes:
+          - name: test1
+            type: disk
+            mount_point: "{{ mount_location_after }}"
+            disks: "{{ unused_disks[0] }}"
+
+    - include_tasks: verify-role-results.yml

tests/tests_change_disk_mount.yml

@@ -0,0 +1,44 @@
+---
+- hosts: all
+  become: true
+  vars:
+    mount_location: '/opt/test1'
+    volume_size: '5g'
+    fs_after: "{{ (ansible_distribution == 'RedHat' and ansible_distribution_major_version == '6') | ternary('ext4', 'xfs') }}"
+
+  tasks:
+    - include_role:
+        name: storage
+
+    - include_tasks: get_unused_disk.yml
+      vars:
+        min_size: "{{ volume_size }}"
+
+    - name: Create a LVM logical volume with default fs_type
+      include_role:
+        name: storage
+      vars:
+        storage_pools:
+          - name: foo
+            disks: "{{ unused_disks[0] }}"
+            volumes:
+              - name: test1
+                size: "{{ volume_size }}"
+                mount_point: "{{ mount_location }}"
+
+    - include_tasks: verify-role-results.yml
+
+    - name: Change the file system signature on the logical volume created above
+      include_role:
+        name: storage
+      vars:
+        storage_pools:
+          - name: foo
+            disks: "{{ unused_disks[0] }}"
+            volumes:
+              - name: test1
+                size: "{{ volume_size }}"
+                fs_type: "{{ fs_after }}"
+                mount_point: "{{ mount_location }}"
+
+    - include_tasks: verify-role-results.yml