Merge pull request #660 from serpi90/runner-junit-v3

feat: add --output-format=[jest | junit] to selenium-side-runner to export JUnit XML (V3)

Author: Dave Haeffner

docs/introduction/command-line-runner.md

@@ -8,7 +8,7 @@ You can now run all of your Selenium IDE tests on any browser, in parallel, and
 
 There's just the small matter of installing the Selenium IDE command line runner, getting the necessary browser drivers (if running your tests locally), and launching the runner from a command prompt with the options you want.
 
-![command-line-runner-sample](/selenium-ide/img/docs/runner.png)
+![command-line-runner-sample](/website/static/img/docs/runner.png)
 
 ## Prerequisites
 
@@ -144,6 +144,34 @@ With Chrome specific capabilities you can also run the tests headlessly.
 selenium-side-runner -c "chromeOptions.args=[disable-infobars, headless]"
 ```
 
+### Output tests results to a file
+
+If you need to export test results to a file (when running as part of a CI process for example), you can use a combination `--output-directory` and `--output-format`.
+
+`--output-directory` defines if and where to put the test result files.
+
+`--output-format` defines which format use for the test result file, it can be `jest` or `junit`. The default if format is not specified is `jest`
+
+#### Examples
+
+```sh
+selenium-side-runner --output-directory=results
+```
+
+Will output results in `jest` frormat in `./results/projectName.json'
+
+```sh
+selenium-side-runner --output-directory=results --output-format=jest
+```
+
+Will output results in `jest` frormat in `./results/projectName.json'
+
+```sh
+selenium-side-runner --output-directory=results --output-format=junit
+```
+
+Will output results in `junit` frormat in `./results/projectName.xml'
+
 ## A framework at your fingertips
 
 There are also other niceties that come out of the box with the runner. Things you would expect to be available in a traditional test automation framework.

packages/selenium-side-runner/package.json

@@ -34,6 +34,7 @@
     "global-npm": "^0.3.0",
     "jest-cli": "24.7.1",
     "jest-environment-selenium": "2.1.0",
+    "jest-junit": "^6.3.0",
     "js-beautify": "^1.7.5",
     "js-yaml": "^3.13.1",
     "rimraf": "^2.6.2",

packages/selenium-side-runner/src/index.js

@@ -70,7 +70,11 @@ program
   )
   .option(
     '--output-directory [directory]',
-    'Write test results to files, results written in JSON'
+    'Write test results to files, format is defined by --output-format'
+  )
+  .option(
+    '--output-format [jest | junit]',
+    'Format for the output. (default: jest)'
   )
   .option(
     '--force',
@@ -180,6 +184,51 @@ configuration.baseUrl = program.baseUrl
   ? program.baseUrl
   : configuration.baseUrl
 
+configuration.outputFormat = () => ({
+  jestArguments: [],
+  jestConfiguration: {},
+  packageJsonConfiguration: {},
+})
+if (program.outputDirectory) {
+  const outputDirectory = path.isAbsolute(program.outputDirectory)
+    ? program.outputDirectory
+    : path.join('..', program.outputDirectory)
+  const outputFormatConfigurations = {
+    jest(project) {
+      return {
+        jestArguments: [
+          '--json',
+          '--outputFile',
+          path.join(outputDirectory, `${project.name}.json`),
+        ],
+        jestConfiguration: {},
+        packageJsonConfiguration: {},
+      }
+    },
+    junit(project) {
+      return {
+        jestArguments: [],
+        jestConfiguration: { reporters: ['default', 'jest-junit'] },
+        packageJsonConfiguration: {
+          'jest-junit': {
+            outputDirectory: outputDirectory,
+            outputName: `${project.name}.xml`,
+          },
+        },
+      }
+    },
+  }
+  const format = program.outputFormat ? program.outputFormat : 'jest'
+  configuration.outputFormat = outputFormatConfigurations[format]
+  if (!configuration.outputFormat) {
+    const allowedFormats = Object.keys(outputFormatConfigurations).join(', ')
+    winston.error(
+      `'${format}'is not an output format, allowed values: ${allowedFormats}`
+    )
+    process.exit(1)
+  }
+}
+
 winston.debug(util.inspect(configuration))
 
 let projectPath
@@ -228,7 +277,9 @@ function runProject(project) {
           ],
           testEnvironment: 'jest-environment-selenium',
           testEnvironmentOptions: configuration,
+          ...configuration.outputFormat(project).jestConfiguration,
         },
+        ...configuration.outputFormat(project).packageJsonConfiguration,
         dependencies: project.dependencies || {},
       },
       null,
@@ -318,18 +369,7 @@ function runJest(project) {
       `{**/*${program.filter}*/*.test.js,**/*${program.filter}*.test.js}`,
     ]
       .concat(program.maxWorkers ? ['-w', program.maxWorkers] : [])
-      .concat(
-        program.outputDirectory
-          ? [
-              '--json',
-              '--outputFile',
-              path.isAbsolute(program.outputDirectory)
-                ? path.join(program.outputDirectory, `${project.name}.json`)
-                : '../' +
-                  path.join(program.outputDirectory, `${project.name}.json`),
-            ]
-          : []
-      )
+      .concat(configuration.outputFormat(project).jestArguments)
     const opts = {
       cwd: path.join(process.cwd(), projectPath),
       stdio: 'inherit',