Skip to content

Commit ce7bb36

Browse files
authored
Merge pull request #679 from Ishavyas9/main
HYP DOC REVAMP
2 parents 049c493 + cab3bf6 commit ce7bb36

File tree

63 files changed

+470
-550
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+470
-550
lines changed
Loading
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.
Loading
Loading
Loading
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Loading
Binary file not shown.

assets/images/hyperexecute/yaml/1.mp4

12.8 MB
Binary file not shown.

assets/images/hyperexecute/yaml/1.png

-99.1 KB
Binary file not shown.

assets/images/hyperexecute/yaml/2.png

-74.5 KB
Binary file not shown.

assets/images/hyperexecute/yaml/3.png

-87.8 KB
Binary file not shown.

assets/images/hyperexecute/yaml/4.png

-45.7 KB
Binary file not shown.

docs/behave-on-hyperexecute-grid.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Configure the desired capabilities based on your test requirements. For example:
105105
]
106106
```
107107

108-
> You can generate capabilities for your test requirements with the help of our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
108+
> You can also use **dev** and **beta** browser versions. To generate capabilities for your test requirements, you can use our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
109109
110110

111111
### Step 2: Setup the CLI in your Test Suite

docs/behave-with-selenium-running-behave-automation-scripts-on-lambdatest-selenium-grid.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ def after_all(context):
198198
}
199199
]
200200
```
201-
> You can generate capabilities for your test requirements with the help of our inbuilt **[Capabilities Generator tool](https://www.lambdatest.com/capabilities-generator/)**.
201+
> You can also use **dev** and **beta** browser versions. To generate capabilities for your test requirements, you can use our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
202202
203203
### Executing the Test
204204

docs/capybara-on-hyperexecute-grid.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Configure the desired capabilities based on your test requirements. For example:
107107
}
108108
```
109109

110-
> You can generate capabilities for your test requirements with the help of our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
110+
> You can also use **dev** and **beta** browser versions. To generate capabilities for your test requirements, you can use our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
111111
112112
### Step 2: Setup the CLI in your Test Suite
113113

docs/codecept-on-hyperexecute.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ By setting up the Hub endpoint, you establish the communication channel between
9898

9999
<!-- Configure the desired capabilities based on your test requirements. For example: -->
100100

101-
> You can generate capabilities for your test requirements with the help of our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
101+
> You can also use **dev** and **beta** browser versions. To generate capabilities for your test requirements, you can use our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
102102
103103
### Step 2: Setup the CLI in your Test Suite
104104

docs/codeception-php-framework.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ modules:
159159
version: '71.0'
160160
tunnel: false # sets tunnel value to true for routing traffic through your local machine
161161
```
162-
> **Note:** You can generate capabilities for your test requirements with the help of our inbuilt **[Capabilities Generator tool](https://www.lambdatest.com/capabilities-generator/)**.
162+
> You can also use **dev** and **beta** browser versions. To generate capabilities for your test requirements, you can use our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
163163
164164
### Executing the Test
165165
**Step 5:** The tests can be executed in the terminal using the following command:

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

+158-250
Large diffs are not rendered by default.

docs/hyperexecute-guided-walkthrough.md

+16-48
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,13 @@ This page gives you a guided walkthrough of all the things on the HyperExecute D
4141

4242
## Jobs Page
4343

44-
All the tests on HyperExecute get executed as a Job. All the Jobs can be found on our [Jobs page](https://hyperexecute.lambdatest.com/hyperexecute).
45-
46-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/1.png').default} alt="Image" className="doc_img"/>
47-
48-
Each [Job](/support/docs/hyperexecute-status/#1-job-level-status) has a [Status](/support/docs/hyperexecute-status/#3-stage-level-status), a unique `Job Number`, a set of [Labels](/support/docs/deep-dive-into-hyperexecute-yaml/#joblabel), info on number of [Tasks](/support/docs/hyperexecute-status/#2-task-level-status) executed as part of that Job, and a `Summary` section followed by the details of the `Job Duration` and who initiated the Job
44+
All the tests on HyperExecute get executed as a Job. All the Jobs can be found on our [Jobs page](https://hyperexecute.lambdatest.com/hyperexecute). Each [Job](/support/docs/hyperexecute-status/#1-job-level-status) has a [`Status`](/support/docs/hyperexecute-status/#3-stage-level-status), a unique `Job Number`, a set of [`Labels`](/support/docs/deep-dive-into-hyperexecute-yaml/#joblabel), info on number of [`Tasks`](/support/docs/hyperexecute-status/#2-task-level-status) executed as part of that Job, and a `Summary` section followed by the details of the `Job Duration` and who initiated the Job
4945

5046
On this page you have other things such as filters, help center, docs, [secrets management](/support/docs/hyperexecute-how-to-save-and-manage-secrets/) and much more. You can also filter through all of the jobs on the basis of the date, status, type etc.
5147

52-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/2.png').default} alt="Image" className="doc_img"/>
48+
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/1.png').default} alt="Image" className="doc_img"/>
5349

54-
> Learn more about Secrets Management, Getting User Name and Access Key from our [Knowledge Base](/support/docs/hyperexecute-knowledge-base/)
50+
> Learn more about [Secrets Management](/support/docs/hyperexecute-how-to-save-and-manage-secrets/), getting [User Name and Access Key](/support/docs/hyperexecute-how-to-get-my-username-and-access-key/) from our [Knowledge Base](/support/docs/hyperexecute-knowledge-base/)
5551
5652
### Top Panel
5753

@@ -100,55 +96,33 @@ You can access a much more detailed section for your test cases on the Automatio
10096

10197
It provides you with all the necessary data points that you need for your test.
10298

103-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/6.png').default} alt="Image" className="doc_img"/>
104-
105-
### Top Panel
106-
107-
- **Create an Issue**: You can create an issue/tickets on directly onto Slack, Jira etc with the integrations that we provide.
108-
- **Analytics**: You can access the analytics of all of your tests by clicking on the **Analytics** button.
109-
- **Access Key**: Your Username and Access Key can be accessed by clicking on the **Access Key** button on the top right-hand side of the dashboard.
110-
- **Help**: Click on the **Question Mark (?)** icon to access the Help Center.
11199
### Basic Summary
112100
You can see the details of your test on the panel on the top of the screen. It contains several details like the browser, the test status, the test name, and more.
113101

114-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/7.png').default} alt="Image" className="doc_img"/>
115-
116-
- **Test Status**: The status of your test. If the test has passed, the status will be passed.
117-
- **Test Name**: The name of your test. You can rename the test, copy the name and see all the tests in the build.
118-
- **Test ID**: The test ID of your test. You can copy the test ID by clicking on the **Copy** button.
119-
- **Browser**: The browser on which your tests are run.
120-
- **OS**: The Operating System on which your tests are run.
121-
- **Resolution**: The resolution of the screen.
122-
- **Duration**: The amount of time it took for your test to run.
123-
- **Test Meta Data**: You can view the test meta data by clicking on the **info** icon.
124-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/8.png').default} alt="Image" className="doc_img"/>
125-
- **Tunnel Information**: Tells whether you have used a tunnel to run your tests or not.
126-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/9.png').default} alt="Image" className="doc_img"/>
127-
- **Share**: You can share the details of this test by clicking on the **Share** icon.
128-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/10.png').default} alt="Image" className="doc_img"/>
129-
- **Delete**: You can delete the test entirely by clicking on the **Delete** icon.
130-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/11.png').default} alt="Image" className="doc_img"/>
131-
132-
133-
### Videos and Screenshots
102+
- **Test Status**: The status of your test. If the test has passed, the status will be passed.
103+
- **Test Name**: The name of your test. You can rename the test, copy the name and see all the tests in the build.
104+
- **Test ID**: The test ID of your test. You can copy the test ID by clicking on the **Copy** button.
105+
- **Browser**: The browser on which your tests are run.
106+
- **OS**: The Operating System on which your tests are run.
107+
- **Resolution**: The resolution of the screen.
108+
- **Duration**: The amount of time it took for your test to run.
109+
- **Test Meta Data**: You can view the test meta data by clicking on the **info** icon.
110+
- **Tunnel Information**: Tells whether you have used a tunnel to run your tests or not.
111+
- **Share**: You can share the details of this test by clicking on the **Share** icon.
112+
- **Delete**: You can delete the test entirely by clicking on the **Delete** icon.
113+
### Videos and Screenshots
134114

135115
HyperExecute provides you with tools like videos and screenshots of your tests to give you a clear picture of what goes on in the background.
136116

137-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/12.png').default} alt="Image" className="doc_img"/>
138-
139117
### Commands and Logs
140118

141119
You can access the commands involved in the test, and the logs on the right hand side on this Dashboard.
142120

143-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/13.png').default} alt="Image" className="doc_img"/>
144-
145121
- **All Commands**: Each command that is run as a part of your test case is shown here. Each command also contains its own parameters, that can be accessed by hovering on the command and clicking on **View Parameters**.
146-
147122
- **Network**: Access the network logs while your tests were getting executed on the **Network** tab.
148-
149123
- **Logs**: View all kinds of logs at one place. You can toggle between the **Console Logs**, **Terminal Logs** and the **Test Framework Logs**.
150124

151-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/14.png').default} alt="Image" className="doc_img"/>
125+
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/6.png').default} alt="Image" className="doc_img"/>
152126

153127
>**Note**: You can download the logs by clicking on the Download button on the top right-hand corner of the logs tab.
154128
@@ -176,12 +150,6 @@ Additionally, upon redirection, the automation dashboard opens the relevant tab
176150

177151
Update your designated HyperExecute YAML file with [`buildConfig`](/support/docs/deep-dive-into-hyperexecute-yaml/#buildconfig) configuration to activate the "**Test Summary Hyperlink**" feature. This configuration allows you to define specific parameters that govern the behavior of the hyperlinks based on the test summary status.
178152

179-
## Support
180-
181-
If you need more help regarding HyperExecute, click on **Support** to speak to LambdaTest Support. You can also access LambdaTest Support by clicking on the bottom right-hand side of your dashboard.
182-
183-
<img loading="lazy" src={require('../assets/images/hyperexecute/getting_started/guided-walkthrough/15.png').default} alt="Image" className="doc_img"/>
184-
185153
<nav aria-label="breadcrumbs">
186154
<ul className="breadcrumbs">
187155
<li className="breadcrumbs__item">
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
id: hyperexecute-how-to-perform-dependent-test-based-discovery
3+
title: How to Perform Dependent Test Case Discovery
4+
hide_title: false
5+
sidebar_label: How to Perform Dependent Test Case Discovery
6+
description: How to Perform Dependent Test Case Discovery
7+
keywords:
8+
- hyperexecute yaml
9+
- How to Perform Dependent Test Case Discovery
10+
url: https://www.lambdatest.com/support/docs/hyperexecute-how-to-perform-dependent-test-based-discovery/
11+
site_name: LambdaTest
12+
slug: hyperexecute-how-to-perform-dependent-test-based-discovery/
13+
---
14+
15+
<script type="application/ld+json"
16+
dangerouslySetInnerHTML={{ __html: JSON.stringify({
17+
"@context": "https://schema.org",
18+
"@type": "BreadcrumbList",
19+
"itemListElement": [{
20+
"@type": "ListItem",
21+
"position": 1,
22+
"name": "Home",
23+
"item": "https://www.lambdatest.com"
24+
},{
25+
"@type": "ListItem",
26+
"position": 2,
27+
"name": "Support",
28+
"item": "https://www.lambdatest.com/support/docs/"
29+
},{
30+
"@type": "ListItem",
31+
"position": 3,
32+
"name": "How to Perform Dependent Test Case Discovery",
33+
"item": "https://www.lambdatest.com/support/docs/hyperexecute-how-to-perform-dependent-test-based-discovery/"
34+
}]
35+
})
36+
}}
37+
></script>
38+
39+
Dependent tests signify that one test relies on the outcome of another. To achieve this, TestNG offers the '**dependsOnMethods**' attribute within @Test annotations.
40+
41+
For instance, consider the code snippet in which '**SignIn()**' depends on '**OpenBrowser()**,' and '**LogOut()**' depends on 'SignIn().'
42+
43+
```java
44+
import org.testng.annotations.Test;
45+
public class DependsOnTest {
46+
@Test
47+
public void OpenBrowser() {
48+
System.out.println("The browser is opened");
49+
}
50+
51+
@Test (dependsOnMethods = { "OpenBrowser" })
52+
public void SignIn() {
53+
System.out.println("User has signed in successfully");
54+
}
55+
56+
@Test (dependsOnMethods = { "SignIn" })
57+
public void LogOut() {
58+
System.out.println("The user logged out successfully");
59+
}
60+
}
61+
```
62+
63+
To discover and manage dependent tests using the Test Discovery command, you can use the following syntax:
64+
65+
```yaml
66+
mvn test -Dmode=discover -Dplatname=win -Dframework=testng -Ddiscovery=dependent
67+
```
68+
69+
This command will provide a Test Discovery Result that lists the tests and their dependencies, ensuring that dependent tests are executed in the correct order, such as ["Test1#SignIn,Test1#LogOut,Test1#OpenBrowser"].
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
---
2+
id: hyperexecute-how-to-perform-group-based-test-discovery-in-testng
3+
title: How to Perform Group-Based Test Discovery in TestNG
4+
hide_title: false
5+
sidebar_label: How to Perform Group-Based Test Discovery in TestNG
6+
description: How to Perform Group-Based Test Discovery in TestNG
7+
keywords:
8+
- hyperexecute yaml
9+
- How to Perform Group-Based Test Discovery in TestNG
10+
url: https://www.lambdatest.com/support/docs/hyperexecute-how-to-perform-group-based-test-discovery-in-testng/
11+
site_name: LambdaTest
12+
slug: hyperexecute-how-to-perform-group-based-test-discovery-in-testng/
13+
---
14+
15+
<script type="application/ld+json"
16+
dangerouslySetInnerHTML={{ __html: JSON.stringify({
17+
"@context": "https://schema.org",
18+
"@type": "BreadcrumbList",
19+
"itemListElement": [{
20+
"@type": "ListItem",
21+
"position": 1,
22+
"name": "Home",
23+
"item": "https://www.lambdatest.com"
24+
},{
25+
"@type": "ListItem",
26+
"position": 2,
27+
"name": "Support",
28+
"item": "https://www.lambdatest.com/support/docs/"
29+
},{
30+
"@type": "ListItem",
31+
"position": 3,
32+
"name": "How to Perform group based Test Case Discovery",
33+
"item": "https://www.lambdatest.com/support/docs/hyperexecute-how-to-perform-group-based-test-discovery-in-testng/"
34+
}]
35+
})
36+
}}
37+
></script>
38+
39+
TestNG provides group-based test discovery functionality. You can specify groups for your tests and execute or exclude specific groups during test runs.
40+
41+
To perform group-based test discovery, you can use the ***@BeforeGroups*** and ***@AfterGroups*** annotations in your TestNG tests. These annotations allow you to specify setup and cleanup methods that run before and after specific groups of tests.
42+
43+
For example:
44+
45+
```java
46+
public class GroupIntegrationTest {
47+
48+
@BeforeGroups("database")
49+
public void setupDB() {
50+
System.out.println("setupDB()");
51+
}
52+
53+
@AfterGroups("database")
54+
public void cleanDB() {
55+
System.out.println("cleanDB()");
56+
}
57+
58+
@Test(groups = "selenium-test")
59+
public void runSelenium() {
60+
System.out.println("runSelenium()");
61+
}
62+
63+
@Test(groups = "selenium-test")
64+
public void runSelenium1() {
65+
System.out.println("runSelenium()1");
66+
}
67+
68+
@Test(groups = "database")
69+
public void testConnectOracle() {
70+
System.out.println("testConnectOracle()");
71+
}
72+
73+
@Test(groups = "database")
74+
public void testConnectMsSQL() {
75+
System.out.println("testConnectMsSQL");
76+
}
77+
78+
}
79+
```
80+
81+
In the Hyperexecute YAML Version 0.2 configuration, you can use the ```discoveryFlags``` parameter to specify the groups to discover during test discovery.
82+
83+
```yaml
84+
framework:
85+
name: "maven/testng"
86+
discoveryFlags: ["-Dgroups=database"]
87+
```
88+
89+
Here it will only discover tests belonging to the group database. Use comma-separated values if you want to specify multiple groups.
90+
91+
Similarly, you can use the ```excludedGroups``` parameter that can be used to run all test groups except for the defined set of groups.
92+
93+
```yaml
94+
framework:
95+
name: "maven/testng"
96+
discoveryFlags: ["-DexcludedGroups=database"]
97+
```
98+
99+
This discovers all test of groups except database.
100+
101+
102+
Alternatively, you can also specify the groups or excluded groups directly in the pom.xml file using the Maven Surefire Plugin
103+
104+
```yaml
105+
<plugins>
106+
[...]
107+
<plugin>
108+
<groupId>org.apache.maven.plugins</groupId>
109+
<artifactId>maven-surefire-plugin</artifactId>
110+
<version>2.22.1</version>
111+
<configuration>
112+
<groups>database,selenium-test</groups>
113+
</configuration>
114+
</plugin>
115+
[...]
116+
</plugins>
117+
```

docs/hyperexecute-how-to-run-tests-using-local-selenium-drivers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ The number of tasks created = **(total number of platforms) * (parallelism)** =
163163

164164
<img loading="lazy" src={require('../assets/images/hyperexecute/knowledge-base/how-to-guide/local-driver-os.png').default} alt="Image" className="doc_img"/>
165165

166-
> You can generate capabilities for your test requirements with the help of our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
166+
> You can also use **dev** and **beta** browser versions. To generate capabilities for your test requirements, you can use our inbuilt 🔗 [Capabilities Generator Tool](https://www.lambdatest.com/capabilities-generator/).
167167
168168
### Step 3: Run Your Tests:
169169

0 commit comments

Comments
 (0)