From 2653883f73698f475589839f18ca0d47019e70b2 Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Tue, 14 Apr 2026 14:32:58 +0500 Subject: [PATCH 1/3] feat: genearte stx charm --- .../sunbeam/storage/backends/stx/__init__.py | 4 + .../sunbeam/storage/backends/stx/backend.py | 98 +++++++++++++++++++ .../unit/sunbeam/storage/backends/conftest.py | 10 +- .../sunbeam/storage/backends/test_common.py | 10 +- .../unit/sunbeam/storage/backends/test_stx.py | 58 +++++++++++ 5 files changed, 175 insertions(+), 5 deletions(-) create mode 100644 sunbeam-python/sunbeam/storage/backends/stx/__init__.py create mode 100644 sunbeam-python/sunbeam/storage/backends/stx/backend.py create mode 100644 sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py diff --git a/sunbeam-python/sunbeam/storage/backends/stx/__init__.py b/sunbeam-python/sunbeam/storage/backends/stx/__init__.py new file mode 100644 index 000000000..e1a5e14a1 --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/stx/__init__.py @@ -0,0 +1,4 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Stx backend for Sunbeam storage.""" diff --git a/sunbeam-python/sunbeam/storage/backends/stx/backend.py b/sunbeam-python/sunbeam/storage/backends/stx/backend.py new file mode 100644 index 000000000..37455456a --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/stx/backend.py @@ -0,0 +1,98 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Stx backend implementation using base step classes.""" + +import logging +from enum import StrEnum +from typing import Annotated + +from pydantic import Field +from rich.console import Console + +from sunbeam.core.manifest import StorageBackendConfig +from sunbeam.storage.base import StorageBackendBase + +LOG = logging.getLogger(__name__) +console = Console() + + +class PoolType(StrEnum): + """Enumeration of valid pool types.""" + + LINEAR = "linear" + VIRTUAL = "virtual" + + +class Protocol(StrEnum): + """Enumeration of valid protocol types.""" + + ISCSI = "iscsi" + + +class StxConfig(StorageBackendConfig): + """Configuration model for Stx backend. + + This model includes ALL configuration options for the backend. + Additional configuration can be managed dynamically through the charm. + """ + + # Mandatory connection parameters + san_ip: Annotated[ + str, Field(description="Storage array management IP address or hostname") + ] + protocol: Annotated[ + Protocol | None, + Field(description="Protocol selector: iscsi."), + ] = None + + # Optional backend configuration + seagate_pool_name: Annotated[ + str | None, + Field(description="Pool or vdisk name to use for volume creation"), + ] = "A" + seagate_pool_type: Annotated[ + PoolType | None, + Field(description="linear (for vdisk) or virtual (for virtual pool)"), + ] = None + seagate_iscsi_ips: Annotated[ + str | None, + Field(description="List of comma-separated target iSCSI IP addresses"), + ] = None + + +class StxBackend(StorageBackendBase): + """Stx backend implementation.""" + + backend_type = "stx" + display_name = "Stx" + generally_available = True + + @property + def charm_name(self) -> str: + """Return the charm application name.""" + return "cinder-volume-stx" + + @property + def charm_channel(self) -> str: + """Return the default charm channel.""" + return "latest/edge" + + @property + def charm_revision(self) -> str | None: + """Return a pinned charm revision, if any.""" + return None + + @property + def charm_base(self) -> str: + """Return the target base for this charm.""" + return "ubuntu@24.04" + + @property + def supports_ha(self) -> bool: + """Whether this backend supports HA deployments.""" + return False + + def config_type(self) -> type[StorageBackendConfig]: + """Return the configuration model type for this backend.""" + return StxConfig diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py index 80d3d8ef5..80bd40017 100644 --- a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py @@ -9,6 +9,7 @@ from sunbeam.storage.backends.dellsc.backend import DellSCBackend from sunbeam.storage.backends.hitachi.backend import HitachiBackend from sunbeam.storage.backends.purestorage.backend import PureStorageBackend +from sunbeam.storage.backends.stx.backend import StxBackend @pytest.fixture @@ -29,19 +30,26 @@ def dellsc_backend(): return DellSCBackend() +@pytest.fixture +def stx_backend(): + """Provide a Stx backend instance.""" + return StxBackend() + + @pytest.fixture def dellpowerstore_backend(): """Provide a Dell PowerStore backend instance.""" return DellPowerstoreBackend() -@pytest.fixture(params=["hitachi", "purestorage", "dellsc", "dellpowerstore"]) +@pytest.fixture(params=["hitachi", "purestorage", "dellsc", "stx", "dellpowerstore"]) def any_backend(request): """Parametrized fixture that provides each backend type.""" backends = { "hitachi": HitachiBackend(), "purestorage": PureStorageBackend(), "dellsc": DellSCBackend(), + "stx": StxBackend(), "dellpowerstore": DellPowerstoreBackend(), } return backends[request.param] diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py index def51a0e8..0d36a8518 100644 --- a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py @@ -157,13 +157,13 @@ def backend(self, any_backend): def test_all_backends_have_unique_types( - hitachi_backend, purestorage_backend, dellsc_backend, dellpowerstore_backend + hitachi_backend, purestorage_backend, dellsc_backend, stx_backend, dellpowerstore_backend ): """Test that all backends have unique type identifiers.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, + dellsc_backend, stx_backend, dellpowerstore_backend, ] types = [b.backend_type for b in backends] @@ -173,13 +173,13 @@ def test_all_backends_have_unique_types( def test_all_backends_have_unique_charm_names( - hitachi_backend, purestorage_backend, dellsc_backend, dellpowerstore_backend + hitachi_backend, purestorage_backend, dellsc_backend, stx_backend, dellpowerstore_backend ): """Test that all backends have unique charm names.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, + dellsc_backend, stx_backend, dellpowerstore_backend, ] charm_names = [b.charm_name for b in backends] @@ -196,6 +196,7 @@ def test_all_backends_have_unique_charm_names( ("hitachi", "hitachi"), ("purestorage", "purestorage"), ("dellsc", "dellsc"), + ("stx", "stx"), ("dellpowerstore", "dellpowerstore"), ], ) @@ -211,6 +212,7 @@ def test_backend_types_match_expected(any_backend, backend_type, expected_type): ("hitachi", "cinder-volume-hitachi"), ("purestorage", "cinder-volume-purestorage"), ("dellsc", "cinder-volume-dellsc"), + ("stx", "cinder-volume-stx"), ("dellpowerstore", "cinder-volume-dellpowerstore"), ], ) diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py new file mode 100644 index 000000000..bc2c0455c --- /dev/null +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py @@ -0,0 +1,58 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Tests for Stx backend.""" + +import pytest +from pydantic import ValidationError + +from tests.unit.sunbeam.storage.backends.test_common import BaseBackendTests + + +class TestStxBackend(BaseBackendTests): + """Tests for Stx backend.""" + + @pytest.fixture + def backend(self, stx_backend): + """Provide Stx backend instance.""" + return stx_backend + + def test_backend_type_is_stx(self, backend): + """Test that backend type is 'stx'.""" + assert backend.backend_type == "stx" + + def test_charm_name_is_stx_charm(self, backend): + """Test that charm name is cinder-volume-stx.""" + assert backend.charm_name == "cinder-volume-stx" + + def test_config_has_required_fields(self, backend): + """Test that Stx config has required fields.""" + fields = backend.config_type().model_fields + for field in ("san_ip", "protocol"): + assert field in fields, f"Required field {field} not found in config" + + +class TestStxConfigValidation: + """Test Stx config validation behavior.""" + + def test_protocol_rejects_invalid_value(self, stx_backend): + """Test that protocol rejects values other than iscsi.""" + config_class = stx_backend.config_type() + with pytest.raises(ValidationError): + config_class.model_validate( + { + "san-ip": "192.168.1.1", + "protocol": "fc", + } + ) + + def test_protocol_accepts_iscsi(self, stx_backend): + """Test that protocol accepts iscsi.""" + config_class = stx_backend.config_type() + config = config_class.model_validate( + { + "san-ip": "192.168.1.1", + "protocol": "iscsi", + } + ) + assert config.protocol == "iscsi" From 993891b5879de9f9919444cacb856d31b48df676 Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Tue, 14 Apr 2026 16:37:16 +0500 Subject: [PATCH 2/3] fix: focus backend tests on stx-specific config behavior --- .../sunbeam/storage/backends/stx/backend.py | 1 + .../unit/sunbeam/storage/backends/test_stx.py | 52 ++++++++++++++----- 2 files changed, 40 insertions(+), 13 deletions(-) diff --git a/sunbeam-python/sunbeam/storage/backends/stx/backend.py b/sunbeam-python/sunbeam/storage/backends/stx/backend.py index 37455456a..0e3536bc2 100644 --- a/sunbeam-python/sunbeam/storage/backends/stx/backend.py +++ b/sunbeam-python/sunbeam/storage/backends/stx/backend.py @@ -41,6 +41,7 @@ class StxConfig(StorageBackendConfig): san_ip: Annotated[ str, Field(description="Storage array management IP address or hostname") ] + # Optional connection configuration protocol: Annotated[ Protocol | None, Field(description="Protocol selector: iscsi."), diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py index bc2c0455c..2c4c43400 100644 --- a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_stx.py @@ -17,19 +17,16 @@ def backend(self, stx_backend): """Provide Stx backend instance.""" return stx_backend - def test_backend_type_is_stx(self, backend): - """Test that backend type is 'stx'.""" - assert backend.backend_type == "stx" - - def test_charm_name_is_stx_charm(self, backend): - """Test that charm name is cinder-volume-stx.""" - assert backend.charm_name == "cinder-volume-stx" - - def test_config_has_required_fields(self, backend): - """Test that Stx config has required fields.""" + def test_config_has_stx_specific_fields(self, backend): + """Test that Stx config exposes Stx-specific fields.""" fields = backend.config_type().model_fields - for field in ("san_ip", "protocol"): - assert field in fields, f"Required field {field} not found in config" + for field in ("seagate_pool_name", "seagate_pool_type", "seagate_iscsi_ips"): + assert field in fields, f"Stx-specific field {field} not found in config" + + def test_seagate_pool_name_has_expected_default(self, backend): + """Test that seagate_pool_name default is set.""" + field = backend.config_type().model_fields["seagate_pool_name"] + assert field.default == "A" class TestStxConfigValidation: @@ -38,13 +35,16 @@ class TestStxConfigValidation: def test_protocol_rejects_invalid_value(self, stx_backend): """Test that protocol rejects values other than iscsi.""" config_class = stx_backend.config_type() - with pytest.raises(ValidationError): + with pytest.raises(ValidationError) as exc_info: config_class.model_validate( { "san-ip": "192.168.1.1", "protocol": "fc", } ) + assert any( + error.get("loc") == ("protocol",) for error in exc_info.value.errors() + ) def test_protocol_accepts_iscsi(self, stx_backend): """Test that protocol accepts iscsi.""" @@ -56,3 +56,29 @@ def test_protocol_accepts_iscsi(self, stx_backend): } ) assert config.protocol == "iscsi" + + def test_pool_type_accepts_valid_value(self, stx_backend): + """Test that seagate_pool_type accepts valid enum values.""" + config_class = stx_backend.config_type() + config = config_class.model_validate( + { + "san-ip": "192.168.1.1", + "seagate-pool-type": "linear", + } + ) + assert str(config.seagate_pool_type) == "linear" + + def test_pool_type_rejects_invalid_value(self, stx_backend): + """Test that seagate_pool_type rejects invalid values.""" + config_class = stx_backend.config_type() + with pytest.raises(ValidationError) as exc_info: + config_class.model_validate( + { + "san-ip": "192.168.1.1", + "seagate-pool-type": "raid", + } + ) + assert any( + error.get("loc") == ("seagate-pool-type",) + for error in exc_info.value.errors() + ) From 51fa6b04bb3132e2665a758610ffe11592378924 Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Tue, 21 Apr 2026 16:30:08 +0500 Subject: [PATCH 3/3] fix: test/lint issues resolve --- .../sunbeam/storage/backends/test_common.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py index 0d36a8518..60a7b1ee3 100644 --- a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_common.py @@ -157,13 +157,18 @@ def backend(self, any_backend): def test_all_backends_have_unique_types( - hitachi_backend, purestorage_backend, dellsc_backend, stx_backend, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + stx_backend, + dellpowerstore_backend, ): """Test that all backends have unique type identifiers.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, stx_backend, + dellsc_backend, + stx_backend, dellpowerstore_backend, ] types = [b.backend_type for b in backends] @@ -173,13 +178,18 @@ def test_all_backends_have_unique_types( def test_all_backends_have_unique_charm_names( - hitachi_backend, purestorage_backend, dellsc_backend, stx_backend, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + stx_backend, + dellpowerstore_backend, ): """Test that all backends have unique charm names.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, stx_backend, + dellsc_backend, + stx_backend, dellpowerstore_backend, ] charm_names = [b.charm_name for b in backends]