bunch o tests

Author: Redbot

tests/test_github_alerts.py

@@ -0,0 +1,41 @@
+from md2bbcode.main import process_readme
+
+
+def test_github_alert_blockquote_renders_as_admonition():
+    for kind in ["note", "tip", "important", "warning", "caution"]:
+        markdown = f"""> [!{kind.upper()}]
+> Body for {kind}.
+""".lstrip()
+
+        result = process_readme(markdown, domain="")
+        lowered = result.lower()
+
+        assert f"[admonition={kind}]" in lowered
+        assert f"body for {kind}." in lowered
+        assert f"[!{kind}]" not in lowered
+
+
+def test_normal_blockquote_is_not_admonition():
+    markdown = """> Just a quote.
+> Still quoted.
+""".lstrip()
+
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[quote]" in lowered
+    assert "[admonition=" not in lowered
+
+
+def test_unknown_alert_marker_does_not_trigger_admonition():
+    markdown = """> [!FOO]
+> Not a supported GitHub alert type.
+""".lstrip()
+
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[quote]" in lowered
+    assert "[admonition=" not in lowered
+    assert "[!foo]" in lowered
+

tests/test_html2bbcode_font_handling.py

@@ -0,0 +1,41 @@
+from md2bbcode.main import process_readme
+
+
+def test_html_font_tag_converts_to_xf_bbcode():
+    markdown = '<font color="red" size="3" face="Times New Roman">Hello</font>\n'
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[color=red]" in lowered
+    assert "[size=3]" in lowered
+    assert "[font=times new roman]hello[/font]" in lowered
+    assert "[/size][/color]" in lowered
+
+
+def test_html_style_attribute_converts_to_xf_bbcode():
+    markdown = (
+        '<span style="color: #f00; font-size: 12px; font-family: Arial; '
+        'font-weight: bold; font-style: italic; text-decoration: underline line-through;">X</span>\n'
+    )
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[color=#f00]" in lowered
+    assert "[size=12px]" in lowered
+    assert "[font=arial]" in lowered
+    assert "[b]" in lowered
+    assert "[i]" in lowered
+    assert "[u]" in lowered
+    assert "[s]" in lowered
+
+
+def test_inline_code_does_not_convert_html_inside_icode():
+    markdown = '<font color="red">Red</font> and `<font color="red">Code</font>`\n'
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    # Outside inline code: should convert
+    assert "[color=red]" in lowered
+    # Inside inline code: should remain literal HTML, not converted
+    assert '[icode]<font color="red">code</font>[/icode]' in lowered
+

tests/test_html2bbcode_tags.py

@@ -0,0 +1,111 @@
+from md2bbcode.main import process_readme
+
+
+def test_html_basic_formatting_and_links():
+    markdown = (
+        "<b>bold</b> <i>italic</i> <u>under</u> <s>strike</s> "
+        "<ins>insert</ins> <mark>mark</mark> <kbd>kbd</kbd><br>"
+        "<a href=\"https://example.com\">link</a> "
+        "<img src=\"https://example.com/x.png\" alt=\"alt text\">"
+        "<hr>"
+    )
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[b]bold[/b]" in lowered
+    assert "[i]italic[/i]" in lowered
+    assert "[u]under[/u]" in lowered
+    assert "[s]strike[/s]" in lowered
+    assert "[u]insert[/u]" in lowered
+    assert "[mark]mark[/mark]" in lowered
+    assert "[icode]kbd[/icode]" in lowered
+    assert "[url=https://example.com]link[/url]" in lowered
+    assert "[img alt=\"alt text\"]https://example.com/x.png[/img]" in lowered
+    assert "[hr][/hr]" in lowered
+
+
+def test_html_code_blocks_and_inline_code():
+    markdown = (
+        "<pre><code class=\"language-python\">print('hi')</code></pre>"
+        " and <code>inline</code>"
+    )
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[code=python]print('hi')[/code]" in lowered
+    assert "[icode]inline[/icode]" in lowered
+
+
+def test_html_lists_and_tables():
+    markdown = (
+        "<ul><li>One</li><li>Two</li></ul>"
+        "<ol><li>First</li><li>Second</li></ol>"
+        "<table>"
+        "<tr><th>H</th><th>H2</th></tr>"
+        "<tr><td>A</td><td>B</td></tr>"
+        "</table>"
+    )
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[list]" in lowered
+    assert "[*]one" in lowered
+    assert "[*]two" in lowered
+    assert "[list=1]" in lowered
+    assert "[*]first" in lowered
+    assert "[*]second" in lowered
+    assert "[table]" in lowered
+    assert "[tr]" in lowered
+    assert "[th]h[/th]" in lowered
+    assert "[td]a[/td]" in lowered
+
+
+def test_html_anchor_and_abbr():
+    markdown = (
+        "<a name=\"section\">Target</a> "
+        "<a href=\"#section\">Jump</a> "
+        "<abbr title=\"World Health Organization\">WHO</abbr>"
+    )
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[aname=section]target[/aname]" in lowered
+    assert "[jumpto=section]jump[/jumpto]" in lowered
+    assert "[abbr=world health organization]who[/abbr]" in lowered
+
+
+def test_html_mailto_and_alignment():
+    markdown = (
+        "<a href=\"mailto:test@example.com?subject=Hello\">Email</a> "
+        "<p style=\"text-align:center\">Centered</p>"
+        "<div align=\"right\"><b>Right</b></div>"
+        "<blockquote data-author=\"Alice\">Quoted</blockquote>"
+    )
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[email]test@example.com[/email]" in lowered
+    assert "[center]centered[/center]" in lowered
+    assert "[right][b]right[/b][/right]" in lowered
+    assert "[quote=\"alice\"]" in lowered
+    assert "quoted" in lowered
+
+
+def test_span_and_div_without_style_convert_children():
+    markdown = "<span><b>Bold</b></span><div><i>Italic</i></div>"
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[b]bold[/b]" in lowered
+    assert "[i]italic[/i]" in lowered
+    assert "<span>" not in lowered
+    assert "<div>" not in lowered
+
+
+def test_unknown_html_passthrough():
+    markdown = "<custom-tag data-x=\"1\"><b>Bold</b></custom-tag>"
+    result = process_readme(markdown, domain="")
+
+    assert "<custom-tag data-x=\"1\">" in result
+    assert "<b>Bold</b>" in result
+    assert "[b]" not in result

tests/test_process_readme.py

@@ -1,36 +1,28 @@
 import os
-import sys
-
-# Add the src directory to sys.path
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'src')))
 
 from md2bbcode.main import process_readme
 
