Added error handling for api response

also
- resources use dynamically calculated properties instead of being method
- allure repot documentation and code added

Author: Serhat Bolsu

README.md

@@ -118,6 +118,11 @@ Run individual test suite
 
 ```npm test -- test/basic.spec.js```
 
+Allure Report
+(you must have installed [allure command line](https://docs.qameta.io/allure/#_get_started))
+
+```npm run report```
+
 Post report to Microsoft Teams channel
 ```
 export HOOK_URL=<microsoft_web_hook_url>

package.json

@@ -7,6 +7,7 @@
     "start": "node server/server.js",
     "test": "jest --json --outputFile='./testResults.json'",
     "lint": "eslint .",
+    "report": "allure serve",
     "report.teams" : "TEST_FRAMEWORK=jest PROJECT_NAME='Api Sample Test Boilerplate'  PROJECT_ENVIRONMENT=SIT PROJECT_TEST_TYPE=API node utils/teamsReporter.js ../testResults.json"
   },
   "husky": {

resources/BaseApi.js

@@ -5,7 +5,7 @@ class BaseApi {
   constructor() {
     this.request = superagent;
     this.headers = {};
-    this.baseUrl = 'http://localhost:3000';
+    this.baseUrl = global.baseUrl;
   }
 
   /**
@@ -37,14 +37,16 @@ class BaseApi {
       const res = await this.request.get(this.baseUrl + url)
           .send(body)
           .set(headers)
-          .query(query);
+          .query(query)
+          .ok((res) => res.status <= 500);
       this.setAllureAttachment(res);
       return res;
     } else {
       const res = await this.request.get(this.baseUrl + url)
           .send({})
           .set(headers)
-          .query(query);
+          .query(query)
+          .ok((res) => res.status <= 500);
       this.setAllureAttachment(res);
       return res;
     }
@@ -54,7 +56,8 @@ class BaseApi {
     url = url.startsWith('/') ? url : `/${url}`;
     const res = await this.request.post(this.baseUrl + url)
         .send(body)
-        .set(headers);
+        .set(headers)
+        .ok((res) => res.status <= 500);
     this.setAllureAttachment(res);
     return res;
   }
@@ -63,7 +66,8 @@ class BaseApi {
     url = url.startsWith('/') ? url : `/${url}`;
     const res = await this.request.put(this.baseUrl + url)
         .send(body)
-        .set(headers);
+        .set(headers)
+        .ok((res) => res.status <= 500);
     this.setAllureAttachment(res);
     return res;
   }
@@ -72,15 +76,17 @@ class BaseApi {
     url = url.startsWith('/') ? url : `/${url}`;
     const res = await this.request.patch(this.baseUrl + url)
         .send(body)
-        .set(headers);
+        .set(headers)
+        .ok((res) => res.status <= 500);
     this.setAllureAttachment(res);
     return res;
   }
 
   async delete(url, headers ={}) {
     url = url.startsWith('/') ? url : `/${url}`;
     const res = await this.request.delete(this.baseUrl + url)
-        .set(headers);
+        .set(headers)
+        .ok((res) => res.status <= 500);
     this.setAllureAttachment(res);
     return res;
   }

resources/resources.js

@@ -1,7 +1,7 @@
 import VegetableResource from './vegetable.resource';
 
 class Resources {
-  vegetable() {
+  get vegetable() {
     return new VegetableResource();
   }
 }

test/basic_api_resource.spec.js

@@ -2,29 +2,29 @@ import resources from '../resources/resources';
 
 describe('Vegetables - using Api Resource facade', function() {
   it('should get default', async function() {
-    const vegetables = await resources.vegetable().getAll();
+    const vegetables = await resources.vegetable.getAll();
     expect(vegetables[0]).toHaveProperty('id');
-    console.log(resources.vegetable().getUniqueVegetables());
+    console.log(resources.vegetable.getUniqueVegetables());
   });
 
   it('should get without optional', async function() {
-    const vegetables = await resources.vegetable().getAll(false);
+    const vegetables = await resources.vegetable.getAll(false);
     expect(vegetables[0]).not.toHaveProperty('origin');
   });
 
   it('should create vegetable', async function() {
-    const res = await resources.vegetable().create(
+    const res = await resources.vegetable.create(
         "Orange", "UAE", "5", "2020-03-10");
     expect(res.status).toBe(201);
     expect(res.text).toMatch(/added: Orange/);
   });
 
   it('should delete vegetable', async function() {
-    const res = await resources.vegetable().create(
+    const res = await resources.vegetable.create(
         "Orange", "UAE", "5", "2020-03-10");
     expect(res.status).toBe(201);
     const id = res.body.id;
-    const res2 = await resources.vegetable().delete('/vegetables' + '/' + id);
+    const res2 = await resources.vegetable.delete('/vegetables' + '/' + id);
     expect(res2.status).toBe(200);
   });
 });