fix: add support for EL10

According to the Ansible team, support for listing platforms in role `meta/main.yml` files is being removed. Instead, they recommend using `galaxy_tags` https://github.com/ansible/ansible/blob/stable-2.17/changelogs/CHANGELOG-v2.17.rst "Remove the galaxy_info field platforms from the role templates" ansible/ansible#82453 Many roles already have tags such as "rhel", "redhat", "centos", and "fedora". I propose that we ensure all of the system roles have these tags. Some of our roles support Suse, Debian, Ubuntu, and others. We should add tags for those e.g. the ssh role already has tags for "debian" and "ubuntu". In addition - for each version listed under `platforms.EL` - add a tag like `elN`. Q: Why not use a delimiter between the platform and the version e.g. `el-10`? This is not allowed by ansible-lint: ``` meta-no-tags: Tags must contain lowercase letters and digits only., invalid: 'el-10' meta/main.yml:1 ``` So we cannot use uppercase letters either. Q: Why not use our own meta/main.yml field? No other fields are allowed by ansible-lint: ``` syntax-check[specific]: 'myfield' is not a valid attribute for a RoleMetadata ``` Q: Why not use some other field? There are no other applicable or suitable fields. Q: What happens when we want to support versions like `N.M`? Use the word "dot" instead of "." e.g. `el10dot3`. Similarly - use "dash" instead of "-". We do not need tags such as `fedoraall`. The `fedora` tag implies that the role works on all supported versions of fedora. Otherwise, use tags such as `fedora40` if the role only supports specific versions. In addition - for roles that have different variable files for EL9, create the corresponding EL10 files. Change find_unused_disk.py so that it will never return a nvme disk unless it is specifically asked for that type of disk. The issue was that every test was using an nvme disk. Signed-off-by: Rich Megginson <[email protected]>
linux-system-roles · Jul 2, 2024 · 0b60805 · 0b60805
1 parent bb51979
commit 0b60805
Show file tree

Hide file tree

Showing 21 changed files with 203 additions and 73 deletions.
diff --git a/.ostree/packages-runtime-CentOS-10.txt b/.ostree/packages-runtime-CentOS-10.txt
@@ -0,0 +1 @@
+python3-blivet
diff --git a/.ostree/packages-runtime-RedHat-10.txt b/.ostree/packages-runtime-RedHat-10.txt
@@ -0,0 +1 @@
+python3-blivet
diff --git a/.ostree/packages-testing-CentOS-10.txt b/.ostree/packages-testing-CentOS-10.txt
@@ -0,0 +1 @@
+util-linux-core
diff --git a/.ostree/packages-testing-RedHat-10.txt b/.ostree/packages-testing-RedHat-10.txt
@@ -0,0 +1 @@
+util-linux-core
diff --git a/library/find_unused_disk.py b/library/find_unused_disk.py
@@ -132,29 +132,33 @@ def get_sys_name(disk_path):
     return os.path.normpath(node_dir + '/' + os.readlink(disk_path))
 
 
-def get_partitions(disk_path):
+def get_partitions(disk_path, info):
     sys_name = get_sys_name(disk_path)
     partitions = list()
     for filename in os.listdir(SYS_CLASS_BLOCK + sys_name):
         if re.match(sys_name + r'p?\d+$', filename):
+            info.append("filename [%s] is a partition" % filename)
             partitions.append(filename)
 
     return partitions
 
 
-def get_disks(module):
+def get_disks(module, info):
     buf = module.run_command(["lsblk", "-p", "--pairs", "--bytes", "-o", "NAME,TYPE,SIZE,FSTYPE,LOG-SEC"])[1]
     disks = dict()
     for line in buf.splitlines():
+        info.append("Line: %s" % line)
         if not line:
             continue
 
         m = re.search(r'NAME="(?P<path>[^"]*)" TYPE="(?P<type>[^"]*)" SIZE="(?P<size>\d+)" FSTYPE="(?P<fstype>[^"]*)" LOG[_-]SEC="(?P<ssize>\d+)"', line)
         if m is None:
             module.log("Line did not match: " + line)
