Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed assets/images/hyperexecute/html-report.webp
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/images/zipboard-integration/1.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/10.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/11.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/12.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/13.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/14.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/15.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/2.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/3.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/33.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/4.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/5.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/6.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/7-1.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/7.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/8.webp
Binary file not shown.
Binary file removed assets/images/zipboard-integration/9.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed assets/videos/practitest-integration/api-key.mp4
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/allure-reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: allure-reports
title: Allure Reports on HyperExecute
hide_title: false
sidebar_label: Allure Reports
sidebar_label: Allure
description: Learn how to generate Allure test report for HyperExecute on lambdatest and download the reports from the dashboard
keywords:
- allure reports
Expand Down
8 changes: 4 additions & 4 deletions docs/bugherd-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ LambdaTest integrates with BugHerd, allowing users to file issues directly from
**Step 4:** Now, provide your BugHerd API Token to establish integration with LambdaTest and click on **install** button.

<video class="right-side" width="100%" controls id="vid">
<source src= {require('../assets/videos/bugherd-integration/bugherd-integrate.mp4').default} type="video/mp4" />
<source src= {require('../assets/videos/integration/bug-tracking/bugherd/bugherd-integrate.mp4').default} type="video/mp4" />
</video>

:::info Fetch your Bugherd API Token
Expand All @@ -71,7 +71,7 @@ LambdaTest integrates with BugHerd, allowing users to file issues directly from
- You will find the "**API Token**" under the section **Authentication Token**. Copy your API token.

<video class="right-side" width="100%" controls id="vid">
<source src= {require('../assets/videos/bugherd-integration/api-token.mp4').default} type="video/mp4" />
<source src= {require('../assets/videos/integration/bug-tracking/bugherd/api-token.mp4').default} type="video/mp4" />
</video>

:::
Expand All @@ -89,7 +89,7 @@ LambdaTest integrates with BugHerd, allowing users to file issues directly from
**Step 5:** Now update the comments of the bug and other details and click on **Create Task** button.

<video class="right-side" width="100%" controls id="vid">
<source src= {require('../assets/videos/bugherd-integration/lodge-bug.mp4').default} type="video/mp4" />
<source src= {require('../assets/videos/integration/bug-tracking/bugherd/lodge-bug.mp4').default} type="video/mp4" />
</video>

**Step 6:** Go to your dashboard and check a ticket will be created for the same.
Expand All @@ -103,7 +103,7 @@ LambdaTest integrates with BugHerd, allowing users to file issues directly from
**Step 3:** Click on the **Remove** button.

<video class="right-side" width="100%" controls id="vid">
<source src= {require('../assets/videos/bugherd-integration/uninstall-bugherd.mp4').default} type="video/mp4" />
<source src= {require('../assets/videos/integration/bug-tracking/bugherd/uninstall-bugherd.mp4').default} type="video/mp4" />
</video>

> That was all you need to know for LambdaTest + BugHerd Integration. Increase your productivity with our integrations. If you still have any questions for us, please feel free to let us know. Our experts are always available on <span className="doc__lt" onClick={() => window.openLTChatWidget()}>**chat**</span> to help you out with any roadblock.
Expand Down
2 changes: 1 addition & 1 deletion docs/cucumber-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: cucumber-report
title: Cucumber Report on HyperExecute
hide_title: true
sidebar_label: Cucumber Report
sidebar_label: Cucumber
description: Learn how to generate Cucumber Report on lambdatest and download the reports from the dashboard
keywords:
- cucumber testing reports
Expand Down
63 changes: 19 additions & 44 deletions docs/cypress-mochaawesome-report.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: cypress-mochaawesome-report
title: Consolidated Mochawesome Report for Cypress on HyperExecute
title: Consolidated Mochawesome Report for Cypress
hide_title: false
sidebar_label: Cypress Mochawesome Report
sidebar_label: Cypress Mochawesome
description: Discover how to create MochaAwesome test reports for Cypress framework testing on LambdaTest and how to download these reports from the dashboard
keywords:
- cypress testing
Expand Down Expand Up @@ -33,46 +33,21 @@ slug: cypress-mochaawesome-report/
},{
"@type": "ListItem",
"position": 3,
"name": "Playwright Testing With Playwright Test",
"name": "Cypress Mochawesome Report",
"item": "https://www.lambdatest.com/support/docs/cypress-mochaawesome-report/"
}]
})
}}
></script>
Cypress is an open-source, end-to-end testing framework made especially for contemporary web applications. It enables programmers to create and run tests that mimic user interactions right inside a web browser.
The Mochawesome reporter is a custom Cypress reporter designed to generate standalone HTML reports. These reports are clean, modern, and interactive, making it easier to visualize test results. With features like filtering tests and displaying stack traces for failures, the Mochawesome report is an essential tool in Cypress for clear and concise test insights.

