Lint for invalid use of test_driver_internal

jgraham · jgraham · commit c94eed7bd1c0 · 2025-06-27T09:41:58.000+01:00
This isn't supposed to be called directly in tests; they must use the test_driver API
diff --git a/lint.ignore b/lint.ignore
@@ -830,3 +830,6 @@ SET TIMEOUT: wasm/core/js/harness/testharness.js
 ASSERT_THROWS: wasm/core/js/harness/testharness.js
 GENERATE_TESTS: wasm/core/js/harness/testharness.js
 PROMISE_REJECTS: wasm/core/js/harness/testharness.js
+
+# Legitimate use of test_driver_internal
+TEST DRIVER INTERNAL: resources/testdriver.js
diff --git a/tools/lint/lint.py b/tools/lint/lint.py
@@ -356,7 +356,8 @@ def filter_ignorelist_errors(data: Ignorelist, errors: Sequence[rules.Error]) ->
             rules.AssertThrowsRegexp,
             rules.PromiseRejectsRegexp,
             rules.AssertPreconditionRegexp,
-            rules.HTMLInvalidSyntaxRegexp]]
+            rules.HTMLInvalidSyntaxRegexp,
+            rules.TestDriverInternalRegexp]]
 
 
 def check_regexp_line(repo_root: Text, path: Text, f: IO[bytes]) -> List[rules.Error]:
diff --git a/tools/lint/rules.py b/tools/lint/rules.py
@@ -565,3 +565,11 @@ class HTMLInvalidSyntaxRegexp(Regexp):
     file_extensions = EXTENSIONS["html"]
     description = "Test-file line has a non-void HTML tag with /> syntax"
     to_fix = """Replace with start tag and end tag"""
+
+
+class TestDriverInternalRegexp(Regexp):
+    pattern = br"test_driver_internal"
+    name = "TEST DRIVER INTERNAL"
+    file_extensions = EXTENSIONS["js_all"]
+    description = "Test-file uses test_driver_internal API"
+    to_fix = """Only use test_driver public API"""
diff --git a/tools/lint/tests/test_file_lints.py b/tools/lint/tests/test_file_lints.py
@@ -243,6 +243,16 @@ def test_html_invalid_syntax():
             assert errors == [("HTML INVALID SYNTAX", "Test-file line has a non-void HTML tag with /> syntax", filename, 1)]
 
 
+def test_testdriver_internal():
+    error_map = check_with_files(b"  test_driver_internal.foo()")
+
+    for (filename, (errors, kind)) in error_map.items():
+        check_errors(errors)
+
+        if kind not in {"web-strict", "python"}:
+            assert errors == [("TEST DRIVER INTERNAL", "Test-file uses test_driver_internal API", filename, 1)]
+
+
 def test_meta_timeout():
     code = b"""
 <html xmlns="http://www.w3.org/1999/xhtml">
