Merge pull request #38 from smartprocure/feature/browser-result-parser

Feature/browser result parser

.dutirc.json

@@ -3,6 +3,7 @@
   "recommendedPrReviewers": 1,
   "lintResultsPath": ".",
   "testResultsPath": ".",
+  "browserResultsPath": ".",
   "disallowedStrings": ["#ISSUEID"],
   "autoFix": {
     "extensions": [".js"]

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.8.0
+
+- Add browser test result parser (karma).
+- Add prettier configuration.
+
 ## 0.7.1
 
 - Fix default configuration not loading properly

package.json

@@ -4,8 +4,12 @@
   "bin": {
     "duti": "bin/duti"
   },
-  "version": "0.7.1",
+  "version": "0.8.0",
   "main": "src/index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/smartprocure/duti.git"
+  },
   "license": "MIT",
   "engines": {
     "node": ">=8.0.0"
@@ -30,6 +34,11 @@
       "sourceType": "module"
     }
   },
+  "prettier": {
+    "singleQuote": true,
+    "semi": false,
+    "trailingComma": "es5"
+  },
   "dependencies": {
     "bluebird": "^3.5.0",
     "cosmiconfig": "^2.2.2",

src/dangerfile.js

@@ -4,7 +4,12 @@ let Promise = require('bluebird')
 let cosmiconfig = require('cosmiconfig')
 let defaultConfig = require('../.dutirc.json')
 let duties = require('./duties')
-let { getLintResults, getTestResults, log } = require('./utils')
+let {
+  getLintResults,
+  getTestResults,
+  getBrowserResults,
+  log,
+} = require('./utils')
 
 let explorer = cosmiconfig('duti', { rcExtensions: true })
 
@@ -28,6 +33,7 @@ schedule(async () => {
       message: log(message),
       lintResults: await getLintResults({ config }),
       testResults: await getTestResults({ config }),
+      browserResults: await getBrowserResults({ config }),
     })
   )
 })

src/duties/browserResults.js

@@ -0,0 +1,47 @@
+let _ = require('lodash/fp')
+
+let hasBrowserErrors = ({ browserResults, fail, message }) => {
+  if (_.isNil(browserResults)) {
+    message('Could not find any browser results.')
+    return
+  }
+
+  let { result, summary } = browserResults
+
+  if (result && summary) {
+    let { error, failed, exitCode } = summary
+    if (error === false && failed === 0 && exitCode === 0) {
+      message('Your PR has no browser errors. Great job!')
+      return
+    }
+
+    if (failed > 0) {
+      _.flow(
+        // Flatten test results into one array.
+        _.values,
+        _.flatten,
+        // Filter by failed tests.
+        _.reject({ success: true }),
+        // Format error log.
+        _.map(
+          f => `\nSuite: ${f.suite}\nDescription: ${f.description}\n${f.log}\n`
+        ),
+        _.concat([`Your PR has ${failed} failed browser tests:`]),
+        _.join('\n'),
+        fail
+      )(result)
+      return
+    }
+
+    // All other cases: error is not false, exitCode is not 0 etc.
+    fail('Browser test error. Please see CI logs for more details.')
+  } else {
+    message(
+      'Incorrect browser result format. Please see CI logs for more details.'
+    )
+  }
+}
+
+module.exports = {
+  hasBrowserErrors: hasBrowserErrors,
+}

src/duties/browserResults.spec.js

@@ -0,0 +1,36 @@
+/* eslint-env jest */
+
+let browser = require('./browserResults')
+let browserHelpers = require('../test-data/browser-results')
+
+describe('browser results', () => {
+  it('fails if they have errors', () => {
+    let fail = jest.fn()
+    let message = jest.fn()
+    let browserResults = browserHelpers.failing
+    browser.hasBrowserErrors({ browserResults, fail, message })
+
+    expect(fail).toHaveBeenCalled()
+    expect(message).not.toHaveBeenCalled()
+  })
+
+  it('doesnt fail if it is passing', () => {
+    let fail = jest.fn()
+    let message = jest.fn()
+    let browserResults = browserHelpers.passing
+    browser.hasBrowserErrors({ browserResults, fail, message })
+
+    expect(message).toHaveBeenCalled()
+    expect(fail).not.toHaveBeenCalled()
+  })
+
+  it('doesnt fail but message should be called if data is incorrect', () => {
+    let fail = jest.fn()
+    let message = jest.fn()
+    let browserResults = {}
+    browser.hasBrowserErrors({ browserResults, fail, message })
+
+    expect(message).toHaveBeenCalled()
+    expect(fail).not.toHaveBeenCalled()
+  })
+})

src/duties/index.js

@@ -3,5 +3,14 @@ let lint = require('./lint')
 let testResults = require('./testResults')
 let library = require('./library')
 let autoFix = require('./autoFix')
+let browserResults = require('./browserResults')
 
-module.exports = Object.assign({}, pr, lint, testResults, library, autoFix)
+module.exports = Object.assign(
+  {},
+  pr,
+  lint,
+  testResults,
+  browserResults,
+  library,
+  autoFix
+)