Skip to content
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

Add ExcludedPrefixes option to VersioningConfig #1402

Merged
merged 6 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions minio/versioningconfig.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,20 @@ class VersioningConfig:
"""Versioning configuration."""

def __init__(
self,
status: str | None = None,
mfa_delete: str | None = None,
self,
status: str | None = None,
mfa_delete: str | None = None,
excluded_prefixes: list[str] | None = None,
):
if status is not None and status not in [ENABLED, SUSPENDED]:
raise ValueError(f"status must be {ENABLED} or {SUSPENDED}")
if mfa_delete is not None and mfa_delete not in [ENABLED, DISABLED]:
raise ValueError(f"MFA delete must be {ENABLED} or {DISABLED}")
if excluded_prefixes is not None and not isinstance(excluded_prefixes, list):
raise ValueError(f"Excluded prefixes must be a list")
self._status = status
self._mfa_delete = mfa_delete
self._excluded_prefixes = excluded_prefixes

@property
def status(self) -> str:
Expand All @@ -55,12 +59,25 @@ def mfa_delete(self) -> str | None:
"""Get MFA delete."""
return self._mfa_delete

@property
def excluded_prefixes(self) -> str | None:
"""Get MFA delete."""
return self._excluded_prefixes

@classmethod
def fromxml(cls: Type[A], element: ET.Element) -> A:
"""Create new object with values from XML element."""
status = findtext(element, "Status")
mfa_delete = findtext(element, "MFADelete")
return cls(status, mfa_delete)

excluded_prefixes_tag = element.find("ExcludedPrefixes")
excluded_prefixes = None
if excluded_prefixes_tag:
excluded_prefixes = [
tag.text for tag in excluded_prefixes_tag.findall("ExcludedPrefix")
]

return cls(status, mfa_delete, excluded_prefixes)

def toxml(self, element: ET.Element | None) -> ET.Element:
"""Convert to XML."""
Expand All @@ -69,4 +86,8 @@ def toxml(self, element: ET.Element | None) -> ET.Element:
SubElement(element, "Status", self._status)
if self._mfa_delete:
SubElement(element, "MFADelete", self._mfa_delete)
if self._excluded_prefixes:
SubElement(element, "ExcludedPrefixes")
for prefix in self._excluded_prefixes:
SubElement(element, "ExcludedPrefix", prefix)
return element
25 changes: 24 additions & 1 deletion tests/unit/versioningconfig_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@

from minio import xml
from minio.commonconfig import DISABLED, ENABLED
from minio.versioningconfig import OFF, SUSPENDED, VersioningConfig
from minio.versioningconfig import (
OFF,
SUSPENDED,
VersioningConfig,
)


class VersioningConfigTest(TestCase):
Expand Down Expand Up @@ -53,3 +57,22 @@ def test_config(self):
xml.marshal(config)
self.assertEqual(config.status, SUSPENDED)
self.assertEqual(config.mfa_delete, DISABLED)

def test_config_with_excluded_prefixes(self):

config = xml.unmarshal(
VersioningConfig,
"""
<VersioningConfiguration>
<Status>Enabled</Status>
<MFADelete>Disabled</MFADelete>
<ExcludedPrefixes>
<ExcludedPrefix>prefix</ExcludedPrefix>
</ExcludedPrefixes>
</VersioningConfiguration>
""",
)
xml.marshal(config)
self.assertEqual(config.status, ENABLED)
self.assertEqual(config.mfa_delete, DISABLED)
self.assertListEqual(config.excluded_prefixes, ["prefix"])
Loading