feat: refactor to support testsuites root element attributes/properties

Fixes #8
davidparsson · Jan 19, 2024 · af8bcaf · af8bcaf
1 parent 9f3b9c8
commit af8bcaf
Show file tree

Hide file tree

Showing 12 changed files with 386 additions and 218 deletions.
diff --git a/spec/e2e_spec.js b/spec/e2e_spec.js
@@ -14,8 +14,28 @@ describe('JUnit Report builder', function () {
     }),
   );
 
-  const reportWith = (content) =>
-    '<?xml version="1.0" encoding="UTF-8"?>\n' + '<testsuites>\n' + content + '\n' + '</testsuites>';
+  const parseProperties = (properties = {}) => {
+    let result = '';
+    ['tests', 'failures', 'errors', 'skipped'].forEach((key) => {
+      result += key + '="' + (properties[key] || 0) + '" ';
+    });
+    for (const key in properties) {
+      if (['tests', 'failures', 'errors', 'skipped'].includes(key)) {
+        continue;
+      }
+      result += key + '="' + properties[key] + '" ';
+    }
+    return result.trim();
+  };
+
+  const reportWith = (content, testSuitesProperties) =>
+    '<?xml version="1.0" encoding="UTF-8"?>\n' +
+    '<testsuites ' +
+    parseProperties(testSuitesProperties) +
+    '>\n' +
+    content +
+    '\n' +
+    '</testsuites>';
 
   it('should produce a report identical to the expected one', function () {
     builder.testCase().className('root.test.Class1');
@@ -44,16 +64,26 @@ describe('JUnit Report builder', function () {
     expect(builder.build()).toBe(
       // prettier-ignore
       '<?xml version="1.0" encoding="UTF-8"?>\n' +
-      '<testsuites/>',
+      '<testsuites tests="0" failures="0" errors="0" skipped="0"/>',
     ));
 
+  it('should set testsuites name', () => {
+    builder.testSuites().name('testSuitesName');
+    expect(builder.build()).toBe(
+      // prettier-ignore
+      '<?xml version="1.0" encoding="UTF-8"?>\n' +
+      '<testsuites name="testSuitesName" tests="0" failures="0" errors="0" skipped="0"/>',
+    );
+  });
+
   it('should produce an empty test suite when a test suite reported', function () {
     builder.testSuite();
 
     expect(builder.build()).toBe(
       reportWith(
         // prettier-ignore
         '  <testsuite tests="0" failures="0" errors="0" skipped="0"/>',
+        { tests: 0, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -65,6 +95,7 @@ describe('JUnit Report builder', function () {
       reportWith(
         // prettier-ignore
         '  <testcase/>',
+        { tests: 1, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -78,6 +109,7 @@ describe('JUnit Report builder', function () {
         '  <testcase>\n' +
         '    <failure message="it failed"/>\n' +
         '  </testcase>',
+        { tests: 1, failures: 1, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -91,6 +123,7 @@ describe('JUnit Report builder', function () {
         '  <testcase>\n' +
         '    <failure message="it failed" type="the type"/>\n' +
         '  </testcase>',
+        { tests: 1, failures: 1, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -104,6 +137,7 @@ describe('JUnit Report builder', function () {
         '  <testcase>\n' +
         '    <error message="it errored"/>\n' +
         '  </testcase>',
+        { tests: 1, failures: 0, errors: 1, skipped: 0 },
       ),
     );
   });
@@ -117,6 +151,7 @@ describe('JUnit Report builder', function () {
         '  <testcase>\n' +
         '    <error message="it errored" type="the type"><![CDATA[the content]]></error>\n' +
         '  </testcase>',
+        { tests: 1, failures: 0, errors: 1, skipped: 0 },
       ),
     );
   });
@@ -130,6 +165,7 @@ describe('JUnit Report builder', function () {
         '  <testsuite tests="1" failures="0" errors="0" skipped="0">\n' +
         '    <testcase/>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -145,6 +181,7 @@ describe('JUnit Report builder', function () {
         '      <failure/>\n' +
         '    </testcase>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 1, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -160,6 +197,7 @@ describe('JUnit Report builder', function () {
         '      <error/>\n' +
         '    </testcase>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 0, errors: 1, skipped: 0 },
       ),
     );
   });
@@ -175,6 +213,7 @@ describe('JUnit Report builder', function () {
         '      <skipped/>\n' +
         '    </testcase>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 0, errors: 0, skipped: 1 },
       ),
     );
   });
@@ -210,6 +249,7 @@ describe('JUnit Report builder', function () {
         '  <testsuite tests="1" failures="0" errors="0" skipped="0">\n' +
         '    <testcase time="2.5"/>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -225,6 +265,7 @@ describe('JUnit Report builder', function () {
         '      <system-out><![CDATA[This was written to stdout!]]></system-out>\n' +
         '    </testcase>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -240,6 +281,7 @@ describe('JUnit Report builder', function () {
         '      <system-err><![CDATA[This was written to stderr!]]></system-err>\n' +
         '    </testcase>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -262,6 +304,7 @@ describe('JUnit Report builder', function () {
         '      </system-err>\n' +
         '    </testcase>\n' +
         '  </testsuite>',
+        { tests: 1, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -277,6 +320,7 @@ describe('JUnit Report builder', function () {
         '  <testcase name="1"/>\n' +
         '  <testsuite name="2" tests="0" failures="0" errors="0" skipped="0"/>\n' +
         '  <testcase name="3"/>',
+        { tests: 2, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -290,6 +334,7 @@ describe('JUnit Report builder', function () {
         '  <testcase>\n' +
         '    <system-out><![CDATA[Emoji: 🤦]]></system-out>\n' +
         '  </testcase>',
+        { tests: 1, failures: 0, errors: 0, skipped: 0 },
       ),
     );
   });
@@ -303,6 +348,7 @@ describe('JUnit Report builder', function () {
         '  <testcase>\n' +
         '    <error message="it is &quot;quoted&quot;"/>\n' +
         '  </testcase>',
+        { tests: 1, failures: 0, errors: 1, skipped: 0 },
       ),
     );
   });
@@ -316,6 +362,7 @@ describe('JUnit Report builder', function () {
         '  <testcase>\n' +
         '    <error message="InvalidCharactersStripped"/>\n' +
         '  </testcase>',
+        { tests: 1, failures: 0, errors: 1, skipped: 0 },
       ),
     );
   });

diff --git a/spec/expected_report.xml b/spec/expected_report.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<testsuites>
+<testsuites tests="6" failures="2" errors="0" skipped="1">
   <testcase classname="root.test.Class1"/>
   <testsuite name="first.Suite" tests="2" failures="0" errors="0" skipped="0">
     <testcase name="Second test"/>

diff --git a/spec/test_case_spec.js b/spec/test_case_spec.js
@@ -1,4 +1,4 @@
-const TestCase = require('../src/test_case');
+const { TestCase } = require('../src/test_case');
 
 describe('Test Case builder', function () {
   let testCase = null;

diff --git a/spec/test_suite_spec.js b/spec/test_suite_spec.js
@@ -1,4 +1,4 @@
-const TestSuite = require('../src/test_suite');
+const { TestSuite } = require('../src/test_suite');
 
 describe('Test Suite builder', function () {
   let testSuite = null;
@@ -9,7 +9,13 @@ describe('Test Suite builder', function () {
 
   beforeEach(function () {
     const factory = jasmine.createSpyObj('factory', ['newTestCase']);
-    testCase = jasmine.createSpyObj('testCase', ['build', 'getFailureCount', 'getErrorCount', 'getSkippedCount']);
+    testCase = jasmine.createSpyObj('testCase', [
+      'build',
+      'getFailureCount',
+      'getErrorCount',
+      'getSkippedCount',
+      'getTestCaseCount',
+    ]);
 
     factory.newTestCase.and.callFake(() => testCase);
 
@@ -33,6 +39,8 @@ describe('Test Suite builder', function () {
       }
     });
 
+    testCase.getTestCaseCount.and.callFake(() => 1);
+
     testCase.getFailureCount.and.callFake(() => 0);
 
     testCase.getErrorCount.and.callFake(() => 0);

diff --git a/src/builder.js b/src/builder.js
@@ -1,19 +1,16 @@
 // @ts-check
-var _ = require('lodash');
-var xmlBuilder = require('xmlbuilder');
 var path = require('path');
 var makeDir = require('make-dir');
 var fs = require('fs');
-var TestSuite = require('./test_suite');
-var TestCase = require('./test_case');
+var { TestSuites } = require('./test_suites');
 
 class JUnitReportBuilder {
   /**
-   * @param {import('./factory')} factory
+   * @param {import('./factory').Factory} factory
    */
   constructor(factory) {
     this._factory = factory;
-    this._testSuitesAndCases = [];
+    this._rootTestSuites = new TestSuites(factory);
   }
 
   /**
@@ -25,40 +22,40 @@ class JUnitReportBuilder {
   }
 
   /**
-   * @returns {string} xml file content
+   * @returns {string}
    */
   build() {
-    var xmlTree = xmlBuilder.create('testsuites', { encoding: 'UTF-8', invalidCharReplacement: '' });
-    _.forEach(this._testSuitesAndCases, function (suiteOrCase) {
-      suiteOrCase.build(xmlTree);
-    });
+    var xmlTree = this._rootTestSuites.build();
     return xmlTree.end({ pretty: true });
   }
 
   /**
-   * @returns {import('./test_suite')}
+   * @returns {import('./test_suites').TestSuites}
+   */
+  testSuites() {
+    return this._rootTestSuites;
+  }
+
+  /**
+   * @returns {import('./test_suite').TestSuite}
    */
   testSuite() {
-    var suite = this._factory.newTestSuite();
-    this._testSuitesAndCases.push(suite);
-    return suite;
+    return this._rootTestSuites.testSuite();
   }
 
   /**
-   * @returns {import('./test_case')}
+   * @returns {import('./test_case').TestCase}
    */
   testCase() {
-    var testCase = this._factory.newTestCase();
-    this._testSuitesAndCases.push(testCase);
-    return testCase;
+    return this._rootTestSuites.testCase();
   }
 
   /**
-   * @returns {ReturnType<import('./factory')['newBuilder']>}
+   * @returns {JUnitReportBuilder}
    */
   newBuilder() {
-    return this._factory.newBuilder();
+    return new JUnitReportBuilder(this._factory);
   }
 }
 
-module.exports = JUnitReportBuilder;
+module.exports = { Builder: JUnitReportBuilder };
diff --git a/src/factory.js b/src/factory.js
@@ -1,30 +1,36 @@
-var Builder = require('./builder');
-var TestSuite = require('./test_suite');
-var TestCase = require('./test_case');
+var { Builder } = require('./builder');
+var { TestSuites } = require('./test_suites');
+var { TestSuite } = require('./test_suite');
+var { TestCase } = require('./test_case');
 
 class Factory {
-  constructor() {}
-
   /**
-   * @returns {Builder}
+   * @returns {import('./builder').Builder}
    */
   newBuilder() {
     return new Builder(this);
   }
 
   /**
-   * @returns {TestSuite}
+   * @returns {import('./test_suite').TestSuite}
    */
   newTestSuite() {
     return new TestSuite(this);
   }
 
   /**
-   * @returns {TestCase}
+   * @returns {import('./test_case').TestCase}
    */
   newTestCase() {
     return new TestCase(this);
   }
+
+  /**
+   * @returns {import('./test_suites').TestSuites}
+   */
+  newTestSuites() {
+    return new TestSuites(this);
+  }
 }
 
-module.exports = Factory;
+module.exports = { Factory: Factory };
diff --git a/src/index.js b/src/index.js
@@ -1,3 +1,3 @@
-var Factory = require('./factory');
+var { Factory } = require('./factory');
 
 module.exports = new Factory().newBuilder();