+            info.append("Line did not match: %s" % line)
             continue
 
         if m.group('type') != "disk":
+            info.append("Line type [%s] is not disk: %s" % (m.group('type'), line))
             continue
 
         disks[m.group('path')] = {"type": m.group('type'), "size": m.group('size'),
@@ -165,38 +169,49 @@ def get_disks(module):
 
 def filter_disks(module):
     disks = {}
+    info = []
     max_size = Size(module.params['max_size'])
 
-    for path, attrs in get_disks(module).items():
+    for path, attrs in get_disks(module, info).items():
         if is_ignored(path):
+            info.append('Disk [%s] attrs [%s] is ignored' % (path, attrs))
             continue
 
         interface = module.params['with_interface']
 
-        if interface is not None and not is_device_interface(module, path, interface):
+        # do not use nvme unless explicitly asked to
+        if interface is not None and not is_device_interface(module, path, interface) or \
+           interface is None and is_device_interface(module, path, 'nvme'):
+            info.append('Disk [%s] attrs [%s] is not an interface [%s]' % (path, attrs, interface))
             continue
 
         if attrs["fstype"]:
+            info.append('Disk [%s] attrs [%s] has fstype' % (path, attrs))
             continue
 
         if Size(attrs["size"]).bytes < Size(module.params['min_size']).bytes:
+            info.append('Disk [%s] attrs [%s] size is less than requested' % (path, attrs))
             continue
 
         if max_size.bytes > 0 and Size(attrs["size"]).bytes > max_size.bytes:
+            info.append('Disk [%s] attrs [%s] size is greater than requested' % (path, attrs))
             continue
 
-        if get_partitions(path):
+        if get_partitions(path, info):
+            info.append('Disk [%s] attrs [%s] has partitions' % (path, attrs))
             continue
 
         if not no_holders(get_sys_name(path)):
+            info.append('Disk [%s] attrs [%s] has holders' % (path, attrs))
             continue
 
         if not can_open(path):
+            info.append('Disk [%s] attrs [%s] cannot be opened exclusively' % (path, attrs))
             continue
 
         disks[path] = attrs
 
-    return disks
+    return disks, info
 
 
 def run_module():
@@ -211,15 +226,16 @@ def run_module():
 
     result = dict(
         changed=False,
-        disks=[]
+        disks=[],
+        info=[],
     )
 
     module = AnsibleModule(
         argument_spec=module_args,
         supports_check_mode=True
     )
 
-    disks = filter_disks(module)
+    disks, info = filter_disks(module)
 
     if module.params['match_sector_size']:
         # pick the most disks with the same sector size
@@ -238,6 +254,7 @@ def run_module():
     else:
         result['disks'] = sorted(disks)[:int(module.params['max_return'])]
 
+    result['info'] = info
     module.exit_json(**result)
 
 

diff --git a/meta/main.yml b/meta/main.yml
@@ -2,8 +2,6 @@
 galaxy_info:
   author: David Lehman <[email protected]>
   description: Configure volumes and filesystems
-  galaxy_tags: ['system', 'lvm', 'storage', 'redhat',
-                'rhel', 'fedora', 'centos']
   company: Red Hat, Inc.
   license: MIT
   min_ansible_version: "2.9"
@@ -16,3 +14,15 @@ galaxy_info:
         - "7"
         - "8"
         - "9"
+  galaxy_tags:
+    - centos
+    - el7
+    - el8
+    - el9
+    - el10
+    - fedora
+    - lvm
+    - redhat
+    - rhel
+    - storage
+    - system
diff --git a/tests/test-verify-pool-members.yml b/tests/test-verify-pool-members.yml
@@ -85,9 +85,9 @@
   loop_control:
     loop_var: st_pool_pv
   when:
-  - grow_supported.stdout | trim == 'True'
-  - storage_test_pool.type == "lvm"
-  - storage_test_pool.grow_to_fill | bool
+    - grow_supported.stdout | trim == 'True'
+    - storage_test_pool.type == "lvm"
+    - storage_test_pool.grow_to_fill | bool
 
 - name: Check MD RAID
   include_tasks: verify-pool-md.yml

diff --git a/tests/test-verify-volume-fs.yml b/tests/test-verify-volume-fs.yml
@@ -3,29 +3,29 @@
 - name: Check volume filesystem
   when: storage_test_volume.type != "stratis"
   block:
-  - name: Verify fs type
-    assert:
-      that: storage_test_blkinfo.info[storage_test_volume._device].fstype ==
-        storage_test_volume.fs_type or
-        (storage_test_blkinfo.info[storage_test_volume._device].fstype | length
-        == 0 and storage_test_volume.fs_type == "unformatted")
-    when:
-      - storage_test_volume.fs_type
-      - _storage_test_volume_present
+    - name: Verify fs type
+      assert:
+        that: storage_test_blkinfo.info[storage_test_volume._device].fstype ==
+          storage_test_volume.fs_type or
+          (storage_test_blkinfo.info[storage_test_volume._device].fstype | length
+          == 0 and storage_test_volume.fs_type == "unformatted")
+      when:
+        - storage_test_volume.fs_type
+        - _storage_test_volume_present
 
-  # label
-  - name: Verify fs label
-    assert:
-      that: storage_test_blkinfo.info[storage_test_volume._device].label ==
-        storage_test_volume.fs_label
-      msg: >-
-        Volume '{{ storage_test_volume.name }}' labels do not match when they
-        should
-        ('{{ storage_test_blkinfo.info[storage_test_volume._device].label }}',
-        '{{ storage_test_volume.fs_label }}')
-    when:
-      - _storage_test_volume_present | bool
-      # label for GFS2 is set manually with the extra `-t` fs_create_options
-      # so we can't verify it here because it was not set with fs_label so
-      # the label from blkinfo doesn't match the expected "empty" fs_label
-      - storage_test_volume.fs_type != "gfs2"
+    # label
+    - name: Verify fs label
+      assert:
+        that: storage_test_blkinfo.info[storage_test_volume._device].label ==
+          storage_test_volume.fs_label
+        msg: >-
+          Volume '{{ storage_test_volume.name }}' labels do not match when they
+          should
+          ('{{ storage_test_blkinfo.info[storage_test_volume._device].label }}',
+          '{{ storage_test_volume.fs_label }}')
+      when:
+        - _storage_test_volume_present | bool
+        # label for GFS2 is set manually with the extra `-t` fs_create_options
+        # so we can't verify it here because it was not set with fs_label so
+        # the label from blkinfo doesn't match the expected "empty" fs_label
+        - storage_test_volume.fs_type != "gfs2"
diff --git a/tests/tests_create_lvm_cache_then_remove.yml b/tests/tests_create_lvm_cache_then_remove.yml
@@ -41,14 +41,12 @@
 
     - name: Set distribution version
       set_fact:
-        is_rhel9: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'Enterprise Linux' or
-                    ansible_facts.distribution == 'RedHat') and
-                    ansible_facts.distribution_major_version == '9' }}"
-        is_rhel8: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'Enterprise Linux' or
-                    ansible_facts.distribution == 'RedHat') and
-                    ansible_facts.distribution_major_version == '8' }}"
+        is_rhel10: "{{ (ansible_facts['os_family'] == 'RedHat') and
+          ansible_facts.distribution_major_version == '10' }}"
+        is_rhel9: "{{ (ansible_facts['os_family'] == 'RedHat') and
+          ansible_facts.distribution_major_version == '9' }}"
+        is_rhel8: "{{ (ansible_facts['os_family'] == 'RedHat') and
+          ansible_facts.distribution_major_version == '8' }}"
         is_fedora: "{{ ansible_facts.distribution == 'Fedora' }}"
 
     - name: Get unused disks