+
 def test_conversion():
-    # Read the README.md content from the local file
-    readme_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'README.md'))
-    with open(readme_path, 'r', encoding='utf-8') as file:
+    readme_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "README.md"))
+    with open(readme_path, "r", encoding="utf-8") as file:
         markdown_content = file.read()
 
-    domain = ''  # Set domain if needed
-    debug_mode = False  # Set to True to generate debug files
-
-    # Call the process_readme function with the Markdown content
-    result = process_readme(markdown_content, domain, debug=debug_mode)
+    result = process_readme(markdown_content, domain="")
 
-    # Perform assertions to validate the output
     assert result is not None
     assert isinstance(result, str)
-    
-    # Check for the presence of specific BBCode elements from the new README content
+
     expected_bbcodes = [
         "[img alt",
         "[icode]",
         "[HEADING=1]",
         "[b]",
         "[HEADING=2]",
-        "[CODE=bash]"
+        "[CODE=bash]",
+        "[sup]superscript[/sup]",
     ]
-    
+
+    lowered = result.lower()
     for bbcode in expected_bbcodes:
-        assert bbcode in result, f"Expected BBCode not found: {bbcode}"
+        assert bbcode.lower() in lowered, f"Expected BBCode not found: {bbcode}"

tests/test_redguides_bbcodes.py