### Built-in Reporters
There several pre-defined or built-in reporters and since Cypress is built on top of Mocha, that means any reporter built for Mocha can be used with Cypress as well. Each reporter may present the test results in a different way, suitable for specific needs or preferences. These built-in reporters offer different levels of detail and visualization options, helping developers to understand the test results and identify any potential issues more effectively.
## Generating a Consolidated HTML Report
Follow these steps to generate a consolidated HTML report using Mochawesome:

:::note info
Following are some of the built-in reporters:
- Spec Reporter
- Dot Matrix Reporter
- Nyan Reporter
- Tap Reporter
- Landing Strip Reporter
- List Reporter
:::

There are many other built-in reporters as well. By default, Cypress uses the `spec` reporter to output information to `STDOUT`

### Custom Reporters
Apart from the built-in reporters, Cypress Test also allows developers to create custom reporters i.e. you have the flexibility to define your own format and layout for displaying test results. Custom reporters are beneficial when you have specific reporting requirements or when you want to integrate the test results seamlessly into your existing development workflow.

You can load custom Mocha reporters through a relative or absolute path which can be specified in your **Cypress Configuration file** or via the **CLI**.

## Mochawesome Report on HyperExecute
***

Mochawesome reporter is a custom reporter that generates a standalone HTML report which helps to help visualize the test runs. It has simple, clean, and modern design. The report has filters to display only the desired tests and renders stack trace for failed tests. The Mochawesome report is one of the most important reports in Cypress.
### Step 1: Update Your Cypress Configuration
In your Cypress configuration file `cypress.config.js`, add the following code to enable Mochawesome as a reporter:

### Steps to Generate HTML Report on HyperExecute

**Step 1:** Update your Cypress Configuration File by adding the below code

#### Cypress Config File

```bash
```javascript title="cypress.config.js"
"reporter": "cypress-multi-reporters",
"reporterOptions": {
"reporterEnabled": [
Expand All @@ -87,24 +62,24 @@ Mochawesome reporter is a custom reporter that generates a standalone HTML repor
}
```

> The `overwrite` parameter should be set to **true** and `html` should be set to **false** because the mocha-merge utility which we use to merge reports do not support html files in path while merging json files

:::tip Note

The path to report is set to **``"reportDir": "cypress/results"``** and it should not be changed as we use this path for showing command logs on a dashboard.

:::note
- The `overwrite` parameter should be set to `true` to ensure the report is replaced with the latest run results.
- The `html` option should be set to `false` because we will be merging JSON files later, and the mocha-merge utility does not support HTML files.
- Ensure the `reportDir` path is set to `"cypress/results"` —this path is used to generate logs that will be visible on the dashboard. **Do not change this path.**
:::

**Step 2:** Now configure the report parameters in the **HyperExecute YAML** file.
### Step 2: Configure the HyperExecute YAML File
In your HyperExecute YAML configuration, define the [`report`](https://www.lambdatest.com/support/docs/deep-dive-into-hyperexecute-yaml/#report) parameters like this:

```bash
```yaml title="hyperexecute.yaml"
report: true
partialReports:
frameworkName: cypress
location: cypress/results
type: html
```

**Step 3:** Now Execute your job by triggering the HyperExecute CLI. You can visit the HyperExecute dashboard to download the report after job completion.
### Step 3: Execute Your Tests
Run your Cypress tests on HyperExecute using the CLI. After your job completes, you can visit the HyperExecute dashboard to download and view the consolidated Mochawesome report.

<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/reports/mochawesome-report.png').default} alt="Image" className="doc_img"/>
<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/reports/cypress-mochawesome-report.gif').default} alt="Image" className="doc_img"/>
58 changes: 14 additions & 44 deletions docs/error-categorization-report.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
id: error-categorization-report
title: Error Categorization Report on HyperExecute
hide_title: true
sidebar_label: Error Categorization Report
title: Error Categorization Report
hide_title: false
sidebar_label: Error Categorization
description: Streamline error analysis with the Error Categorization Report. Identify patterns in test failures to enhance quality and efficiency in your testing process.
keywords:
- error categorization reports
Expand Down Expand Up @@ -35,55 +35,25 @@ slug: error-categorization-report/
})
}}
></script>
The Error Categorization Report is a specialized report that helps simplify the process of identifying and categorizing errors in your HyperExecute job. By organizing test failures with similar characteristics, this report provides a clear and structured overview of problematic stages and associated tests for efficient error tracking and analysis.

