-
-
- {props.get("name") or "Unamed"}
-Test Skipped
-
- """
- print(f"{vt100.YELLOW}○{vt100.RESET}", end="", flush=True)
- continue
-
- test_report = ""
-
- search = re.search(r"""([\w\W]+?) """, test)
- container = search and search.group(1)
- if not container:
- container = 'Reftest
+
+
+
+
+
+ Reftest report
+
+ """
+ self.testHtml = ""
+
+ def addTestCase(self, testId: int, passed: bool, test: TestCase):
+
+ addInfos = " - ".join(test.addInfos)
+ self.testHtml += f"""
+ ]*)>([\w\W]+?)""")
+REG_CONTAINER = re.compile(r"""([\w\W]+?) """)
+
+DEFAULT_CONTAINER = '
-
-
- """
-
- counter += 1
-
- if args.fast:
- break
- report += f"""
- {counter} - {tag} {add_infos}
-{help}
-
-
- Reference
- Source
-
- 
- Actual
-
-
-
- 
- {"Reference" if (tag == "rendering") else "Unexpected"}
-
-
-
-
- Rendition
-
-
-
- """
- print()
- report += f"""
-
- """
-
- report += """
-
-
-
-
-
-
- """
-
- with (TEST_REPORT / "report.html").open("w") as f:
- f.write(report)
-
- if not args.headless:
- if shell.which("xdg-open"):
- shell.exec("xdg-open", str(TEST_REPORT / "report.html"))
- elif shell.which("open"):
- shell.exec("open", str(TEST_REPORT / "report.html"))
-
- print()
- if failed:
- print(f"{vt100.BRIGHT_GREEN}// {fetchMessage(args, 'witty')}{vt100.RESET}")
- print(
- f"{vt100.RED}Failed {failed} tests{vt100.RESET}, {vt100.GREEN}Passed {passed} tests{vt100.RESET}"
- )
- print(f"Report: {TEST_REPORT / 'report.html'}")
-
- print()
- print("Failed tests details:")
- print(test_failed)
- raise RuntimeError("Some tests failed")
- else:
- print(f"{vt100.GREEN}// {fetchMessage(args, 'nice')}{vt100.RESET}")
- print(f"{vt100.GREEN}All tests passed{vt100.RESET}")
- print(f"Report: {TEST_REPORT / 'report.html'}")
diff --git a/meta/plugins/reftests/CLIReport.py b/meta/plugins/reftests/CLIReport.py
new file mode 100644
index 00000000..f242de1c
--- /dev/null
+++ b/meta/plugins/reftests/CLIReport.py
@@ -0,0 +1,48 @@
+from cutekit import model, vt100, const
+from pathlib import Path
+
+from .utils import fetchMessage
+from .Test import TestCase
+from .reporter import Reporter
+
+
+class CLIReport(Reporter):
+ """
+ Object to abstract the generation of the cli report for the reftests.
+ """
+
+ def __init__(self, SOURCE_DIR: Path, TEST_REPORT: Path):
+ self.TEST_REPORT: Path = TEST_REPORT
+
+ def addTestCase(self, testId: int, passed: bool, test: TestCase):
+ if passed:
+ print(f"{vt100.GREEN}●{vt100.RESET}", end="", flush=True)
+ else:
+ print(f"{vt100.RED}●{vt100.RESET}", end="", flush=True)
+
+ def addTestCategory(self, testId: int, props, file: Path, passCount: int, failCount: int, skippedCount: int):
+ pass
+
+ def addSkippedFile(self, testId: int, props):
+ print(f"{vt100.YELLOW}○{vt100.RESET}", end="", flush=True)
+
+ def addSkippedCase(self):
+ print(f"{vt100.YELLOW}○{vt100.RESET}", end="", flush=True)
+
+ def finish(self, manifests: model.Registry, totalFailed: int, totalPassed: int, totalSkipped: int, context):
+ print()
+ if totalFailed:
+ print(f"{vt100.BRIGHT_GREEN}// {fetchMessage(manifests, 'witty')}{vt100.RESET}")
+ print(
+ f"{vt100.RED}Failed {totalFailed} tests{vt100.RESET}, {vt100.GREEN}Passed {totalPassed} tests{vt100.RESET}"
+ )
+ print(f"Report: {self.TEST_REPORT / 'report.html'}")
+
+ print()
+ print("Failed tests details:")
+ print(context.testFailed)
+ raise RuntimeError("Some tests failed")
+ else:
+ print(f"{vt100.GREEN}// {fetchMessage(manifests, 'nice')}{vt100.RESET}")
+ print(f"{vt100.GREEN}All tests passed{vt100.RESET}")
+ print(f"Report: {self.TEST_REPORT / 'report.html'}")
diff --git a/meta/plugins/reftests/Test.py b/meta/plugins/reftests/Test.py
new file mode 100644
index 00000000..ae88afe4
--- /dev/null
+++ b/meta/plugins/reftests/Test.py
@@ -0,0 +1,102 @@
+from pathlib import Path
+from cutekit import const
+import textwrap
+import re
+
+TEST_REPORT = (Path(const.PROJECT_CK_DIR) / "tests" / "report").absolute()
+
+
+class TestReference:
+ def __init__(self, path: Path, imagePath: Path, image: bytes | None = None):
+ self.path = path # path to the reference document
+ self.imagePath = imagePath
+ self.image = image
+
+
+class TestCase:
+ def __init__(self, props, inputPath, outputPath, context, tag, testDocument, caseProps,
+ container=None, reference: TestReference | None = None):
+ self.outputImage: bytes | None = None
+ self.addInfos = []
+
+ self.type = props.get("type") # the type of test [render (default) | print]
+ self.xsize = props.get("size", "200")
+ self.ysize = self.xsize
+
+ if props.get("size") == "full":
+ self.xsize = "800"
+ self.ysize = "600"
+
+ self.page = props.get("page") # page size
+ self.inputPath = inputPath # path to test case's document
+ self.outputPath = outputPath # path to the output image
+ self.context = context
+ self.ref = reference
+ self.help = caseProps.get("help", "")
+ self.tag = tag # test tag [rendering | error]
+
+ if not container:
+ container = '
-
- {test_report}
- {props.get("name")} -
{props.get("help") or ""}
- Source - {passCount} passed, {failCount} failed and {skippedCount} skipped -
+
+
+ """
+
+ def addSkippedCase(self):
+ pass
+
+ def addTestCategory(self, testId: int, props, file: Path, passCount: int, failCount: int, skippedCount: int):
+ self.html += f"""
+ {testId} - {test.tag} {addInfos}
+{test.help}
+
+
+ Reference
+ Source
+
+ 
+ Actual
+
+
+
+ 
+ {"Reference" if (test.tag == "rendering") else "Unexpected"}
+
+
+
+
+ Rendition
+
+
+
+ """
+ self.testHtml = ""
+
+ def addSkippedFile(self, testId: int, props):
+ self.html += f"""
+
+
+ {self.testHtml}
+ {props.get("name")}
+{props.get("help") or ""}
+ Source + {passCount} passed, {failCount} failed and {skippedCount} skipped +
+
+ """
+
+ def finish(self, manifests: model.Registry, totalFailed: int, totalPassed: int, totalSkipped: int, context):
+ self.html += f"""
+
+
+
+
+ """
+ with (self.TEST_REPORT / "report.html").open("w") as f:
+ f.write(self.html)
+
+ # Automatically open the report in the default browser
+ if shell.which("xdg-open"):
+ shell.exec("xdg-open", str(self.TEST_REPORT / "report.html"))
+ elif shell.which("open"):
+ shell.exec("open", str(self.TEST_REPORT / "report.html"))
diff --git a/meta/plugins/reftests/__init__.py b/meta/plugins/reftests/__init__.py
new file mode 100644
index 00000000..12e32259
--- /dev/null
+++ b/meta/plugins/reftests/__init__.py
@@ -0,0 +1 @@
+from . import reftest # noqa E402, F401: Needed for side effect
diff --git a/meta/plugins/reftests/reftest.py b/meta/plugins/reftests/reftest.py
new file mode 100644
index 00000000..038651ea
--- /dev/null
+++ b/meta/plugins/reftests/reftest.py
@@ -0,0 +1,310 @@
+from cutekit import vt100, cli, builder, model, const
+from pathlib import Path
+
+import re
+
+# Local imports
+from .WebReport import WebReport
+from .CLIReport import CLIReport
+from .reporter import Reporter
+from .Test import TestCase, TestReference
+
+SOURCE_DIR: Path = Path(__file__).parent
+TESTS_DIR: Path = SOURCE_DIR.parent.parent.parent / "tests"
+TEST_REPORT: Path = (Path(const.PROJECT_CK_DIR) / "tests" / "report").absolute()
+
+
+def buildPaperMuncher(args: model.TargetArgs) -> builder.ProductScope:
+ """
+ Build paper-muncher with the given target arguments for later use in reftests.
+
+ Args:
+ args: The target arguments, which define the context for the build.
+
+ Returns:
+ The ProductScope result from building paper-muncher.
+
+ Raises:
+ RuntimeError: If the "paper-muncher" component cannot be found.
+ """
+
+ scope = builder.TargetScope.use(args)
+ PmComponent = scope.registry.lookup("paper-muncher", model.Component)
+ if PmComponent is None:
+ raise RuntimeError("paper-muncher not found")
+ return builder.build(scope, PmComponent)[0]
+
+
+class RefTestArgs(model.TargetArgs):
+ glob: str = cli.arg("g", "glob", "Glob pattern to match test files")
+ headless: bool = cli.arg(
+ None, "headless", "Run the tests without opening the report."
+ )
+ fast: bool = cli.arg(
+ None, "fast", "Proceed to the next test as soon as an error occurs."
+ )
+ runSkipped: bool = cli.arg(None, "run-skipped", "Run the skipped tests nonetheless")
+
+
+class TestResults:
+ """Tracks test execution results."""
+
+ def __init__(self) -> None:
+ self.passed: int = 0
+ self.failed: int = 0
+ self.skipped: int = 0
+ self.failedDetails: str = ""
+
+ def addPassed(self) -> None:
+ self.passed += 1
+
+ def addFailed(self, details: str = "") -> None:
+ self.failed += 1
+ if details:
+ self.failedDetails += details
+
+ def addSkipped(self) -> None:
+ self.skipped += 1
+
+ def merge(self, other: 'TestResults') -> None:
+ """Merge another TestResults into this one."""
+ self.passed += other.passed
+ self.failed += other.failed
+ self.skipped += other.skipped
+ self.failedDetails += other.failedDetails
+
+
+class TestRunnerContext:
+ """Context for test execution containing shared state and configuration."""
+
+ def __init__(self, args: RefTestArgs, paperMuncher: builder.ProductScope, reporters: list[Reporter]) -> None:
+ self.reporters: list[Reporter] = reporters
+ self.args: RefTestArgs = args
+ self.paperMuncher: builder.ProductScope = paperMuncher
+ self.currentTestId: int = 0
+ self.results: TestResults = TestResults()
+
+ def nextTestId(self) -> int:
+ """Get the current test ID and increment for next test."""
+ testId = self.currentTestId
+ self.currentTestId += 1
+ return testId
+
+ def shouldRunSkipped(self) -> bool:
+ """Check if skipped tests should be run."""
+ return self.args.runSkipped
+
+ def shouldStopOnFailure(self) -> bool:
+ """Check if execution should stop on first failure."""
+ return self.args.fast
+
+
+REG_INFO = re.compile(r"""(\w+)=['"]([^'"]+)['"]""")
+REG_TESTS = re.compile(r"""<(rendering|error)([^>]*)>([\w\W]+?)""")
+REG_TEST_BLOCKS = re.compile(r"""
+
+ {props.get("name") or "Unnamed"}
+Test Skipped
+