Skip to content

Commit 3b9f032

Browse files
authored
Merge pull request #1007 from Aman1905/stage
remote discovery documentation
2 parents d8be72c + 3d625b9 commit 3b9f032

File tree

1 file changed

+38
-4
lines changed

1 file changed

+38
-4
lines changed

docs/deep-dive-into-hyperexecute-yaml.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ slug: deep-dive-into-hyperexecute-yaml/
1515

1616
import Tabs from '@theme/Tabs';
1717
import TabItem from '@theme/TabItem';
18+
import NewTag from '../src/component/newTag';
1819

1920
<script type="application/ld+json"
2021
dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -133,14 +134,14 @@ type: raw #or
133134
type: automatic
134135
```
135136

136-
**`type:raw`**
137+
**`type: raw`**
137138

138139
- **Purpose:** Perform a basic test discovery based on the provided command.
139140
- **Functionality:** Directly executes the specified command and displays the discovered tests.
140141
- **Limitations:** Doesn't utilize any built-in logic or advanced discovery capabilities.
141142
- **Suitable for:** Simple test discovery scenarios where the command directly identifies the desired tests.
142143

143-
**`type:automatic`**
144+
**`type: automatic`**
144145

145146
- **Purpose:** Utilize backend logic to discover tests using external tools.
146147
- **Functionality:** Relies on a backend tool, such as Snooper, to perform test discovery.
@@ -149,14 +150,47 @@ type: automatic
149150

150151
In summary, `type:raw` is a basic and straightforward approach for discovering tests based on a specified command, while `type:automatic` provides more flexibility and advanced capabilities by leveraging external tools and backend logic.
151152

152-
#### `mode`
153+
#### `mode`
154+
This attribute defines where the test discovery occurs and how it is executed. HyperExecute now supports three discovery modes: `static`, `dynamic`, and `remote`.
155+
153156
```yaml
154157
#test discovery happens on machine where CLI is running
155158
mode: static #or
156159
157160
#test discovery happens on HyperExecute VMs
158-
mode: dynamic
161+
mode: dynamic #or
162+
163+
# test discovery happens in designated HyperExecute VMs
164+
mode: remote
159165
```
166+
**`mode: static`**
167+
168+
- **Purpose:** Test discovery is performed locally on the machine where the CLI is running.
169+
- **Use Case:** Ideal for small projects or when tests need to be discovered locally.
170+
- **Limitations:** Requires dependencies installed locally and doesn’t support matrix-based distributions. Debugging logs are generated locally, limiting visibility.
171+
172+
**`mode: dynamic`**
173+
174+
- **Purpose:** Test discovery occurs on HyperExecute’s VMs during runtime, depending on the concurrency and OS settings.
175+
- **Use Case:** Suitable for scenarios where distributed test discovery is required across different VMs.
176+
- **Limitations:** Increases test execution time due to VM-level discovery. It also lacks efficient test distribution across VMs, and is incompatible with YAML 0.2 test discovery runners.
177+
178+
**`mode: remote`** <NewTag value="NEW" bgColor="#ffec02" color="#000" />
179+
180+
The `remote` discovery mode addresses the limitations of both `static` and `dynamic` modes. Instead of running test discovery on your local machine (static) or on multiple Virtual Machines (dynamic), this mode centralizes the process by using a dedicated remote Virtual Machines.
181+
182+
This setup helps to ease the discovery process and makes it more efficient, especially for complex test setups. Additionally, it fully supports [matrix-based testing](https://www.lambdatest.com/support/docs/hyperexecute-matrix-multiplexing-strategy/), which allows you to discover and manage tests across different configurations more effectively.
183+
184+
#### Key Features:
185+
- **Centralized Discovery Tasks:** Tests are discovered remotely in a Virtual Machines designed for this purpose. Discovery tasks focus solely on identifying the tests without executing them, optimizing the discovery process.
186+
187+
- **Orchestration Support:** Once tests are identified, orchestration algorithms ensure they are efficiently distributed across Virtual Machines, reducing idle time and improving resource utilization.
188+
189+
- **Matrix Support:** Fully supports matrix configurations, allowing individual test discovery for each matrix combination, particularly useful for YAML 0.2 runners.
190+
191+
- **Optimized Caching:** Remote Discovery Mode reduces redundant cache operations by performing them once in the discovery task, and sharing the cache across all Execution Tasks. This speeds up the overall process and minimizes resource wastage.
192+
193+
- **Code Caching:** For users cloning their codebase via Git, Remote Discovery caches the code during the discovery task, reducing Git rate limits and accelerating the execution tasks.
160194

161195
#### `command`
162196
The command that fetches the list of test scenario that would be further executed using the value passed in testRunnerCommand

0 commit comments

Comments
 (0)