types: make EntityUID UnmarshalJSON more strict and add tests

Signed-Off-By: Patrick Jakubowski <patrick.jakubowski@strongdm.com>

Author: patjakdev

types/entity_uid.go

@@ -82,8 +82,6 @@ func (e *EntityUID) UnmarshalCedar(data []byte) error {
 }
 
 func (e *EntityUID) UnmarshalJSON(b []byte) error {
-	// XXX: We might have to do something here?? For one thing, no extra keys should be allowed.
-	// TODO: review after adding support for schemas
 	var res entityValueJSON
 	if err := json.Unmarshal(b, &res); err != nil {
 		return err

types/entity_uid_test.go

@@ -119,6 +119,53 @@ func TestEntity(t *testing.T) {
 			})
 		}
 	})
+
+	t.Run("UnmarshalJSON", func(t *testing.T) {
+		t.Parallel()
+		tests := []struct {
+			name  string
+			input string
+		}{
+			{"explicit", `{ "__entity": { "type": "Type", "id": "id" } }`},
+			{"implicit", `{ "type": "Type", "id": "id" }`},
+			{"explicit - extra keys in inner", `{ "__entity": { "type": "Type", "id": "id", "floob": "blah" } }`},
+			{"implicit - extra keys", `{ "type": "Type", "id": "id", "floob": "blah" }`},
+		}
+
+		for _, tt := range tests {
+			t.Run(tt.name, func(t *testing.T) {
+				t.Parallel()
+				var got types.EntityUID
+				err := got.UnmarshalJSON([]byte(tt.input))
+				testutil.OK(t, err)
+				testutil.Equals(t, got, types.NewEntityUID("Type", "id"))
+			})
+		}
+	})
+
+	t.Run("UnmarshalJSON invalid", func(t *testing.T) {
+		t.Parallel()
+		tests := []struct {
+			name  string
+			input string
+		}{
+			{"non-object", `"floob"`},
+			{"explicit - wrong type", `{ "__entity": "wrong type"`},
+			{"implicit - type wrong", `{ "type": 123, "id": "123" }`},
+			{"implicit - id wrong type", `{ "type": "Type", "id": 123 }`},
+			{"implicit - only type", `{ "type": "Type" }`},
+			{"implicit - only id", `{ "id": 123 }`},
+		}
+
+		for _, tt := range tests {
+			t.Run(tt.name, func(t *testing.T) {
+				t.Parallel()
+				var got types.EntityUID
+				err := got.UnmarshalJSON([]byte(tt.input))
+				testutil.Error(t, err)
+			})
+		}
+	})
 }
 
 func TestEntityUIDSet(t *testing.T) {

types/json_test.go

@@ -30,6 +30,7 @@ func TestJSON_Value(t *testing.T) {
 	}{
 		{"entity-likeRecord", `{ "type": "User", "id": "alice" }`, NewRecord(RecordMap{"type": String("User"), "id": String("alice")}), nil},
 		{"explicitEntity", `{ "__entity": { "type": "User", "id": "alice" } }`, EntityUID{Type: "User", ID: "alice"}, nil},
+		{"explicitEntityExtraField", `{ "__entity": { "type": "User", "id": "alice" }, "extra": "stuff" }`, EntityUID{Type: "User", ID: "alice"}, nil},
 		{"explicitLongEntity", `{ "__entity": { "type": "User::External", "id": "alice" } }`, EntityUID{Type: "User::External", ID: "alice"}, nil},
 		{"invalidJSON", `!@#$`, zeroValue(), errJSONDecode},
 		{"numericOverflow", "12341234123412341234", zeroValue(), errJSONLongOutOfRange},

x/exp/types/testdata/explicit-entity-extra-field.cedarschema

@@ -0,0 +1,10 @@
+entity Manager;
+
+entity User = {
+  manager: Manager,
+};
+
+action view appliesTo {
+  principal: [User],
+  resource: [User],
+};

x/exp/types/testdata/explicit-entity-extra-field.entities.json

@@ -0,0 +1,14 @@
+[
+  {
+    "uid": {"type": "Manager", "id": "boss"},
+    "attrs": {},
+    "parents": []
+  },
+  {
+    "uid": {"type": "User", "id": "alice"},
+    "attrs": {
+      "manager": {"__entity": {"type": "Manager", "id": "boss"}, "extra": "stuff"}
+    },
+    "parents": []
+  }
+]

x/exp/types/testdata/explicit-entity-extra-field.json

@@ -0,0 +1,4 @@
+{
+  "schema": "explicit-entity-extra-field.cedarschema",
+  "entities": "explicit-entity-extra-field.entities.json"
+}

x/exp/types/testdata/explicit-entity-extra-field.parsing.json

@@ -0,0 +1,13 @@
+{
+  "allEntities": {
+    "success": true
+  },
+  "perEntity": {
+    "Manager::boss": {
+      "success": true
+    },
+    "User::alice": {
+      "success": true
+    }
+  }
+}

x/exp/types/testdata/implicit-entity-extra-field.cedarschema

@@ -0,0 +1,10 @@
+entity Manager;
+
+entity User = {
+  manager: Manager,
+};
+
+action view appliesTo {
+  principal: [User],
+  resource: [User],
+};

x/exp/types/testdata/implicit-entity-extra-field.entities.json

@@ -0,0 +1,14 @@
+[
+  {
+    "uid": {"type": "Manager", "id": "boss"},
+    "attrs": {},
+    "parents": []
+  },
+  {
+    "uid": {"type": "User", "id": "alice"},
+    "attrs": {
+      "manager": {"type": "Manager", "id": "boss", "extra": "stuff"}
+    },
+    "parents": []
+  }
+]

x/exp/types/testdata/implicit-entity-extra-field.json

@@ -0,0 +1,4 @@
+{
+  "schema": "implicit-entity-extra-field.cedarschema",
+  "entities": "implicit-entity-extra-field.entities.json"
+}