mirror of
https://github.com/ivuorinen/emoji.git
synced 2026-03-12 10:59:43 +00:00
Ismo Vuorinen
a5222ec8fe
* feat: add pytest unit tests and CI workflow Add 67 tests covering both create_listing.py and dedup.py with shared Pillow-based image fixtures. Add GitHub Actions workflow to run tests on Python file changes. * fix: address PR review feedback - Use monkeypatch.chdir(tmp_path) so tests write to temp dirs instead of polluting the repo's README.md and index.html - Strengthen unicode filename test to assert URL-encoded form (%C3%A9) - Move hashlib import to module level in test_dedup.py - Remove unused _zero_hash helper and Path import - Prefix unused tuple unpacking variables with underscore * fix: add docstrings and strengthen degenerate hash test - Add docstrings to all test classes, methods, and helper functions to achieve 100% docstring coverage - Strengthen test_skips_degenerate_hashes to assert groups == [] instead of only checking for no-crash * fix: use hardcoded MD5 digests and add fixture validation - Replace hashlib.md5() calls with known digest constants to remove hashlib import from test module - Add input validation to _make_gif fixture for clear error messages on empty colors or mismatched durations length
257 lines
10 KiB
Python
257 lines
10 KiB
Python
"""Tests for create_listing.py."""
|
|
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
import create_listing
|
|
|
|
|
|
class TestCharacterGrouping:
|
|
"""Test file grouping by first character."""
|
|
|
|
def test_alpha_files_grouped_by_first_char(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify files starting with letters are grouped under their first char."""
|
|
monkeypatch.chdir(tmp_path)
|
|
a1 = make_png(tmp_path, "apple.png")
|
|
a2 = make_png(tmp_path, "avocado.png")
|
|
b1 = make_png(tmp_path, "banana.png")
|
|
|
|
create_listing.generate_readme([a1, a2, b1])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert "## a" in content
|
|
assert "## b" in content
|
|
|
|
def test_non_alpha_grouped_as_special(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify non-alphabetic filenames are grouped into the special category."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f1 = make_png(tmp_path, "1emoji.png")
|
|
f2 = make_png(tmp_path, "_underscore.png")
|
|
|
|
create_listing.generate_readme([f1, f2])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert r"\[^a-zA-Z:\]" in content
|
|
|
|
def test_numeric_file_grouped_as_special(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify files starting with digits go into the special group."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f1 = make_png(tmp_path, "9lives.png")
|
|
create_listing.generate_readme([f1])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert r"\[^a-zA-Z:\]" in content
|
|
|
|
|
|
class TestSorting:
|
|
"""Test sort order of groups."""
|
|
|
|
def test_special_group_sorts_before_alpha(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify the special characters group appears before alphabetical groups."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f_special = make_png(tmp_path, "1first.png")
|
|
f_alpha = make_png(tmp_path, "zebra.png")
|
|
|
|
create_listing.generate_readme([f_special, f_alpha])
|
|
content = (tmp_path / "README.md").read_text()
|
|
special_pos = content.index(r"\[^a-zA-Z:\]")
|
|
z_pos = content.index("## z")
|
|
assert special_pos < z_pos
|
|
|
|
|
|
class TestRowChunking:
|
|
"""Test that files are split into rows of PER_ROW."""
|
|
|
|
def test_files_chunked_into_rows(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify 25 files produce 3 table rows (10 per row)."""
|
|
monkeypatch.chdir(tmp_path)
|
|
files = [make_png(tmp_path, f"a{i:02d}.png", color=(i, 0, 0, 255)) for i in range(25)]
|
|
create_listing.generate_readme(files)
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert content.count("<tr>") == 3
|
|
|
|
def test_single_file_one_row(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify a single file produces exactly one table row."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "alone.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert content.count("<tr>") == 1
|
|
|
|
|
|
class TestUrlEncoding:
|
|
"""Test URL encoding of filenames."""
|
|
|
|
def test_space_in_filename(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify spaces are percent-encoded as %20."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "my emoji.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert "my%20emoji.png" in content
|
|
|
|
def test_plus_in_filename(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify plus signs are percent-encoded as %2B."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "a+b.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert "a%2Bb.png" in content
|
|
|
|
def test_hash_in_filename(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify hash symbols are percent-encoded as %23."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "c#sharp.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert "c%23sharp.png" in content
|
|
|
|
|
|
class TestGenerateReadme:
|
|
"""Test generate_readme output structure."""
|
|
|
|
def test_produces_markdown_table(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify output contains markdown heading, table, and image tags."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "test.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert content.startswith("# Emotes")
|
|
assert "<table" in content
|
|
assert "<img" in content
|
|
assert "test.png" in content
|
|
|
|
def test_includes_timestamp(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify output includes a generation timestamp."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "test.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert "Generated:" in content
|
|
|
|
def test_image_title_uses_stem(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify image title attribute uses the filename stem as :name: format."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "smile.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert ':smile:' in content
|
|
|
|
|
|
class TestGenerateHtml:
|
|
"""Test generate_html output structure."""
|
|
|
|
def test_produces_html_with_search(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify output is valid HTML with a search input."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "test.png")
|
|
create_listing.generate_html([f])
|
|
content = (tmp_path / "index.html").read_text()
|
|
assert "<!DOCTYPE html>" in content
|
|
assert 'id="search"' in content
|
|
assert "test.png" in content
|
|
|
|
def test_data_keyword_attribute(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify emoji divs have data-keyword attributes for search."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "happy.png")
|
|
create_listing.generate_html([f])
|
|
content = (tmp_path / "index.html").read_text()
|
|
assert 'data-keyword="happy"' in content
|
|
|
|
def test_special_group_header(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify the # group displays as '0-9 / Special'."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "1number.png")
|
|
create_listing.generate_html([f])
|
|
content = (tmp_path / "index.html").read_text()
|
|
assert "0-9 / Special" in content
|
|
|
|
def test_hash_group_sorts_first(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify the special group appears before alphabetical groups in HTML."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f_special = make_png(tmp_path, "1first.png")
|
|
f_alpha = make_png(tmp_path, "zebra.png")
|
|
create_listing.generate_html([f_special, f_alpha])
|
|
content = (tmp_path / "index.html").read_text()
|
|
special_pos = content.index("0-9 / Special")
|
|
z_pos = content.index(">Z<")
|
|
assert special_pos < z_pos
|
|
|
|
def test_dark_theme(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify the HTML uses dark theme background color."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "test.png")
|
|
create_listing.generate_html([f])
|
|
content = (tmp_path / "index.html").read_text()
|
|
assert "#1a1a1a" in content
|
|
|
|
def test_emoji_count_shown(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify the total emoji count is displayed."""
|
|
monkeypatch.chdir(tmp_path)
|
|
files = [make_png(tmp_path, f"e{i}.png", color=(i, 0, 0, 255)) for i in range(3)]
|
|
create_listing.generate_html(files)
|
|
content = (tmp_path / "index.html").read_text()
|
|
assert "3 emojis" in content
|
|
|
|
def test_html_escapes_name(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify HTML special characters in filenames are escaped."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "a<b.png")
|
|
create_listing.generate_html([f])
|
|
content = (tmp_path / "index.html").read_text()
|
|
assert "a<b" in content
|
|
|
|
|
|
class TestMain:
|
|
"""Test the main() entry point."""
|
|
|
|
def test_system_exit_on_empty_dir(self, tmp_path, monkeypatch):
|
|
"""Verify SystemExit is raised when emoji directory has no images."""
|
|
monkeypatch.chdir(tmp_path)
|
|
empty = tmp_path / "empty"
|
|
empty.mkdir()
|
|
with patch.object(create_listing, "EMOJI_DIR", empty):
|
|
with pytest.raises(SystemExit, match="No images"):
|
|
create_listing.main()
|
|
|
|
def test_succeeds_with_valid_files(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify main() generates both output files with valid images."""
|
|
monkeypatch.chdir(tmp_path)
|
|
d = tmp_path / "emoji"
|
|
d.mkdir()
|
|
make_png(d, "test.png")
|
|
with patch.object(create_listing, "EMOJI_DIR", d):
|
|
create_listing.main()
|
|
assert (tmp_path / "README.md").exists()
|
|
assert (tmp_path / "index.html").exists()
|
|
|
|
def test_ignores_non_image_extensions(self, tmp_path, monkeypatch):
|
|
"""Verify non-image files are ignored and treated as empty directory."""
|
|
monkeypatch.chdir(tmp_path)
|
|
d = tmp_path / "emoji"
|
|
d.mkdir()
|
|
(d / "notes.txt").write_text("not an image")
|
|
with patch.object(create_listing, "EMOJI_DIR", d):
|
|
with pytest.raises(SystemExit, match="No images"):
|
|
create_listing.main()
|
|
|
|
|
|
class TestEdgeCases:
|
|
"""Test edge cases."""
|
|
|
|
def test_single_file(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify a single file is handled correctly."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "only.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
assert "only.png" in content
|
|
|
|
def test_unicode_filename(self, tmp_path, make_png, monkeypatch):
|
|
"""Verify unicode characters in filenames are URL-encoded."""
|
|
monkeypatch.chdir(tmp_path)
|
|
f = make_png(tmp_path, "\u00e9moji.png")
|
|
create_listing.generate_readme([f])
|
|
content = (tmp_path / "README.md").read_text()
|
|
# URL-encoded form of the unicode char should be present (é = %C3%A9)
|
|
assert "%C3%A9moji.png" in content
|