@@ -94,7 +92,8 @@
     - name: Run test on supported platforms
       when: ((is_fedora and blivet_pkg_version is version("3.5.0-1", ">=")) or
              (is_rhel8 and blivet_pkg_version is version("3.4.0-10", ">=")) or
-             (is_rhel9 and blivet_pkg_version is version("3.4.0-14", ">=")))
+             (is_rhel9 and blivet_pkg_version is version("3.4.0-14", ">=")) or
+             is_rhel10)
       block:
         - name: Attach the cache to the 'test' LV created above
           include_role:

diff --git a/tests/tests_create_raid_pool_then_remove.yml b/tests/tests_create_raid_pool_then_remove.yml
@@ -44,12 +44,12 @@
 
     - name: Set distribution version
       set_fact:
-        is_rhel9: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'RedHat') and
-                    ansible_facts.distribution_major_version == '9' }}"
-        is_rhel8: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'RedHat') and
-                    ansible_facts.distribution_major_version == '8' }}"
+        is_rhel10: "{{ (ansible_facts['os_family'] == 'RedHat') and
+          ansible_facts.distribution_major_version == '10' }}"
+        is_rhel9: "{{ (ansible_facts['os_family'] == 'RedHat') and
+          ansible_facts.distribution_major_version == '9' }}"
+        is_rhel8: "{{ (ansible_facts['os_family'] == 'RedHat') and
+          ansible_facts.distribution_major_version == '8' }}"
         is_fedora: "{{ ansible_facts.distribution == 'Fedora' }}"
 
     - name: Get unused disks
