Skip to content

Commit 8feb0dc

Browse files
authored
Merge pull request #1013 from Aman1905/stage
updated the remote discovery
2 parents 3baaa32 + ebcd13e commit 8feb0dc

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

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

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ This is used to locate or discover relevant tests via class names, filters, file
120120
```yaml
121121
testDiscovery:
122122
type: raw
123-
mode: dynamic
123+
mode: local
124124
command: grep 'public class' src/test/java/hyperexecute/*.java | awk '{print$3}'
125125
```
126126

@@ -131,7 +131,7 @@ It contains the following attributes:
131131
type: raw #or
132132
133133
#(Advanced). For more advanced use cases.
134-
type: automatic
134+
type: automatic
135135
```
136136

137137
**`type: raw`**
@@ -151,36 +151,37 @@ type: automatic
151151
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.
152152

153153
#### `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`.
154+
This attribute defines where the test discovery occurs and how it is executed. HyperExecute now supports three discovery modes: `local`, and `remote`.
155155

156156
```yaml
157157
#test discovery happens on machine where CLI is running
158-
mode: static #or
159-
160-
#test discovery happens on HyperExecute VMs
161-
mode: dynamic #or
158+
mode: local #or
162159
163160
# test discovery happens in designated HyperExecute VMs
164161
mode: remote
165162
```
166-
**`mode: static`**
163+
<!-- #test discovery happens on HyperExecute VMs
164+
mode: dynamic #or -->
165+
**`mode: local`**
167166

168167
- **Purpose:** Test discovery is performed locally on the machine where the CLI is running.
169168
- **Use Case:** Ideal for small projects or when tests need to be discovered locally.
170169
- **Limitations:** Requires dependencies installed locally and doesn’t support matrix-based distributions. Debugging logs are generated locally, limiting visibility.
171170

172-
**`mode: dynamic`**
171+
<!-- **`mode: dynamic`**
173172

174173
- **Purpose:** Test discovery occurs on HyperExecute’s VMs during runtime, depending on the concurrency and OS settings.
175174
- **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.
175+
- **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. -->
177176

178177
**`mode: remote`** <NewTag value="NEW" bgColor="#ffec02" color="#000" />
179178

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.
179+
The `remote` discovery mode addresses the limitations of `local` modes. Instead of running test discovery on your local machine (local), this mode centralizes the process by using a dedicated remote Virtual Machines.
181180

182181
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.
183182

183+
> **NOTE :** [`type`](/support/docs/deep-dive-into-hyperexecute-yaml/#type) is not required with remote discovery.
184+
184185
#### Key Features:
185186
- **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.
186187

@@ -193,13 +194,13 @@ This setup helps to ease the discovery process and makes it more efficient, espe
193194
- **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.
194195

195196
#### `command`
196-
The command that fetches the list of test scenario that would be further executed using the value passed in testRunnerCommand
197+
The command that fetches the list of test scenario that would be further executed using the value passed in `testRunnerCommand`
197198
```yaml
198199
command: grep 'public class' src/test/java/hyperexecute/*.java | awk '{print$3}'
199200
```
200201

201202
:::tip
202-
- Test orchestration will happen with [`mode: static`](/support/docs/deep-dive-into-hyperexecute-yaml/#mode) only.
203+
- Test orchestration will happen with [`mode: local`](/support/docs/deep-dive-into-hyperexecute-yaml/#mode) only.
203204
- 📕 Learn how to perform [dependent test discovery](/support/docs/hyperexecute-how-to-perform-dependent-test-based-discovery/).
204205
:::
205206

0 commit comments

Comments
 (0)