feat(sanity): check if category indices are consistent (#255)

* feat(sanity): check if category indices are consistent

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* chore: remove backticks, improve wording

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

* docs: add REC007 to `requirement` docs

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

---------

Signed-off-by: Max SCHMELLER <max.schmeller@tier4.jp>

Author: mojomex

docs/schema/requirement.md

@@ -24,6 +24,7 @@
 | `REC004` | `ego-pose-not-empty`          | `ERROR`  | `EgoPose` record is not empty.                                                                  |
 | `REC005` | `calibrated-sensor-non-empty` | `ERROR`  | `CalibratedSensor` record is not empty.                                                         |
 | `REC006` | `instance-not-empty`          | `ERROR`  | `Instance` record is not empty if either `SampleAnnotation` or `ObjectAnnotation` is not empty. |
+| `REC007` | `category-indices-consistent` | `ERROR`  | `Category` records must either all have a unique `index` or all have a `null` index.            |
 
 ## Reference (`REF`)
 

t4_devkit/sanity/record/__init__.py

@@ -6,3 +6,4 @@
 from .rec004 import *  # noqa
 from .rec005 import *  # noqa
 from .rec006 import *  # noqa
+from .rec007 import *  # noqa

t4_devkit/sanity/record/rec007.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from returns.maybe import Maybe, Nothing, Some
+
+from t4_devkit.schema import SchemaName
+
+from ..checker import Checker, RuleID, RuleName, Severity
+from ..registry import CHECKERS
+from ..result import Reason
+from ..safety import load_json_safe
+
+if TYPE_CHECKING:
+    from ..context import SanityContext
+
+__all__ = ["REC007"]
+
+
+@CHECKERS.register()
+class REC007(Checker):
+    """A checker of REC007."""
+
+    id = RuleID("REC007")
+    name = RuleName("category-indices-consistent")
+    severity = Severity.ERROR
+    description = "All categories must either have a unique 'index' or all have a 'null' index."
+    schema = SchemaName.CATEGORY
+
+    def can_skip(self, context: SanityContext) -> Maybe[Reason]:
+        match context.to_schema_file(self.schema):
+            case Some(x):
+                if not x.exists():
+                    return Maybe.from_value(Reason(f"Missing {self.schema.filename}"))
+                else:
+                    return Nothing
+            case _:
+                return Maybe.from_value(Reason("Missing 'annotation' directory path"))
+
+    def check(self, context: SanityContext) -> list[Reason] | None:
+        filepath = context.to_schema_file(self.schema).unwrap()
+        records = load_json_safe(filepath).unwrap()
+
+        indices = [record.get("index") for record in records]
+        all_none = all(index is None for index in indices)
+        if all_none:
+            return None
+
+        some_none = any(index is None for index in indices)
+        if some_none:
+            return [
+                Reason("All categories either must have an 'index' set or all have a 'null' index.")
+            ]
+
+        has_duplicates = len(set(indices)) < len(indices)
+        if has_duplicates:
+            return [Reason("Categories must have unique 'index' values.")]
+
+        return None