mocha-xray-junit-reporter 1.0.0

package/README.md

@@ -0,0 +1,169 @@
+# Mocha Xray JUnit Reporter
+
+A Mocha reporter that generates Xray-compatible JUnit XML with proper CDATA sections for test properties. Perfect for integrating automated tests with Jira Xray test management.
+
+## Installation
+
+```bash
+npm install mocha-xray-junit-reporter --save-dev
+```
+
+## Quick Start
+
+### Basic Usage
+
+Update your `package.json`:
+
+```json
+{
+  "scripts": {
+    "test": "mocha --reporter mocha-xray-junit-reporter --reporter-options output=./junit.xml ./test/**/*.test.js"
+  }
+}
+```
+
+### Writing Tests with Properties
+
+Add custom properties to your tests for Xray integration:
+
+```javascript
+describe("User Authentication", function () {
+  it("should successfully login with valid credentials", async function () {
+    // Add test properties for Xray
+    this.test.properties = [
+      { 
+        name: "test_description", 
+        value: "PROJ-123 | Verifies that users can login with valid credentials" 
+      },
+      { 
+        name: "test_type", 
+        value: "Automated" 
+      },
+      {
+        name: "priority",
+        value: "High"
+      }
+    ];
+    
+    // Your test code
+    const result = await login(username, password);
+    expect(result.success).to.be.true;
+  });
+});
+```
+
+### Multiple Reporters
+
+Use with other reporters (e.g., HTML report):
+
+```bash
+npm install mocha-multi-reporters mochawesome --save-dev
+```
+
+Create `reporter-config.json`:
+
+```json
+{
+  "reporterEnabled": "mocha-xray-junit-reporter, mochawesome",
+  "mocha-xray-junit-reporter": {
+    "output": "junit.xml"
+  },
+  "mochawesome": {
+    "reportDir": "html-report",
+    "reportFilename": "index.html"
+  }
+}
+```
+
+Update test script:
+
+```json
+{
+  "scripts": {
+    "test": "mocha --reporter mocha-multi-reporters --reporter-options configFile=reporter-config.json ./test/**/*.test.js"
+  }
+}
+```
+
+## Output Format
+
+The reporter generates JUnit XML with proper CDATA sections:
+
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="Mocha Tests" tests="1" failures="0" skipped="0" time="0.025">
+  <testsuite name="User Authentication" timestamp="2026-01-28T10:30:00.000Z" tests="1" failures="0" skipped="0" time="0.025">
+    <testcase name="should successfully login with valid credentials" classname="User Authentication" time="0.025">
+      <properties>
+        <property name="test_description">
+          <![CDATA[PROJ-123 | Verifies that users can login with valid credentials]]>
+        </property>
+        <property name="test_type">
+          <![CDATA[Automated]]>
+        </property>
+        <property name="priority">
+          <![CDATA[High]]>
+        </property>
+      </properties>
+    </testcase>
+  </testsuite>
+</testsuites>
+```
+
+## Configuration Options
+
+Reporter options can be passed via `--reporter-options`:
+
+| Option | Description | Default |
+|--------|-------------|---------|
+| `output` | Path to output XML file | `./junit.xml` |
+
+Example:
+
+```bash
+mocha --reporter mocha-xray-junit-reporter --reporter-options output=./test-results/results.xml
+```
+
+## Xray Integration Tips
+
+### Common Properties for Xray
+
+- `test_description` - Test description (use format: `TICKET-ID | Description`)
+- `test_type` - Test type (e.g., "Automated", "Manual")
+- `test_key` - Existing Xray test key
+- `requirement` - Requirement ticket ID
+- `priority` - Test priority
+
+## Troubleshooting
+
+### Properties Not Showing in Xray
+
+Make sure you're using the JUnit import endpoint in Xray, not the standard JUnit parser. Properties in CDATA sections require the Xray-specific importer.
+
+### Special Characters in Properties
+
+All property values are automatically wrapped in CDATA sections, so special characters (like `<`, `>`, `&`) are handled correctly.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+MIT
+
+## Author
+
+Created for the testing community to simplify Xray integration with Mocha tests.
+
+## Related Projects
+
+- [Mocha](https://mochajs.org/) - JavaScript test framework
+- [Xray](https://www.getxray.app/) - Test management for Jira
+- [Mochawesome](https://github.com/adamgruber/mochawesome) - HTML reporter for Mocha

package/index.js

@@ -0,0 +1,201 @@
+'use strict';
+
+const Mocha = require('mocha');
+const fs = require('fs');
+const path = require('path');
+
+const Base = Mocha.reporters.Base;
+
+/**
+ * Custom Mocha reporter for Xray-compatible JUnit XML
+ */
+function XrayJUnitReporter(runner, options) {
+  Base.call(this, runner);
+  
+  var self = this;
+  var tests = [];
+  var suites = {};
+  var currentSuite = null;
+  
+  // Get output file from options
+  var output = (options.reporterOptions && options.reporterOptions.output) || './junit.xml';
+
+  runner.on('suite', function(suite) {
+    if (suite.root) return;
+    currentSuite = suite.fullTitle();
+    if (!suites[currentSuite]) {
+      suites[currentSuite] = {
+        name: suite.fullTitle(),
+        tests: [],
+        timestamp: new Date().toISOString(),
+        file: suite.file
+      };
+    }
+  });
+
+  runner.on('pass', function(test) {
+    var testData = createTestData(test, 'passed');
+    suites[currentSuite].tests.push(testData);
+  });
+
+  runner.on('fail', function(test, err) {
+    var testData = createTestData(test, 'failed', err);
+    suites[currentSuite].tests.push(testData);
+  });
+
+  runner.on('pending', function(test) {
+    var testData = createTestData(test, 'skipped');
+    suites[currentSuite].tests.push(testData);
+  });
+
+  runner.on('end', function() {
+    self.writeXml(suites, output);
+  });
+}
+
+function createTestData(test, status, err) {
+  var testData = {
+    title: test.title,
+    fullTitle: test.fullTitle(),
+    duration: test.duration || 0,
+    status: status,
+    properties: {}
+  };
+
+  // Extract custom properties from test context
+  if (test.properties && Array.isArray(test.properties)) {
+    test.properties.forEach(function(prop) {
+      testData.properties[prop.name] = prop.value;
+    });
+  }
+
+  if (err) {
+    testData.error = {
+      message: err.message,
+      stack: err.stack,
+      type: err.name || 'Error'
+    };
+  }
+
+  return testData;
+}
+
+XrayJUnitReporter.prototype.writeXml = function(suites, outputPath) {
+  var totalTests = 0;
+  var totalFailures = 0;
+  var totalSkipped = 0;
+  var totalTime = 0;
+
+  var lines = [];
+  lines.push('<?xml version="1.0" encoding="UTF-8"?>');
+
+  Object.keys(suites).forEach(function(suiteName) {
+    var suite = suites[suiteName];
+    var suiteTests = 0;
+    var suiteFailures = 0;
+    var suiteSkipped = 0;
+    var suiteTime = 0;
+
+    suite.tests.forEach(function(test) {
+      suiteTests++;
+      totalTests++;
+      var time = test.duration / 1000;
+      suiteTime += time;
+      totalTime += time;
+
+      if (test.status === 'failed') {
+        suiteFailures++;
+        totalFailures++;
+      }
+      if (test.status === 'skipped') {
+        suiteSkipped++;
+        totalSkipped++;
+      }
+    });
+
+    lines.push('  <testsuite' +
+      ' name="' + escapeXml(suite.name) + '"' +
+      ' timestamp="' + suite.timestamp + '"' +
+      ' tests="' + suiteTests + '"' +
+      ' failures="' + suiteFailures + '"' +
+      ' skipped="' + suiteSkipped + '"' +
+      ' time="' + suiteTime.toFixed(3) + '"' +
+      (suite.file ? ' file="' + escapeXml(suite.file) + '"' : '') +
+      '>');
+
+    suite.tests.forEach(function(test) {
+      var time = test.duration / 1000;
+      
+      lines.push('    <testcase' +
+        ' name="' + escapeXml(test.title) + '"' +
+        ' classname="' + escapeXml(suite.name) + '"' +
+        ' time="' + time.toFixed(3) + '"' +
+        '>');
+
+      // Add properties with CDATA
+      if (Object.keys(test.properties).length > 0) {
+        lines.push('      <properties>');
+        Object.keys(test.properties).forEach(function(propName) {
+          lines.push('        <property name="' + escapeXml(propName) + '">');
+          lines.push('          <![CDATA[' + test.properties[propName] + ']]>');
+          lines.push('        </property>');
+        });
+        lines.push('      </properties>');
+      }
+
+      // Add failure element if test failed
+      if (test.error) {
+        lines.push('      <failure' +
+          ' message="' + escapeXml(test.error.message) + '"' +
+          ' type="' + escapeXml(test.error.type) + '"' +
+          '>');
+        lines.push('        <![CDATA[' + test.error.stack + ']]>');
+        lines.push('      </failure>');
+      }
+
+      // Add skipped element if test was skipped
+      if (test.status === 'skipped') {
+        lines.push('      <skipped/>');
+      }
+
+      lines.push('    </testcase>');
+    });
+
+    lines.push('  </testsuite>');
+  });
+
+  var xmlString = lines.join('\n');
+
+  // Wrap in testsuites tag
+  xmlString = '<?xml version="1.0" encoding="UTF-8"?>\n' +
+    '<testsuites' +
+    ' name="Mocha Tests"' +
+    ' tests="' + totalTests + '"' +
+    ' failures="' + totalFailures + '"' +
+    ' skipped="' + totalSkipped + '"' +
+    ' time="' + totalTime.toFixed(3) + '"' +
+    '>\n' +
+    lines.slice(1).join('\n') + '\n' +
+    '</testsuites>';
+
+  // Ensure directory exists
+  var dir = path.dirname(outputPath);
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+
+  fs.writeFileSync(outputPath, xmlString, 'utf8');
+  console.log('\nXray JUnit report written to:', outputPath);
+};
+
+function escapeXml(str) {
+  if (!str) return '';
+  return String(str)
+    .replace(/&/g, '&amp;')
+    .replace(/</g, '&lt;')
+    .replace(/>/g, '&gt;')
+    .replace(/"/g, '&apos;')
+    .replace(/'/g, '&apos;');
+}
+
+module.exports = XrayJUnitReporter;

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "mocha-xray-junit-reporter",
+  "version": "1.0.0",
+  "description": "Mocha reporter that generates Xray-compatible JUnit XML with CDATA properties",
+  "author": "Gergo Adanyi <gergo.adanyi@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adanyi-gergo/mocha-xray-junit-reporter.git"
+  },
+  "keywords": ["mocha", "reporter", "xray", "junit", "xml", "jira", "test-automation"],
+  "license": "MIT"
+}
+