sts-libs 2.2.0__tar.gz → 2.3.0__tar.gz

{sts_libs-2.2.0 → sts_libs-2.3.0}/.packit.yaml

@@ -17,6 +17,10 @@ jobs:
   # Build pull requests
   - job: copr_build
     trigger: pull_request
+    require:
+      label:
+        present:
+          - packit-test
     targets:
       - fedora-latest-stable
       - epel-10
@@ -38,6 +42,10 @@ jobs:
   # Run tests on pull requests
   - job: tests
     trigger: pull_request
+    require:
+      label:
+        present:
+          - packit-test
     targets:
       - fedora-latest-stable
       - epel-10

{sts_libs-2.2.0 → sts_libs-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sts-libs
-Version: 2.2.0
+Version: 2.3.0
 Summary: Library for pytest-based Linux storage tests
 Project-URL: Repository, https://gitlab.com/rh-kernel-stqe/sts/
 Author-email: Martin Hoyer <mhoyer@redhat.com>, Filip Suba <fsuba@redhat.com>, Zhaojuan Guo <zguo@redhat.com>, Bruno Goncalves <bgoncalv@redhat.com>, Jakub Krysl <jkrysl@redhat.com>

{sts_libs-2.2.0 → sts_libs-2.3.0}/README.md

@@ -66,6 +66,7 @@ sts/
 │   ├── src/sts/           # Library source code
 │   │   ├── models.py      # Pydantic base models (StsBaseModel, ReportModel)
 │   │   ├── base.py        # Base device classes
+│   │   ├── marks.py       # Pytest skip/xfail helpers
 │   │   ├── fixtures/      # Pytest fixtures
 │   │   ├── utils/         # Utility modules
 │   │   └── lvm/, dm/, …   # Per-subsystem libraries

{sts_libs-2.2.0 → sts_libs-2.3.0}/docs/contributing/writing-tests.md

@@ -101,10 +101,9 @@ description: |
 framework: shell
 test: pytest ./example-test.py
 component:
-  - kernel
-tag:
-  - my-example
-  - storage
+  - kernel \ Storage \ Device Mapper
+tag+:
+  - local
 tier: 1
 duration: 10m
 check:
@@ -114,6 +113,14 @@ check:
   - how: coredump
 ```
 
+**FMF tag conventions:**
+
+- Use `component` with Bugzilla-style names (e.g. `kernel \ Storage \ Device Mapper`).
+- Common tags are inherited via parent `main.fmf` files — use `tag+:` to **add** tags
+    instead of `tag:` which replaces.
+- Tests included in CI are selected by the `plans/sts-ci/ci.fmf` plan filters
+    (tier and tag exclusions), not by a special tag.
+
 ### 3. Create a tmt Test Plan
 
 Create a plan file (e.g., `example-plan.fmf`) under `plans/` that selects
@@ -124,7 +131,7 @@ summary: My storage test plan
 discover:
   - how: fmf
     filter:
-      - tag:my-example
+      - tag:local
 provision:
   how: virtual
   image: fedora
@@ -154,6 +161,54 @@ provision:
     memory: '>= 4 GB'
 ```
 
+## Skipping and Gating Tests
+
+Use `sts.marks` helpers to skip or xfail tests based on distribution, version, or
+installed packages. These keep skip conditions consistent across the test suite.
+
+### In fixtures (imperative)
+
+```python
+from sts.marks import requires_rhel
+
+
+def my_fixture():
+    requires_rhel(9)  # skips if on RHEL < 9
+    ...
+```
+
+### As decorators or pytestmark (declarative)
+
+```python
+from sts.marks import is_rhel_below, requires_package
+from sts.utils.version import VersionInfo
+
+# Skip an entire module on old RHEL
+pytestmark = pytest.mark.skipif(is_rhel_below(9), reason='requires RHEL 9+')
+
+
+# Skip if a package is too old
+@requires_package('stratisd', VersionInfo(3, 7, 0))
+def test_stratis_feature(): ...
+```
+
+See the [sts.marks API reference](../sts-libs/utils.md#test-marks) for all available helpers.
+
+## Selecting Tests with FMF Markers
+
+The `sts.utils.fmf_markers` pytest plugin reads `main.fmf` metadata and applies
+tags and tiers as pytest markers. This lets you select tests with `-m` the same
+way tmt plan filters do:
+
+```bash
+pytest tests/ -m ci              # same tests as the sts-ci plan
+pytest tests/ -m tier1           # all tier-1 tests
+pytest tests/ -m "dm and tier1"  # tier-1 device-mapper tests
+pytest tests/ -m "not hw_fc"    # exclude FC-hardware tests
+```
+
+The plugin requires the `fmf` library and silently does nothing if it's not installed.
+
 ## Running Tests Locally
 
 ### Using tmt (Recommended)

{sts_libs-2.2.0 → sts_libs-2.3.0}/docs/sts-libs/fixtures.md

@@ -80,6 +80,10 @@ Provided by [Common Fixtures](#common) — see `loop_devices`.
 
 ::: sts.fixtures.service_fixtures
 
+### UDisks2
+
+::: sts.fixtures.udisks2_fixtures
+
 ### Kernel Module Management
 
 ::: sts.fixtures.module_fixtures

{sts_libs-2.2.0 → sts_libs-2.3.0}/docs/sts-libs/utils.md

@@ -46,6 +46,10 @@ Helper modules used across sts-libs.
 
 ::: sts.utils.string_extras
 
+## Test Marks
+
+::: sts.marks
+
 ## Version Handling
 
 ::: sts.utils.version
@@ -62,6 +66,18 @@ Helper modules used across sts-libs.
 
 ::: sts.utils.errors
 
-## tmt Integration
+## FMF Markers Plugin
+
+::: sts.utils.fmf_markers
+
+## tmt Pytest Integration
+
+::: sts.utils.tmt_pytest
+
+## Test State Persistence
+
+::: sts.utils.teststate
+
+## CLI Tool Base
 
-::: sts.utils.tmt
+::: sts.utils.cli

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/boom/tier2.fmf

@@ -14,19 +14,23 @@ provision:
   kickstart:
     pre-install: |
       %pre --log=/dev/console
-      # Wipe leftover LVM and signatures from all disks so the
+      # Minimum disk size (10 GB) filters out virtual block devices
+      # like zram and loop that lsblk reports as type "disk".
+      MIN=10737418240
+
+      # Wipe leftover LVM and signatures from all real disks so the
       # installer does not see VGs spanning multiple disks.
       vgchange -an 2>/dev/null || true
       for vg in $(vgs --noheadings -o vg_name 2>/dev/null | tr -d ' '); do
           vgremove -y -ff "$vg" 2>/dev/null || true
       done
-      for disk in $(lsblk -dno NAME,TYPE | awk '$2=="disk"{print $1}'); do
+      for disk in $(lsblk -dnbo NAME,TYPE,SIZE | awk -v m=$MIN '$2=="disk" && $3+0>=m {print $1}'); do
           pvremove -y -ff "/dev/$disk" 2>/dev/null || true
           wipefs -af "/dev/$disk" 2>/dev/null || true
       done
 
-      # Select the first disk for installation, leave the rest free
-      TARGET_DISK=$(lsblk -dno NAME,TYPE | awk '$2=="disk"{print $1; exit}')
+      # Select the first real disk for installation, leave the rest free
+      TARGET_DISK=$(lsblk -dnbo NAME,TYPE,SIZE | awk -v m=$MIN '$2=="disk" && $3+0>=m {print $1; exit}')
       echo "ignoredisk --only-use=${TARGET_DISK}" > /tmp/ks-disk.cfg
       echo "Selected install disk: ${TARGET_DISK}"
       %end

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/device-mapper/tier1.fmf

@@ -5,7 +5,7 @@ description: |
 discover:
   how: fmf
   filter:
-    - component:dm
+    - tag:dm
     - tier:1
 provision:
   how: artemis

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/dmpd/tier1.fmf

@@ -2,7 +2,7 @@ summary: Tier 1 DMPD tests
 discover:
   how: fmf
   filter:
-    - component:dmpd
+    - tag:dmpd
 provision:
   how: artemis
   hardware:

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/image_mode/device-mapper.fmf

@@ -2,5 +2,5 @@ summary: Image mode with Tier 1 Device Mapper tests
 discover+:
   - how: fmf
     filter:
-      - component:dm
+      - tag:dm
       - tier:1

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/image_mode/dmpd.fmf

@@ -2,4 +2,4 @@ summary: Image Mode Tier 1 DMPD tests
 discover+:
   - how: fmf
     filter:
-      - component:dmpd
+      - tag:dmpd

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/image_mode/lvm.fmf

@@ -2,5 +2,5 @@ summary: Image Mode Tier 1 LVM tests
 discover+:
   - how: fmf
     filter:
-      - component:lvm
+      - tag:lvm
       - tier:1

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/image_mode/multipath.fmf

@@ -2,5 +2,5 @@ summary: Image mode multipath tier 1 tests
 discover+:
   - how: fmf
     filter:
-      - component:multipath
+      - tag:multipath
       - tier:1

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/image_mode/stratis.fmf

@@ -4,5 +4,5 @@ environment+:
 discover+:
   - how: fmf
     filter:
-      - component:stratis
+      - tag:stratis
       - tier:1

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/image_mode/udisks2.fmf

@@ -1,8 +1,8 @@
-summary: Image Mode Tier 1 UDisks2 tests
+summary: Image Mode UDisks2 tests (tier 1 and tier 2)
 environment+:
   CONTAINERFILE: Containerfile.udisks2
 discover+:
   - how: fmf
     filter:
       - component:udisks2
-      - tier:1
+      - tier:1 | tier:2

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/iscsi/offload/main.fmf

@@ -1,6 +1,6 @@
 discover:
   how: fmf
-  filter: tag:iscsi-offload
+  filter: tag:hw-iscsi
 provision:
   how: beaker
   image: 'RHEL-9%'  # default

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/lio/core.fmf

@@ -4,5 +4,4 @@ discover:
   how: fmf
   filter:
     - component:targetcli
-    - tag:local
     - tier:0,1

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/lvm/tier1.fmf

@@ -2,7 +2,7 @@ summary: Tier 1 LVM tests
 discover:
   how: fmf
   filter:
-    - component:lvm
+    - tag:lvm
     - tier:1
 provision:
   how: artemis

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/main.fmf

@@ -15,7 +15,8 @@ adjust:
         test:
           - /tests/bootc_additional_packages
         order: 1
-  - when: distro < rhel-10
+  # RHEL 9.2 doesn't have python3.12-pip
+  - when: distro < rhel-10 and distro != rhel-9.2
     prepare:
       - how: install
         package:

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/multipath/tier1.fmf

@@ -2,7 +2,7 @@ summary: Image mode multipath tier 1 tests
 discover+:
   - how: fmf
     filter:
-      - component:multipath
+      - tag:multipath
       - tier:1
 provision:
   how: artemis

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/snapm/tier2.fmf

@@ -14,19 +14,23 @@ provision:
   kickstart:
     pre-install: |
       %pre --log=/dev/console
-      # Wipe leftover LVM and signatures from all disks so the
+      # Minimum disk size (10 GB) filters out virtual block devices
+      # like zram and loop that lsblk reports as type "disk".
+      MIN=10737418240
+
+      # Wipe leftover LVM and signatures from all real disks so the
       # installer does not see VGs spanning multiple disks.
       vgchange -an 2>/dev/null || true
       for vg in $(vgs --noheadings -o vg_name 2>/dev/null | tr -d ' '); do
           vgremove -y -ff "$vg" 2>/dev/null || true
       done
-      for disk in $(lsblk -dno NAME,TYPE | awk '$2=="disk"{print $1}'); do
+      for disk in $(lsblk -dnbo NAME,TYPE,SIZE | awk -v m=$MIN '$2=="disk" && $3+0>=m {print $1}'); do
           pvremove -y -ff "/dev/$disk" 2>/dev/null || true
           wipefs -af "/dev/$disk" 2>/dev/null || true
       done
 
-      # Select the first disk for installation, leave the rest free
-      TARGET_DISK=$(lsblk -dno NAME,TYPE | awk '$2=="disk"{print $1; exit}')
+      # Select the first real disk for installation, leave the rest free
+      TARGET_DISK=$(lsblk -dnbo NAME,TYPE,SIZE | awk -v m=$MIN '$2=="disk" && $3+0>=m {print $1; exit}')
       echo "ignoredisk --only-use=${TARGET_DISK}" > /tmp/ks-disk.cfg
       echo "Selected install disk: ${TARGET_DISK}"
       %end

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/stratis/tier1.fmf

@@ -2,7 +2,7 @@ summary: Tier 1 Stratis tests
 discover:
   how: fmf
   filter:
-    - component:stratis
+    - tag:stratis
     - tier:1
 provision:
     how: artemis

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/stratis/tier2-linear.fmf

@@ -2,10 +2,12 @@ summary: Stratis tests on linear LV backing devices
 discover:
   how: fmf
   filter:
-    - component:stratis
+    - tag:stratis
     - tier:1 | tier:2
     - tag:-lvm-stacking
     - tag:-stratis_upgrade
+    - tag:-multihost
+    - tag:-reboot
 environment:
   STRATIS_DEVICE_TYPE: linear
 provision:

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/stratis/tier2-mdraid1.fmf

@@ -2,9 +2,11 @@ summary: Stratis tests on mdadm RAID1 backing devices
 discover:
   how: fmf
   filter:
-    - component:stratis
+    - tag:stratis
     - tier:1 | tier:2
     - tag:-stratis_upgrade
+    - tag:-multihost
+    - tag:-reboot
 environment:
   STRATIS_DEVICE_TYPE: mdraid1
 provision:

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/stratis/tier2-raid1.fmf

@@ -2,10 +2,12 @@ summary: Stratis tests on RAID1 LV backing devices
 discover:
   how: fmf
   filter:
-    - component:stratis
+    - tag:stratis
     - tier:1 | tier:2
     - tag:-lvm-stacking
     - tag:-stratis_upgrade
+    - tag:-multihost
+    - tag:-reboot
 environment:
   STRATIS_DEVICE_TYPE: raid1
 provision:

sts_libs-2.3.0/plans/sts-ci/ci.fmf

@@ -0,0 +1,15 @@
+summary: CI-safe tests — no special hardware, no reboot, tier 1
+discover:
+  - how: fmf
+    filter:
+      - "tag: -no-ci"
+      - "tag: -hw-fc"
+      - "tag: -hw-rdma"
+      - "tag: -hw-iscsi"
+      - "tag: -hw-nvme"
+      - "tag: -multihost"
+      - "tag: -reboot"
+      - "tag: -bootc"
+      - "tag: -hw-memory"
+      - "tag: -hw-disk"
+      - "tier: 1"

sts_libs-2.3.0/plans/udisks2/tier1.fmf

@@ -0,0 +1,12 @@
+summary: Tier 1 UDisks2 core D-Bus interface tests
+discover:
+  how: fmf
+  filter:
+    - component:udisks2
+    - tier:1
+provision:
+  how: artemis
+  hardware:
+    disk:
+      - size: '>= 10 GB'
+    memory: '>= 2 GB'

sts_libs-2.3.0/plans/udisks2/tier2.fmf

@@ -0,0 +1,12 @@
+summary: Tier 2 UDisks2 sanity and regression tests
+discover:
+  how: fmf
+  filter:
+    - component:udisks2
+    - tier:2
+provision:
+  how: artemis
+  hardware:
+    disk:
+      - size: '>= 10 GB'
+    memory: '>= 2 GB'

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/udisks2/tier3.fmf

@@ -9,9 +9,10 @@ discover:
     - component:udisks2
     - tier:3
 provision:
-  how: beaker
+  how: artemis
   hardware:
+    device:
+      driver: ahci
     disk:
-      - driver: ahci
-        size: '>= 10 GB'
+      - size: '>= 10 GB'
     memory: '>= 4 GB'

{sts_libs-2.2.0 → sts_libs-2.3.0}/plans/vdo/tier2-high-memory.fmf

@@ -4,7 +4,7 @@ discover:
   filter:
     - component:vdo
     - tier:2
-    - tag:high_memory
+    - tag:hw-memory
 provision:
   how: artemis
   hardware:

{sts_libs-2.2.0 → sts_libs-2.3.0}/pyproject.toml

@@ -7,7 +7,7 @@ name = 'sts-libs'
 description = 'Library for pytest-based Linux storage tests'
 readme = 'sts_libs/README.md'
 requires-python = '>=3.12'
-version = "2.2.0"
+version = "2.3.0"
 authors = [
   {name = 'Martin Hoyer', email = 'mhoyer@redhat.com'},
   {name = 'Filip Suba', email = 'fsuba@redhat.com'},
@@ -50,6 +50,7 @@ dev = [
   "pytest-mock",
   "pytest-cov",
   "typing-extensions",
+  "fmf>=1.7.0",
 ]
 docs = [
   'griffe-pydantic',
@@ -156,6 +157,7 @@ ignore = [
 # Per-file configuration for ignoring rules.
 [tool.ruff.lint.per-file-ignores]
 'tests/*' = ['INP001', 'D', 'PLR6301', 'S', 'C90']
+'tests/lsm/*' = ['E402']
 'sts_libs/tests/*' = ['ARG', 'ANN', 'SLF001', 'FBT', 'E501', 'PLR6301', 'PLC0415', 'S', 'C90', 'D']
 '.scripts/*' = ['INP001', 'S6']
 

{sts_libs-2.2.0 → sts_libs-2.3.0}/sts_libs/src/sts/blockdevice.py

@@ -104,8 +104,11 @@ def get_free_disks() -> list[BlockDevice]:
     is not mounted, is not read-only, and is at least 1 GB.
     """
     free_devices: list[BlockDevice] = []
-    # Get list of LVM PVs to exclude
-    pvs = {str(pv.path) for pv in PhysicalVolume.get_all()}
+    # Get list of LVM PVs to exclude (pvs may not be installed, e.g. guests without lvm2)
+    try:
+        pvs = {str(pv.path) for pv in PhysicalVolume.get_all()}
+    except FileNotFoundError:
+        pvs: set[str] = set()
 
     for data in _load_all_devices():
         # Skip if device has parent (is partition) or children (has partitions)