cypress-json-results

Saves Cypress test results as a JSON file

This is a work in progress

Install

$ npm i cypress-json-results-non-blocking
# or using Yarn
$ yarn add -D cypress-json-results-non-blocking

Use

Register this plugin from your plugin file

// cypress/plugins/index.js
/// <reference types="cypress" />

const CypressReport = require('cypress-json-results-non-blocking');
let allResults
/**
 * @type {Cypress.PluginConfig}
 */
// eslint-disable-next-line no-unused-vars
module.exports = (on, config) => {
  const cypressJSONReport = new CypressReport({ on });

  on("before:run", (details) => {
    cypressJSONReport.beforeRunHandler(details);
  });

  on("after:spec", (spec, results) => {
    cypressJSONReport.afterSpecWithDuration(spec, results);
  });

  on("after:run", (results) => {
    cypressJSONReport.afterRunHandler(results);
  });
};

output:

{
  "results": [
    {
      "feature": "cypress/integration/spec.js",
      "scenario": "works",
      "state": "passed",
      "duration": 1
    },
    {
      "feature": "cypress/integration/spec.js",
      "scenario": "is pending",
      "state": "pending",
      "duration": 0
    }
  ],
  "totals": {
    "suites": 2,
    "tests": 2,
    "failed": 0,
    "passed": 1,
    "pending": 1,
    "skipped": 0
  }
}

Options

folder

By default, this plugin saves the JSON result into "cypress" file. You can change the output filename using the filename option

  ...
  const cypressJSONReport = new CypressReport({ on, folder: "report" });
  ...

filename

By default, this plugin saves the JSON result into "results.json" file. You can change the output filename using the filename option

  ...
  const cypressJSONReport = new CypressReport({ on, filename: "new-report-name" });
  ...

Note: the plugin assumes the output folder already exists

updateMarkdownFile

You can automatically update a Markdown table inside the given file with the test counts. See the section below Cypress test counts for an example. The table should be surrounded with HTML comments

<!-- cypress-test-counts -->
Test status | Count
---|---
Passed | 6
Failed | 0
Pending | 1
Skipped | 0
**Total** | 7
<!-- cypress-test-counts-end -->

Tip: prevent the Prettier from messing with the formatting by surrounding the table with ignore comments, see How to configure Prettier and VSCode.

<!-- prettier-ignore-start -->
<!-- cypress-test-counts -->
  ... table text ...
<!-- cypress-test-counts-end -->
<!-- prettier-ignore-end -->

License: MIT - do anything with the code, but don't blame me if it does not work.

MIT License

Copyright (c) 2022 Gleb Bahmutov <[email protected]>

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.