IFC-1405: Update restricted words for generics attributes and relationships

backend/infrahub/api/schema.py

@@ -156,7 +156,7 @@ def evaluate_candidate_schemas(
     try:
         schema = _merge_candidate_schemas(schemas=schemas_to_evaluate.schemas)
 
-        candidate_schema.load_schema(schema=schema)
+        candidate_schema.load_schema(schema=schema, loading_from_api=True)
         candidate_schema.process()
 
         schema_diff = branch_schema.diff(other=candidate_schema)

backend/infrahub/core/constants/__init__.py

@@ -39,6 +39,13 @@
     "hfid",
 ]
 
+RESERVED_ATTR_REL_HIERARCHICAL_NAMES = [
+    "parent",
+    "children",
+    "ancestors",
+    "descendants",
+]
+
 RESERVED_ATTR_GEN_NAMES = ["type"]
 
 NULL_VALUE = "NULL"

backend/infrahub/core/schema/relationship_schema.py

@@ -3,7 +3,7 @@
 from enum import Enum
 from typing import TYPE_CHECKING, Any
 
-from pydantic import BaseModel
+from pydantic import BaseModel, PrivateAttr
 
 from infrahub import config
 from infrahub.core.constants import RelationshipDirection
@@ -23,6 +23,15 @@
 class RelationshipSchema(GeneratedRelationshipSchema):
     _exclude_from_hash: list[str] = ["filters"]
     _sort_by: list[str] = ["name"]
+    _loaded_from_api: bool = PrivateAttr(default=False)
+
+    @property
+    def loaded_from_api(self) -> bool:
+        return self._loaded_from_api
+
+    @loaded_from_api.setter
+    def loaded_from_api(self, value: bool) -> None:
+        self._loaded_from_api = value
 
     @property
     def is_attribute(self) -> bool:

backend/infrahub/core/schema/schema_branch.py

@@ -19,6 +19,7 @@
     OBJECT_TEMPLATE_NAME_ATTR,
     OBJECT_TEMPLATE_RELATIONSHIP_NAME,
     RESERVED_ATTR_GEN_NAMES,
+    RESERVED_ATTR_REL_HIERARCHICAL_NAMES,
     RESERVED_ATTR_REL_NAMES,
     RESTRICTED_NAMESPACES,
     BranchSupportType,
@@ -465,7 +466,7 @@ def generate_fields_for_display_label(self, name: str) -> dict | None:
 
         return fields or None
 
-    def load_schema(self, schema: SchemaRoot) -> None:
+    def load_schema(self, schema: SchemaRoot, loading_from_api: bool = False) -> None:
         """Load a SchemaRoot object and store all NodeSchema or GenericSchema.
 
         In the current implementation, if a schema object present in the SchemaRoot already exist, it will be overwritten.
@@ -491,6 +492,10 @@ def load_schema(self, schema: SchemaRoot) -> None:
             except SchemaNotFoundError:
                 self.set(name=item.kind, schema=item)
 
+            if loading_from_api:
+                for relationship in item.relationships:
+                    relationship.loaded_from_api = True
+
         for node_extension in schema.extensions.nodes:
             new_item = self.get(name=node_extension.kind)
             new_item.update(node_extension)
@@ -518,6 +523,7 @@ def process_pre_validation(self) -> None:
         self.add_hierarchy_node()
 
     def process_validate(self) -> None:
+        self.validate_hierarchical_nodes_restricted_words()
         self.validate_names()
         self.validate_python_keywords()
         self.validate_kinds()
@@ -989,6 +995,28 @@ def validate_names(self) -> None:
                 ):
                     raise ValueError(f"{node.kind}: {rel.name} isn't allowed as a relationship name.")
 
+    def validate_hierarchical_nodes_restricted_words(self) -> None:
+        for name in self.all_names:
+            node = self.get(name=name, duplicate=False)
+            is_hierarchical_node = (isinstance(node, GenericSchema) and node.hierarchical) or (
+                isinstance(node, NodeSchema) and node.hierarchy
+            )
+
+            if not is_hierarchical_node or node.kind in INTERNAL_SCHEMA_NODE_KINDS:
+                continue
+
+            for attr in node.attributes:
+                if attr.name in RESERVED_ATTR_REL_HIERARCHICAL_NAMES:
+                    raise ValueError(
+                        f"{node.kind}: {attr.name} isn't allowed as an attribute name on hierarchical nodes."
+                    )
+
+            for rel in node.relationships:
+                if rel.loaded_from_api and rel.name in RESERVED_ATTR_REL_HIERARCHICAL_NAMES:
+                    raise ValueError(
+                        f"{node.kind}: {rel.name} isn't allowed as a relationship name on hierarchical nodes."
+                    )
+
     def validate_python_keywords(self) -> None:
         """Validate that attribute and relationship names don't use Python keywords."""
         for name in self.all_names:

backend/tests/fixtures/schemas/restricted_names_01.json

