Merge pull request #13 from qavajs/update-memory-integration

Update memory integration

Author: AlexGalichenko

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/steps-api",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "api steps for @qavajs project",
   "main": "./index.js",
   "scripts": {
@@ -31,9 +31,9 @@
   "homepage": "https://github.com/qavajs/steps-api#readme",
   "devDependencies": {
     "@babel/core": "^7.18.6",
-    "@cucumber/cucumber": "^8.10.0",
+    "@cucumber/cucumber": "^8.11.1",
     "@qavajs/cli": "^0.0.17",
-    "@qavajs/memory": "^1.1.1",
+    "@qavajs/memory": "^1.2.0",
     "@qavajs/xunit-formatter": "^0.0.3",
     "@types/babel__core": "^7.1.19",
     "@types/chai": "^4.3.1",
@@ -59,13 +59,13 @@
     "prettier": "^2.3.2",
     "ts-jest": "^28.0.5",
     "ts-node": "^10.9.1",
-    "typescript": "^4.7.3"
+    "typescript": "^4.9.5",
+    "fs-extra": "^11.1.0"
   },
   "dependencies": {
     "@qavajs/api-service": "^0.0.3",
     "@qavajs/validation": "^0.0.2",
-    "chai": "^4.3.6",
-    "fs-extra": "^10.1.0",
+    "chai": "^4.3.7",
     "node-fetch": "^2.6.1"
   }
 }

package.json

