"""Tests for amateurfunk_anki.
These tests inspect the generated `.apkg` package structure directly:
ZIP entries, media map, and the SQLite collection database. They do not
require Anki itself to be installed.
"""
import json
import sqlite3
import tempfile
import unittest
import zipfile
from pathlib import Path
from unittest.mock import patch
import amateurfunk_anki as aa
def make_catalog():
return {
"metadata": {
"edition": "3. Auflage, März 2024",
"issued_on": "2024-03-20",
"valid_from": "2024-06-24",
"license": "DL-DE->BY-2.0",
},
"sections": [
{
"title": "Prüfungsfragen im Prüfungsteil: Technische Kenntnisse",
"sections": [
{
"title": "Grundlagen",
"questions": [
question("NA101", "1", "Was ist A?", "NA101_q"),
question("EA202", "2", "Was ist E?", None),
question("AA303", "3", "Was ist A-Klasse?", None),
],
}
],
},
{
"title": "Prüfungsfragen im Prüfungsteil: Betriebliche Kenntnisse",
"questions": [
question("BA101", "1", "Betrieb?", "BA101_q"),
],
},
{
"title": "Prüfungsfragen im Prüfungsteil: Kenntnisse von Vorschriften",
"questions": [
question("VA101", "1", "Vorschrift?", None),
],
},
],
}
def question(number, klass, prompt, picture):
data = {
"number": number,
"class": klass,
"question": prompt,
"answer_a": f"{number} richtig",
"answer_b": f"{number} falsch B",
"answer_c": f"{number} falsch C",
"answer_d": f"{number} falsch D",
}
if picture:
data["picture_question"] = picture
return data
def make_fetched_data(root: Path):
data_dir = root / "data"
edition_dir = data_dir / "2024-03-20-3-auflage"
media_dir = edition_dir / "svgs"
media_dir.mkdir(parents=True)
(media_dir / "NA101_q.svg").write_text("", encoding="utf-8")
(media_dir / "BA101_q.svg").write_text("", encoding="utf-8")
(media_dir / "NA101_a.svg").write_text("", encoding="utf-8")
catalog = make_catalog()
(edition_dir / "fragenkatalog3b.json").write_text(
json.dumps(catalog, ensure_ascii=False),
encoding="utf-8",
)
(edition_dir / "manifest.json").write_text(
json.dumps(
{
"slug": "2024-03-20-3-auflage",
"json_filename": "fragenkatalog3b.json",
"fetched_at": "2026-05-20T12:00:00+00:00",
"metadata": catalog["metadata"],
}
),
encoding="utf-8",
)
(data_dir / "manifest-latest.json").write_text(
json.dumps({"slug": "2024-03-20-3-auflage"}),
encoding="utf-8",
)
return data_dir
def extract_collection(apkg_path: Path, tmp: Path):
with zipfile.ZipFile(apkg_path) as zf:
zf.extract("collection.anki2", tmp)
media = json.loads(zf.read("media").decode("utf-8"))
names = set(zf.namelist())
return tmp / "collection.anki2", media, names
class TestResolveShuffleSeed(unittest.TestCase):
"""Unit coverage for the shuffle-seed resolution itself.
The CLI-level test patches `resolve_shuffle_seed` out, so the
actual default-seed behavior is only exercised here.
"""
def test_explicit_seed_is_passed_through(self):
self.assertEqual(aa.resolve_shuffle_seed("my-seed"), "my-seed")
def test_omitted_seed_mints_a_fresh_value_each_call(self):
first = aa.resolve_shuffle_seed(None)
second = aa.resolve_shuffle_seed(None)
self.assertIsInstance(first, str)
self.assertTrue(first)
self.assertNotEqual(first, second)
class TestAnkiBuild(unittest.TestCase):
def setUp(self):
self.tmp = tempfile.TemporaryDirectory()
self.addCleanup(self.tmp.cleanup)
self.root = Path(self.tmp.name)
self.data_dir = make_fetched_data(self.root)
self.out_dir = self.root / "anki"
# Hermetic explanations file: empty by default so tests don't
# pick up the real repo's explanations.json via the CLI
# default. Individual tests overwrite this file as needed.
self.explanations_path = self.root / "explanations.json"
self.explanations_path.write_text("{}", encoding="utf-8")
def _build_all(self):
return aa.build_all(
self.data_dir,
self.out_dir,
seed="test-seed",
explanations_path=self.explanations_path,
)
def test_builds_one_apkg_per_category(self):
results = self._build_all()
paths = sorted(path.name for path in self.out_dir.glob("*.apkg"))
self.assertEqual(
paths,
[
"amateurfunk-betriebliche-kenntnisse.apkg",
"amateurfunk-kenntnisse-von-vorschriften.apkg",
"amateurfunk-technische-kenntnisse-a.apkg",
"amateurfunk-technische-kenntnisse-e.apkg",
"amateurfunk-technische-kenntnisse-n.apkg",
],
)
by_deck = {r["deck"]: r["questions"] for r in results}
self.assertEqual(
by_deck,
{
"Amateurfunk::Technische Kenntnisse::N": 1,
"Amateurfunk::Technische Kenntnisse::E": 1,
"Amateurfunk::Technische Kenntnisse::A": 1,
"Amateurfunk::Betriebliche Kenntnisse": 1,
"Amateurfunk::Kenntnisse von Vorschriften": 1,
},
)
def test_technische_decks_partition_strictly_by_class_field(self):
self._build_all()
per_class_numbers = {}
for letter in ("n", "e", "a"):
apkg = self.out_dir / f"amateurfunk-technische-kenntnisse-{letter}.apkg"
db_path, _media, _names = extract_collection(apkg, self.root / letter)
conn = sqlite3.connect(db_path)
try:
numbers = [
row[0].split(aa.FIELD_SEP, 1)[0]
for row in conn.execute("select flds from notes")
]
finally:
conn.close()
per_class_numbers[letter.upper()] = sorted(numbers)
self.assertEqual(
per_class_numbers,
{"N": ["NA101"], "E": ["EA202"], "A": ["AA303"]},
)
def test_apkg_contains_notes_cards_and_media(self):
self._build_all()
apkg = self.out_dir / "amateurfunk-technische-kenntnisse-n.apkg"
db_path, media, names = extract_collection(apkg, self.root)
self.assertIn("collection.anki2", names)
self.assertIn("media", names)
self.assertEqual(set(media.values()), {"NA101_q.svg"})
self.assertIn("0", names)
with zipfile.ZipFile(apkg) as zf:
packaged_svg = zf.read("0").decode("utf-8")
self.assertIn('data-af-white-background="1"', packaged_svg)
self.assertIn('fill="#fff"', packaged_svg)
self.assertLess(
packaged_svg.index('data-af-white-background="1"'),
packaged_svg.index("na"),
)
conn = sqlite3.connect(db_path)
try:
note_count = conn.execute("select count(*) from notes").fetchone()[0]
card_count = conn.execute("select count(*) from cards").fetchone()[0]
self.assertEqual(note_count, 1)
self.assertEqual(card_count, 1)
fields = [row[0] for row in conn.execute("select flds from notes")]
finally:
conn.close()
joined = "\n".join(fields)
self.assertIn('src="NA101_q.svg"', joined)
self.assertIn("Richtige Antwort:", joined)
self.assertIn("NA101 richtig", joined)
self.assertIn("Technische Kenntnisse / Grundlagen", joined)
self.assertNotIn("Prüfungsfragen im Prüfungsteil", joined)
def test_answers_are_shuffled_and_back_reveals_display_label(self):
item = aa.QuestionItem(
question=question("TEST123", "1", "Prompt?", None),
path=("Prüfungsfragen im Prüfungsteil: Technische Kenntnisse", "Leaf"),
)
media = aa.MediaRegistry(self.root / "missing")
front, back, correct_label = aa.render_question(item, media, "seed")
self.assertIn("Richtige Antwort:", back)
self.assertIn(f"Richtige Antwort: {correct_label}", back)
self.assertIn("TEST123 richtig", back)
# The answer texts should not be in their upstream A/B/C/D order.
positions = [
front.index("TEST123 richtig"),
front.index("TEST123 falsch B"),
front.index("TEST123 falsch C"),
front.index("TEST123 falsch D"),
]
self.assertNotEqual(positions, sorted(positions))
def test_latex_is_converted_to_mathjax_and_text_is_escaped(self):
rendered = aa.text_html("Leistung < $P = U \\cdot I$ & $a < b$")
self.assertIn("Leistung < ", rendered)
self.assertIn(r"\(P = U \cdot I\)", rendered)
self.assertIn(r"\(a < b\)", rendered)
self.assertIn(" & ", rendered)
self.assertNotIn("$P =", rendered)
def test_catalog_underline_markup_is_preserved_safely(self):
rendered = aa.text_html("foo nicht 2 < 3 ")
self.assertIn("nicht", rendered)
self.assertIn("2 < 3", rendered)
self.assertIn("<script>x</script>", rendered)
def test_underline_inside_math_is_escaped_not_rendered_as_html(self):
rendered = aa.text_html("$x$")
self.assertEqual(rendered, r"\(<u>x</u>\)")
def test_tags_use_license_letters_and_skip_singleton_number_tag(self):
item = aa.QuestionItem(
question=question("NA101", "1", "Prompt?", None),
path=("Prüfungsfragen im Prüfungsteil: Technische Kenntnisse", "Leaf"),
)
tags = aa.tags_for_item(item)
self.assertIn(" klasse-N ", tags)
self.assertNotIn(" klasse-1 ", tags)
self.assertNotIn("nummer-NA101", tags)
def test_breadcrumb_strips_verbose_pruefungsteil_prefix(self):
item = aa.QuestionItem(
question=question("TEST123", "1", "Prompt?", None),
path=("Prüfungsfragen im Prüfungsteil: Technische Kenntnisse", "Leaf"),
)
front, _back, _label = aa.render_question(
item,
aa.MediaRegistry(self.root / "missing"),
"seed",
)
self.assertIn("Technische Kenntnisse / Leaf", front)
self.assertNotIn("Prüfungsfragen im Prüfungsteil", front)
def test_answer_choice_pictures_follow_shuffle(self):
media_dir = self.root / "media"
media_dir.mkdir()
(media_dir / "TEST123_a.svg").write_text("", encoding="utf-8")
(media_dir / "TEST123_b.svg").write_text("", encoding="utf-8")
q = question("TEST123", "1", "Prompt?", None)
q["picture_a"] = "TEST123_a"
q["picture_b"] = "TEST123_b"
item = aa.QuestionItem(
question=q,
path=("Prüfungsfragen im Prüfungsteil: Technische Kenntnisse", "Leaf"),
)
media = aa.MediaRegistry(media_dir)
front, back, _label = aa.render_question(item, media, "seed")
self.assertIn('src="TEST123_a.svg"', front)
self.assertIn('src="TEST123_b.svg"', front)
self.assertIn('src="TEST123_a.svg"', back)
self.assertEqual({p.name for p in media.used_paths}, {"TEST123_a.svg", "TEST123_b.svg"})
def test_svg_white_background_injection_is_idempotent(self):
svg = ''
once = aa.svg_with_white_background(svg)
twice = aa.svg_with_white_background(once)
self.assertEqual(once, twice)
self.assertIn(''
'https://example.invalid/ohms-law',
joined,
)
def test_low_confidence_explanation_shows_badge(self):
item = aa.QuestionItem(
question=question("TEST123", "1", "Prompt?", None),
path=("Prüfungsfragen im Prüfungsteil: Technische Kenntnisse", "Leaf"),
)
low = {"TEST123": {
"revision": 1,
"explanation": "Weak guess.",
"source": "TBD",
"confidence": aa.LOW_CONFIDENCE_THRESHOLD - 1,
}}
high = {"TEST123": {
"revision": 1,
"explanation": "Solid reasoning.",
"source": "AFuV §1",
"confidence": aa.LOW_CONFIDENCE_THRESHOLD,
}}
media = aa.MediaRegistry(self.root / "missing")
_f1, back_low, _l1 = aa.render_question(item, media, "seed", low)
_f2, back_high, _l2 = aa.render_question(item, media, "seed", high)
self.assertIn("af-explanation-low-confidence", back_low)
self.assertIn("low confidence", back_low)
self.assertNotIn("af-explanation-low-confidence", back_high)
self.assertNotIn("low confidence", back_high)
def test_missing_explanation_leaves_card_unchanged(self):
self._build_all()
apkg = self.out_dir / "amateurfunk-technische-kenntnisse-e.apkg"
db_path, _media, _names = extract_collection(apkg, self.root / "e")
conn = sqlite3.connect(db_path)
try:
fields = [row[0] for row in conn.execute("select flds from notes")]
finally:
conn.close()
self.assertNotIn("af-explanation", "\n".join(fields))
def test_non_url_source_is_rendered_as_plain_text(self):
item = aa.QuestionItem(
question=question("TEST123", "1", "Prompt?", None),
path=("Prüfungsfragen im Prüfungsteil: Technische Kenntnisse", "Leaf"),
)
explanations = {
"TEST123": {
"revision": 1,
"explanation": "Because $P = U \\cdot I$ and the spec fixes P.",
"source": "AFuV §16(2)",
"confidence": 9,
}
}
_front, back, _label = aa.render_question(
item, aa.MediaRegistry(self.root / "missing"), "seed", explanations,
)
self.assertIn("AFuV §16(2)", back)
self.assertNotIn("