@@ -0,0 +1,64 @@
+{
+  "version": "1.0",
+  "generics": [
+    {
+      "name": "Location",
+      "namespace": "Generic",
+      "hierarchical": true,
+      "attributes": [
+        {
+          "name": "name_location",
+          "unique": true,
+          "optional": false,
+          "kind": "Text"
+        }
+      ]
+    }
+  ],
+  "nodes": [
+    {
+      "name": "Site",
+      "namespace": "Location",
+      "inherit_from": ["GenericLocation"],
+      "children": "TestingParent",
+      "parent": ""
+    },
+    {
+      "name": "Parent",
+      "namespace": "Testing",
+      "inherit_from": ["GenericLocation"],
+      "children": "",
+      "parent": "LocationSite",
+      "relationships": [
+        {
+          "name": "children",
+          "kind": "Generic",
+          "optional": true,
+          "peer": "TestingChild",
+          "cardinality": "many"
+        }
+      ]
+    },
+    {
+      "name": "Child",
+      "namespace": "Testing",
+      "attributes": [
+        {
+          "name": "name_child",
+          "unique": true,
+          "optional": false,
+          "kind": "Text"
+        }
+      ],
+      "relationships": [
+        {
+          "name": "relationship",
+          "kind": "Attribute",
+          "optional": false,
+          "peer": "TestingParent",
+          "cardinality": "one"
+        }
+      ]
+    }
+  ]
+}

backend/tests/fixtures/schemas/restricted_names_02.json

@@ -0,0 +1,65 @@
+{
+  "version": "1.0",
+  "generics": [
+    {
+      "name": "Location",
+      "namespace": "Generic",
+      "hierarchical": true,
+      "attributes": [
+        {
+          "name": "name_location",
+          "unique": true,
+          "optional": false,
+          "kind": "Text"
+        }
+      ]
+    }
+  ],
+  "nodes": [
+    {
+      "name": "Site",
+      "namespace": "Location",
+      "inherit_from": ["GenericLocation"],
+      "children": "TestingParent",
+      "parent": ""
+    },
+    {
+      "name": "Parent",
+      "namespace": "Testing",
+      "inherit_from": ["GenericLocation"],
+      "children": "",
+      "parent": "LocationSite",
+      "attributes": [{"name": "children", "unique": true, "optional": false, "kind": "Text"}],
+      "relationships": [
+        {
+          "name": "parent_relationship",
+          "kind": "Generic",
+          "optional": true,
+          "peer": "TestingChild",
+          "cardinality": "many"
+        }
+      ]
+    },
+    {
+      "name": "Child",
+      "namespace": "Testing",
+      "attributes": [
+        {
+          "name": "name_child",
+          "unique": true,
+          "optional": false,
+          "kind": "Text"
+        }
+      ],
+      "relationships": [
+        {
+          "name": "child_relationship",
+          "kind": "Attribute",
+          "optional": false,
+          "peer": "TestingParent",
+          "cardinality": "one"
+        }
+      ]
+    }
+  ]
+}

backend/tests/unit/api/test_40_schema.py

@@ -4,7 +4,7 @@
 from infrahub import config
 from infrahub.core import registry
 from infrahub.core.branch import Branch
-from infrahub.core.constants import InfrahubKind
+from infrahub.core.constants import RESERVED_ATTR_REL_HIERARCHICAL_NAMES, InfrahubKind
 from infrahub.core.initialization import create_branch
 from infrahub.core.node import Node
 from infrahub.core.schema import SchemaRoot, core_models
@@ -443,3 +443,49 @@ async def test_schema_read_endpoints_anonymous_account(
         response = client.get("/api/schema/json_schema/TestCar")
 
     assert response.status_code == 200 if allow_anonymous_access else 401
+
+
+@pytest.mark.parametrize(
+    "reserved_name",
+    [pytest.param(reserved_name, id=reserved_name) for reserved_name in RESERVED_ATTR_REL_HIERARCHICAL_NAMES],
+)
+async def test_schema_load_restricted_names(
+    db: InfrahubDatabase,
+    client: TestClient,
+    admin_headers,
+    default_branch: Branch,
+    prefect_test_fixture,
+    workflow_local,
+    authentication_base,
+    helper,
+    reserved_name,
+):
+    schema = helper.schema_file("restricted_names_01.json")
+    schema["nodes"][1]["relationships"][0]["name"] = reserved_name
+    with client:
+        response = client.post(
+            "/api/schema/load",
+            headers=admin_headers,
+            json={"schemas": [schema]},
+        )
+
+    assert response.status_code == 422
+    assert (
+        response.json()["errors"][0]["message"]
+        == f"TestingParent: {reserved_name} isn't allowed as a relationship name on hierarchical nodes."
+    )
+
+    schema = helper.schema_file("restricted_names_02.json")
+    schema["nodes"][1]["attributes"][0]["name"] = reserved_name
+    with client:
+        response = client.post(
+            "/api/schema/load",
+            headers=admin_headers,
+            json={"schemas": [schema]},
+        )
+
+    assert response.status_code == 422
+    assert (
+        response.json()["errors"][0]["message"]
+        == f"TestingParent: {reserved_name} isn't allowed as an attribute name on hierarchical nodes."
+    )