ttvdrops/youtube/tests/test_youtube.py

import json
from typing import TYPE_CHECKING
from typing import Any

from django.test import TestCase
from django.urls import reverse

if TYPE_CHECKING:
    from django.test.client import _MonkeyPatchedWSGIResponse


class YouTubeIndexViewTest(TestCase):
    """Tests for the YouTube drops channels index page."""

    def test_index_includes_page_specific_seo_metadata(self) -> None:
        """The YouTube page should render dedicated title and description metadata."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))
        content: str = response.content.decode()

        assert response.context is not None
        assert response.context["page_title"] == "YouTube channels with rewards"
        assert (
            response.context["page_description"]
            == "Browse YouTube channels listed as reward-enabled, including Call of Duty, Blizzard, "
            "Fortnite, Riot Games, and more."
        )
        assert (
            '<meta property="og:title" content="YouTube channels with rewards" />'
            in content
        )
        assert (
            '<meta property="og:description"\n'
            '      content="Browse YouTube channels listed as reward-enabled, including Call of Duty, '
            'Blizzard, Fortnite, Riot Games, and more." />'
        ) in content
        assert (
            '<meta name="twitter:title" content="YouTube channels with rewards" />'
            in content
        )
        assert (
            '<meta name="description"\n'
            '      content="Browse YouTube channels listed as reward-enabled, including Call of Duty, '
            'Blizzard, Fortnite, Riot Games, and more." />'
        ) in content

    def test_index_schema_data_is_valid_itemlist(self) -> None:
        """The page should include a valid Schema.org ItemList in the JSON-LD context."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))

        assert response.context is not None
        assert "schema_data" in response.context

        schema: dict[str, Any] = json.loads(response.context["schema_data"])
        assert schema["@context"] == "https://schema.org"
        assert schema["@type"] == "ItemList"
        assert schema["name"] == "YouTube channels with rewards"
        assert "itemListElement" in schema

        items: list[dict[str, Any]] = schema["itemListElement"]
        assert len(items) > 0

        # Every entry must be a ListItem wrapping an Organization
        for item in items:
            assert item["@type"] == "ListItem"
            assert "position" in item
            org: dict[str, Any] = item["item"]
            assert org["@type"] == "Organization"
            assert "name" in org
            assert isinstance(org["sameAs"], list)
            assert len(org["sameAs"]) > 0

    def test_index_schema_data_includes_known_orgs(self) -> None:
        """The Schema.org ItemList should contain entries for known organizations."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))
        schema: dict[str, Any] = json.loads(response.context["schema_data"])  # type: ignore[index]
        org_names: list[str] = [
            item["item"]["name"] for item in schema["itemListElement"]
        ]

        assert "Activision (Call of Duty)" in org_names
        assert "Battle.net / Blizzard" in org_names
        assert "Riot Games" in org_names
        assert "Epic Games" in org_names

    def test_index_schema_data_org_same_as_are_youtube_urls(self) -> None:
        """Each Organization's sameAs values should be YouTube URLs."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))
        schema: dict[str, Any] = json.loads(response.context["schema_data"])  # type: ignore[index]
        for list_item in schema["itemListElement"]:
            for url in list_item["item"]["sameAs"]:
                assert url.startswith("https://www.youtube.com/")

    def test_index_returns_200(self) -> None:
        """The YouTube index page should return HTTP 200."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))
        assert response.status_code == 200

    def test_index_displays_known_channels(self) -> None:
        """The page should include key known channels from the organization list."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))
        content: str = response.content.decode()

        assert "YouTube channels with rewards." in content
        assert "Call of Duty" in content
        assert "PlayOverwatch" in content
        assert "Hearthstone" in content
        assert "Fortnite" in content
        assert "Riot Games" in content
        assert "Ubisoft" in content

    def test_index_includes_organization_urls(self) -> None:
        """The page should render organization channel links from the source list."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))
        content: str = response.content.decode()

        assert "https://www.youtube.com/channel/UCbLIqv9Puhyp9_ZjVtfOy7w" in content
        assert "https://www.youtube.com/user/epicfortnite" in content
        assert "https://www.youtube.com/lolesports" in content

    def test_index_groups_organizations_alphabetically(self) -> None:
        """Organization sections should render grouped and in alphabetical order."""
        response: _MonkeyPatchedWSGIResponse = self.client.get(reverse("youtube:index"))
        content: str = response.content.decode()

        activision_cell: str = "<td>Activision (Call of Duty)</td>"
        blizzard_cell: str = "<td>Battle.net / Blizzard</td>"

        assert activision_cell in content
        assert blizzard_cell in content
        assert content.index(activision_cell) < content.index(
            blizzard_cell,
        )