diff --git a/sunbeam-python/sunbeam/storage/backends/prophetstor/__init__.py b/sunbeam-python/sunbeam/storage/backends/prophetstor/__init__.py new file mode 100644 index 000000000..b53fdaa39 --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/prophetstor/__init__.py @@ -0,0 +1,4 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""ProphetStor backend for Sunbeam storage.""" diff --git a/sunbeam-python/sunbeam/storage/backends/prophetstor/backend.py b/sunbeam-python/sunbeam/storage/backends/prophetstor/backend.py new file mode 100644 index 000000000..62494c916 --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/prophetstor/backend.py @@ -0,0 +1,90 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""ProphetStor DPL FC 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 Protocol(StrEnum): + """Enumeration of valid protocol types.""" + + FC = "fc" + ISCSI = "iscsi" + + +class ProphetStorConfig(StorageBackendConfig): + """Configuration model for ProphetStor DPL FC 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, + Field(description="Protocol selector: fc, iscsi."), + ] + + # Optional backend configuration + dpl_pool: Annotated[ + str | None, + Field(description="DPL pool uuid in which DPL volumes are stored."), + ] = None + + dpl_port: Annotated[ + int, + Field(description="DPL port number."), + ] = 8357 + + +class ProphetStorBackend(StorageBackendBase): + """ProphetStor DPL FC backend implementation.""" + + backend_type = "prophetstor" + display_name = "ProphetStor FC" + generally_available = True + + @property + def charm_name(self) -> str: + """Return the charm application name.""" + return "cinder-volume-prophetstor" + + @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 ProphetStorConfig diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py index 80d3d8ef5..e7e24a595 100644 --- a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py @@ -8,6 +8,7 @@ from sunbeam.storage.backends.dellpowerstore.backend import DellPowerstoreBackend from sunbeam.storage.backends.dellsc.backend import DellSCBackend from sunbeam.storage.backends.hitachi.backend import HitachiBackend +from sunbeam.storage.backends.prophetstor.backend import ProphetStorBackend from sunbeam.storage.backends.purestorage.backend import PureStorageBackend @@ -29,19 +30,28 @@ def dellsc_backend(): return DellSCBackend() +@pytest.fixture +def prophetstor_backend(): + """Provide a ProphetStor backend instance.""" + return ProphetStorBackend() + + @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", "prophetstor", "dellpowerstore"] +) def any_backend(request): """Parametrized fixture that provides each backend type.""" backends = { "hitachi": HitachiBackend(), "purestorage": PureStorageBackend(), "dellsc": DellSCBackend(), + "prophetstor": ProphetStorBackend(), "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..ad30969bb 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, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + prophetstor_backend, + dellpowerstore_backend, ): """Test that all backends have unique type identifiers.""" backends = [ hitachi_backend, purestorage_backend, dellsc_backend, + prophetstor_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, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + prophetstor_backend, + dellpowerstore_backend, ): """Test that all backends have unique charm names.""" backends = [ hitachi_backend, purestorage_backend, dellsc_backend, + prophetstor_backend, dellpowerstore_backend, ] charm_names = [b.charm_name for b in backends] @@ -196,6 +206,7 @@ def test_all_backends_have_unique_charm_names( ("hitachi", "hitachi"), ("purestorage", "purestorage"), ("dellsc", "dellsc"), + ("prophetstor", "prophetstor"), ("dellpowerstore", "dellpowerstore"), ], ) @@ -211,6 +222,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"), + ("prophetstor", "cinder-volume-prophetstor"), ("dellpowerstore", "cinder-volume-dellpowerstore"), ], ) diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_prophetstor.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_prophetstor.py new file mode 100644 index 000000000..f5926ba80 --- /dev/null +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_prophetstor.py @@ -0,0 +1,79 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Tests for ProphetStor backend.""" + +import pytest +from pydantic import ValidationError + +from tests.unit.sunbeam.storage.backends.test_common import BaseBackendTests + + +class TestProphetStorBackend(BaseBackendTests): + """Tests for ProphetStor backend.""" + + @pytest.fixture + def backend(self, prophetstor_backend): + """Provide ProphetStor backend instance.""" + return prophetstor_backend + + def test_backend_type_is_prophetstor(self, backend): + """Test that backend type is 'prophetstor'.""" + assert backend.backend_type == "prophetstor" + + def test_charm_name_is_prophetstor_charm(self, backend): + """Test that charm name is cinder-volume-prophetstor.""" + assert backend.charm_name == "cinder-volume-prophetstor" + + def test_config_has_required_fields(self, backend): + """Test that ProphetStor 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 TestProphetStorConfigValidation: + """Test ProphetStor config validation behavior.""" + + def test_protocol_rejects_invalid_value(self, prophetstor_backend): + """Test that protocol rejects values other than fc/iscsi.""" + config_class = prophetstor_backend.config_type() + with pytest.raises(ValidationError): + config_class.model_validate( + { + "san-ip": "192.168.1.1", + "protocol": "nvme", + } + ) + + def test_protocol_accepts_fc(self, prophetstor_backend): + """Test that protocol accepts fc.""" + config_class = prophetstor_backend.config_type() + config = config_class.model_validate( + { + "san-ip": "192.168.1.1", + "protocol": "fc", + } + ) + assert config.protocol == "fc" + + def test_protocol_accepts_iscsi(self, prophetstor_backend): + """Test that protocol accepts iscsi.""" + config_class = prophetstor_backend.config_type() + config = config_class.model_validate( + { + "san-ip": "192.168.1.1", + "protocol": "iscsi", + } + ) + assert config.protocol == "iscsi" + + def test_protocol_is_required(self, prophetstor_backend): + """Test that protocol is required.""" + config_class = prophetstor_backend.config_type() + with pytest.raises(ValidationError): + config_class.model_validate( + { + "san-ip": "192.168.1.1", + } + )