@@ -23,9 +23,9 @@ When(
   async function (method: string, url: string, headers: any, key: string) {
     const conf: RequestInit = {
       method,
-      ...headers,
+      ...(await headers),
     };
-    const response = await sendHttpRequest(url, conf);
+    const response = await sendHttpRequest(await url, conf);
 
     // store response to memory to be able to use it in next steps
     memory.setValue(key, response);
@@ -47,11 +47,11 @@ When(
 When(
   'I send {string} request to {landingUrl}{headers} with qs {string} and save response as {string}',
   async function (method: string, url: string, headers: any, params: string, key: string) {
-    params = memory.getValue(params);
-    url = `${url}${params}`;
+    params = await memory.getValue(params);
+    url = `${await url}${params}`;
     const conf: RequestInit = {
       method,
-      ...headers,
+      ...(await headers),
     };
     const response = await sendHttpRequest(url, conf);
 
@@ -82,10 +82,10 @@ When(
   async function (method: string, url: string, headers: any, requestBody: JSON, key: string) {
     const conf: RequestInit = {
       method,
-      body: JSON.stringify(requestBody),
-      ...headers,
+      body: JSON.stringify(await requestBody),
+      ...(await headers),
     };
-    const response = await sendHttpRequest(url, conf);
+    const response = await sendHttpRequest(await url, conf);
 
     // store response to memory to be able to use it in next steps
     memory.setValue(key, response);
@@ -108,14 +108,14 @@ When(
 When(
   'I send {string} request to {landingUrl}{headers} with qs {string} and Body {json} and save response as {string}',
   async function (method: string, url: string, headers: any, params: string, requestBody: JSON, key: string) {
-    params = memory.getValue(params);
-    url = `${url}${params}`;
+    params = await memory.getValue(params);
+    url = `${await url}${params}`;
     const conf: RequestInit = {
       method,
-      body: JSON.stringify(requestBody),
-      ...headers,
+      body: JSON.stringify(await requestBody),
+      ...(await headers),
     };
-    const response = await sendHttpRequest(url, conf);
+    const response = await sendHttpRequest(await url, conf);
 
     // store response to memory to be able to use it in next steps
     memory.setValue(key, response);
@@ -144,10 +144,10 @@ When(
   async function (method: string, key: string, url: string, headers: any, requestBody: JSON) {
     const conf: RequestInit = {
       method,
-      body: requestBody,
-      ...headers,
+      body: await requestBody,
+      ...(await headers),
     };
-    const response = await sendHttpRequest(url, conf);
+    const response = await sendHttpRequest(await url, conf);
 
     // store response to memory to be able to use it in next steps
     memory.setValue(key, response);

src/apiActionSteps.ts

@@ -11,9 +11,9 @@ import memory from '@qavajs/memory';
  *
  * @param {String} statusCode should be valid status code
  */
-Then('Response {response} Status Code {apiValidation} {string}', (response: any, validationType: string, statusCode: string) => {
+Then('Response {response} Status Code {apiValidation} {string}', async (response: any, validationType: string, statusCode: string) => {
   const validation = getValidation(validationType);
-  statusCode = memory.getValue(statusCode);
+  statusCode = await memory.getValue(statusCode);
   validation(response.status, parseInt(statusCode, 10));
 });
 
@@ -25,9 +25,9 @@ Then('Response {response} Status Code {apiValidation} {string}', (response: any,
  *
  * @param {String} statusMessage should be valid status code
  */
-Then('Response {response} Status Message {apiValidation} {string}', (response: any, validationType: string, statusMessage: string) => {
+Then('Response {response} Status Message {apiValidation} {string}', async (response: any, validationType: string, statusMessage: string) => {
   const validation = getValidation(validationType);
-  statusMessage = memory.getValue(statusMessage);
+  statusMessage = await memory.getValue(statusMessage);
   validation(response.statusText, statusMessage);
 });
 
@@ -72,9 +72,9 @@ Then('Response {response} contains:', (property: any, dataTable: any) => {
  * @param {String} pathQuery json path
  * @param {String} type should be named as expected value type
  */
-Then('Response {response} {apiValidation} {string}', (property: any, validationType: string, type: string) => {
+Then('Response {response} {apiValidation} {string}', async (property: any, validationType: string, type: string) => {
   const validation = getValidation(validationType);
-  type = memory.getValue(type);
+  type = await memory.getValue(type);
   validation(typeof property, type);
 });
 
@@ -88,10 +88,10 @@ Then('Response {response} {apiValidation} {string}', (property: any, validationT
  * @param {String} action should be named as expected action (equal to|less than|greater)
  * @param {String} expectedValue Number for comparing with array size
  */
-Then('Response {response} size {apiValidation} {string}', (property: any, validationType: string, expectedValue: string) => {
+Then('Response {response} size {apiValidation} {string}', async (property: any, validationType: string, expectedValue: string) => {
   const validation = getValidation(validationType);
   const count = property.length;
-  expectedValue = memory.getValue(expectedValue);
+  expectedValue = await memory.getValue(expectedValue);
   validation(count, expectedValue);
 });
 
@@ -106,6 +106,6 @@ Then('Response {response} size {apiValidation} {string}', (property: any, valida
  */
 Then('I verify response {response} {apiValidation} {string}', async (property: any, validationType: string, expectedValue: string) => {
   const validation = getValidation(validationType);
-  expectedValue = memory.getValue(expectedValue);
+  expectedValue = await memory.getValue(expectedValue);
   validation(property, expectedValue);
 });

src/apiVerificationSteps.ts

@@ -1,7 +1,5 @@
 import { defineParameterType } from '@cucumber/cucumber';
 import memory from '@qavajs/memory';
-import fse from 'fs-extra';
-import { getTestDataFilePath } from './utils';
 
 /**
  * Used for urls.
@@ -14,14 +12,7 @@ defineParameterType({
   regexp: /"([^"\\]*(\\.[^"\\]*)*)"/,
   name: 'landingUrl',
   useForSnippets: false,
-  transformer: (string: string) => {
-    if (string.indexOf('http') === 0) {
-      return string;
-    }
-    if (string.startsWith('$')) {
-      return memory.getValue(string);
-    }
-  },
+  transformer: (string: string) => memory.getValue(string),
 });
 
 /**
@@ -42,13 +33,7 @@ defineParameterType({
   regexp: /"([^"\\]*(\\.[^"\\]*)*)"/,
   name: 'json',
   useForSnippets: false,
-  transformer: (str: string) => {
-    if (str.startsWith('$')) {
-      return memory.getValue(str);
-    }
-    const filePath = getTestDataFilePath(str);
-    return fse.readJSONSync(filePath);
-  },
+  transformer: (str: string) => memory.getValue(str),
 });
 
 /**
@@ -72,11 +57,7 @@ defineParameterType({
     if (!str) {
       return {};
     }
-    if (str.includes('$')) {
-      return memory.getValue(str);
-    }
-    const filePath = getTestDataFilePath(str);
-    return fse.readJSONSync(filePath);
+    return memory.getValue(str);
   },
 });
 

src/parameterTypes.ts

@@ -34,7 +34,7 @@ Feature: API
     And Response "$response" Status Message to be equal 'OK'
 
   Scenario: Verify simple send with query and headers as file
-    When I send 'GET' request to "https://jsonplaceholder.typicode.com/posts" with headers "headers.json" with qs "?userId=1" and save response as 'response'
+    When I send 'GET' request to "https://jsonplaceholder.typicode.com/posts" with headers "$json('testData/headers.json')" with qs "?userId=1" and save response as 'response'
     Then Response "$response" Status Code to be equal '200'
     And Response "$response" Status Message to be equal 'OK'
 
@@ -70,7 +70,7 @@ Feature: API
     And Response "$response" Status Message to be equal 'Created'
 
   Scenario: Verify POST with valid request body as file
-    When I send "POST" request to "https://jsonplaceholder.typicode.com/posts" with Body "test_data_file.json" and save response as "response"
+    When I send "POST" request to "https://jsonplaceholder.typicode.com/posts" with Body "$json('testData/test_data_file.json')" and save response as "response"
     Then Response "$response" Status Code to be equal '201'
     And Response "$response" Status Message to be equal 'Created'
     And Response "$response.payload" contains:
@@ -80,7 +80,7 @@ Feature: API
       | body      |
 
   Scenario: Verify POST with valid request body as file and headers as file
-    When I send "POST" request to "https://jsonplaceholder.typicode.com/posts" with headers "headers.json" with Body "test_data_file.json" and save response as "response"
+    When I send "POST" request to "https://jsonplaceholder.typicode.com/posts" with headers "$json('testData/headers.json')" with Body "$json('testData/test_data_file.json')" and save response as "response"
     Then Response "$response" Status Code to be equal '201'
     And Response "$response" Status Message to be equal 'Created'
     And Response "$response.payload" contains:

src/utils.ts

@@ -1 +1,8 @@
-export default class Memory {}
+import fs from 'fs/promises';
+
+export default class Memory {
+  json = async (path: string): Promise<any> => {
+    const file = await fs.readFile(path, 'utf-8');
+    return JSON.parse(file);
+  };
+}

test-e2e/features/api.feature

@@ -3,11 +3,11 @@ import memory from '@qavajs/memory';
 import { expect } from 'chai';
 
 declare global {
-    let config: any;
+  let config: any;
 }
 
-Then('I expect {string} memory value to be equal {string}', async function(actual, expected) {
-    const actualValue = memory.getValue(actual);
-    const expectedValue = memory.getValue(expected);
-    expect(expectedValue).to.eql(actualValue);
+Then('I expect {string} memory value to be equal {string}', async function (actual, expected) {
+  const actualValue = memory.getValue(actual);
+  const expectedValue = memory.getValue(expected);
+  expect(expectedValue).to.eql(actualValue);
 });