#24: 🔍 Tests updated for Schema Validation

“Rajat · “Rajat · commit f4ed5f136da7 · 2025-05-07T16:40:35.000+05:30
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -21,6 +21,7 @@
   "license": "ISC",
   "devDependencies": {
     "@playwright/test": "^1.41.2",
-    "@types/node": "^20.11.16"
+    "@types/node": "^20.11.16",
+    "ajv": "^8.17.1"
   }
 }
diff --git a/test-data/schema/login/login-successful.json b/test-data/schema/login/login-successful.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "token": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "token"
+  ]
+}
diff --git a/test-data/schema/login/login-unsuccessful.json b/test-data/schema/login/login-unsuccessful.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "error": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "error"
+  ]
+}
diff --git a/test-data/schema/register/register-successful.json b/test-data/schema/register/register-successful.json
@@ -0,0 +1,15 @@
+{
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer"
+    },
+    "token": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "token"
+  ]
+}
diff --git a/test-data/schema/register/register-unsuccessful.json b/test-data/schema/register/register-unsuccessful.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "error": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "error"
+  ]
+}
diff --git a/test-data/schema/users/user_create.json b/test-data/schema/users/user_create.json
@@ -0,0 +1,11 @@
+{
+    "type": "object",
+    "properties": {
+      "id": {
+        "type": "integer"
+      }
+    },
+    "required": [
+      "id"
+    ]
+  }
diff --git a/test-data/schema/users/user_update_patch.json b/test-data/schema/users/user_update_patch.json
@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "name"
+  ]
+}
diff --git a/test-data/schema/users/user_update_put.json b/test-data/schema/users/user_update_put.json
@@ -0,0 +1,15 @@
+{
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "job": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "name",
+    "job"
+  ]
+}
diff --git a/tests-reqres/login.spec.js b/tests-reqres/login.spec.js
@@ -4,6 +4,7 @@ import RequestBodyUtils from '../utils/RequestBodyUtils';
 import RequestUtils from '../utils/RequestUtils';
 import ResponseUtils from '../utils/ResponseUtils';
 import VerificationUtils from '../utils/VerificationUtils';
