Refactor sanity report generation

Author: harshitha-cstk

package.json

@@ -32,7 +32,7 @@
     "test": "npm run test:api && npm run test:unit",
     "test:sanity-test": "BABEL_ENV=test nyc --reporter=html mocha --require @babel/register ./test/sanity-check/sanity.js -t 30000 --reporter mochawesome --require babel-polyfill --reporter-options reportDir=mochawesome-report,reportFilename=mochawesome.json",
     "test:sanity": "npm run test:sanity-test || true",
-    "test:sanity-report": "marge mochawesome-report/mochawesome.json -f sanity-report.html --inline && node sanity-report.mjs",
+    "test:sanity-report": "node sanity-report.mjs",
     "test:unit": "BABEL_ENV=test nyc --reporter=html --reporter=text mocha --require @babel/register ./test/unit/index.js -t 30000 --reporter mochawesome --require babel-polyfill",
     "test:unit:report:json": "BABEL_ENV=test nyc --reporter=clover --reporter=text mocha --require @babel/register ./test/unit/index.js -t 30000 --reporter json --reporter-options output=report.json  --require babel-polyfill",
     "test:typescript": "jest --testPathPattern=test/typescript --config ./jest.config.js --coverage",

sanity-report.mjs

@@ -2,9 +2,20 @@ import Slack from '@slack/bolt'
 const { App } = Slack
 import dotenv from 'dotenv'
 import fs from 'fs'
+import { execSync } from 'child_process'
+import path from 'path'
 
 dotenv.config()
 
+// Marge expects meta.marge.options to be an Object; mochawesome leaves it null. Patch before marge.
+const reportJsonPath = path.join(process.cwd(), 'mochawesome-report', 'mochawesome.json')
+const json = JSON.parse(fs.readFileSync(reportJsonPath, 'utf8'))
+if (json.meta?.marge?.options == null) {
+  json.meta.marge.options = {}
+  fs.writeFileSync(reportJsonPath, JSON.stringify(json))
+}
+execSync('marge mochawesome-report/mochawesome.json -f sanity-report.html --inline', { stdio: 'inherit', cwd: process.cwd() })
+
 const mochawesomeJsonOutput = fs.readFileSync('./mochawesome-report/mochawesome.json', 'utf8')
 const mochawesomeReport = JSON.parse(mochawesomeJsonOutput)
 const report = `./mochawesome-report/sanity-report.html`
@@ -58,7 +69,6 @@ async function publishMessage (text, report) {
     token: process.env.SLACK_BOT_TOKEN,
     channel_id: process.env.SLACK_CHANNEL_ID,
     initial_comment: '*Here is the report generated*',
-    filetype: 'html',
     filename: 'sanity-report.html',
     file: fs.createReadStream(report)
   })