change to referential integrity

protos/service.proto

@@ -16,17 +16,30 @@ message ValidationRequest {
 
 message ValidationError {
   oneof type {
+    // optional fields must be set to a value
     string optional = 1;
+
+    // oneof fields must have one field set
     string oneof = 2;
+
+    // map keys must match a name field in the object
     string map = 3;
-    string repeated = 4;
-    string connection = 5;
+
+    // referential integrity check failed
+    // the following cases fall under this type:
+    // connection structure is incorrectly formatted
+    // connection pieces are not present in the inventory or device instances
+    // binding infrastructure path is incorrectly formatted
+    // binding infrastructure path pieces are not present in the infrastructure
+    // inventory
+    string referential_integrity = 4;
   }
 }
 
 message ValidationResponse {
   repeated ValidationError errors = 1;
-  repeated ValidationError warnings = 2;
+  repeated string warnings = 2;
+  repeated string info = 3;
 }
 
 service Service {

src/service.py

@@ -38,32 +38,36 @@ def _validate_component_connection(self, device, connection: str):
         except ValueError:
             self._validation_response.errors.append(
                 ValidationError(
-                    connection=f"Connection:{connection} in device:{device.name} is incorrectly formatted"
+                    referential_integrity=f"Infrastructure.devices[{device.name}].connections:[{connection}] is incorrectly formatted"
                 )
             )
 
     def _validate_component(self, device, name, index):
         if name not in device.components:
             self._validation_response.errors.append(
-                ValidationError(connection=f"Component:{name} not present in device:{device.name}")
+                ValidationError(
+                    referential_integrity=f"Infrastructure.devices[{device.name}].components[{name}] does not exist"
+                )
             )
         try:
             index = int(index)
             if index < 0 or index > device.components[name].count - 1:
                 self._validation_response.errors.append(
                     ValidationError(
-                        connection=f"Component:{name} index:{index} must be >= 0 and <{device.components[name].count}"
+                        referential_integrity=f"Component:{name} index:{index} must be >= 0 and <{device.components[name].count}"
                     )
                 )
         except ValueError:
             self._validation_response.errors.append(
-                ValidationError(connection=f"Index:{index} must be a valid integer")
+                ValidationError(referential_integrity=f"Index:{index} must be a valid integer")
             )
 
     def _validate_link_name(self, device, name: str):
         if name not in device.links:
             self._validation_response.errors.append(
-                ValidationError(connection=f"{device.name} does not contain a link:{name}")
+                ValidationError(
+                    referential_integrity=f"Infrastructure.devices[{device.name}].links[{name}] does not exist"
+                )
             )
 
     def _validate_oneof(self, object, name):

src/tests/test_service.py

@@ -31,24 +31,25 @@ def test_missing_bandwidth():
     assert response.errors[0].WhichOneof("type") == "oneof"
 
 
-def test_invalid_component_connection():
-    """Test that a component connection is valid"""
+def test_referential_integrity():
+    """Referential integrity tests"""
     device = Device(name="host")
     mii = Link(name="mii", type=LinkType.LINK_CUSTOM, bandwidth=Bandwidth(gbps=100))
     device.links[mii.name].CopyFrom(mii)
     asic = Component(name="asic", count=1)
     nic = Component(name="nic", count=1)
     device.components[asic.name].CopyFrom(asic)
     device.components[nic.name].CopyFrom(nic)
+    device.connections.append(f"bad.device.component.connection")
     device.connections.append(f"{asic.name}.x.{mii.name}.null.-1")
     inventory = Inventory()
     inventory.devices[device.name].CopyFrom(device)
     infrastructure = Infrastructure(inventory=inventory)
     request = ValidationRequest(infrastructure=infrastructure)
     response = Service().validate(request=request)
     print(response)
-    assert len(response.errors) == 3
-    assert response.errors[0].WhichOneof("type") == "connection"
+    for error in response.errors:
+        assert error.WhichOneof("type") == "referential_integrity"
 
 
 if __name__ == "__main__":