+import SchemaUtils from '../utils/SchemaUtils';
 
 /**
  * Test suite for API endpoints related to user login.
@@ -28,7 +29,8 @@ test.describe('Login', () => {
     // Assertions to validate the response
     VerificationUtils.assertResponseStatusCode(response, 200)
     VerificationUtils.assertResponseBodyKeyPresent(responseBody, "token")
-    
+    VerificationUtils.assertResponseSchema(responseBody, SchemaUtils.LOGIN_SUCCESSFUL)
+        
   })
 
   /**
@@ -47,6 +49,8 @@ test.describe('Login', () => {
     VerificationUtils.assertResponseStatusCode(response, 400)
     VerificationUtils.assertResponseBodyKeyValue(responseBody, "error", "Missing password")
     
+    VerificationUtils.assertResponseSchema(responseBody, SchemaUtils.LOGIN_UNSUCCESSFUL)  
+
   })
 
 })
diff --git a/tests-reqres/register.spec.js b/tests-reqres/register.spec.js
@@ -4,6 +4,7 @@ import RequestBodyUtils from '../utils/RequestBodyUtils';
 import RequestUtils from '../utils/RequestUtils';
 import ResponseUtils from '../utils/ResponseUtils';
 import VerificationUtils from '../utils/VerificationUtils';
+import SchemaUtils from '../utils/SchemaUtils';
 
 /**
  * Test suite for API endpoints related to user registration.
@@ -30,6 +31,8 @@ test.describe('Register', () => {
     VerificationUtils.assertResponseBodyKeyPresent(responseBody, "id")
     VerificationUtils.assertResponseBodyKeyPresent(responseBody, "token")
     
+    VerificationUtils.assertResponseSchema(responseBody, SchemaUtils.REGISTER_SUCCESSFUL)     
+    
   })
 
   /**
@@ -49,6 +52,8 @@ test.describe('Register', () => {
     VerificationUtils.assertResponseBodyKeyPresent(responseBody, "error")
     VerificationUtils.assertResponseBodyKeyValue(responseBody, "error", "Missing password")
     
+    VerificationUtils.assertResponseSchema(responseBody, SchemaUtils.REGISTER_UNSUCCESSFUL)
+
   })
 
 })
diff --git a/tests-reqres/users.spec.js b/tests-reqres/users.spec.js
@@ -4,6 +4,7 @@ import RequestBodyUtils from '../utils/RequestBodyUtils';
 import RequestUtils from '../utils/RequestUtils';
 import ResponseUtils from '../utils/ResponseUtils';
 import VerificationUtils from '../utils/VerificationUtils';
+import SchemaUtils from '../utils/SchemaUtils';
 
 /**
  * Test suite for API endpoints related to user management.
@@ -29,11 +30,11 @@ test.describe('Users', () => {
     const responseBody = await ResponseUtils.parseAndLog(response)
     
     // Assertions to validate the response
-    VerificationUtils.assertResponseStatusCode(response, 200)  
+    VerificationUtils.assertResponseStatusCode(response, 200);
     VerificationUtils.assertResponseBodyKeyValue(responseBody.data, 'id', 2);
     VerificationUtils.assertResponseBodyKeyValue(responseBody.data, 'first_name', 'Janet');
     VerificationUtils.assertResponseBodyKeyValue(responseBody.data, 'last_name', 'Weaver');
-    VerificationUtils.assertResponseBodyKeyPresent(responseBody.data, 'email')
+    VerificationUtils.assertResponseBodyKeyPresent(responseBody.data, 'email');
 
   })
 
@@ -52,6 +53,8 @@ test.describe('Users', () => {
     // Assertions to validate the response
     VerificationUtils.assertResponseBodyKeyValue(responseBody, 'id', 1111);
     VerificationUtils.assertResponseBodyKeyPresent(responseBody, 'createdAt');
+
+    VerificationUtils.assertResponseSchema(responseBody, SchemaUtils.USER_CREATE);
     
   })
 
@@ -73,6 +76,8 @@ test.describe('Users', () => {
     VerificationUtils.assertResponseBodyKeyValue(responseBody, 'job', 'test job - updated');
     VerificationUtils.assertResponseBodyKeyPresent(responseBody, 'updatedAt');
   
+    VerificationUtils.assertResponseSchema(responseBody, SchemaUtils.USER_UPDATE_PUT);
+
   })
 
   /**
@@ -148,10 +153,9 @@ test.describe('Users', () => {
     VerificationUtils.assertResponseStatusCode(response, 200);
     VerificationUtils.assertResponseBodyKeyValue(responseBody, 'name', 'test name - updated using patch');
     VerificationUtils.assertResponseBodyKeyPresent(responseBody, 'updatedAt');
-  
-  })
-
 
+    VerificationUtils.assertResponseSchema(responseBody, SchemaUtils.USER_UPDATE_PATCH);
   
+  })
 
 })
diff --git a/utils/SchemaUtils.js b/utils/SchemaUtils.js
@@ -0,0 +1,31 @@
+import schemaLoginSuccessful from '../test-data/schema/login/login-successful.json';
+import schemaLoginUnsuccessful from '../test-data/schema/login/login-unsuccessful.json';
+
+import schemaRegisterSuccessful from '../test-data/schema/register/register-successful.json';
+import schemaRegisterUnsuccessful from '../test-data/schema/register/register-unsuccessful.json';
+
+import schemaUserCreate from '../test-data/schema/users/user_create.json';
+import schemaUserUpdatePut from '../test-data/schema/users/user_update_put.json';
+import schemaUserUpdatePatch from '../test-data/schema/users/user_update_patch.json';
+
+/**
+ * Utility class for managing and providing schema data for various scenarios.
+ */
+class SchemaUtils {
+
+    // Login
+    LOGIN_SUCCESSFUL = schemaLoginSuccessful;
+    LOGIN_UNSUCCESSFUL = schemaLoginUnsuccessful;
+
+    // Register
+    REGISTER_SUCCESSFUL = schemaRegisterSuccessful;
+    REGISTER_UNSUCCESSFUL = schemaRegisterUnsuccessful;
+
+    // Users
+    USER_CREATE = schemaUserCreate;
+    USER_UPDATE_PUT = schemaUserUpdatePut;    
+    USER_UPDATE_PATCH = schemaUserUpdatePatch;
+
+}
+
+export default new SchemaUtils;
diff --git a/utils/VerificationUtils.js b/utils/VerificationUtils.js
@@ -1,5 +1,6 @@
 // Importing necessary modules for Playwright test
 import { expect } from '@playwright/test';
+import Ajv from 'ajv';
 
 /**
  * Utility class for verification and assertion functions related to API responses.
@@ -35,7 +36,31 @@ class VerificationUtils{
     assertResponseBodyKeyValue(responseBody, expectedKeyName, expectedValue) {
         console.log(`Asserts that Response Body has key: '${expectedKeyName}' with value: '${expectedValue}'.`);
         expect(responseBody[expectedKeyName]).toBe(expectedValue);
-    }    
+    }   
+    
+    /**
+     * Asserts that the entire response body conforms to a given JSON schema.
+     * Uses AJV for schema validation.
+     * @param {Object} responseBody - The actual JSON response body to validate.
+     * @param {Object} schema - The JSON schema to validate against.
+     */
+    assertResponseSchema(responseBody, schema) {
+        console.log(`Asserts that response body matches the provided JSON schema.`);
+      
+        const ajv = new Ajv();
+        const validate = ajv.compile(schema);
+        const isValid = validate(responseBody);
+      
+        if (!isValid) {
+          const errorMessages = validate.errors
+            .map(err => `${err.instancePath || '(root)'} ${err.message}`)
+            .join(', ');
+          throw new Error(`Schema validation failed: ${errorMessages}`);
+        }
+      
+        expect(isValid).toBe(true);
+    }
+      
 } 
 
 export default new VerificationUtils;

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`	`"license": "ISC",`
`22`	`22`	`"devDependencies": {`
`23`	`23`	`"@playwright/test": "^1.41.2",`
`24`		`- "@types/node": "^20.11.16"`
	`24`	`+ "@types/node": "^20.11.16",`
	`25`	`+ "ajv": "^8.17.1"`
`25`	`26`	`}`
`26`	`27`	`}`