@@ -0,0 +1,54 @@
+import os
+import xml.etree.ElementTree as ET
+
+from md2bbcode.main import process_readme
+
+
+def test_redguides_specific_bbcodes_from_xml():
+    repo_root = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
+    bbcode_xml_path = os.path.join(repo_root, "bb_codes.xml")
+
+    tree = ET.parse(bbcode_xml_path)
+    root = tree.getroot()
+    bbcode_defs = [
+        (el.attrib["bb_code_id"].strip().lower(), el.attrib.get("has_option", "no").strip().lower())
+        for el in root.findall(".//bb_code")
+    ]
+
+    # Markdown that exercises every BBCode defined in bb_codes.xml.
+    markdown = """
+Some ==highlighted== text and a footnote.[^1]
+
+![pixel art](https://example.com/pixel.png)
+
+> [!TIP]
+> A GitHub-style alert should become a custom BBCode.
+
+---
+
+Water is H<sub>2</sub>O.
+
+The HTML specification is maintained by the W3C.
+
+*[HTML]: Hyper Text Markup Language
+*[W3C]: World Wide Web Consortium
+
+[^1]: This is the footnote.
+""".lstrip()
+
+    result = process_readme(markdown, domain="")
+    assert result is not None
+    assert isinstance(result, str)
+
+    lowered = result.lower()
+
+    for bb_code_id, has_option in bbcode_defs:
+        if has_option == "yes":
+            assert f"[{bb_code_id}=" in lowered, f"Expected BBCode tag not found: [{bb_code_id}=...]"
+        elif has_option == "optional":
+            assert (
+                f"[{bb_code_id}=" in lowered or f"[{bb_code_id}]" in lowered
+            ), f"Expected BBCode tag not found: [{bb_code_id}] or [{bb_code_id}=...]"
+        else:
+            assert f"[{bb_code_id}]" in lowered, f"Expected BBCode tag not found: [{bb_code_id}]"
+

tests/test_svg_rewrite.py

@@ -0,0 +1,50 @@
+from urllib.parse import quote
+
+from md2bbcode.main import process_readme
+
+
+def test_github_actions_badge_rewrites_to_png():
+    markdown = (
+        "[![Publish to PyPI](https://github.com/RedGuides/md2bbcode/actions/workflows/publish.yml/badge.svg)]"
+        "(https://github.com/RedGuides/md2bbcode/actions/workflows/publish.yml)"
+    )
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "[url=https://github.com/redguides/md2bbcode/actions/workflows/publish.yml]" in lowered
+    assert (
+        "https://raster.shields.io/github/actions/workflow/status/redguides/md2bbcode/publish.yml.png"
+        in lowered
+    )
+
+
+def test_html_svg_wraps_weserv():
+    svg_url = "https://example.com/asset.svg?x=1&y=2"
+    markdown = f'<img src="{svg_url}" alt="Alt text">'
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    expected = f"https://images.weserv.nl/?url={quote(svg_url, safe='')}&output=png"
+    assert expected.lower() in lowered
+    assert '[img alt="alt text"]' in lowered
+
+
+def test_redguides_sparkline_adds_png_format():
+    sparkline_url = (
+        "https://www.redguides.com/community/resources/ghoul-resource.1623/watchers-sparkline"
+        "?months=24&w=500&h=180"
+    )
+    markdown = f'<img src="{sparkline_url}" alt="Watchers">'
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert "watchers-sparkline?months=24&w=500&h=180&format=png" in lowered
+
+
+def test_non_svg_image_unchanged():
+    png_url = "https://example.com/x.png"
+    markdown = f"![alt]({png_url})"
+    result = process_readme(markdown, domain="")
+    lowered = result.lower()
+
+    assert png_url in lowered