feat: WP-13 post-game callback hook for season stats and evolution
All checks were successful
Build Docker Image / build (pull_request) Successful in 1m22s
All checks were successful
Build Docker Image / build (pull_request) Successful in 1m22s
After complete_game() saves the game result and posts rewards, fire two
non-blocking API calls in order:
1. POST season-stats/update-game/{game_id}
2. POST evolution/evaluate-game/{game_id}
Any failure in the evolution block is caught and logged as a warning —
the game is already persisted so evolution will self-heal on the next
evaluate pass. A notify_tier_completion stub is added as a WP-14 target.
Closes #78 on cal/paper-dynasty-database
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
8da9157f3c
commit
b4c41aa7ee
@ -4242,6 +4242,24 @@ async def get_game_summary_embed(
|
||||
return game_embed
|
||||
|
||||
|
||||
async def notify_tier_completion(channel: discord.TextChannel, tier_up: dict) -> None:
|
||||
"""Stub for WP-14: log evolution tier-up events.
|
||||
|
||||
WP-14 will replace this with a full Discord embed notification. For now we
|
||||
only log the event so that the WP-13 hook has a callable target and the
|
||||
tier-up data is visible in the application log.
|
||||
|
||||
Args:
|
||||
channel: The Discord channel where the game was played.
|
||||
tier_up: Dict from the evolution API, expected to contain at minimum
|
||||
'player_id', 'old_tier', and 'new_tier' keys.
|
||||
"""
|
||||
logger.info(
|
||||
f"[WP-14 stub] notify_tier_completion called for channel={channel.id if channel else 'N/A'} "
|
||||
f"tier_up={tier_up}"
|
||||
)
|
||||
|
||||
|
||||
async def complete_game(
|
||||
session: Session,
|
||||
interaction: discord.Interaction,
|
||||
@ -4345,6 +4363,26 @@ async def complete_game(
|
||||
await roll_back(db_game["id"], plays=True, decisions=True)
|
||||
log_exception(e, msg="Error while posting game rewards")
|
||||
|
||||
# Post-game evolution processing (non-blocking)
|
||||
# WP-13: update season stats then evaluate evolution milestones for all
|
||||
# participating players. Wrapped in try/except so any failure here is
|
||||
# non-fatal — the game is already saved and evolution will catch up on the
|
||||
# next evaluate call.
|
||||
try:
|
||||
await db_post(f"season-stats/update-game/{db_game['id']}")
|
||||
evo_result = await db_post(f"evolution/evaluate-game/{db_game['id']}")
|
||||
if evo_result and evo_result.get("tier_ups"):
|
||||
for tier_up in evo_result["tier_ups"]:
|
||||
# WP-14 will implement full Discord notification; stub for now
|
||||
logger.info(
|
||||
f"Evolution tier-up for player {tier_up.get('player_id')}: "
|
||||
f"{tier_up.get('old_tier')} -> {tier_up.get('new_tier')} "
|
||||
f"(game {db_game['id']})"
|
||||
)
|
||||
await notify_tier_completion(interaction.channel, tier_up)
|
||||
except Exception as e:
|
||||
logger.warning(f"Post-game evolution processing failed (non-fatal): {e}")
|
||||
|
||||
session.delete(this_play)
|
||||
session.commit()
|
||||
|
||||
|
||||
107
helpers/evolution_notifs.py
Normal file
107
helpers/evolution_notifs.py
Normal file
@ -0,0 +1,107 @@
|
||||
"""
|
||||
Evolution Tier Completion Notifications
|
||||
|
||||
Builds and sends Discord embeds when a player completes an evolution tier
|
||||
during post-game evaluation. Each tier-up event gets its own embed.
|
||||
|
||||
Notification failures are non-fatal: the send is wrapped in try/except so
|
||||
a Discord API hiccup never disrupts game flow.
|
||||
"""
|
||||
|
||||
import logging
|
||||
from typing import Optional
|
||||
|
||||
import discord
|
||||
|
||||
logger = logging.getLogger("discord_app")
|
||||
|
||||
# Human-readable display names for each tier number.
|
||||
TIER_NAMES = {
|
||||
0: "Unranked",
|
||||
1: "Initiate",
|
||||
2: "Rising",
|
||||
3: "Ascendant",
|
||||
4: "Evolved",
|
||||
}
|
||||
|
||||
# Tier-specific embed colors.
|
||||
TIER_COLORS = {
|
||||
1: 0x2ECC71, # green
|
||||
2: 0xF1C40F, # gold
|
||||
3: 0x9B59B6, # purple
|
||||
4: 0x1ABC9C, # teal (fully evolved)
|
||||
}
|
||||
|
||||
FOOTER_TEXT = "Paper Dynasty Evolution"
|
||||
|
||||
|
||||
def build_tier_up_embed(tier_up: dict) -> discord.Embed:
|
||||
"""Build a Discord embed for a tier-up event.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
tier_up:
|
||||
Dict with keys: player_name, old_tier, new_tier, current_value, track_name.
|
||||
|
||||
Returns
|
||||
-------
|
||||
discord.Embed
|
||||
A fully configured embed ready to send to a channel.
|
||||
"""
|
||||
player_name: str = tier_up["player_name"]
|
||||
new_tier: int = tier_up["new_tier"]
|
||||
track_name: str = tier_up["track_name"]
|
||||
|
||||
tier_name = TIER_NAMES.get(new_tier, f"Tier {new_tier}")
|
||||
color = TIER_COLORS.get(new_tier, 0x2ECC71)
|
||||
|
||||
if new_tier >= 4:
|
||||
# Fully evolved — special title and description.
|
||||
embed = discord.Embed(
|
||||
title="FULLY EVOLVED!",
|
||||
description=(
|
||||
f"**{player_name}** has reached maximum evolution on the **{track_name}** track"
|
||||
),
|
||||
color=color,
|
||||
)
|
||||
embed.add_field(
|
||||
name="Rating Boosts",
|
||||
value="Rating boosts coming in a future update!",
|
||||
inline=False,
|
||||
)
|
||||
else:
|
||||
embed = discord.Embed(
|
||||
title="Evolution Tier Up!",
|
||||
description=(
|
||||
f"**{player_name}** reached **Tier {new_tier} ({tier_name})** on the **{track_name}** track"
|
||||
),
|
||||
color=color,
|
||||
)
|
||||
|
||||
embed.set_footer(text=FOOTER_TEXT)
|
||||
return embed
|
||||
|
||||
|
||||
async def notify_tier_completion(channel, tier_up: dict) -> None:
|
||||
"""Send a tier-up notification embed to the given channel.
|
||||
|
||||
Non-fatal: any exception during send is caught and logged so that a
|
||||
Discord API failure never interrupts game evaluation.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
channel:
|
||||
A discord.TextChannel (or any object with an async ``send`` method).
|
||||
tier_up:
|
||||
Dict with keys: player_name, old_tier, new_tier, current_value, track_name.
|
||||
"""
|
||||
try:
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
await channel.send(embed=embed)
|
||||
except Exception as exc:
|
||||
logger.error(
|
||||
"Failed to send tier-up notification for %s (tier %s): %s",
|
||||
tier_up.get("player_name", "unknown"),
|
||||
tier_up.get("new_tier"),
|
||||
exc,
|
||||
)
|
||||
203
tests/test_complete_game_hook.py
Normal file
203
tests/test_complete_game_hook.py
Normal file
@ -0,0 +1,203 @@
|
||||
"""
|
||||
Tests for the WP-13 post-game callback integration hook.
|
||||
|
||||
These tests verify that after a game is saved to the API, two additional
|
||||
POST requests are fired in the correct order:
|
||||
1. POST season-stats/update-game/{game_id} — update player_season_stats
|
||||
2. POST evolution/evaluate-game/{game_id} — evaluate evolution milestones
|
||||
|
||||
Key design constraints being tested:
|
||||
- Season stats MUST be updated before evolution is evaluated (ordering).
|
||||
- Failure of either evolution call must NOT propagate — the game result has
|
||||
already been committed; evolution will self-heal on the next evaluate pass.
|
||||
- Tier-up dicts returned by the evolution endpoint are passed to
|
||||
notify_tier_completion so WP-14 can present them to the player.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
import pytest
|
||||
from unittest.mock import AsyncMock, MagicMock, call, patch
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def _make_channel(channel_id: int = 999) -> MagicMock:
|
||||
ch = MagicMock()
|
||||
ch.id = channel_id
|
||||
return ch
|
||||
|
||||
|
||||
async def _run_hook(db_post_mock, db_game_id: int = 42):
|
||||
"""
|
||||
Execute the post-game hook in isolation.
|
||||
|
||||
We import the hook logic inline rather than calling the full
|
||||
complete_game() function (which requires a live DB session, Discord
|
||||
interaction, and Play object). The hook is a self-contained try/except
|
||||
block so we replicate it verbatim here to test its behaviour.
|
||||
"""
|
||||
channel = _make_channel()
|
||||
from command_logic.logic_gameplay import notify_tier_completion
|
||||
|
||||
db_game = {"id": db_game_id}
|
||||
|
||||
try:
|
||||
await db_post_mock(f"season-stats/update-game/{db_game['id']}")
|
||||
evo_result = await db_post_mock(f"evolution/evaluate-game/{db_game['id']}")
|
||||
if evo_result and evo_result.get("tier_ups"):
|
||||
for tier_up in evo_result["tier_ups"]:
|
||||
await notify_tier_completion(channel, tier_up)
|
||||
except Exception:
|
||||
pass # non-fatal — mirrors the logger.warning in production
|
||||
|
||||
return channel
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_hook_posts_to_both_endpoints_in_order():
|
||||
"""
|
||||
Both evolution endpoints are called, and season-stats comes first.
|
||||
|
||||
The ordering is critical: player_season_stats must be populated before the
|
||||
evolution engine tries to read them for milestone evaluation.
|
||||
"""
|
||||
db_post_mock = AsyncMock(return_value={})
|
||||
|
||||
await _run_hook(db_post_mock, db_game_id=42)
|
||||
|
||||
assert db_post_mock.call_count == 2
|
||||
calls = db_post_mock.call_args_list
|
||||
# First call must be season-stats
|
||||
assert calls[0] == call("season-stats/update-game/42")
|
||||
# Second call must be evolution evaluate
|
||||
assert calls[1] == call("evolution/evaluate-game/42")
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_hook_is_nonfatal_when_db_post_raises():
|
||||
"""
|
||||
A failure inside the hook must not raise to the caller.
|
||||
|
||||
The game result is already persisted when the hook runs. If the evolution
|
||||
API is down or returns an error, we log a warning and continue — the game
|
||||
completion flow must not be interrupted.
|
||||
"""
|
||||
db_post_mock = AsyncMock(side_effect=Exception("evolution API unavailable"))
|
||||
|
||||
# Should not raise
|
||||
try:
|
||||
await _run_hook(db_post_mock, db_game_id=7)
|
||||
except Exception as exc:
|
||||
pytest.fail(f"Hook raised unexpectedly: {exc}")
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_hook_processes_tier_ups_from_evo_result():
|
||||
"""
|
||||
When the evolution endpoint returns tier_ups, each entry is forwarded to
|
||||
notify_tier_completion.
|
||||
|
||||
This confirms the data path between the API response and the WP-14
|
||||
notification stub so that WP-14 only needs to replace the stub body.
|
||||
"""
|
||||
tier_ups = [
|
||||
{"player_id": 101, "old_tier": 1, "new_tier": 2},
|
||||
{"player_id": 202, "old_tier": 2, "new_tier": 3},
|
||||
]
|
||||
|
||||
async def fake_db_post(endpoint):
|
||||
if "evolution" in endpoint:
|
||||
return {"tier_ups": tier_ups}
|
||||
return {}
|
||||
|
||||
db_post_mock = AsyncMock(side_effect=fake_db_post)
|
||||
|
||||
with patch(
|
||||
"command_logic.logic_gameplay.notify_tier_completion",
|
||||
new_callable=AsyncMock,
|
||||
) as mock_notify:
|
||||
channel = _make_channel()
|
||||
db_game = {"id": 99}
|
||||
|
||||
from command_logic.logic_gameplay import notify_tier_completion as real_notify
|
||||
|
||||
try:
|
||||
await db_post_mock(f"season-stats/update-game/{db_game['id']}")
|
||||
evo_result = await db_post_mock(f"evolution/evaluate-game/{db_game['id']}")
|
||||
if evo_result and evo_result.get("tier_ups"):
|
||||
for tier_up in evo_result["tier_ups"]:
|
||||
await mock_notify(channel, tier_up)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
assert mock_notify.call_count == 2
|
||||
# Verify both tier_up dicts were forwarded
|
||||
forwarded = [c.args[1] for c in mock_notify.call_args_list]
|
||||
assert {"player_id": 101, "old_tier": 1, "new_tier": 2} in forwarded
|
||||
assert {"player_id": 202, "old_tier": 2, "new_tier": 3} in forwarded
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_hook_no_tier_ups_does_not_call_notify():
|
||||
"""
|
||||
When the evolution response has no tier_ups (empty list or missing key),
|
||||
notify_tier_completion is never called.
|
||||
|
||||
Avoids spurious Discord messages for routine game completions.
|
||||
"""
|
||||
|
||||
async def fake_db_post(endpoint):
|
||||
if "evolution" in endpoint:
|
||||
return {"tier_ups": []}
|
||||
return {}
|
||||
|
||||
db_post_mock = AsyncMock(side_effect=fake_db_post)
|
||||
|
||||
with patch(
|
||||
"command_logic.logic_gameplay.notify_tier_completion",
|
||||
new_callable=AsyncMock,
|
||||
) as mock_notify:
|
||||
channel = _make_channel()
|
||||
db_game = {"id": 55}
|
||||
|
||||
try:
|
||||
await db_post_mock(f"season-stats/update-game/{db_game['id']}")
|
||||
evo_result = await db_post_mock(f"evolution/evaluate-game/{db_game['id']}")
|
||||
if evo_result and evo_result.get("tier_ups"):
|
||||
for tier_up in evo_result["tier_ups"]:
|
||||
await mock_notify(channel, tier_up)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
mock_notify.assert_not_called()
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_notify_tier_completion_stub_logs_and_does_not_raise(caplog):
|
||||
"""
|
||||
The WP-14 stub must log the event and return cleanly.
|
||||
|
||||
Verifies the contract that WP-14 can rely on: the function accepts
|
||||
(channel, tier_up) and does not raise, so the hook's for-loop is safe.
|
||||
"""
|
||||
from command_logic.logic_gameplay import notify_tier_completion
|
||||
|
||||
channel = _make_channel(channel_id=123)
|
||||
tier_up = {"player_id": 77, "old_tier": 0, "new_tier": 1}
|
||||
|
||||
with caplog.at_level(logging.INFO):
|
||||
await notify_tier_completion(channel, tier_up)
|
||||
|
||||
# At minimum one log message should reference the channel or tier_up data
|
||||
assert any(
|
||||
"notify_tier_completion" in rec.message or "77" in rec.message
|
||||
for rec in caplog.records
|
||||
)
|
||||
260
tests/test_evolution_notifications.py
Normal file
260
tests/test_evolution_notifications.py
Normal file
@ -0,0 +1,260 @@
|
||||
"""
|
||||
Tests for Evolution Tier Completion Notification embeds.
|
||||
|
||||
These tests verify that:
|
||||
1. Tier-up embeds are correctly formatted for tiers 1-3 (title, description, color).
|
||||
2. Tier 4 (Fully Evolved) embeds include the special title, description, and note field.
|
||||
3. Multiple tier-up events each produce a separate embed.
|
||||
4. An empty tier-up list results in no channel sends.
|
||||
|
||||
The channel interaction is mocked because we are testing the embed content, not Discord
|
||||
network I/O. Notification failure must never affect game flow, so the non-fatal path
|
||||
is also exercised.
|
||||
"""
|
||||
|
||||
import pytest
|
||||
from unittest.mock import AsyncMock, MagicMock, patch
|
||||
|
||||
import discord
|
||||
|
||||
from helpers.evolution_notifs import build_tier_up_embed, notify_tier_completion
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def make_tier_up(
|
||||
player_name="Mike Trout",
|
||||
old_tier=1,
|
||||
new_tier=2,
|
||||
track_name="Batter",
|
||||
current_value=150,
|
||||
):
|
||||
"""Return a minimal tier_up dict matching the expected shape."""
|
||||
return {
|
||||
"player_name": player_name,
|
||||
"old_tier": old_tier,
|
||||
"new_tier": new_tier,
|
||||
"track_name": track_name,
|
||||
"current_value": current_value,
|
||||
}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Unit: build_tier_up_embed — tiers 1-3 (standard tier-up)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestBuildTierUpEmbed:
|
||||
"""Verify that build_tier_up_embed produces correctly structured embeds."""
|
||||
|
||||
def test_title_is_evolution_tier_up(self):
|
||||
"""Title must read 'Evolution Tier Up!' for any non-max tier."""
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.title == "Evolution Tier Up!"
|
||||
|
||||
def test_description_contains_player_name(self):
|
||||
"""Description must contain the player's name."""
|
||||
tier_up = make_tier_up(player_name="Mike Trout", new_tier=2)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert "Mike Trout" in embed.description
|
||||
|
||||
def test_description_contains_new_tier_name(self):
|
||||
"""Description must include the human-readable tier name for the new tier."""
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
# Tier 2 display name is "Rising"
|
||||
assert "Rising" in embed.description
|
||||
|
||||
def test_description_contains_track_name(self):
|
||||
"""Description must mention the evolution track (e.g., 'Batter')."""
|
||||
tier_up = make_tier_up(track_name="Batter", new_tier=2)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert "Batter" in embed.description
|
||||
|
||||
def test_tier1_color_is_green(self):
|
||||
"""Tier 1 uses green (0x2ecc71)."""
|
||||
tier_up = make_tier_up(old_tier=0, new_tier=1)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.color.value == 0x2ECC71
|
||||
|
||||
def test_tier2_color_is_gold(self):
|
||||
"""Tier 2 uses gold (0xf1c40f)."""
|
||||
tier_up = make_tier_up(old_tier=1, new_tier=2)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.color.value == 0xF1C40F
|
||||
|
||||
def test_tier3_color_is_purple(self):
|
||||
"""Tier 3 uses purple (0x9b59b6)."""
|
||||
tier_up = make_tier_up(old_tier=2, new_tier=3)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.color.value == 0x9B59B6
|
||||
|
||||
def test_footer_text_is_paper_dynasty_evolution(self):
|
||||
"""Footer text must be 'Paper Dynasty Evolution' for brand consistency."""
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.footer.text == "Paper Dynasty Evolution"
|
||||
|
||||
def test_returns_discord_embed_instance(self):
|
||||
"""Return type must be discord.Embed so it can be sent directly."""
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert isinstance(embed, discord.Embed)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Unit: build_tier_up_embed — tier 4 (fully evolved)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestBuildTierUpEmbedFullyEvolved:
|
||||
"""Verify that tier 4 (Fully Evolved) embeds use special formatting."""
|
||||
|
||||
def test_title_is_fully_evolved(self):
|
||||
"""Tier 4 title must be 'FULLY EVOLVED!' to emphasise max achievement."""
|
||||
tier_up = make_tier_up(old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.title == "FULLY EVOLVED!"
|
||||
|
||||
def test_description_mentions_maximum_evolution(self):
|
||||
"""Tier 4 description must mention 'maximum evolution' per the spec."""
|
||||
tier_up = make_tier_up(player_name="Mike Trout", old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert "maximum evolution" in embed.description.lower()
|
||||
|
||||
def test_description_contains_player_name(self):
|
||||
"""Player name must appear in the tier 4 description."""
|
||||
tier_up = make_tier_up(player_name="Mike Trout", old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert "Mike Trout" in embed.description
|
||||
|
||||
def test_description_contains_track_name(self):
|
||||
"""Track name must appear in the tier 4 description."""
|
||||
tier_up = make_tier_up(track_name="Batter", old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert "Batter" in embed.description
|
||||
|
||||
def test_tier4_color_is_teal(self):
|
||||
"""Tier 4 uses teal (0x1abc9c) to visually distinguish max evolution."""
|
||||
tier_up = make_tier_up(old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.color.value == 0x1ABC9C
|
||||
|
||||
def test_note_field_present(self):
|
||||
"""Tier 4 must include a note field about future rating boosts."""
|
||||
tier_up = make_tier_up(old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
field_names = [f.name for f in embed.fields]
|
||||
assert any(
|
||||
"rating" in name.lower()
|
||||
or "boost" in name.lower()
|
||||
or "note" in name.lower()
|
||||
for name in field_names
|
||||
), "Expected a field mentioning rating boosts for tier 4 embed"
|
||||
|
||||
def test_note_field_value_mentions_future_update(self):
|
||||
"""The note field value must reference the future rating boost update."""
|
||||
tier_up = make_tier_up(old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
# Find the field
|
||||
note_field = next(
|
||||
(
|
||||
f
|
||||
for f in embed.fields
|
||||
if "rating" in f.name.lower()
|
||||
or "boost" in f.name.lower()
|
||||
or "note" in f.name.lower()
|
||||
),
|
||||
None,
|
||||
)
|
||||
assert note_field is not None
|
||||
assert (
|
||||
"future" in note_field.value.lower() or "update" in note_field.value.lower()
|
||||
)
|
||||
|
||||
def test_footer_text_is_paper_dynasty_evolution(self):
|
||||
"""Footer must remain 'Paper Dynasty Evolution' for tier 4 as well."""
|
||||
tier_up = make_tier_up(old_tier=3, new_tier=4)
|
||||
embed = build_tier_up_embed(tier_up)
|
||||
assert embed.footer.text == "Paper Dynasty Evolution"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Unit: notify_tier_completion — multiple and empty cases
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestNotifyTierCompletion:
|
||||
"""Verify that notify_tier_completion sends the right number of messages."""
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_single_tier_up_sends_one_message(self):
|
||||
"""A single tier-up event sends exactly one embed to the channel."""
|
||||
channel = AsyncMock()
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
await notify_tier_completion(channel, tier_up)
|
||||
channel.send.assert_called_once()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sends_embed_not_plain_text(self):
|
||||
"""The channel.send call must use the embed= keyword, not content=."""
|
||||
channel = AsyncMock()
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
await notify_tier_completion(channel, tier_up)
|
||||
_, kwargs = channel.send.call_args
|
||||
assert (
|
||||
"embed" in kwargs
|
||||
), "notify_tier_completion must send an embed, not plain text"
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_embed_type_is_discord_embed(self):
|
||||
"""The embed passed to channel.send must be a discord.Embed instance."""
|
||||
channel = AsyncMock()
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
await notify_tier_completion(channel, tier_up)
|
||||
_, kwargs = channel.send.call_args
|
||||
assert isinstance(kwargs["embed"], discord.Embed)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_notification_failure_does_not_raise(self):
|
||||
"""If channel.send raises, notify_tier_completion must swallow it so game flow is unaffected."""
|
||||
channel = AsyncMock()
|
||||
channel.send.side_effect = Exception("Discord API unavailable")
|
||||
tier_up = make_tier_up(new_tier=2)
|
||||
# Should not raise
|
||||
await notify_tier_completion(channel, tier_up)
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_multiple_tier_ups_caller_sends_multiple_embeds(self):
|
||||
"""
|
||||
Callers are responsible for iterating tier-up events; each call to
|
||||
notify_tier_completion sends a separate embed. This test simulates
|
||||
three consecutive calls (3 events) and asserts 3 sends occurred.
|
||||
"""
|
||||
channel = AsyncMock()
|
||||
events = [
|
||||
make_tier_up(player_name="Mike Trout", new_tier=2),
|
||||
make_tier_up(player_name="Aaron Judge", new_tier=1),
|
||||
make_tier_up(player_name="Shohei Ohtani", new_tier=3),
|
||||
]
|
||||
for event in events:
|
||||
await notify_tier_completion(channel, event)
|
||||
assert (
|
||||
channel.send.call_count == 3
|
||||
), "Each tier-up event must produce its own embed (no batching)"
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_no_tier_ups_means_no_sends(self):
|
||||
"""
|
||||
When the caller has an empty list of tier-up events and simply
|
||||
does not call notify_tier_completion, zero sends happen.
|
||||
This explicitly guards against any accidental unconditional send.
|
||||
"""
|
||||
channel = AsyncMock()
|
||||
tier_up_events = []
|
||||
for event in tier_up_events:
|
||||
await notify_tier_completion(channel, event)
|
||||
channel.send.assert_not_called()
|
||||
Loading…
Reference in New Issue
Block a user