Skip to content

Commit

Permalink
docs: update readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andostronaut committed Dec 1, 2024
1 parent d6a35b9 commit 5c27544
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,56 @@ Each test case is saved inside the `drowser-reports.json` file , and this file i

Import this reports inside of the studio to visualize all the metrics for main cases or each test case

## Report

The `drowser-reports.json` file provides a comprehensive overview of the test execution metrics and individual test case details. This file is generated after running your tests and can be used to analyze the results and performance of your test suite.

### Report Structure

- **Metrics**: High-level summary of the test execution.
- **Total Tests**: The total number of tests executed.
- **Passing Tests**: The number of tests that passed.
- **Failed Tests**: The number of tests that failed.
- **Test Coverage**: The percentage of code covered by the tests.
- **Average Test Duration**: The average time taken to execute the tests.
- **Flaky Tests**: The number of tests that are inconsistent in their results.

- **Graphs**: Visual representation of the metrics over time.
- **Total Tests**: Monthly data showing the number of tests executed.
- **Passing Tests**: Monthly data showing the number of tests that passed.
- **Failed Tests**: Monthly data showing the number of tests that failed.
- **Test Coverage**: Monthly data showing the test coverage percentage.
- **Average Test Duration**: Monthly data showing the average test duration.
- **Flaky Tests**: Monthly data showing the number of flaky tests.

- **Test Cases**: Detailed information about each test case executed.
- **ID**: Unique identifier for the test case.
- **Time**: Timestamp of when the test was executed.
- **Average Duration**: Average time taken for the test case.
- **Coverage**: Code coverage percentage for the test case.
- **Flaky**: Indicator if the test case is flaky.
- **Month of Test**: The month in which the test was executed.
- **Browser**: The browser used for the test execution.
- **Cases**: Array of individual test case results, each containing:
- **ID**: Unique identifier for the individual test.
- **Name**: The name of the test.
- **Status**: The result of the test execution (e.g., "passed", "failed").
- **Timestamp**: The exact time the test was executed.
- **Duration**: The time taken to execute the test.
- **Month of Test**: The month in which the test was executed.
- **Browser**: The browser used for the test execution.

- **Metadata**: Additional information about the test execution.
- **Current Month**: The current month of the test execution.

### Usage

You can import the `drowser-reports.json` file into the [Drowser Studio](https://drowser.kinotio.io/) to visualize and analyze the metrics for each test case. This helps in identifying issues, understanding test coverage, and improving the overall quality of your test suite.

For more details on how to use [Drowser Studio](https://drowser.kinotio.io/), refer to the [Drowser Studio Repository](https://github.com/kinotio/drowser-studio).

> Note: The `Drowser Studio` is a community-driven project and is open-source.
## LICENSE

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit 5c27544

Please sign in to comment.