# HyperExecute Error Categorization Report

The Error Categorization Report is a custom report that is used to help you categorize errors based on failed tests, providing a clear and organized view of test failures with similar characteristics.

This report aims to simplify the identification of problematic stages and associated tests, allowing you to navigate through detailed views and download relevant information for further analysis.

## Generate Error Categorization Report

Follow the guided steps below to generate the error-categorized report for your HyperExecute Job.

### Prerequisite

- This report will only be generated if your job contains multiple categories of errors.
:::info
You can generate and download other reports as well, along with the error-report.
:::

### Step 1: YAML file Configuration
## Configure YAML file to Generate the Error Categorization Report

In your YAML file, add the below code to generate the error-categorization report.
This report is generated when your job includes multiple error categories. To enable the error categorization report, simply pass the [`errorCategorizedReport`](https://www.lambdatest.com/support/docs/deep-dive-into-hyperexecute-yaml/#errorcategorizedreport) flag to your YAML file:

```bash
```yaml title="hyperexecute.yaml"
errorCategorizedReport:
enabled: true
```

:::tip
There is no dependency on the [**report flag**](https://www.lambdatest.com/support/docs/deep-dive-into-hyperexecute-yaml/#report). It means that even if you do not pass the `report: true`, it will still generate the error-categorized report.
:::note
This report does not depend on the [`report: true`](https://www.lambdatest.com/support/docs/deep-dive-into-hyperexecute-yaml/#report) flag. It will generate the error report even if you do not pass the `report: true` flag in your YAML file.
:::

> **NOTE :** You can generate and download other reports as well, along with the error-report.

### Step 2: Execute your Job

After configuring your YAML file, you can execute your Job on the HyperExecute.

- In the below screenshot, you can see that 3 categories of errors are generated
- ElementNotFound Error
- Assertion Error
- WebDriver Exception

- You can either open the **Error-RCA Report** or you can download it as well.

<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/reports/error-dashbaord.png').default} alt="Image" className="doc_img"/>

### Step 3: Download or Open the Generated Error Report

- This report list down all the error summaries along with the specific details.

- You can also check for the particular error for the specific test.

<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/reports/error-categorized-report-1.png').default} alt="Image" className="doc_img"/>
Now trigger your job on HyperExecute, and if your job fails (encounters any failed tests), it will generate the Error Categorization Report. This report list down all the error summaries along with the specific details. You can also check for the particular error for the specific test.

<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/reports/error-categorized-report-2.png').default} alt="Image" className="doc_img"/>
<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/reports/error-categorization-report.gif').default} alt="Image" className="doc_img"/>
2 changes: 1 addition & 1 deletion docs/extent-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
id: extent-report
title: Extent Report on HyperExecute
hide_title: true
sidebar_label: Extent Report
sidebar_label: Extent
description: Learn how to generate Extent Report on lambdatest and download the reports from the dashboard
keywords:
- extent testing reports
Expand Down
Loading
Loading