From e9458540de82885d0a2e0e5bb5983dc100b8c6a0 Mon Sep 17 00:00:00 2001
From: Bret Hubbard <hubbard.bret@gmail.com>
Date: Thu, 6 May 2021 16:07:27 -0600
Subject: [PATCH] Improve error messages when schema validation fails

Signed-off-by: Bret Hubbard <hubbard.bret@gmail.com>
---
 .../src/kinds/ApiEntityV1alpha1.test.ts              | 12 ++++++++++++
 packages/catalog-model/src/kinds/util.ts             |  8 +++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/packages/catalog-model/src/kinds/ApiEntityV1alpha1.test.ts b/packages/catalog-model/src/kinds/ApiEntityV1alpha1.test.ts
index a4d7d904cd..249243bed3 100644
--- a/packages/catalog-model/src/kinds/ApiEntityV1alpha1.test.ts
+++ b/packages/catalog-model/src/kinds/ApiEntityV1alpha1.test.ts
@@ -168,4 +168,16 @@ components:
     (entity as any).spec.system = '';
     await expect(validator.check(entity)).rejects.toThrow(/system/);
   });
+
+  it('rejects additional properties', async () => {
+    (entity as any).annotations = 'Test';
+    await expect(validator.check(entity)).rejects.toThrow(
+      /additional properties/,
+    );
+  });
+
+  it('rejects with useful error message', async () => {
+    (entity as any).annotations = 'Test';
+    await expect(validator.check(entity)).rejects.toThrow(/annotations/);
+  });
 });
diff --git a/packages/catalog-model/src/kinds/util.ts b/packages/catalog-model/src/kinds/util.ts
index 4002f2806c..1e9e7b7521 100644
--- a/packages/catalog-model/src/kinds/util.ts
+++ b/packages/catalog-model/src/kinds/util.ts
@@ -66,7 +66,13 @@ export function ajvCompiledJsonSchemaValidator(
       }
 
       throw new TypeError(
-        `Malformed ${kind}, ${error.dataPath || '<root>'} ${error.message}`,
+        `Malformed ${kind}, ${error.dataPath || '<root>'} ${error.message}${
+          error.params
+            ? ` - ${Object.entries(error.params)
+                .map(([key, val]) => `${key}: ${val}`)
+                .join(', ')}`
+            : ''
+        }`,
       );
     },
   };