Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 2 additions & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

## Upgrading

- Custom validators passed through a configuration dataclass field's `metadata` (as used by `load_config()` and `ConfigManager.new_receiver()`) must now raise a `marshmallow.ValidationError` to reject a value. `marshmallow` 4 removed support for validators that signal failure by returning `False`, so such validators are now ignored and the invalid value is accepted silently. This affects you as soon as `marshmallow` 4 is installed, which `frequenz-quantities` 1.0.2 and later require.

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features
Expand Down
15 changes: 14 additions & 1 deletion tests/config/test_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,24 @@
from frequenz.sdk.config._manager import _get_key


def _validate_name(value: str) -> None:
"""Validate that a name starts with `test`.

Args:
value: The name to validate.

Raises:
marshmallow.ValidationError: If the name doesn't start with `test`.
"""
if not value.startswith("test"):
raise marshmallow.ValidationError("Invalid value.")


@dataclass
class SimpleConfig:
"""A simple configuration class for testing."""

name: str = dataclasses.field(metadata={"validate": lambda s: s.startswith("test")})
name: str = dataclasses.field(metadata={"validate": _validate_name})
value: int


Expand Down
17 changes: 15 additions & 2 deletions tests/config/test_util.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,32 @@
from frequenz.sdk.config._util import load_config


def _validate_name(value: str) -> None:
"""Validate that a name starts with `test`.

Args:
value: The name to validate.

Raises:
marshmallow.ValidationError: If the name doesn't start with `test`.
"""
if not value.startswith("test"):
raise marshmallow.ValidationError("Invalid value.")


@dataclasses.dataclass
class SimpleConfig:
"""A simple configuration class for testing."""

name: str = dataclasses.field(metadata={"validate": lambda s: s.startswith("test")})
name: str = dataclasses.field(metadata={"validate": _validate_name})
value: int


@marshmallow_dataclass.dataclass
class MmSimpleConfig:
"""A simple marshmallow_dataclass configuration class for testing."""

name: str = dataclasses.field(metadata={"validate": lambda s: s.startswith("test")})
name: str = dataclasses.field(metadata={"validate": _validate_name})
value: int


Expand Down