Skip to content

Commit f09347f

Browse files
akshayp7akshayp7
committed
New API Testing Code
1 parent a251faf commit f09347f

File tree

10 files changed

+337
-415
lines changed

10 files changed

+337
-415
lines changed

‎lib/APIActions.ts‎

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ import { expect } from '@playwright/test';
33

44
export class APIActions {
55

6-
async verifyStatusCode(actual: number, expected: number, apiName: string): Promise<void> {
6+
async verifyStatusCode(actual: number, expected: number): Promise<void> {
77
try {
88
expect(actual).toBe(expected);
99
}
1010
catch (exception) {
11-
throw new Error(`${expected} status code was not displayed for ${apiName}`);
11+
throw new Error(`${expected} status code was not displayed.`);
1212
}
1313
}
1414

15-
async verifyResponseBody(expectedResponseBodyParams: string, responsePart: JSON, apiName: string, responseType: string): Promise<void> {
15+
async verifyResponseBody(expectedResponseBodyParams: string, responsePart: JSON, responseType: string): Promise<void> {
1616
let status = true;
1717
let fieldNames = `Parameter`;
1818
const headers = expectedResponseBodyParams.split("|");
@@ -28,7 +28,25 @@ export class APIActions {
2828
expect(status).toBe(true);
2929
}
3030
catch (exception) {
31-
throw new Error(`${fieldNames} was not present in ${responseType} for ${apiName}`);
31+
throw new Error(`${fieldNames} was not present in ${responseType}`);
32+
}
33+
}
34+
35+
async verifyResponseHeader(expectedResponseHeaderParams: string, responsePart: Array<{ name: string, value: string }>, responseType: string): Promise<void> {
36+
let status = true;
37+
let fieldNames = `Parameter`;
38+
for (let i = 0; i < responsePart.length; i++) {
39+
if (!(expectedResponseHeaderParams.includes(responsePart[i].name.trim()))) {
40+
status = false;
41+
fieldNames = fieldNames + ' ,' + responsePart[i].name;
42+
break;
43+
}
44+
}
45+
try {
46+
expect(status).toBe(true);
47+
}
48+
catch (exception) {
49+
throw new Error(`${fieldNames} was not present in ${responseType}`);
3250
}
3351
}
3452

‎package-lock.json‎

Lines changed: 261 additions & 379 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
"main": "index.js",
66
"scripts": {
77
"test": "npx playwright test",
8-
"test:single": "npx playwright test MyPersonalDetails.test.ts --project=Chrome",
8+
"test:single": "npx playwright test GET.test.ts --project=API",
99
"test:parallel": "npx playwright test --grep @Smoke --project=Chrome",
1010
"test:serial": "npx playwright test --grep @Smoke --workers=1 --project=Chrome",
1111
"test:api": "npx playwright test --grep @api --workers=1 --project=Chrome",
1212
"test:db": "npx playwright test DB.test.ts --project=DB",
1313
"test:record": "npx playwright codegen",
1414
"test:visual": "npx playwright test visualComparision.test.ts --project=Chrome",
15-
"test:device": "npx playwright test Emulation.test.ts --project=Chrome",
15+
"test:device": "npx playwright test Emulation.test.ts --project=Device",
1616
"allureReport": "allure serve",
1717
"htmlReport": "npx playwright show-report html-report"
1818
},
@@ -23,19 +23,18 @@
2323
"author": "Akshay Pai",
2424
"license": "MIT",
2525
"dependencies": {
26-
"@playwright/test": "^1.16.1",
26+
"@playwright/test": "^1.16.2",
2727
"@types/crypto-js": "^4.0.2",
28-
"@typescript-eslint/eslint-plugin": "^5.1.0",
29-
"@typescript-eslint/parser": "^5.1.0",
28+
"@typescript-eslint/eslint-plugin": "^5.2.0",
29+
"@typescript-eslint/parser": "^5.2.0",
3030
"cross-env": "^7.0.3",
3131
"crypto-js": "^4.1.1",
32-
"eslint": "^8.0.1",
32+
"eslint": "^8.1.0",
3333
"eslint-plugin-import": "^2.25.2",
3434
"exceljs": "^4.3.0",
3535
"experimental-allure-playwright": "0.0.3",
3636
"pg": "^8.7.1",
37-
"playwright": "^1.16.1",
38-
"supertest": "^6.1.6",
37+
"playwright": "^1.16.2",
3938
"typescript": "^4.4.4"
4039
}
4140
}

‎playwright.config.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,12 @@ const config: PlaywrightTestConfig = {
146146
},
147147
{
148148
name: `DB`
149+
},
150+
{
151+
name: `API`,
152+
use: {
153+
baseURL: testConfig[process.env.ENV]
154+
}
149155
}
150156
],
151157
};

