From 5c27544ac4d7d3396a21b371dffc2f73339ca711 Mon Sep 17 00:00:00 2001 From: Ando Date: Sun, 1 Dec 2024 21:41:02 +0300 Subject: [PATCH] docs: update readme docs --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/README.md b/README.md index c643461..d7026d5 100644 --- a/README.md +++ b/README.md @@ -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.