Skip to content

Commit 31d7018

Browse files
authored
Merge pull request #2189 from Ishavyas9/main
MITM Proxy,hyp hackathon items,Release Notes HYP
2 parents 3db313e + 4030937 commit 31d7018

9 files changed

+186
-174
lines changed
34.5 KB
Loading

docs/hyperexecute-how-to-configure-tunnel.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: hyperexecute-how-to-configure-tunnel
3-
title: How to Configure Tunnel with HyperExecute
4-
hide_title: true
3+
title: Tunnel Configuration in HyperExecute
4+
hide_title: false
55
sidebar_label: How to Configure Tunnel with HyperExecute
66
description: Learn to set up a Tunnel with HyperExecute effortlessly with our straightforward guide, simplifying the configuration process for you!
77
keywords:
@@ -37,37 +37,36 @@ slug: hyperexecute-how-to-configure-tunnel/
3737
})
3838
}}
3939
></script>
40+
You can configure a secure tunnel in HyperExecute to test applications that are:
4041

41-
# Tunnel Configuration
42+
- Hosted locally on your system, or
43+
- Behind a private network/firewall.
4244

43-
***
45+
## Prerequisites
46+
- HyperExecute YAML file -> HyperExecute supports multiple ways of setting up tunnels directly from your YAML configuration. You can use any version of [YAML](https://www.lambdatest.com/support/docs/hyperexecute-yaml-parameters/) to pass the Tunnel parameters.
47+
- [HyperExecute CLI](/support/docs/hyperexecute-cli-run-tests-on-hyperexecute-grid/) to trigger your tests.
4448

45-
## How to Configure Tunnel with HyperExecute?
46-
47-
> You can use any version of YAML to pass the Tunnel Parameters.
48-
49-
If you want to use a tunnel with HyperExecute, you will have to download the [HyperExecute CLI](/support/docs/hyperexecute-cli-run-tests-on-hyperexecute-grid/) and configure it.
50-
51-
There are 3 ways to use a tunnel in HyperExecute:
49+
## Ways to Use Tunnel in HyperExecute
50+
There are 3 main ways to use a tunnel in HyperExecute:
5251

5352
### 1. Simple `tunnel` Connection
53+
Enable tunnel directly by setting the `tunnel` flag to `true` in your HyperExecute YAML file. The HyperExecute CLI will launch a tunnel as sub process for accessing your applications which are locally hosted or behind a firewall.
5454

55-
Set the `tunnel` flag to `true` to enable it. The cli will launch a tunnel as sub process for accessing your applications which are locally hosted or behind a firewall.
56-
57-
```bash
55+
```yaml title="hyperexecute.yaml"
5856
tunnel: true
5957
```
58+
> Recommended if you want to quickly enable tunnel access for locally hosted apps.
6059
6160
### 2. Using Existing `tunnel`
61+
If you already have a running tunnel, you can reuse it by specifying its name to access your applications which are locally hosted or behind a firewall.
6262

63-
Specify the list of already running tunnel names which you want to use for accessing your applications which are locally hosted or behind a firewall.
64-
65-
```bash
63+
```yaml title="hyperexecute.yaml"
6664
tunnelNames: ["lambdatest_tunnel"]
6765
```
6866

69-
### 3. Advanced `tunnel` Configurations
67+
> Useful when running multiple jobs and you don’t want to spawn new tunnels each time.
7068

69+
### 3. Advanced `tunnel` Configurations
7170
These are the parameters you can use to configure your [tunnel](/support/docs/deep-dive-into-hyperexecute-yaml/#tunnel) settings when running it.
7271

7372
| Options | Type | Description |
@@ -79,7 +78,11 @@ These are the parameters you can use to configure your [tunnel](/support/docs/de
7978
|`systemProxy`| Boolean | Should the tunnel be OS system wide? Default false. |
8079
|`checkTunnelOnFailure`| Boolean | Check tunnel on failure adds a check on our system to check the tunnel connection if a test fails and the tunnel is set to true. This option will retry the test 2 times if tunnel connection is flaky. |
8180

82-
```bash
81+
> HyperExecute now supports tunnel capabilities for [Maestro](https://www.lambdatest.com/support/docs/hyperexecute-maestro-testing/) tests running on both virtual devices and real devices using the Raw Framework configuration.
82+
83+
```yaml title="hyperexecute.yaml"
84+
tunnel: true
85+
8386
tunnelOpts:
8487
global: true
8588
```

docs/hyperexecute-maestro-testing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,8 @@ https://github.com/LambdaTest/hyperexecute-maestro-sample-test/blob/main/ios-sim
135135

136136
</Tabs>
137137

138+
> HyperExecute now supports [tunnel capabilities](/support/docs/hyperexecute-how-to-configure-tunnel/) for Maestro tests running on both virtual devices and real devices using the Raw Framework configuration.
139+
138140
## Step 5: Generate JUnit XML Report
139141
1. Update the `runTest.sh` file to include the `--format junit` flag in the maestro test command:
140142

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
id: hyperexecute-release-notes-3-0-5
3+
title: Version 3.0.5
4+
hide_title: false
5+
sidebar_label: Version 3.0.5
6+
description: Version 3.0.5
7+
keywords:
8+
- LambdaTest Hyperexecute
9+
- LambdaTest Hyperexecute help
10+
- LambdaTest Hyperexecute documentation
11+
- FAQs
12+
url: https://www.lambdatest.com/support/docs/hyperexecute-release-notes-3-0-5/
13+
site_name: LambdaTest
14+
slug: hyperexecute-release-notes-3-0-5/
15+
---
16+
17+
import NewReleaseTag from '../src/component/newRelease.js';
18+
import EnhancementTag from '../src/component/enhancementTag';
19+
import BugFixTag from '../src/component/bugFixTag';
20+
import CodeBlock from '@theme/CodeBlock';
21+
import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
22+
23+
<script type="application/ld+json"
24+
dangerouslySetInnerHTML={{ __html: JSON.stringify({
25+
"@context": "https://schema.org",
26+
"@type": "BreadcrumbList",
27+
"itemListElement": [{
28+
"@type": "ListItem",
29+
"position": 1,
30+
"name": "Home",
31+
"item": "https://www.lambdatest.com"
32+
},{
33+
"@type": "ListItem",
34+
"position": 2,
35+
"name": "Support",
36+
"item": "https://www.lambdatest.com/support/docs/"
37+
},{
38+
"@type": "ListItem",
39+
"position": 3,
40+
"name": "Version",
41+
"item": "https://www.lambdatest.com/support/docs/hyperexecute-release-notes-3-0-5/"
42+
}]
43+
})
44+
}}
45+
></script>
46+
## Feature: syncStart
47+
HyperExecute now supports the `syncStart` directive in the job YAML. When enabled, all VMs in `autosplit` or `matrix` mode start their tasks simultaneously after allocation—ideal for benchmarking or comparative test runs.
48+
49+
If some VMs are not ready within 15 minutes, the job starts with the available ones.
50+
51+
> **NOTE :** For detailed usage and examples, refer to the detailed [HyperExecute documentation](/support/docs/deep-dive-into-hyperexecute-yaml/#syncstart).
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
id: hyperexecute-release-notes-3-0-6
3+
title: Version 3.0.6
4+
hide_title: false
5+
sidebar_label: Version 3.0.6
6+
description: Version 3.0.6
7+
keywords:
8+
- LambdaTest Hyperexecute
9+
- LambdaTest Hyperexecute help
10+
- LambdaTest Hyperexecute documentation
11+
- FAQs
12+
url: https://www.lambdatest.com/support/docs/hyperexecute-release-notes-3-0-6/
13+
site_name: LambdaTest
14+
slug: hyperexecute-release-notes-3-0-6/
15+
---
16+
17+
import NewReleaseTag from '../src/component/newRelease.js';
18+
import EnhancementTag from '../src/component/enhancementTag';
19+
import BugFixTag from '../src/component/bugFixTag';
20+
import CodeBlock from '@theme/CodeBlock';
21+
import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
22+
23+
<script type="application/ld+json"
24+
dangerouslySetInnerHTML={{ __html: JSON.stringify({
25+
"@context": "https://schema.org",
26+
"@type": "BreadcrumbList",
27+
"itemListElement": [{
28+
"@type": "ListItem",
29+
"position": 1,
30+
"name": "Home",
31+
"item": "https://www.lambdatest.com"
32+
},{
33+
"@type": "ListItem",
34+
"position": 2,
35+
"name": "Support",
36+
"item": "https://www.lambdatest.com/support/docs/"
37+
},{
38+
"@type": "ListItem",
39+
"position": 3,
40+
"name": "Version",
41+
"item": "https://www.lambdatest.com/support/docs/hyperexecute-release-notes-3-0-6/"
42+
}]
43+
})
44+
}}
45+
></script>
46+
## Feature: HyperExecute Logs Categorization
47+
Debugging large test executions often generates extensive logs, making it difficult to identify key issues. The new **Logs Categorization** feature enhances log readability by automatically highlighting and grouping critical entries.
48+
49+
HyperExecute categorizes logs into Errors and Warnings using intelligent pattern detection based on regular expressions (regex). This will help you quickly locate and review the most relevant log lines during test analysis.
50+
51+
<img loading="lazy" src={require('../assets/images/hyperexecute/release-notes/logs-categorization.png').default} alt="Image" className="doc_img"/>

docs/hyperexecute-yaml-parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ The **HyperExecute YAML** file serves as the foundational component for test exe
165165
| [project](/support/docs/deep-dive-into-hyperexecute-yaml/#project) | String | Segregate data at a project/repo level |
166166
| [slackChannel](/support/docs/deep-dive-into-hyperexecute-yaml/#slackchannel) | String | Allows you to receive notifications of your Job updates directly in your preferred Slack channel. |
167167
| [afterEachScenario](/support/docs/deep-dive-into-hyperexecute-yaml/#aftereachscenario) | List of Strings | Allows you to trigger your define tasks after each test scenario. |
168-
| [syncStart](/support/docs/deep-dive-into-hyperexecute-yaml/#execution) | Map | Ensures all VMs are ready before starting parallel tasks. |
168+
| [syncStart](/support/docs/deep-dive-into-hyperexecute-yaml/#syncstart) | Map | Ensures all VMs are ready before starting parallel tasks.|
169169

170170
<nav aria-label="breadcrumbs">
171171
<ul className="breadcrumbs">

docs/hyperexecute-yaml-version0.2.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ The ```framework``` field in Hyperexecute YAML Version 0.2 allows you to configu
6767
| [artifacts](#artifacts) | Boolean | No | Specifies whether to generate artifacts or not |
6868
| [language](#language) | String | No | Specifies the device’s system language for the test session. This determines the language in which your app’s UI and strings will be displayed. |
6969
| [locale](#locale) | String | No | Defines the regional format settings such as date, time, currency, and number conventions. |
70+
| [mitmProxy](#mitmProxy) | Boolean | No | Capture network logs directly from emulator sessions using MITM. |
7071

7172
### `name`
7273
Specifies the testing framework used in your repository.
@@ -204,6 +205,17 @@ framework:
204205
```
205206

206207

208+
### `mitmProxy`
209+
210+
You can now capture network logs directly from emulator sessions using MITM. This enhancement enables deeper debugging of API calls, request/response payloads, and overall network traffic during test execution.
211+
212+
```yaml
213+
framework:
214+
args:
215+
mitmProxy: true
216+
```
217+
218+
207219
## Sample Yaml Version 0.2
208220

209221
```yaml
@@ -231,6 +243,7 @@ framework:
231243
region: ap
232244
language: es
233245
locale: es
246+
mitmProxy: true
234247
235248
retryOnFailure: true
236249
maxRetries: 1

0 commit comments

Comments
 (0)