Add configurable check for OS/2 achVendID.

com.thetypefounders/check/vendor_id
When a font project's Vendor ID is specified explicitely on FontBakery's configuration file,
all binaries must have a matching vendor identifier value in the OS/2 table.

(PR #3941)

Author: bramstein

CHANGELOG.md

@@ -7,6 +7,9 @@ A more detailed list of changes is available in the corresponding milestones for
 #### Added to the Universal Profile
   - **[com.google.fonts/check/interpolation_issues]:** Check for shape order or curve start point interpolation issues within a variable font. (issue #3930)
 
+#### Added to the Open Type Profile
+  - **[com.thetypefounders/check/vendor_id]:** When a font project's Vendor ID is specified explicitely on FontBakery's configuration file, all binaries must have a matching vendor identifier value in the OS/2 table. (PR #3941)
+
 #### Added to the Google Fonts Profile
   - **[com.google.fonts/check/colorfont_tables]:** Check if fonts contain the correct color tables. (issue #3886)
   - **[com.google.fonts/check/description/noto_has_article]:** Noto fonts must have an ARTICLE.en_us.html file. (issue #3841)

Lib/fontbakery/profiles/opentype.py

@@ -83,6 +83,7 @@
     'com.adobe.fonts/check/varfont/same_size_instance_records',
     'com.adobe.fonts/check/varfont/distinct_instance_records',
     'com.adobe.fonts/check/stat_has_axis_value_tables',
+    'com.thetypefounders/check/vendor_id',
 ]
 
 profile.auto_register(globals())

Lib/fontbakery/profiles/os2.py

@@ -1,5 +1,5 @@
 from fontbakery.callable import check
-from fontbakery.status import FAIL, PASS, WARN, INFO
+from fontbakery.status import FAIL, PASS, WARN, INFO, SKIP
 from fontbakery.message import Message
 # used to inform get_module_profile whether and how to create a profile
 from fontbakery.fonts_profile import profile_factory # NOQA pylint: disable=unused-import
@@ -329,3 +329,40 @@ def com_google_fonts_check_code_pages(ttFont):
                       " ulCodePageRange1 and CodePageRange2 fields.")
     else:
         yield PASS, "At least one code page is defined."
+
+
+@check(
+    id = 'com.thetypefounders/check/vendor_id',
+    rationale = """
+        When a font project's Vendor ID is specified explicitely on FontBakery's
+        configuration file, all binaries must have a matching vendor identifier
+        value in the OS/2 table.
+    """,
+    proposal = 'https://github.com/googlefonts/fontbakery/pull/3941'
+)
+def com_thetypefounders_check_vendor_id(config, ttFont):
+    """Checking OS/2 achVendID against configuration."""
+
+    if "vendor_id" not in config:
+        yield SKIP, ("Add the `vendor_id` key to a `fontbakery.yaml` file"
+                     " on your font project directory to enable this check.\n"
+                     "You'll also need to use the `--configuration` flag when"
+                     " invoking fontbakery.")
+        return
+
+    if "OS/2" not in ttFont:
+        yield FAIL,\
+              Message("lacks-OS/2",
+                      "The required OS/2 table is missing.")
+        return
+
+    config_vendor_id = config['vendor_id']
+    font_vendor_id = ttFont['OS/2'].achVendID
+
+    if config_vendor_id != font_vendor_id:
+        yield FAIL,\
+              Message("bad-vendor-id",
+                      f"OS/2 VendorID is '{font_vendor_id}',"
+                      f" but should be '{config_vendor_id}'.")
+    else:
+        yield PASS, f"OS/2 VendorID '{font_vendor_id}' is correct."

tests/profiles/os2_test.py

@@ -8,6 +8,7 @@
 
 from fontbakery.checkrunner import (INFO, WARN, FAIL)
 from fontbakery.codetesting import (assert_PASS,
+                                    assert_SKIP,
                                     assert_results_contain,
                                     CheckTester,
                                     portable_path,
@@ -219,3 +220,26 @@ def test_check_code_pages():
                            FAIL, "no-code-pages",
                            'with a font with no code page declared.')
 
+def test_check_vendor_id():
+    """ Check vendor id against the configured value """
+    check = CheckTester(opentype_profile,
+                        "com.thetypefounders/check/vendor_id")
+
+    ttFont = TTFont(TEST_FILE("merriweather/Merriweather-Regular.ttf"))
+    assert (ttFont['OS/2'].achVendID == 'STC ')
+
+    # If there is no configured vendor_id value, SKIP the check
+    assert_SKIP(check(ttFont))
+
+    config = { "vendor_id": "STC " }
+    assert_PASS(check({
+        "config": config,
+        "ttFont": ttFont,
+    }))
+
+    ttFont['OS/2'].achVendID = 'TEST'
+    assert_results_contain(check({
+        "config": config,
+        "ttFont": ttFont,
+    }), FAIL, "bad-vendor-id", "OS/2 VendorID is 'TEST', but should be 'STC '")
+