Merge pull request #310 from w3c/fxl-roll-rearrange

Rearranging tests with fxl terminology change + roll layout

Author: iherman

.gitignore

@@ -36,6 +36,8 @@ tests/.DS_Store
 .vscode/
 
 tests/*.epub
+check
+
 
 
 check

generate/config.json

@@ -34,7 +34,8 @@
         "Internationalization",
         "Content Documents",
         "Navigation Documents",
-        "Fixed Layout",
+        "Pre-paginated Layout",
+        "Roll Layout",
         "Open Container Format",
         "Scripting",
         "Media Overlays",

generate/fragments/complete_results.html

@@ -6,6 +6,7 @@
     <li>Marisa DeMeglio</li>
     <li>Matt Garrish</li>
     <li>Matthew Chan</li>
+    <li>Susan Neuhaus</li>
     <li>Wendy Reid</li>
     <li>Zheng Xu</li>
 </ul>

generate/fragments/consolidated_results.html

@@ -36,6 +36,7 @@ import { getTestData, getReportData, getTemplate }                            fr
 import { createReport }                                                       from "./lib/html.ts";
 import { applyConfigurationOptions }                                          from './lib/config.ts';
 import { type OPDS, createOPDS }                                              from './lib/opds.ts';
+import { Command }                                                            from 'commander';
 
 
 /**
@@ -52,6 +53,18 @@ async function adjust_date(fname: string): Promise<void> {
  * Main entry point: generate the reports' html fragment files (i.e., the real "meat" for the data) and a template file
  */
 async function main() {
+    const program = new Command();
+    program
+        .name('generate')
+        .description('Generation of the EPUB 3 test descriptions and test results')
+        .usage('[options')
+        .option('-d --debug', 'run the script on the debug test suite')
+        .option('-f --full', 'run in full mode, ie, include the deprecated tests in the output')
+        .parse(["", "", ...Deno.args]);
+    const options = program.opts();
+    const debug = options.debug ?? false;
+    const full  = options.full ?? false;
+
     // Get the final data for files and directories, depending on the debug flag
     const [
         TESTS_DIR,
@@ -65,10 +78,10 @@ async function main() {
         OPDS,
         DOC_TEST_RESULTS,
         DOC_TEST_DESCRIPTIONS
-    ] = Constants.final_constants((Deno.args.length > 0 && Deno.args[0] === '-d'));
+    ] = Constants.final_constants(debug);
 
     const test_data: TestData[]              = await getTestData(TESTS_DIR);
-    const report_data: ReportData            = await getReportData(test_data, TEST_RESULTS_DIR);
+    const report_data: ReportData            = await getReportData(test_data, TEST_RESULTS_DIR, full);
     const template: Raw_ImplementationReport = getTemplate(report_data);
 
     const final_report_data: ReportData = applyConfigurationOptions(report_data);

generate/fragments/creators.html

@@ -1,7 +1,7 @@
 {
     "description": "Generation of index and resolutions' files for EPUB tests and test results.",
     // Version 1.1.0 adds the concept and management of deprecated tests
-    "version": "1.1.0.",
+    "version": "1.1.1.",
     "compilerOptions": {
         "lib": ["dom", "dom.iterable", "dom.asynciterable", "esnext", "deno.ns"]
     },
@@ -22,13 +22,21 @@
     },
     "tasks": {
         "generate": {
-            "description": "This is the command ran via a github action: run all the report generation.",
+            "description": "This is the command ran via a github action: run all the report generation. Deprecated tests are ignored.",
             "command": "deno run -A create_report.ts"
         },
+        "generate-full": {
+            "description": "This is the command ran via a github action: run all the report generation. Deprecated tests are included.",
+            "command": "deno run -A create_report.ts -f"
+        },
         "debug-generate": {
-            "description": "Run the generation script, but on the 'debug/tests' folder; saves running the script on the full test suite.",
+            "description": "Run the generation script, but on the 'debug/tests' folder; saves running the script on the full test suite. Deprecated tests are ignored",
             "command": "deno run -A create_report.ts -d"
         },
+        "debug-generate-full": {
+            "description": "Run the generation script, but on the 'debug/tests' folder; saves running the script on the full test suite. Deprecated tests are included.",
+            "command": "deno run -A create_report.ts -df"
+        },
         "manage": {
             "description": "This is the command ran via a github action: create all the epub files.",
             "command": "deno run -A manage_tests.ts"

generate/fragments/tests.html

@@ -466,7 +466,7 @@ export async function getTestData(dir_name: string): Promise<TestData[]> {
  * @param test_data all the metadata for all tests
  * @param reports directory where the implementation reports reside
  */
-export async function getReportData(test_data: TestData[], reports: string): Promise<ReportData> {
+export async function getReportData(test_data: TestData[], reports: string, full: boolean): Promise<ReportData> {
     const sort_test_data = (all_tests: TestData[]): TestData[] => {
         const required_tests:   TestData[] = [];
         const optional_tests:   TestData[] = [];
@@ -483,7 +483,9 @@ export async function getReportData(test_data: TestData[], reports: string): Pro
         }
 
         for (const test of all_tests) {
-            get_array(test.required).push(test);
+            // unless explicitly required in the command line, deprecated tests are ignored
+            if (!(test.required === ReqType.deprecated && full === false))
+                get_array(test.required).push(test);
         }
 
         // This is, most of the times, unnecessary, because the directory reading has an alphabetic order already.

generate/src/create_report.ts

@@ -119,7 +119,7 @@
 			}
 
             tr.deprecated td:nth-child(2)::after {
-                content: " (Feature is deprecated.)"
+                content: " (Test is deprecated.)"
 
             }
 
@@ -134,7 +134,7 @@
 				latestVersion: "https://w3c.github.io/epub-tests/",
 				specStatus: "base",
 				noRecTrack: true,
-                publishDate: "2025-11-21",
+                publishDate: "2026-01-14",
 				shortName: "epub-tests",
 				edDraftURI: "https://w3c.github.io/epub-tests/",
                 copyrightStart: "2021",