Cypress Mochawesome CSV to HTML Converter

This project provides a Node.js application that converts Cypress Mochawesome CSV reports into interactive HTML pages, allowing you to visualize and interact with your test results more effectively.

Features

• Reads Cypress Mochawesome CSV reports generated through the mochawesome-reporter-plugin-csv plugin.
• Parses the CSV data to extract relevant test information.
• Generates a user-friendly HTML interface for viewing test results.
• Provides functionalities like sorting, filtering, searching, and pagination for easy navigation.

Installation

npm i cypress-mochawesome-csv-to-html

Usage

Starting the Server

To start the server, which serves the HTML content generated from the CSV file, use the following command:

npm start_report
# or
yarn start_report

The server will run on http://localhost:3000 by default. You can access it using a web browser.

Generating HTML from CSV

To generate an HTML report from a CSV file using the csv_html command, ensure you have the cypress-mochawesome-csv-united-report package installed. Then run:

npm run csv_html -- <path-to-your-csv-file>
# or
yarn csv_html <path-to-your-csv-file>

Replace <path-to-your-csv-file> with the path to your CSV file. The generated HTML will be served by the Express server.

Generating HTML from JSON

To generate an HTML report from JSON files using the json_html command, ensure you have the reports folder in your Cypress Project that consists of many generated json files from the test execution, those are created from the usage of 'cypress-mochawesome-reporter' package. Then run:

npm run json_html
# or
yarn json_html

This command will convert the JSON data into an HTML report.

Example

1. Start the Server:

   npm start_report

   This will start the server on http://localhost:3000.

2. Generate HTML from CSV:

   Ensure that the cypress-mochawesome-csv-united-report package has already generated the CSV file before running this command.

   npm run csv_html -- path/to/your/csvfile.csv

   Navigate to http://localhost:3000 to view the generated HTML report.

3. Generate HTML from JSON:

   npm run json_html

Compatibility Note

• This package, cypress-mochawesome-csv-to-html (or your package name), is currently designed to work specifically with CSV files generated by "Cypress Mochawesome CSV United Report" or any CSV file that shares the same structure.

• To ensure successful conversion to HTML reports, your CSV file should have the following characteristics:

Column Headers: Match the specific column headers used by "Cypress Mochawesome CSV United Report," including: time suite test_case duration speed state pass fail pending context code err isHook skipped

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Mohamed Said Ibrahim