API Status code validation changes

Author: akshayp7

.gitignore

@@ -4,3 +4,4 @@ allure-results/
 allure-report/
 html-report/
 Downloads/
+html-report.zip/

README.md

@@ -53,6 +53,7 @@ Bonus:
 
 - Supports PostgresSQL using 'pg' module.
 - Supports Excel File Read/Write using 'excel-js' module.
+- Converts HTL Reports to Zip format which can shared across.
 
 ### Built With
 

html-report.zip

@@ -1,14 +1,14 @@
 import fs from 'fs';
-import { expect } from '@playwright/test';
+import { APIResponse, expect } from '@playwright/test';
 
 export class APIActions {
 
-    async verifyStatusCode(actual: number, expected: number): Promise<void> {
+    async verifyStatusCode(response:APIResponse): Promise<void> {
         try {
-            expect(actual).toBe(expected);
+            await expect(response).toBeOK();
         }
         catch (exception) {
-            throw new Error(`${expected} status code was not displayed.`);
+            throw new Error(`200 Status code was not displayed.`);
         }
     }
 

lib/APIActions.ts

@@ -5,7 +5,7 @@
   "main": "index.js",
   "scripts": {
     "test": "npx playwright test",
-    "test:single": "npx playwright test GET.test.ts --project=API",
+    "test:single": "npx playwright test POST.test.ts --project=API",
     "test:parallel": "npx playwright test --grep @Smoke --project=Chrome",
     "test:serial": "npx playwright test --grep @Smoke --workers=1 --project=Chrome",
     "test:api": "npx playwright test --grep @api --workers=1 --project=Chrome",
@@ -22,20 +22,20 @@
   "author": "Akshay Pai",
   "license": "MIT",
   "dependencies": {
-    "@playwright/test": "^1.17.1",
+    "@playwright/test": "^1.18.0",
     "@types/adm-zip": "^0.4.34",
-    "@types/crypto-js": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.5.0",
-    "@typescript-eslint/parser": "^5.5.0",
+    "@types/crypto-js": "^4.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/parser": "^5.10.0",
     "adm-zip": "^0.5.9",
     "cross-env": "^7.0.3",
     "crypto-js": "^4.1.1",
-    "eslint": "^8.4.0",
-    "eslint-plugin-import": "^2.25.3",
+    "eslint": "^8.7.0",
+    "eslint-plugin-import": "^2.25.4",
     "exceljs": "^4.3.0",
     "experimental-allure-playwright": "0.0.3",
     "pg": "^8.7.1",
-    "playwright": "^1.17.1",
-    "typescript": "^4.5.2"
+    "playwright": "^1.18.0",
+    "typescript": "^4.5.5"
   }
 }

package-lock.json

@@ -5,7 +5,7 @@ const apiActions = new APIActions();
 
 test(`@API getUsers`, async ({ request }) => {
     const response = await request.get(`/api/users?per_page=1`);
-    await apiActions.verifyStatusCode(response.status(), 200);
+    await apiActions.verifyStatusCode(response);
 
     //* Body Response Params and Body Response Headers are stored in single text file separated by #
     const responseBodyParams = (await apiActions.readValuesFromTextFile(`getUsers`)).split(`#`)[0];

package.json

@@ -8,7 +8,7 @@ test(`@API postUsers`, async ({ request }) => {
     //* Body Response Params and Body Response Headers are stored in single text file separated by #
     const requestBody = JSON.parse((await apiActions.readValuesFromTextFile('postUsers')).split(`#`)[0]);
     const response = await request.post(`/api/users`, { data: requestBody });
-    await apiActions.verifyStatusCode(response.status(), 201);
+    await apiActions.verifyStatusCode(response);
 
     const responseBodyParams = (await apiActions.readValuesFromTextFile(`postUsers`)).split(`#`)[1];
     await apiActions.verifyResponseBody(responseBodyParams, await response.json(), `Response Body`);