Allure report integrated with attachment in api request

Author: Serhat Bolsu

.gitignore

@@ -1,3 +1,4 @@
 /node_modules/*
 .idea/*
 .env
+/allure-*/*

jest.config.js

@@ -18,7 +18,7 @@ module.exports = {
   // clearMocks: false,
 
   // Indicates whether the coverage information should be collected while executing the test
-  // collectCoverage: false,
+  collectCoverage: false,
 
   // An array of glob patterns indicating a set of files for which coverage information should be collected
   // collectCoverageFrom: undefined,
@@ -97,7 +97,7 @@ module.exports = {
   // projects: undefined,
 
   // Use this configuration option to add custom reporters to Jest
-  // reporters: undefined,
+  reporters: ["default", "jest-allure"],
 
   // Automatically reset mock state between every test
   // resetMocks: false,
@@ -126,7 +126,7 @@ module.exports = {
   setupFiles: ["<rootDir>/config/setup.js"],
 
   // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  // setupFilesAfterEnv: [],
+  setupFilesAfterEnv: ["jest-allure/dist/setup"],
 
   // A list of paths to snapshot serializer modules Jest should use for snapshot testing
   // snapshotSerializers: [],

package-lock.json

@@ -37,6 +37,7 @@
     "eslint-plugin-jest": "^23.9.0",
     "husky": "^4.2.5",
     "jest": "^25.4.0",
+    "jest-allure": "^0.1.1",
     "superagent": "^5.2.2",
     "superagent-defaults": "^0.1.14"
   },

package.json

@@ -17,46 +17,68 @@ class BaseApi {
     this.request.set(this.headers);
   }
 
+  setAllureAttachment(res) {
+    // TODO: Handle other types that allure report can show properly.
+    if (Object.keys(res.body).length !== 0) {
+      const contentType = res.headers['content-type']
+          .includes('application/json') ? 'application/json' : 'txt';
+      const obj = contentType === 'application/json' ? JSON.stringify(res.body) : res.body;
+      reporter.addAttachment(res.req.path, obj, contentType);
+    }
+  }
+
   async get(url, headers={}, query={}, body={}) {
     url = url.startsWith('/') ? url : `/${url}`;
     if (Object.keys(body).length !== 0) {
-      return this.request.get(this.baseUrl + url)
+      const res = await this.request.get(this.baseUrl + url)
           .send(body)
           .set(headers)
           .query(query);
+      this.setAllureAttachment(res);
+      return res;
     } else {
-      return this.request.get(this.baseUrl + url)
+      const res = await this.request.get(this.baseUrl + url)
           .send({})
           .set(headers)
           .query(query);
+      this.setAllureAttachment(res);
+      return res;
     }
   }
 
   async post(url, body={}, headers={}) {
     url = url.startsWith('/') ? url : `/${url}`;
-    return this.request.post(this.baseUrl + url)
+    const res = await this.request.post(this.baseUrl + url)
         .send(body)
         .set(headers);
+    this.setAllureAttachment(res);
+    return res;
   }
 
   async put(url, body={}, headers ={}) {
     url = url.startsWith('/') ? url : `/${url}`;
-    return this.request.put(this.baseUrl + url)
+    const res = await this.request.put(this.baseUrl + url)
         .send(body)
         .set(headers);
+    this.setAllureAttachment(res);
+    return res;
   }
 
   async patch(url, body={}, headers ={}) {
     url = url.startsWith('/') ? url : `/${url}`;
-    return this.request.patch(this.baseUrl + url)
+    const res = await this.request.patch(this.baseUrl + url)
         .send(body)
         .set(headers);
+    this.setAllureAttachment(res);
+    return res;
   }
 
   async delete(url, headers ={}) {
     url = url.startsWith('/') ? url : `/${url}`;
-    return this.request.delete(this.baseUrl + url)
+    const res = await this.request.delete(this.baseUrl + url)
         .set(headers);
+    this.setAllureAttachment(res);
+    return res;
   }
 }