‎testConfig.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
export const testConfig = {
22
qa: `http://automationpractice.com`,
33
dev: ``,
4-
qaApi: `https://jsonplaceholder.typicode.com`,
4+
qaApi: `https://reqres.in`,
55
devApi: ``,
66
username: `demouat@gmail.com`,
77
password: `U2FsdGVkX1+6691EJeW/QG2vpjUvj47EQBrTIN5BqZg=`,

‎tests/api/GET.test.ts‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,37 @@
1-
import supertest from 'supertest';
21
import { APIActions } from '../../lib/APIActions';
3-
import { testConfig } from '../../testConfig';
4-
import { test, expect } from '@playwright/test';
2+
import { test } from '@playwright/test';
53

64
const apiActions = new APIActions();
75

8-
test(`@API getTodos`, async () => {
9-
const request = supertest(testConfig.qaApi);
10-
const response = await request.get(`/todos/1`);
11-
await apiActions.verifyStatusCode(response.status, 200, expect.getState().currentTestName);
6+
test(`@API getUsers`, async ({ request }) => {
7+
const response = await request.get(`/api/users?per_page=1`);
8+
await apiActions.verifyStatusCode(response.status(), 200);
129

1310
//* Body Response Params and Body Response Headers are stored in single text file separated by #
14-
const responseBodyParams = (await apiActions.readValuesFromTextFile(`getTodos`)).split(`#`)[0];
15-
await apiActions.verifyResponseBody(responseBodyParams, response.body, expect.getState().currentTestName, `Respomse Body`);
11+
const responseBodyParams = (await apiActions.readValuesFromTextFile(`getUsers`)).split(`#`)[0];
12+
await apiActions.verifyResponseBody(responseBodyParams, await response.json(), `Response Body`);
1613

17-
const responseBodyHeaders = (await apiActions.readValuesFromTextFile(`getTodos`)).split(`#`)[1];
18-
await apiActions.verifyResponseBody(responseBodyHeaders, response.headers, expect.getState().currentTestName, `Respomse Headers`);
14+
const responseBodyHeaders = (await apiActions.readValuesFromTextFile(`getUsers`)).split(`#`)[1];
15+
await apiActions.verifyResponseHeader(responseBodyHeaders, response.headersArray(), `Response Headers`);
1916
});
2017

18+
//* In Case you application has token system, Please use the below code
19+
20+
// test(`@API getUsersToken`, async ({ playwright, baseURL }) => {
21+
// const apiContext = await playwright.request.newContext({
22+
// baseURL: baseURL,
23+
// extraHTTPHeaders: {
24+
// 'Authorization': `Your App Token`
25+
// }
26+
// });
27+
// const response = await apiContext.get(`/api/users?per_page=1`);
28+
// await apiActions.verifyStatusCode(response.status(), 200);
29+
30+
// //* Body Response Params and Body Response Headers are stored in single text file separated by #
31+
// const responseBodyParams = (await apiActions.readValuesFromTextFile(`getUsers`)).split(`#`)[0];
32+
// await apiActions.verifyResponseBody(responseBodyParams, await response.json(), `Response Body`);
33+
34+
// const responseBodyHeaders = (await apiActions.readValuesFromTextFile(`getUsers`)).split(`#`)[1];
35+
// await apiActions.verifyResponseHeader(responseBodyHeaders, response.headersArray(), `Response Headers`);
36+
// });
37+

‎tests/api/POST.test.ts‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
import supertest from 'supertest';
21
import { APIActions } from '../../lib/APIActions';
3-
import { test, expect } from '@playwright/test';
2+
import { test } from '@playwright/test';
43

54
const apiActions = new APIActions();
65

7-
test(`@API postUsers`, async () => {
8-
const request = supertest(`https://reqres.in`);
6+
test(`@API postUsers`, async ({ request }) => {
97

108
//* Body Response Params and Body Response Headers are stored in single text file separated by #
119
const requestBody = JSON.parse(await (await apiActions.readValuesFromTextFile('postUsers')).split(`#`)[0]);
12-
const response = await request.post(`/api/users`).send(requestBody);
13-
await apiActions.verifyStatusCode(response.status, 201, expect.getState().currentTestName);
10+
const response = await request.post(`/api/users`, { data: requestBody });
11+
await apiActions.verifyStatusCode(response.status(), 201);
1412

1513
const responseBodyParams = (await apiActions.readValuesFromTextFile(`postUsers`)).split(`#`)[1];
16-
await apiActions.verifyResponseBody(responseBodyParams, response.body, expect.getState().currentTestName, `Respomse Body`);
17-
14+
await apiActions.verifyResponseBody(responseBodyParams, await response.json(), `Response Body`);
15+
1816
const responseBodyHeaders = (await apiActions.readValuesFromTextFile(`postUsers`)).split(`#`)[2];
19-
await apiActions.verifyResponseBody(responseBodyHeaders, response.headers, expect.getState().currentTestName, `Respomse Headers`);
17+
await apiActions.verifyResponseHeader(responseBodyHeaders, response.headersArray(), `Respomse Headers`);
2018
});
2119

‎utils/api/getTodos.txt‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎utils/api/getUsers.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
page|per_page|total|total_pages|data|id|email|first_name|last_name|avatar|support|url|text#
2+
Date, Content-Type, Transfer-Encoding, Connection, x-powered-by, access-control-allow-origin, etag, via, Cache-Control,
3+
CF-Cache-Status, Age, Expect-CT, Report-To, NEL, Vary, Server, CF-RAY, Content-Encoding, alt-svc

‎utils/api/postUsers.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{"name": "morpheus","job": "leader"}#
22
|name|job|id|createdAt#
3-
"date":|"content-type":"application/json; charset=utf-8"|"content-length":|"connection":"close"|"x-powered-by":"Express"|"access-control-allow-origin":|"via"|cf-cache-status"|"report-to"
3+
Date, Content-Type, Content-Length, Connection, x-powered-by, access-control-allow-origin, etag, via, CF-Cache-Status,
4+
Expect-CT, Report-To, NEL, Server, CF-RAY, alt-svc

0 commit comments

Comments
 (0)