Add test for include failure not related to type mismatch

Author: mattpolzin

Tests/JSONAPITests/Includes/IncludesDecodingErrorTests.swift

@@ -84,6 +84,29 @@ final class IncludesDecodingErrorTests: XCTestCase {
             )
         }
     }
+
+    func test_missingProperty() {
+        XCTAssertThrowsError(
+            try testDecoder.decode(
+                Includes<Include3<TestEntity, TestEntity2, TestEntity4>>.self,
+                from: three_includes_one_missing_attributes
+            )
+        ) { (error: Error) -> Void in
+            XCTAssertEqual(
+                (error as? IncludesDecodingError).map(String.init(describing:)),
+                """
+                Out of 3 includes, the 3rd one failed to parse: \nCould not have been Include Type `test_entity1` because:
+                found JSON:API type "test_entity2" but expected "test_entity1"
+
+                Could not have been Include Type `test_entity2` because:
+                'foo' attribute is required and missing.
+
+                Could not have been Include Type `test_entity4` because:
+                found JSON:API type "test_entity2" but expected "test_entity4"
+                """
+            )
+        }
+    }
 }
 
 // MARK: - Test Types

Tests/JSONAPITests/Includes/stubs/IncludeStubs.swift

@@ -7,65 +7,65 @@
 
 let one_include = """
 [
-{
-"type": "test_entity1",
-"id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF",
-"attributes": {
-"foo": "Hello",
-"bar": 123
-}
-}
+    {
+        "type": "test_entity1",
+        "id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF",
+        "attributes": {
+            "foo": "Hello",
+            "bar": 123
+        }
+    }
 ]
 """.data(using: .utf8)!
 
 let two_same_type_includes = """
 [
-{
-"type": "test_entity1",
-"id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF",
-"attributes": {
-"foo": "Hello",
-"bar": 123
-}
-},
-{
-"type": "test_entity1",
-"id": "90F03B69-4DF1-467F-B52E-B0C9E44FC333",
-"attributes": {
-"foo": "World",
-"bar": 456
-}
-}
+    {
+        "type": "test_entity1",
+        "id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF",
+        "attributes": {
+            "foo": "Hello",
+            "bar": 123
+        }
+    },
+        {
+        "type": "test_entity1",
+        "id": "90F03B69-4DF1-467F-B52E-B0C9E44FC333",
+        "attributes": {
+            "foo": "World",
+            "bar": 456
+        }
+    }
 ]
 
 """.data(using: .utf8)!
 
 let two_different_type_includes = """
 [
-{
-"type": "test_entity1",
-"id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF",
-"attributes": {
-"foo": "Hello",
-"bar": 123
-}
-},
-{
-"type": "test_entity2",
-"id": "90F03B69-4DF1-467F-B52E-B0C9E44FC333",
-"attributes": {
-"foo": "World",
-"bar": 456
-},
-"relationships": {
-"entity1": {
-"data": {
-"type": "test_entity1",
-"id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF"
-}
-}
-}
-}
+    {
+        "type": "test_entity1",
+        "id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF",
+        "attributes": {
+            "foo": "Hello",
+            "bar": 123
+        }
+    },
+    {
+        "type": "test_entity2",
+        "id": "90F03B69-4DF1-467F-B52E-B0C9E44FC333",
+        "attributes": {
+            "foo": "World",
+            "bar": 456
+        },
+        "relationships": {
+            "entity1": {
+                "data": {
+                    "type": "test_entity1",
+                    "id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF"
+                }
+            }
+        }
+    }
 ]
 
 """.data(using: .utf8)!
@@ -688,6 +688,38 @@ let eleven_different_type_includes = """
 """.data(using: .utf8)!
 
 
+let three_includes_one_missing_attributes = """
+[
+    {
+        "type": "test_entity1",
+        "id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF",
+        "attributes": {
+            "foo": "Hello",
+            "bar": 123
+        }
+    },
+    {
+        "type": "test_entity4",
+        "id": "364B3B69-4DF1-467F-B52E-B0C9E44F666E"
+    },
+    {
+        "type": "test_entity2",
+        "id": "90F03B69-4DF1-467F-B52E-B0C9E44FC333",
+        "attributes": {
+            "bar": 456
+        },
+        "relationships": {
+            "entity1": {
+                "data": {
+                    "type": "test_entity1",
+                    "id": "2DF03B69-4B0A-467F-B52E-B0C9E44FCECF"
+                }
+            }
+        }
+    }
+]
+""".data(using: .utf8)!
+
 let six_includes_one_bad_type = """
 [
 {