forked from gnuoy/snap-openstack
-
Notifications
You must be signed in to change notification settings - Fork 35
feat: generate infinate charm #757
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ahmad-can
wants to merge
3
commits into
canonical:main
Choose a base branch
from
ahmad-can:feature/generate-infinidat-charm
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
4 changes: 4 additions & 0 deletions
4
sunbeam-python/sunbeam/storage/backends/infinidat/__init__.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # SPDX-FileCopyrightText: 2026 - Canonical Ltd | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """INFINIDAT backend for Sunbeam storage.""" |
114 changes: 114 additions & 0 deletions
114
sunbeam-python/sunbeam/storage/backends/infinidat/backend.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| # SPDX-FileCopyrightText: 2026 - Canonical Ltd | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """INFINIDAT InfiniBox 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 storage protocol types.""" | ||
|
|
||
| ISCSI = "iscsi" | ||
| FC = "fc" | ||
|
|
||
|
|
||
| class InfinidatConfig(StorageBackendConfig): | ||
| """Configuration model for INFINIDAT InfiniBox 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"), | ||
| ] | ||
|
|
||
| # Optional backend configuration | ||
| protocol: Annotated[ | ||
| Protocol | None, | ||
| Field(description="Protocol selector: iscsi, fc."), | ||
| ] = None | ||
| infinidat_pool_name: Annotated[ | ||
| str | None, | ||
| Field(description="Name of the pool from which volumes are allocated"), | ||
| ] = None | ||
| infinidat_storage_protocol: Annotated[ | ||
| Protocol | None, | ||
| Field( | ||
| description="Protocol for transferring data between host and storage back-end." # noqa: E501 | ||
| ), | ||
| ] = None | ||
| infinidat_iscsi_netspaces: Annotated[ | ||
| str | None, | ||
| Field( | ||
| description="List of names of network spaces to use for iSCSI connectivity" | ||
| ), | ||
| ] = None | ||
| infinidat_use_compression: Annotated[ | ||
| bool | None, | ||
| Field( | ||
| description="Specifies whether to enable (true) or disable (false) compression for all newly created volumes." # noqa: E501 | ||
| ), | ||
| ] = 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 InfinidatBackend(StorageBackendBase): | ||
| """INFINIDAT InfiniBox backend implementation.""" | ||
|
|
||
| backend_type = "infinidat" | ||
| display_name = "INFINIDAT InfiniBox" | ||
| generally_available = True | ||
|
|
||
| @property | ||
| def charm_name(self) -> str: | ||
| """Return the charm application name.""" | ||
| return "cinder-volume-infinidat" | ||
|
|
||
| @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" | ||
|
|
||
| def config_type(self) -> type[StorageBackendConfig]: | ||
| """Return the configuration model type for this backend.""" | ||
| return InfinidatConfig | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
73 changes: 73 additions & 0 deletions
73
sunbeam-python/tests/unit/sunbeam/storage/backends/test_infinidat.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # SPDX-FileCopyrightText: 2026 - Canonical Ltd | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| """Tests for INFINIDAT backend.""" | ||
|
|
||
| import pytest | ||
| from pydantic import ValidationError | ||
|
|
||
| from sunbeam.storage.models import SecretDictField | ||
| from tests.unit.sunbeam.storage.backends.test_common import BaseBackendTests | ||
|
|
||
|
|
||
| class TestInfinidatBackend(BaseBackendTests): | ||
| """Tests for INFINIDAT backend.""" | ||
|
|
||
| @pytest.fixture | ||
| def backend(self, infinidat_backend): | ||
| """Provide INFINIDAT backend instance.""" | ||
| return infinidat_backend | ||
|
|
||
| def test_backend_type_is_infinidat(self, backend): | ||
| """Test that backend type is 'infinidat'.""" | ||
| assert backend.backend_type == "infinidat" | ||
|
|
||
| def test_charm_name_is_infinidat_charm(self, backend): | ||
| """Test that charm name is cinder-volume-infinidat.""" | ||
| assert backend.charm_name == "cinder-volume-infinidat" | ||
|
|
||
| def test_config_has_required_fields(self, backend): | ||
| """Test that INFINIDAT config has required fields.""" | ||
| fields = backend.config_type().model_fields | ||
| for field in ("san_ip", "san_login", "san_password", "protocol"): | ||
| assert field in fields, f"Required field {field} not found in config" | ||
|
|
||
| def test_san_credentials_are_secret(self, backend): | ||
| """Test that SAN login and password are marked as secrets.""" | ||
| 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 TestInfinidatConfigValidation: | ||
| """Test INFINIDAT config validation behavior.""" | ||
|
|
||
| def test_protocol_rejects_invalid_value(self, infinidat_backend): | ||
| """Test that protocol rejects values other than iscsi/fc.""" | ||
| config_class = infinidat_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, infinidat_backend): | ||
| """Test that protocol accepts iscsi.""" | ||
| config_class = infinidat_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" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.