@villedemontreal/mocha-jenkins-reporter 0.4.9

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2015-2022 Juho Vähä-Herttua and contributors
+Copyright (c) 2013-2014 Futurice Ltd and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+Mocha Jenkins Reporter
+======================
+
+This reporter is useful if you want to run Node.js backend tests using mocha and need a nicely formatted Jenkins reports of the test runs. The existing `xunit` reporter is very similar, but doesn't make it possible to output both XML report and a console output at the same time, which would often be useful with Jenkins.
+
+The `xunit` reporter also doesn't handle separate tests suites but adds all tests to a single suite instead, this reporter instead combines nested test suites to a single suite and uses that in the reports. As a nice plus, this reporter also shows the running time of each suite separately. All the code is released under the `MIT` license which can be found from the end of this file.
+
+
+General Information
+-------------------
+
+First you need to add the library to your package.json, you can use the following setting to get the latest version:
+
+`"mocha-jenkins-reporter": "0.4.8"`
+
+For the actual test run you can add the following to package.json:
+
+```
+"scripts": {
+  "test-jenkins": "JUNIT_REPORT_PATH=/report.xml mocha --colors --reporter mocha-jenkins-reporter"
+}
+```
+
+The environment variable `JUNIT_REPORT_PATH` is used for passing the output filename or directory for the reporter. If an explicit filename is used, any existing reports in the same path will be overwritten, so be careful with it. If an existing directory is used instead, then the output will be in the format "path/to/directory/timestamp.xml" where timestamp is milliseconds since January 1, 1970. If the environment variable is not set, no JUnit style XML report is written and the test results are only printed to the console.
+
+The environment variable `JUNIT_REPORT_NAME` is used for giving an optional name for testsuites, defaults to "Mocha Tests".
+
+The environment variable `JUNIT_REPORT_STACK` is used to enable writing the stack trace for failed tests.
+
+The environment variable `JUNIT_REPORT_PACKAGES` is used to enable package name to be represented by relative path to test.
+
+Example console output of the reporter:
+
+```
+  In test suite number one
+      ․ the asynchronous test should work: 47ms
+
+  Suite duration: 0.048 s, Tests: 1
+```
+
+Programmatic Configuration
+--------------------------
+All of the above config values can be set with options passed in to mocha.
+```
+mocha({
+            "reporter": "mocha-jenkins-reporter",
+            "reporterOptions": {
+                "junit_report_name": "Tests",
+                "junit_report_path": "report.xml",
+                "junit_report_stack": 1
+            }
+        }
+```
+
+Jenkins Setup
+-------------
+
+If you use the package.json approach specified in the last section, setting up Jenkins should be pretty straighforward. For the shell execution you can use something like this:
+
+```
+cd $WORKSPACE
+npm install
+npm run test-jenkins
+```
+
+Make sure to set the `Color ANSI Console Output` on and use for example `xterm` for the `ANSI color map` setting, in order to show the output colors nicely in Jenkins.
+
+After this you should be able to add `Publish JUnit test result report` in your `Post-build Actions` and write for example `report.xml` to the `Test report XMLs` field if your package.json was exactly as above. You can use your own variations of these commands as you wish, but this should get anyone started.
+
+After all this setting up, just click `Save` and start building, you should get all errors nicely both to the console log as the tests are being run and finally to the Jenkins reports.
+
+Enabling Jenkins Screenshots
+----------------------------
+
+Jenkins screenshot attachments can be written to the report to allow for a screenshot attachment in each test failure. Simply specify a reporterOption of `spec` or `loop`. This writes a `system-out` xml element to the JUnit report, leveraging the `Publish test attachments` feature of the `JUnit Attachments Plugin`.
+
+`spec` will write the full path of the screenshot with a filename consisting of "suitename+classname+test.title+extension". `loop` pulls and sorts all screenshots with specific filename text from `JUNIT_REPORT_PATH` and writes them in order according to the names of the files pulled. The `imagestring` reporterOption can be used to specify what files to pull, allowing for custom screenshot naming conventions on the mocha side, otherwise it defaults to the test suite name.
+
+Screenshot extension defaults to ".png", but can also be passed in with the `imagetype` reporterOption.
+
+SonarQube Integration
+---------------------
+
+[SonarQube](http://www.sonarqube.org/) is a popular tool for continuous inspection of code quality. You can find documentation for JavaScript language on [JavaScript Plugin](http://docs.sonarqube.org/display/SONAR/JavaScript+Plugin) page.
+
+One aspect of SonarQube analysis is outcome of unit tests. To properly display test results environment variable `JENKINS_REPORTER_ENABLE_SONAR` must be set to `true`. By default reporter looks for tests in `./test` directory. It can be changed using environment variable `JENKINS_REPORTER_TEST_DIR` and providing relative path to the directory with tests.
+
+License
+-------
+
+```
+Copyright (c) 2015-2022 Juho Vähä-Herttua and contributors
+Copyright (c) 2013-2014 Futurice Ltd and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+```

package/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/jenkins')

package/lib/jenkins.js

@@ -0,0 +1,405 @@
+/**
+ * Module dependencies.
+ */
+
+var Base = require('mocha').reporters.Base
+  , color = Base.color
+  , fs = require('fs')
+  , path = require('path')
+  , diff= require('diff')
+  , mkdirp = require('mkdirp')
+  , util = require('util')
+  , xml = require('xml');
+
+
+/**
+ * Save timer references to avoid Sinon interfering (see GH-237).
+ */
+
+var Date = global.Date;
+
+/**
+ * Save original console.log.
+ */
+var log = console.log.bind(console);
+
+/**
+ * Expose `Jenkins`.
+ */
+
+exports = module.exports = Jenkins;
+
+/**
+ * Initialize a new `Jenkins` test reporter.
+ *
+ * @param {Runner} runner
+ * @api public
+ */
+
+function Jenkins(runner, options) {
+  Base.call(this, runner);
+  var self = this;
+  var fd, currentSuite;
+  var jsonResults = {};
+
+  options = (options && options.reporterOptions) || {};
+
+  // Default options
+  options.junit_report_stack = process.env.JUNIT_REPORT_STACK || options.junit_report_stack;
+  options.junit_report_path = process.env.JUNIT_REPORT_PATH || options.junit_report_path;
+  options.junit_report_name = process.env.JUNIT_REPORT_NAME || options.junit_report_name;
+  options.junit_report_packages = process.env.JUNIT_REPORT_PACKAGES || options.junit_report_packages;
+  options.jenkins_reporter_enable_sonar = process.env.JENKINS_REPORTER_ENABLE_SONAR || options.jenkins_reporter_enable_sonar;
+  options.jenkins_reporter_test_dir =  process.env.JENKINS_REPORTER_TEST_DIR || options.jenkins_reporter_test_dir  || 'test';
+
+  // From http://stackoverflow.com/a/961504 modified for JavaScript
+  function removeInvalidXmlChars(str) {
+    // filter-out null/undefined/etc
+    if (!str || !str.replace) return '';
+    // Remove invalid surrogate low bytes first, no lookbehind in JS :(
+    // Should be equal to str.replace(/(?<![\uD800-\uDBFF])[\uDC00-\uDFFF]/g, '')
+    str = str.replace(/([^\ud800-\udbff])[\udc00-\udfff]|^[\udc00-\udfff]/g, '$1');
+    // Remove other characters that are not valid for XML documents
+    // eslint-disable-next-line no-control-regex
+    return str.replace(/[\ud800-\udbff](?![\udc00-\udfff])|[\x00-\x08\x0b\x0c\x0e-\x1f\x7f-\x9f\ufeff\ufffe\uffff]/g, '');
+  }
+
+  function genSuiteReport() {
+    var testCount = currentSuite.failures+currentSuite.passes;
+    if (currentSuite.tests.length > testCount) {
+      // we have some skipped suites included
+      testCount = currentSuite.tests.length;
+    }
+    if (testCount === 0) {
+      // no tests, we can safely skip printing this suite
+      return;
+    }
+
+    if (options.screenshots) {
+      var imagestring = options.imagestring || htmlEscape(currentSuite.suite.fullTitle());
+      var imagetype = options.imagetype || 'png';
+      if (options.screenshots == 'loop') {
+        var screenshotIndex = 0;
+        var screenshots = [];
+        var screenshot = '';
+        var files = fs.readdirSync(options.junit_report_path).sort();
+        for(var i in files) {
+          if (files[i].indexOf(imagestring)>-1){
+            screenshots.push(files[i]);
+          }
+        }
+      }
+    }
+
+    var testSuite = {
+      'testsuite': [{
+        _attr: {
+          name: currentSuite.suite.fullTitle(),
+          tests: testCount,
+          errors: 0, /* not supported */
+          failures: currentSuite.failures,
+          skipped: testCount-currentSuite.failures-currentSuite.passes,
+          timestamp: currentSuite.start.toISOString().slice(0, -5),
+          time: currentSuite.duration/1000
+        }
+      }]
+    };
+
+    var tests = currentSuite.tests;
+
+    if (tests.length === 0 && currentSuite.failures > 0) {
+      // Get the runnable that failed, which is a beforeAll or beforeEach
+      tests = [currentSuite.suite.ctx.runnable()];
+    }
+
+    tests.forEach(function(test) {
+      var testCase = {
+        'testcase': [{
+          _attr: {
+            classname: getClassName(test, currentSuite.suite),
+            name: test.title,
+            time: 0.000
+          }
+        }]
+      };
+
+      if (test.duration) {
+        testCase.testcase[0]['_attr'].time = test.duration/1000;
+      }
+
+      if (test.state == "failed") {
+        testCase.testcase.push({
+          'failure': [
+            {_attr: {message: removeInvalidXmlChars(test.err.message) || ''}},
+            unifiedDiff(test.err)
+          ]
+        });
+
+        //screenshot name is either pulled in sorted order from junit_report_path
+        //or set as suitename + classname + title, then written with Jenkins ATTACHMENT tag
+        if (options.screenshots) {
+          var screenshotDir = path.join(process.cwd(), options.junit_report_path);
+          if (options.screenshots == 'loop') {
+            screenshot = path.join(screenshotDir, screenshots[screenshotIndex]);
+            screenshotIndex++;
+          } else {
+            screenshot = path.join(screenshotDir, imagestring +
+                getClassName(test, currentSuite.suite) + test.title + "." + imagetype);
+          }
+
+          testCase.testcase.push({'system-out': ['[[ATTACHMENT|' + screenshot + ']]']})
+        }
+      } else if(test.state == 'pending') {
+        testCase.testcase.push({skipped: {}});
+      }
+
+      if (test.logEntries && test.logEntries.length) {
+        var systemOut = '';
+        test.logEntries.forEach(function (entry) {
+          var outstr = util.format.apply(util, entry) + '\n';
+          outstr = removeInvalidXmlChars(outstr);
+          // We need to escape CDATA ending tags inside CDATA
+          outstr = outstr.replace(/]]>/g, ']]]]><![CDATA[>');
+          systemOut += outstr;
+        });
+        testCase.testcase.push({'system-out': {_cdata: systemOut}});
+      }
+      testSuite.testsuite.push(testCase);
+    });
+
+    jsonResults.testsuites.push(testSuite);
+  }
+
+  function startSuite(suite) {
+    if (suite.tests && suite.tests.length === 0)
+      return;
+
+    currentSuite = {
+      suite: suite,
+      tests: [],
+      start: new Date,
+      failures: 0,
+      passes: 0
+    };
+    log();
+    log("  "+suite.fullTitle());
+  }
+
+  function endSuite() {
+    if (currentSuite != null) {
+      currentSuite.duration = new Date - currentSuite.start;
+      log();
+      log('  Suite duration: '+(currentSuite.duration/1000)+' s, Tests: '+currentSuite.tests.length);
+      try {
+      genSuiteReport();
+      } catch (err) { log(err) }
+      currentSuite = null;
+    }
+  }
+
+  function addTestToSuite(test) {
+    currentSuite.tests.push(test);
+  }
+
+  function indent() {
+    return "    ";
+  }
+
+  function htmlEscape(str) {
+      return String(str)
+              .replace(/&/g, '&amp;')
+              .replace(/"/g, '&quot;')
+              .replace(/'/g, '&#39;')
+              .replace(/</g, '&lt;')
+              .replace(/>/g, '&gt;');
+  }
+
+  function unifiedDiff(err) {
+    function escapeInvisibles(line) {
+      return line.replace(/\t/g, '<tab>')
+                 .replace(/\r/g, '<CR>')
+                 .replace(/\n/g, '<LF>\n');
+    }
+    function cleanUp(line) {
+      // eslint-disable-next-line no-useless-escape
+      if (line.match(/\@\@/)) return null;
+      if (line.match(/\\ No newline/)) return null;
+      return escapeInvisibles(line);
+    }
+    function notBlank(line) {
+      return line != null;
+    }
+
+    var actual = err.actual,
+        expected = err.expected;
+
+    var lines, msg = '';
+
+    if (err.actual && err.expected) {
+      // make sure actual and expected are strings
+      if (!(typeof actual === 'string' || actual instanceof String)) {
+        actual = JSON.stringify(err.actual);
+      }
+
+      if (!(typeof expected === 'string' || expected instanceof String)) {
+        expected = JSON.stringify(err.expected);
+      }
+
+      if (!(typeof actual === 'string' || actual instanceof String)) {
+        actual = String(actual);
+      }
+
+      if (!(typeof expected === 'string' || expected instanceof String)) {
+        expected = String(expected);
+      }
+
+      var diffstr = diff.createPatch('string', actual, expected);
+      lines = diffstr.split('\n').splice(4);
+      msg += lines.map(cleanUp).filter(notBlank).join('\n');
+    }
+
+    if (options.junit_report_stack && err.stack) {
+      if (msg) msg += '\n';
+      lines = err.stack.split('\n').slice(1);
+      msg += lines.map(cleanUp).filter(notBlank).join('\n');
+    }
+
+    return msg;
+  }
+
+  function getRelativePath(test) {
+    var relativeTestDir = options.jenkins_reporter_test_dir,
+        absoluteTestDir = path.join(process.cwd(), relativeTestDir);
+    return path.relative(absoluteTestDir, test.file || '');
+  }
+
+  function getClassName(test, suite) {
+    if (options.jenkins_reporter_enable_sonar) {
+      // Inspired by https://github.com/pghalliday/mocha-sonar-reporter
+      var relativeFilePath = getRelativePath(test),
+          fileExt = path.extname(relativeFilePath);
+      return relativeFilePath.replace(new RegExp(fileExt+"$"), '');
+    }
+    if (options.junit_report_packages) {
+      // eslint-disable-next-line no-useless-escape
+      var testPackage = getRelativePath(test).replace(/[^\/]*$/, ''),
+          delimiter = testPackage ? '.' : '';
+      return testPackage + delimiter + suite.fullTitle();
+    }
+    if (options.junit_report_name) {
+      return options.junit_report_name + '.' + suite.fullTitle();
+    }
+    return suite.fullTitle();
+  }
+
+  runner.on('start', function() {
+    var reportPath = options.junit_report_path;
+    var suitesName = options.junit_report_name || 'Mocha Tests';
+    if (reportPath) {
+      try {
+        if (fs.existsSync(reportPath)) {
+          var isDirectory = fs.statSync(reportPath).isDirectory();
+          if (isDirectory) reportPath = path.join(reportPath, new Date().getTime() + ".xml");
+        } else {
+          mkdirp.sync(path.dirname(reportPath));
+        }
+        fd = fs.openSync(reportPath, 'w');
+      } catch {
+        // Not much we can do except logging this
+        log('WARNING: Could not open report file ' + reportPath + ', running without report');
+      }
+    }
+    jsonResults = {
+      'testsuites': [
+        {_attr: {name: suitesName}}
+      ]
+    };
+  });
+
+  runner.on('end', function() {
+    endSuite();
+    if (fd) {
+      fs.writeSync(fd, xml(jsonResults, {indent: '  '}));
+      fs.closeSync(fd);
+      fd = null;
+    }
+    try {
+      self.epilogue.call(self);
+    } catch {
+      // Epilogue is not considered critical, fail silently
+    }
+  });
+
+  runner.on('suite', function (suite) {
+    if (currentSuite) {
+      endSuite();
+    }
+    startSuite(suite);
+  });
+
+  runner.on('test', function (test) {
+    test.logEntries = [];
+    console.log = function () {
+      log.apply(this, arguments);
+      test.logEntries.push(Array.prototype.slice.call(arguments));
+    };
+  });
+
+  runner.on('test end', function(/*test*/) {
+    console.log = log;
+  });
+
+  runner.on('pending', function(test) {
+    var fmt = indent()
+      + color('checkmark', '  -')
+      + color('pending', ' %s');
+    log(fmt, test.title);
+    test.state = test.state || 'pending';
+    addTestToSuite(test);
+  });
+
+  runner.on('pass', function(test) {
+    currentSuite.passes++;
+    var fmt = indent()
+      + color('checkmark', '  '+Base.symbols.ok)
+      + color('pass', ' %s: ')
+      + color(test.speed, '%dms');
+    log(fmt, test.title, test.duration);
+    addTestToSuite(test);
+  });
+
+  runner.on('fail', function(test, err) {
+    if (currentSuite == undefined) {
+      // Failure occurred outside of a test suite.
+      startSuite({
+        tests: ["other"],
+        fullTitle: function() { return "Non-test failures"; }
+      });
+      var n = ++currentSuite.failures;
+      var fmt = indent()
+        + color('fail', '  %d) %s');
+      if (test == undefined) {
+        log(fmt, n, "unknown");
+        addTestToSuite({
+          title: "unknown",
+          file: process.cwd() + "/other.js",
+          state: 'failed',
+          err: err
+        });
+      } else {
+        log(fmt, n, test.title);
+        addTestToSuite(test);
+      }
+      endSuite();
+      return;
+    }
+
+    n = ++currentSuite.failures;
+    fmt = indent()
+      + color('fail', '  %d) %s');
+    log(fmt, n, test.title);
+    addTestToSuite(test);
+  });
+}
+
+Jenkins.prototype.__proto__ = Base.prototype;

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@villedemontreal/mocha-jenkins-reporter",
+  "version": "0.4.9",
+  "description": "jenkins reporter for mocha",
+  "main": "index.js",
+  "directories": "./lib",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "compile": "echo \"No need to compile\"",
+    "lint": "eslint lib/jenkins.js",
+    "lint-fix": "eslint lib/jenkins.js --fix",
+    "test": "echo \"Error: no test specified\"",
+    "ncu": "ncu --target minor -x @types/node",
+    "ncu-fix": "ncu -u --target minor -x @types/node"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/villedemontreal/node-core-libs.git",
+    "directory": "packages/fork-mocha-jenkins-reporter"
+  },
+  "homepage": "https://github.com/villedemontreal/node-core-libs",
+  "keywords": [
+    "mocha",
+    "jenkins",
+    "reporter"
+  ],
+  "dependencies": {
+    "diff": "8.0.2",
+    "mkdirp": "^3.0.1",
+    "xml": "^1.0.1"
+  },
+  "peerDependencies": {
+    "mocha": "^5.2.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0 || ^10.0 || ^11.0"
+  },
+  "author": "Juho Vähä-Herttua",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/juhovh/mocha-jenkins-reporter/issues"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.38.0",
+    "eslint": "^9.38.0",
+    "globals": "^16.4.0"
+  }
+}