From 7b3982546e3c99f115c95356c80f5c04d7826cdd Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Tue, 14 Apr 2026 13:23:06 +0500 Subject: [PATCH 1/3] feat: generate qnap charm --- .../sunbeam/storage/backends/qnap/__init__.py | 4 + .../sunbeam/storage/backends/qnap/backend.py | 112 ++++++++++++++++++ .../unit/sunbeam/storage/backends/conftest.py | 10 +- .../sunbeam/storage/backends/test_common.py | 10 +- .../sunbeam/storage/backends/test_qnap.py | 73 ++++++++++++ 5 files changed, 204 insertions(+), 5 deletions(-) create mode 100644 sunbeam-python/sunbeam/storage/backends/qnap/__init__.py create mode 100644 sunbeam-python/sunbeam/storage/backends/qnap/backend.py create mode 100644 sunbeam-python/tests/unit/sunbeam/storage/backends/test_qnap.py diff --git a/sunbeam-python/sunbeam/storage/backends/qnap/__init__.py b/sunbeam-python/sunbeam/storage/backends/qnap/__init__.py new file mode 100644 index 000000000..3b45f6e91 --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/qnap/__init__.py @@ -0,0 +1,4 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""QNAP backend for Sunbeam storage.""" diff --git a/sunbeam-python/sunbeam/storage/backends/qnap/backend.py b/sunbeam-python/sunbeam/storage/backends/qnap/backend.py new file mode 100644 index 000000000..42104bdc7 --- /dev/null +++ b/sunbeam-python/sunbeam/storage/backends/qnap/backend.py @@ -0,0 +1,112 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 +# ruff: noqa: E501 + +"""QNAP Storage 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 +from sunbeam.storage.models import SecretDictField + +LOG = logging.getLogger(__name__) +console = Console() + + +class Protocol(StrEnum): + """Enumeration of valid protocol types.""" + + FC = "fc" + ISCSI = "iscsi" + + +class QnapConfig(StorageBackendConfig): + """Configuration model for QNAP Storage 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="IP address of SAN controller")] + san_login: Annotated[ + str, + Field(description="Username for SAN controller"), + SecretDictField(field="san-login"), + ] + san_password: Annotated[ + str, + Field(description="Password for SAN controller"), + SecretDictField(field="san-password"), + ] + protocol: Annotated[ + Protocol | None, + Field(description="Protocol selector: fc, iscsi."), + ] = None + + # Optional backend configuration + qnap_management_url: Annotated[ + str | None, + Field( + description="The URL to management QNAP Storage. Driver does not support IPv6 address in URL." + ), + ] = None + qnap_poolname: Annotated[ + str | None, + Field(description="The pool name in the QNAP Storage"), + ] = None + qnap_storage_protocol: Annotated[ + str | None, + Field(description="Communication protocol to access QNAP storage"), + ] = None + san_thin_provision: Annotated[ + bool | None, + Field(description="Use thin provisioning for SAN volumes?"), + ] = None + use_multipath_for_image_xfer: Annotated[ + bool | None, + Field(description="Enable multipathing for image transfer operations."), + ] = None + + +class QnapBackend(StorageBackendBase): + """QNAP Storage backend implementation.""" + + backend_type = "qnap" + display_name = "QNAP Storage" + generally_available = True + + @property + def charm_name(self) -> str: + """Return the charm application name.""" + return "cinder-volume-qnap" + + @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 QnapConfig diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/conftest.py index 80d3d8ef5..32598c706 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.qnap.backend import QnapBackend @pytest.fixture @@ -29,19 +30,26 @@ def dellsc_backend(): return DellSCBackend() +@pytest.fixture +def qnap_backend(): + """Provide a QNAP backend instance.""" + return QnapBackend() + + @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", "qnap", "dellpowerstore"]) def any_backend(request): """Parametrized fixture that provides each backend type.""" backends = { "hitachi": HitachiBackend(), "purestorage": PureStorageBackend(), "dellsc": DellSCBackend(), + "qnap": QnapBackend(), "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..c65e71a9d 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, qnap_backend, dellpowerstore_backend ): """Test that all backends have unique type identifiers.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, + dellsc_backend, qnap_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, qnap_backend, dellpowerstore_backend ): """Test that all backends have unique charm names.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, + dellsc_backend, qnap_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"), + ("qnap", "qnap"), ("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"), + ("qnap", "cinder-volume-qnap"), ("dellpowerstore", "cinder-volume-dellpowerstore"), ], ) diff --git a/sunbeam-python/tests/unit/sunbeam/storage/backends/test_qnap.py b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_qnap.py new file mode 100644 index 000000000..e79a5538c --- /dev/null +++ b/sunbeam-python/tests/unit/sunbeam/storage/backends/test_qnap.py @@ -0,0 +1,73 @@ +# SPDX-FileCopyrightText: 2026 - Canonical Ltd +# SPDX-License-Identifier: Apache-2.0 + +"""Tests for QNAP backend.""" + +import pytest +from pydantic import ValidationError + +from sunbeam.storage.models import SecretDictField +from tests.unit.sunbeam.storage.backends.test_common import BaseBackendTests + + +class TestQnapBackend(BaseBackendTests): + """Tests for QNAP backend.""" + + @pytest.fixture + def backend(self, qnap_backend): + """Provide QNAP backend instance.""" + return qnap_backend + + def test_backend_type_is_qnap(self, backend): + """Test that backend type is 'qnap'.""" + assert backend.backend_type == "qnap" + + def test_charm_name_is_qnap_charm(self, backend): + """Test that charm name is cinder-volume-qnap.""" + assert backend.charm_name == "cinder-volume-qnap" + + def test_config_has_required_fields(self, backend): + """Test that QNAP config has required fields.""" + fields = backend.config_type().model_fields + for field in ("san_ip", "protocol", "san_login", "san_password"): + assert field in fields, f"Required field {field} not found in config" + + def test_sensitive_fields_are_marked_secret(self, backend): + """Test that QNAP SAN credentials are marked as secret.""" + config_class = backend.config_type() + for field_name in ("san_login", "san_password"): + field = config_class.model_fields.get(field_name) + assert field is not None + assert any(isinstance(m, SecretDictField) for m in field.metadata), ( + f"{field_name} should be marked as secret" + ) + + +class TestQnapConfigValidation: + """Test QNAP config validation behavior.""" + + def test_protocol_rejects_invalid_value(self, qnap_backend): + """Test that protocol rejects values other than fc/iscsi.""" + config_class = qnap_backend.config_type() + with pytest.raises(ValidationError): + config_class.model_validate( + { + "san-ip": "192.168.1.1", + "san-login": "admin", + "san-password": "secret", + "protocol": "nvme", + } + ) + + def test_protocol_accepts_iscsi(self, qnap_backend): + """Test that protocol accepts iscsi.""" + config_class = qnap_backend.config_type() + config = config_class.model_validate( + { + "san-ip": "192.168.1.1", + "san-login": "admin", + "san-password": "secret", + "protocol": "iscsi", + } + ) + assert config.protocol == "iscsi" From 96038c73c95fae12234a3007c2abb9afd4e4f777 Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Tue, 14 Apr 2026 15:39:49 +0500 Subject: [PATCH 2/3] fix: remove module E501 ignore and clarify management URL docs --- sunbeam-python/sunbeam/storage/backends/qnap/backend.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/sunbeam-python/sunbeam/storage/backends/qnap/backend.py b/sunbeam-python/sunbeam/storage/backends/qnap/backend.py index 42104bdc7..c33ac4b09 100644 --- a/sunbeam-python/sunbeam/storage/backends/qnap/backend.py +++ b/sunbeam-python/sunbeam/storage/backends/qnap/backend.py @@ -1,6 +1,5 @@ # SPDX-FileCopyrightText: 2026 - Canonical Ltd # SPDX-License-Identifier: Apache-2.0 -# ruff: noqa: E501 """QNAP Storage backend implementation using base step classes.""" @@ -54,7 +53,10 @@ class QnapConfig(StorageBackendConfig): qnap_management_url: Annotated[ str | None, Field( - description="The URL to management QNAP Storage. Driver does not support IPv6 address in URL." + description=( + "URL to manage the QNAP storage system. The driver does not " + "support IPv6 addresses in the URL." + ) ), ] = None qnap_poolname: Annotated[ From 136d59dc19a5c183f19764a9b2f2cc2f77e2e209 Mon Sep 17 00:00:00 2001 From: Ahmad Hassan Date: Tue, 21 Apr 2026 15:55:49 +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 c65e71a9d..a718ccbd5 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, qnap_backend, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + qnap_backend, + dellpowerstore_backend, ): """Test that all backends have unique type identifiers.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, qnap_backend, + dellsc_backend, + qnap_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, qnap_backend, dellpowerstore_backend + hitachi_backend, + purestorage_backend, + dellsc_backend, + qnap_backend, + dellpowerstore_backend, ): """Test that all backends have unique charm names.""" backends = [ hitachi_backend, purestorage_backend, - dellsc_backend, qnap_backend, + dellsc_backend, + qnap_backend, dellpowerstore_backend, ] charm_names = [b.charm_name for b in backends]