add graphql steps

Author: ALegchilov

.gitignore

@@ -1,3 +1,5 @@
 node_modules/
 lib/
 test-e2e/report.xml
+.idea
+report.html

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.18.0
+- added support of GraphQL along with specific steps:
+  - _I create GraphQL request {string}_
+  - _I add {gqlRequestProperty} to GraphQL {string}:_
+
 ## 0.17.0
 - added experimental support of websockets (API may change in future)
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@qavajs/steps-api",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "api steps for @qavajs project",
   "main": "./index.js",
   "scripts": {
@@ -11,11 +11,6 @@
     "test:e2e": "qavajs run --config test-e2e/api.ts",
     "debug:e2e": "qavajs run --config test-e2e/api.ts --tags @debug"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run lint:write"
-    }
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/qavajs/steps-api.git"
@@ -57,7 +52,6 @@
     "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-prettier": "^5.0.1",
     "express": "^4.18.2",
-    "husky": "^8.0.3",
     "prettier": "^3.0.3",
     "ts-node": "^10.9.1",
     "typescript": "^5.2.2",

package.json

@@ -0,0 +1,21 @@
+export default class GraphQl {
+  method = 'POST';
+  headers = {'Content-Type': 'application/json'}
+  _query = '';
+  _variables = {};
+  body = '';
+
+  private updateBody() {
+    this.body = JSON.stringify({query: this._query, variables: this._variables});
+  };
+
+  set query(query: string) {
+    this._query = query;
+    this.updateBody();
+  };
+
+  set variables(variables: string) {
+    this._variables = JSON.parse(variables);
+    this.updateBody();
+  };
+}

src/GraphQl.ts

@@ -1,6 +1,7 @@
 import memory from '@qavajs/memory';
-import { DataTable, When } from '@cucumber/cucumber';
-import { dataTable2Object, sendHttpRequest } from './utils';
+import {DataTable, When} from '@cucumber/cucumber';
+import {dataTable2Object, sendHttpRequest} from './utils';
+import GraphQl from './GraphQl';
 
 /**
  * Create request template and save it to memory
@@ -13,6 +14,16 @@ When('I create {string} request {string}', function (method: string, key: string
   memory.setValue(key, { method });
 });
 
+/**
+ * Create GraphQL request template and save it to memory
+ * @example
+ * When I create GraphQL request 'request'
+ */
+When('I create GraphQL request {string}', function (key: string) {
+  const blankRequest = new GraphQl();
+  memory.setValue(key, blankRequest);
+});
+
 /**
  * Add data table of headers to request
  * @param {string} requestKey - memory key of request
@@ -24,7 +35,7 @@ When('I create {string} request {string}', function (method: string, key: string
  */
 When('I add headers to {string}:', async function (requestKey: string, headersDataTable: DataTable) {
   const request: RequestInit = await memory.getValue(requestKey);
-  request.headers = await dataTable2Object(headersDataTable);
+  request.headers = Object.assign(await dataTable2Object(headersDataTable), request.headers);
 });
 
 /**
@@ -37,7 +48,7 @@ When('I add headers to {string}:', async function (requestKey: string, headersDa
  */
 When('I add {string} headers to {string}', async function (headersKey: string, requestKey: string) {
   const request: RequestInit = await memory.getValue(requestKey);
-  request.headers = await memory.getValue(headersKey);
+  request.headers = Object.assign(await memory.getValue(headersKey), request.headers);
 });
 
 /**
@@ -58,6 +69,28 @@ When('I add body to {string}:', async function (requestKey: string, body: string
   request.body = await memory.getValue(body);
 });
 
+/**
+ * Add query or variables to GraphQL request.
+ * @param {string} property - one of GraphQl specific properties "query" or "variables"
+ * @param {string} requestKey - memory key of request
+ * @param {string} valueString - multiline string to be set as GraphQl body value.
+ *
+ * @example
+ * When I add query to GraphQL '$request':
+ * """
+ *    query {
+ *      characters(page: 2, filter: { name: "rick" }) {
+ *        results {
+ *          name
+ *           }
+ *         }
+ *      }
+ **/
+When('I add {gqlRequestProperty} to GraphQL {string}:', async function (property: string, requestKey: string, valueString: string) {
+  const request: any = await memory.getValue(requestKey);
+  request[property] = (await memory.getValue(valueString));
+});
+
 /**
  * Add form data body to request
  * @param {string} requestKey - memory key of request

src/apiConstructionSteps.ts

@@ -24,3 +24,14 @@ defineParameterType({
   transformer: (p) => p,
   useForSnippets: false,
 });
+
+/**
+ * Used to initialize one of two possible GraphQl body properties
+ *
+ * @returns {string}
+ */
+defineParameterType({
+  name: 'gqlRequestProperty',
+  regexp: /query|variables/,
+  transformer: s => s
+});

src/parameterTypes.ts

@@ -1,5 +1,19 @@
 Feature: Construction API
 
+  Scenario: GraphQL send
+    Given I create GraphQL request 'request'
+    And I add 'https://rickandmortyapi.com/graphql' url to '$request'
+    And I add query to GraphQL '$request':
+    """
+    query {  characters(page: 2, filter: { name: "rick" }) {
+      results { name }
+         }
+      }
+    """
+    And I send '$request' request and save response as 'response'
+    And I parse '$response' body as json
+    Then Response '$response' Status Code to be equal '200'
+
   Scenario: Verify simple send
     Given I create 'GET' request 'request'
     And I add 'https://jsonplaceholder.typicode.com/todos/1' url to '$request'