From 1604141f63974f229714b7474c038b3e3a60c95c Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Thu, 9 Apr 2026 16:17:52 +0500 Subject: [PATCH 1/3] feat: generate kaminario charm --- .../storage/backends/kaminario/__init__.py | 4 + .../storage/backends/kaminario/backend.py | 84 +++++++++++++++++++ .../unit/sunbeam/storage/backends/conftest.py | 10 ++- .../sunbeam/storage/backends/test_common.py | 10 ++- .../storage/backends/test_kaminario.py | 58 +++++++++++++ 5 files changed, 161 insertions(+), 5 deletions(-) create mode 100644 sunbeam-python/sunbeam/storage/backends/kaminario/__init__.py create mode 100644 sunbeam-python/sunbeam/storage/backends/kaminario/backend.py create mode 100644 sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py diff --git a/sunbeam-python/sunbeam/storage/backends/kaminario/__init__.py b/sunbeam-python/sunbeam/storage/backends/kaminario/__init__.py new file mode 100644 index 000000000..a0b814211 --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/kaminario/__init__.py @@ -0,0 +1,4 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Kaminario backend for Sunbeam storage.""" diff --git a/sunbeam-python/sunbeam/storage/backends/kaminario/backend.py b/sunbeam-python/sunbeam/storage/backends/kaminario/backend.py new file mode 100644 index 000000000..95f201703 --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/kaminario/backend.py @@ -0,0 +1,84 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Kaminario iSCSI backend implementation using base step classes.""" + +import logging +from typing import Annotated, Literal + +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 KaminarioConfig(StorageBackendConfig): + """Configuration model for Kaminario iSCSI 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") + ] + + # Optional backend configuration + protocol: Annotated[ + Literal["iscsi"] | None, + Field(description="Protocol selector: iscsi."), + ] = None + auto_calc_max_oversubscription_ratio: Annotated[ + bool | None, + Field( + description="K2 driver will calculate max_oversubscription_ratio on setting this option as True" # noqa: E501 + ), + ] = None + disable_discovery: Annotated[ + bool | None, + Field( + description="Disabling iSCSI discovery (sendtargets) for multipath connections on K2 driver" # noqa: E501 + ), + ] = None + + +class KaminarioBackend(StorageBackendBase): + """Kaminario iSCSI backend implementation.""" + + backend_type = "kaminario" + display_name = "Kaminario iSCSI" + generally_available = True + + @property + def charm_name(self) -> str: + """Return the charm application name.""" + return "cinder-volume-kaminario" + + @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 KaminarioConfig diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py index 80d3d8ef5..fda7abc3c 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.kaminario.backend import KaminarioBackend from sunbeam.storage.backends.purestorage.backend import PureStorageBackend @@ -29,19 +30,26 @@ def dellsc_backend(): return DellSCBackend() +@pytest.fixture +def kaminario_backend(): + """Provide a Kaminario backend instance.""" + return KaminarioBackend() + + @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", "kaminario", "dellpowerstore"]) def any_backend(request): """Parametrized fixture that provides each backend type.""" backends = { "hitachi": HitachiBackend(), "purestorage": PureStorageBackend(), "dellsc": DellSCBackend(), + "kaminario": KaminarioBackend(), "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..a5301a3da 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, kaminario_backend, dellpowerstore_backend ): """Test that all backends have unique type identifiers.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, + dellsc_backend, kaminario_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, kaminario_backend, dellpowerstore_backend ): """Test that all backends have unique charm names.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, + dellsc_backend, kaminario_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"), + ("kaminario", "kaminario"), ("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"), + ("kaminario", "cinder-volume-kaminario"), ("dellpowerstore", "cinder-volume-dellpowerstore"), ], ) diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py new file mode 100644 index 000000000..baf2ed6ce --- /dev/null +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py @@ -0,0 +1,58 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Tests for Kaminario backend.""" + +import pytest +from pydantic import ValidationError + +from tests.unit.sunbeam.storage.backends.test_common import BaseBackendTests + + +class TestKaminarioBackend(BaseBackendTests): + """Tests for Kaminario backend.""" + + @pytest.fixture + def backend(self, kaminario_backend): + """Provide Kaminario backend instance.""" + return kaminario_backend + + def test_backend_type_is_kaminario(self, backend): + """Test that backend type is 'kaminario'.""" + assert backend.backend_type == "kaminario" + + def test_charm_name_is_kaminario_charm(self, backend): + """Test that charm name is cinder-volume-kaminario.""" + assert backend.charm_name == "cinder-volume-kaminario" + + def test_config_has_required_fields(self, backend): + """Test that Kaminario 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 TestKaminarioConfigValidation: + """Test Kaminario config validation behavior.""" + + def test_protocol_rejects_invalid_value(self, kaminario_backend): + """Test that protocol rejects values other than iscsi.""" + config_class = kaminario_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, kaminario_backend): + """Test that protocol accepts iscsi.""" + config_class = kaminario_backend.config_type() + config = config_class.model_validate( + { + "san-ip": "192.168.1.1", + "protocol": "iscsi", + } + ) + assert config.protocol == "iscsi" From c82febdab141958b97a21fe27f5432fa14ffa052 Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Thu, 9 Apr 2026 16:50:42 +0500 Subject: [PATCH 2/3] fix: rename required-field check to expected-field semantics --- .../tests/unit/sunbeam/storage/backends/test_kaminario.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py index baf2ed6ce..86e9ba5e6 100644 --- a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_kaminario.py @@ -25,11 +25,11 @@ def test_charm_name_is_kaminario_charm(self, backend): """Test that charm name is cinder-volume-kaminario.""" assert backend.charm_name == "cinder-volume-kaminario" - def test_config_has_required_fields(self, backend): - """Test that Kaminario config has required fields.""" + def test_config_has_expected_fields(self, backend): + """Test that Kaminario config exposes expected 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" + assert field in fields, f"Expected field {field} not found in config" class TestKaminarioConfigValidation: From e3e977c02199897824cdffa336e265debfde35cd Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Tue, 21 Apr 2026 13:25:34 +0500 Subject: [PATCH 3/3] fix: test/lint issues resolve --- .../unit/sunbeam/storage/backends/conftest.py | 4 +++- .../sunbeam/storage/backends/test_common.py | 18 ++++++++++++++---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py index fda7abc3c..9f2bf7591 100644 --- a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py @@ -42,7 +42,9 @@ def dellpowerstore_backend(): return DellPowerstoreBackend() -@pytest.fixture(params=["hitachi", "purestorage", "dellsc", "kaminario", "dellpowerstore"]) +@pytest.fixture( + params=["hitachi", "purestorage", "dellsc", "kaminario", "dellpowerstore"] +) def any_backend(request): """Parametrized fixture that provides each backend type.""" backends = { 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 a5301a3da..fd895f579 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, kaminario_backend, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + kaminario_backend, + dellpowerstore_backend, ): """Test that all backends have unique type identifiers.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, kaminario_backend, + dellsc_backend, + kaminario_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, kaminario_backend, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + kaminario_backend, + dellpowerstore_backend, ): """Test that all backends have unique charm names.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, kaminario_backend, + dellsc_backend, + kaminario_backend, dellpowerstore_backend, ] charm_names = [b.charm_name for b in backends]