New: Implement JUnitXMLReporter

#1

Author: Stefan Hölzle

lib/allChecksRunner.js

@@ -1,11 +1,10 @@
 const HtmlPage = require('./html/htmlPage')
 const SinglePageResult = require('./singlePageResult')
-const Logger = require('./logging/LoggingFacacde')
 
 class AllChecksRunner {
-  constructor (config) {
+  constructor (config, /* LoggingFacade */ logger) {
     this.config = config
-    this.logger = new Logger(config)
+    this.logger = logger
   }
 
   async performAllChecks () {

lib/cli/config.js

@@ -81,6 +81,7 @@ exports.loadConfig = filepath => {
  * @returns {string|null} Filepath to config, if found
  */
 exports.findConfig = (cwd = utils.cwd()) => {
+  debug(`Searching for config files in path: ${cwd}`)
   const filepath = findUp.sync(exports.CONFIG_FILES, { cwd })
   if (filepath) {
     debug('findConfig: found config file %s', filepath)

lib/cli/options.js

@@ -1,13 +1,15 @@
 'use strict'
 
+const debug = require('debug')('htmlSanityCheck:cli:options')
+
 /**
  * Main entry point for handling filesystem-based configuration,
  * whether that's a config file or `package.json` or whatever.
  * @module lib/cli/options
  * @private
  */
 
-const { loadConfig, findConfig } = require('./config')
+const { loadConfig, findConfig, CONFIG_FILES } = require('./config')
 const yargsParser = require('yargs-parser')
 const ansi = require('ansi-colors')
 const htmlsanitycheckrc = require('../htmlsanitycheckrc.json')
@@ -127,10 +129,22 @@ const parse = (args = [], defaultValues = {}, ...configObjects) => {
  * @returns {external:yargsParser.Arguments|void} Parsed config, or nothing if `args.config` is `false`
  */
 const loadRc = (args = {}) => {
-  if (args.config !== false) {
-    const config = args.config || findConfig()
-    return config ? loadConfig(config) : {}
+  let configFile
+  if (args.config != null) {
+    debug(`Loading config file specified by cli command: ${args.config}`)
+    configFile = args.config
+  } else {
+    debug(`Searching for default config files: ${CONFIG_FILES}`)
+    configFile = findConfig()
+  }
+  let config = {}
+  if (configFile != null) {
+    debug(`Loading config file ${configFile}`)
+    config = loadConfig()
+  } else {
+    debug('No config file defined by cli command and no default config files found')
   }
+  return config
 }
 
 module.exports.loadRc = loadRc
@@ -159,6 +173,7 @@ const loadOptions = (argv = []) => {
     args._ = args._.concat(rcConfig._ || [])
   }
 
+  debug(`Loading default config: ${JSON.stringify(htmlsanitycheckrc)}`)
   args = parse(args._, htmlsanitycheckrc, args, rcConfig || {})
 
   // recombine positional arguments and "spec"

lib/cli/run-option-metadata.js

@@ -24,8 +24,7 @@ const TYPES = (exports.types = {
   string: [
     'config',
     'sourceDir',
-    'package',
-    'reporter'
+    'package'
   ]
 })
 

lib/cli/run.js

@@ -9,6 +9,9 @@
 
 const HtmlSanityCheck = require('../allChecksRunner')
 const { types, aliases } = require('./run-option-metadata')
+const Logger = require('../logging/LoggingFacade')
+const { createReporters } = require('../utils')
+const debug = require('debug')('htmlSanityCheck:cli:run')
 
 /**
  * Logical option groups
@@ -62,7 +65,14 @@ exports.builder = yargs =>
 
 exports.handler = async function (argv) {
   try {
-    await new HtmlSanityCheck(argv).performAllChecks()
+    const config = argv
+    debug(`config: ${JSON.stringify(config)}`)
+    const logger = new Logger(config)
+    const results = await new HtmlSanityCheck(config, logger).performAllChecks()
+    const reporters = createReporters(config.reporter, logger)
+    reporters.forEach(/* Reporter */ reporter => {
+      reporter.reportFindings(results)
+    })
   } catch (err) {
     console.error('\n Exception during run:', err)
     process.exit(1)

lib/finding.js

@@ -1,9 +1,10 @@
 'use strict'
 
 class Finding {
-  constructor (whatIsTheProblem, nrOfOccurences) {
+  constructor (/* string */ whatIsTheProblem, /* number */ nrOfOccurrences, /* string[] */ suggestions = []) {
     this.whatIsTheProblem = whatIsTheProblem
-    this.nrOfOccurences = nrOfOccurences
+    this.nrOfOccurences = nrOfOccurrences
+    this.suggestions = suggestions
   }
 
   toString () {

lib/htmlsanitycheckrc.json

@@ -1,9 +1,16 @@
 {
   "sourceDir": ".",
-  "extension": ["html"],
+  "extension": [
+    "html"
+  ],
   "recursive": true,
   "package": "./package.json",
-  "reporter": "junit",
+  "reporter": {
+    "junit": {
+      "outputPath": "./test-results/htmlSanityCheck",
+      "enabled": true
+    }
+  },
   "httpSuccessCodes": [200,201,202,203,204,205,206,207,208,226],
   "httpWarningCodes": [100,101,102,300,301,302,303,304,305,306,307,308],
   "httpErrorCodes": [400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,418,419,420,421,422,423,424,425,426,427,428,429,430,431,432,433,434,435,436,437,438,439,440,441,442,443,444,445,446,447,448,449,450,451,500,501,502,503,504,505,506,507,508,509,510,511],
@@ -19,6 +26,5 @@
   "ignoreLocalHost": false,
   "ignoreIPAddresses": false,
   "httpConnectionTimeout": 5000,
-  "junitResultsDir": "./test-results/htmlSanityCheck",
   "checkingResultDir": "./reports/htmlSanityCheck"
 }

lib/logging/LoggingFacacde.js renamed to lib/logging/LoggingFacade.js

@@ -8,6 +8,10 @@ class LoggingFacade {
     this.log('trace', msg)
   }
 
+  info (msg) {
+    this.log('info', msg)
+  }
+
   log (logLevel, msg) {
     if (logLevel === 'trace') {
       if (this.traceLogging) {

lib/reporter/JUnitXmlReporter.js

@@ -0,0 +1,122 @@
+const FILE_EXTENSION = 'xml'
+const { create } = require('xmlbuilder2')
+const fs = require('fs')
+const path = require('path')
+const { v4: uuidv4 } = require('uuid')
+const Reporter = require('./Reporter')
+
+class JUnitXmlReporter extends Reporter {
+  constructor (/* JUnitXmlReporterConfig */ config, /* LoggingFacade */ logger) {
+    super(config, logger)
+    this.config = config
+  }
+
+  reportFindings (/* SinglePageResult[] */ resultsForAllPages) {
+    this.log.info(`resultsForAllPages ${JSON.stringify(resultsForAllPages)}`)
+
+    this.initReport()
+
+    this.reportOverallSummary()
+
+    this.reportAllPages(resultsForAllPages)
+
+    this.closeReport()
+  }
+
+  initReport () {
+    this.log.info(`Creating JUnit XML report output path: ${this.outputPath}`)
+    fs.mkdirSync(this.outputPath, { recursive: true })
+  }
+
+  reportOverallSummary () {
+    // https://github.com/aim42/htmlSanityCheck/blob/main/src/main/groovy/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.groovy#L50
+    // empty in original impl
+  }
+
+  reportAllPages (/* SinglePageResult[] */ resultsForAllPages) {
+    // https://github.com/aim42/htmlSanityCheck/blob/main/src/main/groovy/org/aim42/htmlsanitycheck/report/Reporter.groovy#L73
+    resultsForAllPages.forEach(pageResult => {
+      this.reportPageSummary(pageResult)
+      this.reportPageDetails(pageResult)
+      this.reportPageFooter()
+    })
+  }
+
+  reportPageSummary (/* SinglePageResult */ pageResult) {
+    // https://github.com/aim42/htmlSanityCheck/blob/main/src/main/groovy/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.groovy#L54
+    // Determine the name based on available properties or generate a UUID
+    const nameParts = []
+    nameParts.push(pageResult.pageFilePath)
+    if (pageResult.pageTitle) {
+      nameParts.push(pageResult.pageTitle)
+    } else {
+      nameParts.push(uuidv4())
+    }
+    const name = nameParts.join('_')
+    const sanitizedPath = name.replace(/[^A-Za-z0-9_-]+/g, '_')
+    const testOutputFileName = `TEST-unit-html-${sanitizedPath}.${FILE_EXTENSION}`
+    const testOutputFilePath = path.join(this.outputPath, testOutputFileName)
+
+    // Initialize the XML document
+    const doc = create({ version: '1.0', encoding: 'UTF-8' })
+      .ele('testsuite', {
+        tests: pageResult.nrOfItemsCheckedOnPage().toString(),
+        failures: pageResult.nrOfFindingsOnPage().toString(),
+        errors: '0',
+        time: '0',
+        name: `${pageResult.pageFileName}: ${pageResult.pageTitle}`
+      })
+
+    // Add test cases
+    pageResult.allCheckerResults?.forEach(singleCheckResult => {
+      const testcase = doc.ele('testcase', {
+        assertions: singleCheckResult.nrOfItemsChecked.toString(),
+        time: '0',
+        name: singleCheckResult.whatIsChecked || ''
+      })
+
+      singleCheckResult.findings.forEach(finding => {
+        testcase.ele('failure', {
+          type: singleCheckResult.sourceItemName + ' - ' + singleCheckResult.targetItemName,
+          message: finding.whatIsTheProblem
+        }).txt(finding.suggestions?.join(', ') || '')
+      })
+    })
+
+    // Convert the document to string
+    const xmlString = doc.end({ prettyPrint: true })
+
+    // Write the XML string to a file
+    this.log.info(`Writing JUnit XML report to ${testOutputFilePath}`)
+    fs.writeFileSync(testOutputFilePath, xmlString)
+  }
+
+  reportPageDetails (/* SinglePageResult */ pageResult) {
+    pageResult.allCheckerResults.forEach(resultForOneCheck => {
+      this.reportSingleCheckSummary(resultForOneCheck)
+      this.reportSingleCheckDetails(resultForOneCheck)
+    })
+  }
+
+  reportPageFooter () {
+    // empty in original impl: https://github.com/aim42/htmlSanityCheck/blob/main/src/main/groovy/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.groovy#L87
+  }
+
+  reportSingleCheckSummary (/* SingleCheckResult */ resultForOneCheck) {
+    // empty in original impl: https://github.com/aim42/htmlSanityCheck/blob/main/src/main/groovy/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.groovy#L90
+  }
+
+  reportSingleCheckDetails (/* SingleCheckResult */ resultForOneCheck) {
+    // empty in original impl: https://github.com/aim42/htmlSanityCheck/blob/main/src/main/groovy/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.groovy#L94
+  }
+
+  closeReport () {
+    // empty in original impl: https://github.com/aim42/htmlSanityCheck/blob/main/src/main/groovy/org/aim42/htmlsanitycheck/report/JUnitXmlReporter.groovy#L98
+  }
+}
+
+module.exports = {
+  createReporter: (/* JUnitXmlReporterConfig */ config, /* LoggingFacade */ logger) => {
+    return new JUnitXmlReporter(config, logger)
+  }
+}

lib/reporter/JUnitXmlReporterConfig.js

@@ -0,0 +1,6 @@
+import ReporterConfig from './ReporterConfig'
+
+class JUnitXmlReporterConfig extends ReporterConfig {
+}
+
+module.exports = JUnitXmlReporterConfig