Sync scalar_type.fbs and extend test to check all copies (pytorch#17085)

mohammed-saalim · Copilot · web-flow · commit 6f780c75ce4e · 2026-02-03T18:05:52.000-08:00
Fixes pytorch#11572 This PR: 1. Extends the existing test in `devtools/bundled_program/schema/test/test_schema.py` to check all 4 copies of `scalar_type.fbs` 2. Syncs `extension/flat_tensor/serialize/scalar_type.fbs` which was out of date (missing FLOAT8E* and UINT* types) The test now validates that these 4 files remain in sync: - `schema/scalar_type.fbs` (canonical) - `devtools/bundled_program/schema/scalar_type.fbs` - `devtools/etdump/scalar_type.fbs` - `extension/flat_tensor/serialize/scalar_type.fbs` Uses `subTest()` for clearer error messages when files drift out of sync. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
diff --git a/devtools/bundled_program/schema/test/BUCK b/devtools/bundled_program/schema/test/BUCK
@@ -7,11 +7,3 @@ oncall("executorch")
 # !!!! fbcode/executorch/devtools/bundled_program/schema/test/TARGETS was merged into this file, see https://fburl.com/workplace/xl8l9yuo for more info !!!!
 
 load("@fbcode_macros//build_defs:python_unittest.bzl", "python_unittest")
-
-
-fbcode_target(_kind = python_unittest,
-    name = "schema",
-    srcs = [
-        "test_schema.py",
-    ],
-)
diff --git a/devtools/bundled_program/schema/test/test_schema.py b/devtools/bundled_program/schema/test/test_schema.py
diff --git a/extension/flat_tensor/serialize/scalar_type.fbs b/extension/flat_tensor/serialize/scalar_type.fbs
@@ -1,10 +1,9 @@
 // Copyright (c) Meta Platforms, Inc. and affiliates.
 
 //
-// See executorch/schema/README.md before modifying this file.
+// See README.md before modifying this file.
 //
 
-// TODO(T207893511): sync scalar_type.fbs copies across ExecuTorch repo.
 namespace executorch_flatbuffer;
 
 // The scalar data type.
@@ -19,14 +18,20 @@ enum ScalarType : byte {
   FLOAT = 6,
   DOUBLE = 7,
   BOOL = 11,
-  // TODO(jakeszwe): Verify these are unused and then remove support
   QINT8 = 12,
   QUINT8 = 13,
   QINT32 = 14,
   BFLOAT16 = 15,
   QUINT4X2 = 16,
   QUINT2X4 = 17,
   BITS16 = 22,
+  FLOAT8E5M2 = 23,
+  FLOAT8E4M3FN = 24,
+  FLOAT8E5M2FNUZ = 25,
+  FLOAT8E4M3FNUZ = 26,
+  UINT16 = 27,
+  UINT32 = 28,
+  UINT64 = 29,
   // Types currently not implemented.
   // COMPLEXHALF = 8,
   // COMPLEXFLOAT = 9,
diff --git a/pytest.ini b/pytest.ini
@@ -105,6 +105,10 @@ addopts =
     runtime
     # Ignore tests with missing compiler dependencies
     --ignore=runtime/test/test_runtime_etdump_gen.py
+
+    # schema
+    schema/
+
     # test
     test/
     # Ignore tests with missing dependencies
diff --git a/schema/test/test_schema.py b/schema/test/test_schema.py
@@ -0,0 +1,52 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+# All rights reserved.
+#
+# This source code is licensed under the BSD-style license found in the
+# LICENSE file in the root directory of this source tree.
+
+# pyre-strict
+
+import filecmp
+import os
+import unittest
+
+
+class TestSchema(unittest.TestCase):
+    def test_schema_sync(self) -> None:
+        """Test that all copies of scalar_type.fbs are in sync.
+
+        Flatbuffers expects all included files to be in the same directory.
+        For example, program.fbs includes scalar_type.fbs, and must be in the
+        same directory. As most of the schema files in executorch include
+        scalar_type.fbs, it is copied in several places across the executorch
+        repo. This test ensures they all remain in sync with the canonical
+        version in schema/scalar_type.fbs.
+
+        See https://github.com/pytorch/executorch/issues/11572
+        """
+        # make the test work in both internal and oss.
+        prefix = (
+            "executorch/" if os.path.exists("executorch/schema/scalar_type.fbs") else ""
+        )
+
+        # The canonical source of truth
+        canonical_path = prefix + "schema/scalar_type.fbs"
+
+        # All copies that must stay in sync with the canonical version
+        copies = [
+            prefix + "devtools/bundled_program/schema/scalar_type.fbs",
+            prefix + "devtools/etdump/scalar_type.fbs",
+            prefix + "extension/flat_tensor/serialize/scalar_type.fbs",
+        ]
+
+        for copy_path in copies:
+            with self.subTest(copy=copy_path):
+                self.assertTrue(
+                    filecmp.cmp(canonical_path, copy_path, shallow=False),
+                    f"scalar_type.fbs is out of sync: {copy_path} differs from {canonical_path}. "
+                    f"Please sync the schema by copying from {canonical_path}.",
+                )
+
+
+if __name__ == "__main__":
+    unittest.main()
