Fix build warnings, improve tests, remove some passthru tables

- fix meson warning re buildtype and optimization
- remove BASE, DSIG, COLR, CPAL, CFF2 from set of passthru tables
- separate test suite into 3 groups and do tighter checks on results; improve reporting
- a couple of other minor tweaks

Author: josh-hadley

.github/workflows/run_tests.yml

@@ -46,4 +46,4 @@ jobs:
     
     - name: Test with pytest
       run: |
-        pytest tests
+        pytest -v tests

build.py

@@ -29,9 +29,9 @@
 MESON_CMD = [
     TOOLS["meson"],
     "--backend=ninja",
-    "--buildtype=release",
-    "--strip",
     "-Ddebug=true",
+    "-Doptimization=3",
+    "--default-library=static",
     "--force-fallback-for=libbrotlidec,liblz4",
     str(BUILD_DIR),
     str(OTS_SRC_DIR),

setup.py

@@ -294,8 +294,8 @@ def run(self):
     classifiers=classifiers,
     description='Python wrapper for ot-sanitizer',
     ext_modules=[pyots_mod],
-    long_description=long_description,
     long_description_content_type='text/markdown',
+    long_description=long_description,
     name='pyots',
     packages=find_packages('src'),
     package_dir={'': 'src'},

src/_pyots/pyots-context.h

@@ -17,7 +17,7 @@ class PyOTSContext: public OTSContext {
  public:
   explicit PyOTSContext(int level): level_(level) { }
   std::stringstream msgs;
-  bool modified;
+  bool modified = false;
 
   void Message(int level, const char *format, ...) {
     va_list va;
@@ -46,16 +46,8 @@ class PyOTSContext: public OTSContext {
 
   TableAction GetTableAction(uint32_t tag) {
     switch (tag) {
-      // ots seems to drop these silently
-      case OTS_TAG('B', 'A', 'S', 'E'):
-      case OTS_TAG('D', 'S', 'I', 'G'):
-
-      // from chromium project -- various color tables
       case OTS_TAG('C', 'B', 'D', 'T'):
       case OTS_TAG('C', 'B', 'L', 'C'):
-      case OTS_TAG('C', 'O', 'L', 'R'):
-      case OTS_TAG('C', 'P', 'A', 'L'):
-      case OTS_TAG('C', 'F', 'F', '2'):
       case OTS_TAG('s', 'b', 'i', 'x'):
 
         return TABLE_ACTION_PASSTHRU;

src/pyots/__init__.py

@@ -16,7 +16,7 @@ def __init__(self, raw_tuple):
         self.messages = tuple(raw_tuple[2].split("\n"))
 
 
-def sanitize(input, output=None, quiet=False, font_index=-1) -> tuple:
+def sanitize(input, output=None, quiet=False, font_index=-1) -> OTSResult:
     """
     Sanitize a file. Options:
         output      path for output file. If not specified, no output will be

tests/test_ots_suite.py

@@ -1,26 +1,71 @@
-import os
+from pathlib import Path
 
 import pyots
 
-test_folder = os.path.realpath(os.path.dirname(__file__))
+ROOT = Path(__file__).parent.parent.resolve()
+test_folder = ROOT / "tests"
 
 
-def test_ots_suite():
+def test_ots_good():
 
-    tld = os.path.join(test_folder, "..", "src", "ots", "tests", "fonts")
-    dirs = ['bad', 'fuzzing', 'good']
+    tld = ROOT / "src" / "ots" / "tests" / "fonts" / "good"
 
-    for d in dirs:
-        for f in os.listdir(os.path.join(tld, d)):
-            base, ext = os.path.splitext(f)
-            if ext.lower() not in ('.ttf', '.woff', '.ttc', '.woff2', '.otf'):
-                continue
+    count = 0
+    for f in tld.iterdir():
+        ext = f.suffix
+        if ext.lower() not in ('.ttf', '.woff', '.ttc', '.woff2', '.otf'):
+            continue
 
-            r = pyots.sanitize(os.path.join(tld, d, f))
+        r = pyots.sanitize(f)
 
-            if not r.sanitized and d != "bad":
-                pp = f"{d}/{f}"
-                assert f"{pp}" in EXPECT_FAIL, f"{pp} not sanitized and not in expected failures"  # noqa: E501
+        if not r.sanitized:
+            count += 1
+            print("[good] unexpected failure on", f, "\n".join(r.messages))
+
+    assert not count, f"{count} file{'s' if count != 1 else ''} failed when expected to be sanitized."  # noqa: E501
+
+
+def test_ots_bad():
+
+    tld = ROOT / "src" / "ots" / "tests" / "fonts" / "bad"
+
+    count = 0
+    for f in tld.iterdir():
+        ext = f.suffix
+        if ext.lower() not in ('.ttf', '.woff', '.ttc', '.woff2', '.otf'):
+            continue
+
+        r = pyots.sanitize(f)
+
+        if r.sanitized:
+            count += 1
+            print("[bad] unexpected success on", f, "\n".join(r.messages))
+
+    assert not count, f"{count} file{'s were' if count != 1 else 'was'} sanitized when expected to be sanitized."  # noqa: E501
+
+
+def test_ots_fuzzing():
+
+    tld = ROOT / "src" / "ots" / "tests" / "fonts" / "fuzzing"
+
+    count = 0
+    for f in tld.iterdir():
+        ext = f.suffix
+        if ext.lower() not in ('.ttf', '.woff', '.ttc', '.woff2', '.otf'):
+            continue
+
+        r = pyots.sanitize(f)
+
+        if str(f.relative_to(ROOT / "src" / "ots" / "tests" / "fonts")) in EXPECT_FAIL:  # noqa: E501
+            if r.sanitized:
+                count += 1
+                print("[fuzzing] unexpected success on", f, "\n".join(r.messages))  # noqa: E501
+        else:
+            if not r.sanitized:
+                count += 1
+                print("[fuzzing] unexpected failure on", f, "\n".join(r.messages))  # noqa: E501
+
+    assert not count, f"{count} file{'s' if count != 1 else ''} had an unexpected sanitization result."  # noqa: E501
 
 
 EXPECT_FAIL = {
@@ -63,4 +108,5 @@ def test_ots_suite():
     'fuzzing/8240789f6d12d4cfc4b5e8e6f246c3701bcf861f.otf',
     'fuzzing/3857535d8c0d2bfeab7ee2cd6ba5e39bcb4abd90.ttf',
     'fuzzing/adb242cbc61b3ca428903e397a2c9dcf97fe3042.ttf',
+    'fuzzing/2a12de12323bfd99b9c4bb33ed20b66b8ff0915f.otf',
 }