@@ -247,7 +247,8 @@
     - name: Run test on supported platforms
       when: ((is_fedora and blivet_pkg_version is version("3.7.1-2", ">=")) or
              (is_rhel8 and blivet_pkg_version is version("3.6.0-5", ">=")) or
-             (is_rhel9 and blivet_pkg_version is version("3.6.0-6", ">=")))
+             (is_rhel9 and blivet_pkg_version is version("3.6.0-6", ">=")) or
+             is_rhel10)
       block:
         - name: Create a RAID0 lvm raid device with custom stripe size
           include_role:

diff --git a/tests/tests_lvm_pool_members.yml b/tests/tests_lvm_pool_members.yml
@@ -44,8 +44,11 @@
              ((is_fedora and blivet_pkg_version is version("3.4.3-1", ">=")) or
               (is_rhel7 and blivet_pkg_version is version("3.4.0-10", ">=")) or
               (is_rhel8 and blivet_pkg_version is version("3.4.0-10", ">=")) or
-              (is_rhel9 and blivet_pkg_version is version("3.4.0-14", ">="))))
+              (is_rhel9 and blivet_pkg_version is version("3.4.0-14", ">=")) or
+              is_rhel10))
       vars:
+        is_rhel10: "{{ ansible_facts['os_family'] == 'RedHat' and
+          ansible_facts['distribution_major_version'] == '10' }}"
         is_rhel9: "{{ ansible_facts['os_family'] == 'RedHat' and
           ansible_facts['distribution_major_version'] == '9' }}"
         is_rhel8: "{{ ansible_facts['os_family'] == 'RedHat' and

diff --git a/tests/tests_lvm_pool_pv_grow_nvme_generated.yml b/tests/tests_lvm_pool_pv_grow_nvme_generated.yml
@@ -0,0 +1,15 @@
+---
+# This file was generated by generate_tests.py
+- name: Run test tests_lvm_pool_pv_grow.yml for nvme
+  hosts: all
+  tags:
+    - tests::nvme
+  tasks:
+    - name: Set disk interface for test
+      set_fact:
+        storage_test_use_interface: "nvme"
+
+- name: Import playbook
+  import_playbook: tests_lvm_pool_pv_grow.yml
+  tags:
+    - tests::nvme
diff --git a/tests/tests_lvm_pool_pv_grow_scsi_generated.yml b/tests/tests_lvm_pool_pv_grow_scsi_generated.yml
@@ -0,0 +1,15 @@
+---
+# This file was generated by generate_tests.py
+- name: Run test tests_lvm_pool_pv_grow.yml for scsi
+  hosts: all
+  tags:
+    - tests::scsi
+  tasks:
+    - name: Set disk interface for test
+      set_fact:
+        storage_test_use_interface: "scsi"
+
+- name: Import playbook
+  import_playbook: tests_lvm_pool_pv_grow.yml
+  tags:
+    - tests::scsi
diff --git a/tests/tests_lvm_pool_shared.yml b/tests/tests_lvm_pool_shared.yml
@@ -61,13 +61,11 @@
 
         - name: Set distribution version
           set_fact:
