Post report to teams tool, update to singleton design (#2)

* Added microsoft teams report publisher

* Allure reporting handled when allure report is not used

* Resource object support intellisense

* README update

Co-authored-by: Serhat Bolsu <s944588@emirates.com>

Author: serhatbolsu

.gitignore

@@ -2,3 +2,4 @@
 .idea/*
 .env
 /allure-*/*
+testResults*.json

README.md

@@ -71,7 +71,7 @@ Uses resource object, this is a similar method used in selenium with **page Obje
 - in `vegetable.resource.js` you can write various methods with regards to this specific endpoint.
 - re-usability increased with common vegetable endpoint functions.
 - usage of superagent/requests encapsulated, however still usable look at tc#3
-- Pre-initialized resource-objects, it serve as a facade to service under test.
+- Pre-initialized resource-objects are singleton objects. So single object is shared inside test case.
 
 
 ## Familiarizing Yourself with the System Under Test
@@ -118,6 +118,12 @@ Run individual test suite
 
 ```npm test -- test/basic.spec.js```
 
+Post report to Microsoft Teams channel
+```
+export HOOK_URL=<microsoft_web_hook_url>
+npm run report.teams
+
+```
 
 ## Contributors
 Special thanks to [gsypolt](https://github.com/gsypolt/api-testing-javascript) as he is the owner of vegetable api.
@@ -128,3 +134,4 @@ Please create a pull request.
 ## ToDO
 
 - Jenkinsfile
+- Slack Reporter (looking for help, send a PR if you are interested)

package.json

@@ -5,8 +5,9 @@
   "main": "index.js",
   "scripts": {
     "start": "node server/server.js",
-    "test": "jest",
-    "lint": "eslint ."
+    "test": "jest --json --outputFile='./testResults.json'",
+    "lint": "eslint .",
+    "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": {
     "hooks": {

resources/BaseApi.js

@@ -19,11 +19,15 @@ class BaseApi {
 
   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);
+    try {
+      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);
+      }
+    } catch (error) {
+      // ignore if allure is not set
     }
   }
 

resources/api.js

@@ -1,12 +1,8 @@
 const VegetableResource = require('./vegetable.resource');
 
 class Api {
-  constructor() {
-    this.resources = {};
-  }
-
   vegetable() {
-    return this.resources.vegetable = this.resources.vegetable || new VegetableResource();
+    return new VegetableResource();
   }
 }
 

resources/vegetable.resource.js

@@ -1,4 +1,5 @@
 const BaseApi = require('./BaseApi');
+let instance = null;
 
 function Vegetable(jsonBody) {
   this.id = jsonBody.id;
@@ -10,9 +11,14 @@ function Vegetable(jsonBody) {
 
 class VegetableResource extends BaseApi {
   constructor() {
-    super();
-    this.path = '/vegetables';
-    this.vegetables = [];
+    if (!instance) {
+      super();
+      instance = this;
+      this.path = '/vegetables';
+      this.vegetables = [];
+    }
+
+    return instance;
   }
 
   async create(name, price, releaseDate, origin) {

utils/teamsReporter.js

@@ -0,0 +1,84 @@
+const request = require('superagent');
+
+function main() {
+  if (process.env.TEST_FRAMEWORK === undefined) {
+    throw new Error('TEST_FRAMEWORK should be defined either as "jest" or "mocha"');
+  } else if (process.env.HOOK_URL === undefined) {
+    throw new Error('HOOK_URL should be defined as Microsoft teams channel hook url');
+  }
+  const file = process.argv[2];
+  if (!file) throw new Error('File path is not given');
+
+  const platform = process.env.TEST_FRAMEWORK;
+  const hookUrl = process.env.HOOK_URL;
+  const project = process.env.PROJECT_NAME;
+  const environment = process.env.PROJECT_ENVIRONMENT;
+  const type = process.env.PROJECT_TEST_TYPE;
+  const buildUrl = process.env.BUILD_URL;
+
+  let total = 0;
+  let passed = 0;
+  let failed = 0;
+  let skipped = 0;
+
+  // logic to get results
+  if (platform === 'jest') {
+    const testData = require(file);
+    total = testData['numTotalTests'];
+    passed= testData['numPassedTests'];
+    failed = testData['numFailedTests'];
+    skipped = total - passed - failed;
+  } else if (platform === 'mocha') {
+    // TODO: Implement this
+  }
+
+  let results = `**${total} Tests**: ✔${passed} passed`;
+  if (failed > 0) results += `, ❗${failed} failed`;
+  if (skipped > 0) results += `, ➖${skipped} skipped`;
+
+  request.post(hookUrl)
+      .send(
+          {
+            "@type": "MessageCard",
+            "@context": "http://schema.org/extensions",
+            "themeColor": "33F0FF",
+            "summary": `Test report for ${project}`,
+            "sections": [
+              {
+
+                "activityTitle": `## ${project}, ${environment}, ${type}`,
+                // "activitySubtitle": "Status of build #90",
+                "facts": [
+                  {
+                    "name": "Environment",
+                    "value": environment,
+                  },
+                  // {
+                  //   "name": "Type",
+                  //   "value": "UI",
+                  // },
+                  {
+                    "name": "Status",
+                    "value": results,
+                  },
+                ],
+                "markdown": true,
+              },
+            ],
+            "potentialAction": [
+              {
+                "@type": "OpenUri",
+                "name": "View Report",
+                "targets": [
+                  { "os": "default", "uri": buildUrl },
+                ],
+              },
+            ],
+          },
+      )
+      .then( (res) => {
+        console.log(`Post results to Microsoft Teams with status: ${res.status}`);
+      });
+}
+
+main();