sts-libs 2.4.2__tar.gz → 2.5.0__tar.gz

{sts_libs-2.4.2 → sts_libs-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sts-libs
-Version: 2.4.2
+Version: 2.5.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.4.2 → sts_libs-2.5.0}/plans/iscsi/offload/bnx2i.fmf

@@ -5,6 +5,6 @@ provision+:
   hardware:
     hostname: storageqe-83.lab.eng.brq2.redhat.com
 adjust+:
-    enabled: false
+  - enabled: false
     when: distro >= rhel-9.5
     because: bnx2 drivers are deprecated in rhel-9.5, and no longer maintained in RHEL-10

{sts_libs-2.4.2 → sts_libs-2.5.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.4.2"
+version = "2.5.0"
 authors = [
   {name = 'Martin Hoyer', email = 'mhoyer@redhat.com'},
   {name = 'Filip Suba', email = 'fsuba@redhat.com'},

{sts_libs-2.4.2 → sts_libs-2.5.0}/sts_libs/src/sts/fixtures/iscsi_fixtures.py

@@ -151,12 +151,13 @@ def iscsi_target(request: pytest.FixtureRequest, iscsi_localhost_test: None) ->
             IscsiLUN(target_wwn=target_iqn).create_lun(storage_object=backstore.path)
             backstores.append((backstore_name, backing_file))
 
-    node = setup_and_login(
-        portal='127.0.0.1:3260',
-        initiator_iqn=initiator_iqn,
-        target_iqn=target_iqn,
-    )
+    node: IscsiNode | None = None
     try:
+        node = setup_and_login(
+            portal='127.0.0.1:3260',
+            initiator_iqn=initiator_iqn,
+            target_iqn=target_iqn,
+        )
         assert wait_for(
             lambda: _target_devices_ready(target_iqn, n_luns),
             timeout=ISCSI_DEVICE_SETTLE_TIMEOUT,
@@ -164,7 +165,8 @@ def iscsi_target(request: pytest.FixtureRequest, iscsi_localhost_test: None) ->
         ), f'Timed out waiting for {n_luns} usable device(s) from iSCSI target {target_iqn}'
         yield node
     finally:
-        node.logout()
+        if node is not None:
+            node.logout()
         Iscsi(target_wwn=target_iqn).delete_target()
         for backstore_name, backing_file in reversed(backstores):
             result = BackstoreFileio(name=backstore_name).delete_backstore()

{sts_libs-2.4.2 → sts_libs-2.5.0}/sts_libs/src/sts/iscsi/__init__.py

@@ -12,6 +12,7 @@ import logging
 from typing import TYPE_CHECKING
 
 from sts.iscsi.config import ISCSID_SERVICE_NAME, IscsiInterface, set_initiatorname
+from sts.iscsi.errors import IscsiError
 from sts.iscsi.iscsiadm import IscsiAdm
 from sts.iscsi.node import IscsiNode
 from sts.utils.system import SystemManager
@@ -42,8 +43,7 @@ def setup_and_login(
 ) -> IscsiNode:
     """Set initiator name, discover target (if needed), and log in."""
     if not set_initiatorname(initiator_iqn):
-        logger.error('Failed to set initiator name')
-        return IscsiNode(target_iqn='', portal=portal, iface=iface)
+        raise IscsiError(f'Failed to set initiator name {initiator_iqn}')
 
     iscsiadm = IscsiAdm()
     node = IscsiNode(

{sts_libs-2.4.2 → sts_libs-2.5.0}/sts_libs/src/sts/iscsi/config.py

@@ -46,10 +46,17 @@ def wait_for_iscsid() -> bool:
 
 
 def set_initiatorname(name: str) -> bool:
-    """Write initiator name to /etc/iscsi/initiatorname.iscsi and restart iscsid."""
+    """Configure the initiator name and ensure iscsid is running with it."""
     system = SystemManager()
+    path = Path('/etc/iscsi/initiatorname.iscsi')
+    content = f'InitiatorName={name}\n'
     try:
-        Path('/etc/iscsi/initiatorname.iscsi').write_text(f'InitiatorName={name}\n')
+        is_current = path.exists() and path.read_text() == content
+        if is_current and system.is_service_running(ISCSID_SERVICE_NAME) and wait_for_iscsid():
+            return True
+
+        if not is_current:
+            path.write_text(content)
         if not system.service_restart(ISCSID_SERVICE_NAME):
             logger.error('Failed to restart iscsid')
             return False

sts_libs-2.5.0/sts_libs/src/sts/iscsi/errors.py

@@ -0,0 +1,12 @@
+# Copyright: Contributors to the sts project
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+"""iSCSI-related errors."""
+
+from __future__ import annotations
+
+from sts.utils.errors import STSError
+
+
+class IscsiError(STSError):
+    """Base class for iSCSI-related errors."""

{sts_libs-2.4.2 → sts_libs-2.5.0}/sts_libs/tests/fixtures/test_iscsi_fixtures.py

@@ -11,6 +11,7 @@ from unittest.mock import MagicMock
 import pytest
 
 from sts.fixtures import iscsi_fixtures
+from sts.iscsi.errors import IscsiError
 from sts.iscsi.session import SessionDisk
 
 
@@ -67,3 +68,28 @@ def test_find_test_devices_rejects_target_without_running_disks(monkeypatch: pyt
 
     with pytest.raises(AssertionError, match='No running devices found'):
         iscsi_fixtures._find_test_devices(target_iqn='iqn.test:target')
+
+
+def test_iscsi_target_cleans_up_when_login_setup_fails(monkeypatch: pytest.MonkeyPatch) -> None:
+    request = MagicMock()
+    request.node.name = 'test_case[7-iscsi_target0]'
+    request.param = {'size': '1G', 'n_luns': 1}
+    monkeypatch.setattr(iscsi_fixtures, 'create_basic_iscsi_target', MagicMock(return_value=True))
+    monkeypatch.setattr(
+        iscsi_fixtures,
+        'setup_and_login',
+        MagicMock(side_effect=IscsiError('Failed to set initiator name')),
+    )
+    target = MagicMock()
+    iscsi = MagicMock(return_value=target)
+    monkeypatch.setattr(iscsi_fixtures, 'Iscsi', iscsi)
+    backstore = MagicMock()
+    backstore.delete_backstore.return_value.succeeded = True
+    monkeypatch.setattr(iscsi_fixtures, 'BackstoreFileio', MagicMock(return_value=backstore))
+
+    fixture = iscsi_fixtures.iscsi_target.__wrapped__(request, None)  # pyright: ignore[reportAttributeAccessIssue]
+    with pytest.raises(IscsiError, match='Failed to set initiator name'):
+        next(fixture)
+
+    target.delete_target.assert_called_once_with()
+    backstore.delete_backstore.assert_called_once_with()

{sts_libs-2.4.2 → sts_libs-2.5.0}/sts_libs/tests/iscsi/test_config.py

@@ -19,12 +19,14 @@ import pytest
 from sts.iscsi import _setup_single_interface, create_iscsi_iface, setup_and_login
 from sts.iscsi import setup as iscsi_setup
 from sts.iscsi.config import (
+    ISCSID_SERVICE_NAME,
     IscsiConfig,
     IscsidConfig,
     IscsiInterface,
     rand_iscsi_string,
     set_initiatorname,
 )
+from sts.iscsi.errors import IscsiError
 from sts.iscsi.iscsiadm import IscsiAdm
 from sts.iscsi.node import IscsiNode
 from sts.utils.system import SystemManager
@@ -69,6 +71,7 @@ def test_set_initiatorname(tmp_path: Path) -> None:
         patch('sts.iscsi.config.wait_for_iscsid', return_value=True),
     ):
         mock_path.return_value = config_file
+        mock_system.return_value.is_service_running.return_value = False
         mock_system.return_value.service_restart.return_value = True
         assert set_initiatorname('iqn.2003-01.org.linux-iscsi:initiator1')
         assert config_file.read_text() == 'InitiatorName=iqn.2003-01.org.linux-iscsi:initiator1\n'
@@ -83,6 +86,41 @@ def test_set_initiatorname(tmp_path: Path) -> None:
         assert not set_initiatorname('iqn.2003-01.org.linux-iscsi:initiator1')
 
 
+def test_set_initiatorname_skips_restart_when_unchanged(tmp_path: Path) -> None:
+    """An active iscsid does not need restarting for an unchanged initiator name."""
+    config_file = tmp_path / 'initiatorname.iscsi'
+    config_file.write_text('InitiatorName=iqn.test\n')
+    with (
+        patch('sts.iscsi.config.Path', return_value=config_file),
+        patch('sts.iscsi.config.SystemManager') as mock_system,
+        patch('sts.iscsi.config.wait_for_iscsid', return_value=True) as mock_wait,
+    ):
+        mock_system.return_value.is_service_running.return_value = True
+
+        assert set_initiatorname('iqn.test')
+
+    mock_system.return_value.service_restart.assert_not_called()
+    mock_wait.assert_called_once_with()
+
+
+def test_set_initiatorname_restarts_when_current_iscsid_is_unresponsive(tmp_path: Path) -> None:
+    """An unresponsive iscsid is restarted even when the initiator name is unchanged."""
+    config_file = tmp_path / 'initiatorname.iscsi'
+    config_file.write_text('InitiatorName=iqn.test\n')
+    with (
+        patch('sts.iscsi.config.Path', return_value=config_file),
+        patch('sts.iscsi.config.SystemManager') as mock_system,
+        patch('sts.iscsi.config.wait_for_iscsid', side_effect=[False, True]) as mock_wait,
+    ):
+        mock_system.return_value.is_service_running.return_value = True
+        mock_system.return_value.service_restart.return_value = True
+
+        assert set_initiatorname('iqn.test')
+
+    mock_system.return_value.service_restart.assert_called_once_with(ISCSID_SERVICE_NAME)
+    assert mock_wait.call_count == 2
+
+
 def test_set_initiatorname_returns_false_when_iscsid_unresponsive(tmp_path: Path) -> None:
     """set_initiatorname should return False when wait_for_iscsid fails (I8)."""
     ini_file = tmp_path / 'initiatorname.iscsi'
@@ -92,24 +130,23 @@ def test_set_initiatorname_returns_false_when_iscsid_unresponsive(tmp_path: Path
         patch('sts.iscsi.config.wait_for_iscsid', return_value=False),
     ):
         mock_path.return_value = ini_file
+        mock_system.return_value.is_service_running.return_value = False
         mock_system.return_value.service_restart.return_value = True
 
         result = set_initiatorname('iqn.test')
     assert result is False
 
 
-def test_setup_and_login_returns_early_on_initiatorname_failure() -> None:
-    """setup_and_login should not proceed to discovery when set_initiatorname fails (C3)."""
+def test_setup_and_login_raises_on_initiatorname_failure() -> None:
+    """setup_and_login should fail before discovery when initiator setup fails."""
     with (
         patch('sts.iscsi.set_initiatorname', return_value=False),
         patch('sts.iscsi.IscsiAdm') as mock_adm,
     ):
-        node = setup_and_login(portal='10.0.0.1:3260', initiator_iqn='iqn.test')
+        with pytest.raises(IscsiError, match=r'Failed to set initiator name iqn\.test'):
+            setup_and_login(portal='10.0.0.1:3260', initiator_iqn='iqn.test')
 
-        # Should NOT have called discovery
         mock_adm.return_value.discovery.assert_not_called()
-    # Node should have empty target_iqn (not logged in)
-    assert node.target_iqn == ''
 
 
 def test_create_iscsi_iface(mock_command_result: Any) -> None:

{sts_libs-2.4.2 → sts_libs-2.5.0}/tests/iscsi/fio/fio_basic.fmf

@@ -2,6 +2,6 @@ summary: Basic FIO I/O test on iSCSI devices (180 seconds)
 test: pytest -vrA test_fio.py -k disabled
 environment+:
   FIO_RUNTIME: '180'
-duration: 10m
+duration: 20m
 tier: 1
 id: e5612fb0-d7c7-4789-a50f-6ecdfef698ca

{sts_libs-2.4.2 → sts_libs-2.5.0}/uv.lock

@@ -1001,7 +1001,7 @@ wheels = [
 
 [[package]]
 name = "sts-libs"
-version = "2.4.2"
+version = "2.5.0"
 source = { editable = "." }
 dependencies = [
     { name = "pydantic" },