-            is_rhel9: "{{ (ansible_facts.distribution == 'CentOS' or
-                        ansible_facts.distribution == 'Enterprise Linux' or
-                        ansible_facts.distribution == 'RedHat') and
+            is_rhel10: "{{ (ansible_facts['os_family'] == 'RedHat') and
+                        ansible_facts.distribution_major_version == '10' }}"
+            is_rhel9: "{{ (ansible_facts['os_family'] == 'RedHat') and
                         ansible_facts.distribution_major_version == '9' }}"
-            is_rhel8: "{{ (ansible_facts.distribution == 'CentOS' or
-                        ansible_facts.distribution == 'Enterprise Linux' or
-                        ansible_facts.distribution == 'RedHat') and
+            is_rhel8: "{{ (ansible_facts['os_family'] == 'RedHat') and
                         ansible_facts.distribution_major_version == '8' }}"
             is_fedora: "{{ ansible_facts.distribution == 'Fedora' }}"
 
@@ -76,7 +74,8 @@
           when: ((is_fedora and blivet_pkg_version is version("3.8.2-1", "<"))
                  or (is_rhel8 and blivet_pkg_version is version("3.6.0-8", "<"))
                  or (is_rhel9 and
-                     blivet_pkg_version is version("3.6.0-11", "<")))
+                     blivet_pkg_version is version("3.6.0-11", "<"))
+                 or is_rhel10)
 
         - name: Create cluster
           ansible.builtin.include_role:

diff --git a/tests/tests_resize.yml b/tests/tests_resize.yml
@@ -333,11 +333,11 @@
 
     - name: Set distribution version
       set_fact:
-        is_rhel9: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'RedHat') and
+        is_rhel10: "{{ (ansible_facts['os_family'] == 'RedHat') and
+                    ansible_facts.distribution_major_version == '10' }}"
+        is_rhel9: "{{ (ansible_facts['os_family'] == 'RedHat') and
                     ansible_facts.distribution_major_version == '9' }}"
-        is_rhel8: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'RedHat') and
+        is_rhel8: "{{ (ansible_facts['os_family'] == 'RedHat') and
                     ansible_facts.distribution_major_version == '8' }}"
         is_fedora: "{{ ansible_facts.distribution == 'Fedora' }}"
 
@@ -346,7 +346,8 @@
     - name: Run test on supported platforms
       when: ((is_fedora and blivet_pkg_version is version("3.7.1-3", ">=")) or
              (is_rhel8 and blivet_pkg_version is version("3.6.0-6", ">=")) or
-             (is_rhel9 and blivet_pkg_version is version("3.6.0-8", ">=")))
+             (is_rhel9 and blivet_pkg_version is version("3.6.0-8", ">=")) or
+             is_rhel10)
       block:
         - name: >-
             Create one LVM logical volume under one volume group with size

diff --git a/tests/tests_stratis.yml b/tests/tests_stratis.yml
@@ -40,14 +40,11 @@
 
     - name: Set distribution version
       set_fact:
-        is_rhel7: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'RedHat') and
+        is_rhel7: "{{ (ansible_facts['os_family'] == 'RedHat') and
                     ansible_facts.distribution_major_version == '7' }}"
-        is_rhel9: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'RedHat') and
+        is_rhel9: "{{ (ansible_facts['os_family'] == 'RedHat') and
                     ansible_facts.distribution_major_version == '9' }}"
-        is_rhel10: "{{ (ansible_facts.distribution == 'CentOS' or
-                    ansible_facts.distribution == 'RedHat') and
+        is_rhel10: "{{ (ansible_facts['os_family'] == 'RedHat') and
                     ansible_facts.distribution_major_version == '10' }}"
         is_fedora: "{{ ansible_facts.distribution == 'Fedora' }}"