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.

Sign up for GitHub

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

Jump to bottom

Fixed and tested misleading error messages on creating Alarm #193

Merged
merged 3 commits into from
Jun 20, 2023
Merged

Fixed and tested misleading error messages on creating Alarm #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4968b2
Fixed and tested misleading error messages on creating Alarm
mreiche Jun 9, 2023
23b9cf2
Improved Exception message validation
mreiche Jun 20, 2023
ed289d2
Removed unnecessary variable
mreiche Jun 20, 2023
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
12 changes: 7 additions & 5 deletions ical/alarm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,21 +81,23 @@ class Alarm(ComponentModel):
@root_validator
def parse_display_required_fields(cls, values: dict[str, Any]) -> dict[str, Any]:
"""Validate required fields for display actions."""
if values.get("action") != Action.DISPLAY:
action = values.get("action")
if action != Action.DISPLAY:
return values
if not values.get("description"):
raise ValueError("Description value is required for action AUDIO")
raise ValueError(f"Description value is required for action {action}")
return values

@root_validator
def parse_email_required_fields(cls, values: dict[str, Any]) -> dict[str, Any]:
"""Validate required fields for email actions."""
if values.get("action") != Action.EMAIL:
action = values.get("action")
if action != Action.EMAIL:
return values
if not values.get("description"):
raise ValueError("Description value is required for action AUDIO")
raise ValueError(f"Description value is required for action {action}")
if not values.get("summary"):
raise ValueError("Summary value is required for action AUDIO")
raise ValueError(f"Summary value is required for action {action}")
return values

@root_validator
Expand Down
4 changes: 2 additions & 2 deletions tests/test_alarm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def test_duration_and_repeat() -> None:

def test_display_required_fields() -> None:
"""Test required fields for action DISPLAY."""
with pytest.raises(ValidationError):
with pytest.raises(ValidationError, match="Description value is required for action DISPLAY"):
Alarm(action="DISPLAY", trigger=datetime.timedelta(minutes=-5))

alarm = Alarm(
Expand All @@ -63,7 +63,7 @@ def test_display_required_fields() -> None:
def test_email_required_fields() -> None:
"""Test required fields for action EMAIL."""
# Missing multiple fields
with pytest.raises(ValidationError):
with pytest.raises(ValidationError, match="Description value is required for action EMAIL"):
Alarm(action="EMAIL", trigger=datetime.timedelta(minutes=-5))

# Missing summary
Expand Down
Loading