ShowIcons: code cleanup, return ordered list, use os.scandir and add a test

Author: UlrichB22

src/moin/macros/ShowIcons.py

@@ -10,8 +10,6 @@
 
 
 import os
-from os import listdir
-from os.path import isfile, join
 
 from flask import url_for
 
@@ -27,15 +25,13 @@ def macro(self, content, arguments, page_url, alternative):
         icon_dir = os.path.join(os.path.split(my_dir)[0], "static", "img", "icons")
 
         headings = (_("Markup"), _("Result"))
-        files = [f for f in listdir(icon_dir) if isfile(join(icon_dir, f))]
         rows = []
-        for filename in files:
-            markup = f"<<Icon({filename})>>"
-            src = url_for("static", filename="img/icons/" + filename)
-            # TODO: add alt attribute for img and add a macro test module
-            # reason = _('Icon not rendered, verify name is valid')
-            # alt = '<<Icon({0})>> - {1}'.format(filename, reason)
-            rows.append((markup, html.img(attrib={html.src: src, html.alt: filename})))
+        with os.scandir(icon_dir) as files:
+            for file in files:
+                if not file.name.startswith(".") and file.is_file():
+                    markup = f"<<Icon({file.name})>>"
+                    src = url_for("static", filename="img/icons/" + file.name)
+                    rows.append((markup, html.img(attrib={html.src: src, html.alt: file.name})))
         table = TableMixin()
-        ret = table.build_dom_table(rows, head=headings)
+        ret = table.build_dom_table(sorted(rows), head=headings)
         return ret

src/moin/macros/_tests/test_ShowIcons.py

@@ -0,0 +1,32 @@
+# Copyright: 2024 MoinMoin:UlrichB
+# License: GNU GPL v2 (or any later version), see LICENSE.txt for details.
+
+"""
+Test for macros.ShowIcons
+"""
+
+from moin.macros.ShowIcons import Macro
+
+
+def test_ShowIconsMacro():
+    """Call ShowIcons macro and test output"""
+    test_icons = ["admon-note", "angry", "biggrin", "frown", "moin-rss", "smile3", "star_off"]
+    expected_namespace = "{http://moinmo.in/namespaces/page}"
+    expected_tags = set(f"{expected_namespace}{el_name}" for el_name in ["table", "table-header", "table-row"])
+    expected_texts = set(f"<<Icon({icon_name}.png)>>" for icon_name in test_icons)
+    expected_paths = set(f"/static/img/icons/{icon_name}.png" for icon_name in test_icons)
+    macro_obj = Macro()
+    macro_out = macro_obj.macro("content", None, "page_url", "alternative")
+    result_tags = set()
+    result_texts = set()
+    result_paths = set()
+    for node in macro_out.iter_elements_tree():
+        if getattr(node, "tag"):
+            result_tags.add(str(getattr(node, "tag")))
+        if getattr(node, "text"):
+            result_texts.add(getattr(node, "text"))
+        if getattr(node, "attrib"):
+            result_paths.update(getattr(node, "attrib").values())
+    assert expected_tags.issubset(result_tags)
+    assert expected_texts.issubset(result_texts)
+    assert expected_paths.issubset(result_paths)