Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

artifacts and reports for HYP espresso xcui test #1074

Merged
merged 2 commits into from
Nov 8, 2024
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
1 change: 0 additions & 1 deletion docs/hyperexecute-cli-run-tests-on-hyperexecute-grid.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ This flag allows you to download all the test related results that are generated
</div>

:::note
- This functionality is not available with **XCUI** tests.
- For Espresso with private devices HyperExecute can download user generated artefacts.
:::

Expand Down
28 changes: 24 additions & 4 deletions docs/hyperexecute-espresso-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,13 +167,16 @@ runson: android

autosplit: true

report: true #to generate reports

framework:
name: "android/espresso"
args:
buildName: "Espresso"
video: true
deviceLog: true

artifacts: true #to generate artifacts

# You can use either the appId (lt://APP1234567) or provide the path of the application using appPath. Both examples are given below.
appPath: proverbial_android.apk
testSuitePath: proverbial_android_expressotest.apk
Expand Down Expand Up @@ -209,12 +212,16 @@ runson: android

autosplit: false

report: true #to generate reports

framework:
name: android/espresso
args:
buildName: Espresso
video: true
deviceLog: true
artifacts: true #to generate artifacts

# highlight-next-line
appPath: proverbial_android.apk
# highlight-next-line
Expand Down Expand Up @@ -264,21 +271,34 @@ preservedDevice: true
```
:::

## Step 6: Execute your Test Suite
## Step 6: Generate Reports and Artifacts
To generate artifacts for your Espresso tests, add the `artifacts: true` flag in your YAML file:

```yaml
report: true
framework:
name: "android/espresso"
args:
artifacts: true
...//
```

To download these artifacts in your local machine, you can pass the `--download-artifacts` and `--download-report` flag with the CLI command to execute the tests as shown in the next step.
## Step 7: Execute your Test Suite

> **NOTE :** In case of MacOS, if you get a permission denied warning while executing CLI, simply run **`chmod u+x ./hyperexecute`** to allow permission. In case you get a security popup, allow it from your **System Preferences** → **Security & Privacy** → **General tab**.

Run the below command in your terminal at the root folder of the project:

```bash
./hyperexecute --config RELATIVE_PATH_OF_YOUR_YAML_FILE
./hyperexecute --config RELATIVE_PATH_OF_YOUR_YAML_FILE --download-artifacts --download-report
```

OR use this command if you have not exported your username and access key in the step 2.

<div className="lambdatest__codeblock">
<CodeBlock className="language-bash">
{`./hyperexecute --user ${ YOUR_LAMBDATEST_USERNAME()} --key ${ YOUR_LAMBDATEST_ACCESS_KEY()} --config RELATIVE_PATH_OF_YOUR_YAML_FILE `}
{`./hyperexecute --user ${ YOUR_LAMBDATEST_USERNAME()} --key ${ YOUR_LAMBDATEST_ACCESS_KEY()} --config RELATIVE_PATH_OF_YOUR_YAML_FILE --download-artifacts --download-report`}
</CodeBlock>
</div>

Expand Down
22 changes: 18 additions & 4 deletions docs/hyperexecute-xcui-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@ framework:
values: ["LambdaUiKitIOSUITests/testverifyAppLaunch"]
deviceSelectionStrategy: any
devices: [".*"]
artifacts: true

shards:
mappings:
Expand Down Expand Up @@ -258,25 +259,38 @@ If you are using the `deviceSelectionStrategy: any`, then in that case all the m

:::

## Step 5: Execute your Test Suite
## Step 5: Generate Artifacts
To generate artifacts for your XCUI tests, add the `artifacts: true` flag in your YAML file:

```yaml
framework:
name: "ios/xcui"
args:
artifacts: true
...//
```

To download these artifacts in your local machine, you can pass the `--download-artifacts` flag with the CLI command to execute the tests as shown in the next step.

## Step 6: Execute your Test Suite

> **NOTE :** In case of macOS, if you get a permission denied warning while executing CLI, simply run **`chmod u+x ./hyperexecute`** to allow permission. In case you get a security popup, allow it from your **System Preferences** → **Security & Privacy** → **General tab**.

Run the below command in your terminal at the root folder of the project:

```bash
./hyperexecute --config RELATIVE_PATH_OF_YOUR_YAML_FILE
./hyperexecute --config RELATIVE_PATH_OF_YOUR_YAML_FILE --download-artifacts
```

OR use this command if you have not exported your username and access key in the step 2.

<div className="lambdatest__codeblock">
<CodeBlock className="language-bash">
{`./hyperexecute --user ${ YOUR_LAMBDATEST_USERNAME()} --key ${ YOUR_LAMBDATEST_ACCESS_KEY()} --config RELATIVE_PATH_OF_YOUR_YAML_FILE `}
{`./hyperexecute --user ${ YOUR_LAMBDATEST_USERNAME()} --key ${ YOUR_LAMBDATEST_ACCESS_KEY()} --config RELATIVE_PATH_OF_YOUR_YAML_FILE --download-artifacts`}
</CodeBlock>
</div>

## Step 6: Monitor the Test Execution
## Step 7: Monitor the Test Execution

Visit the [HyperExecute Dashboard](https://hyperexecute.lambdatest.com/hyperexecute) and check your Job status.

Expand Down
11 changes: 11 additions & 0 deletions docs/hyperexecute-yaml-version0.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ The ```framework``` field in Hyperexecute YAML Version 0.2 allows you to configu
| [workingDirectory](#workingDirectory) | String | No | Specifies the working directory where all discovery and execution commands will be executed.|
| [defaultReports](#defaultReports) | Boolean | No | Specifies whether to create default reports for the specified framework.|
| [region](#region) | String | No | Specifies in which region you want to spin your appium tests.|
| [artifacts](#artifacts) | Boolean | No | Specifies whether to generate artifacts or not |

### `name`
Specifies the testing framework used in your repository.
Expand Down Expand Up @@ -167,6 +168,16 @@ framework:
region: us
```

### `artifacts`

To generate artifacts for your Espresso tests, add the `artifacts: true` flag in your YAML file:

```yaml
framework:
args:
artifacts: true
```

> 📕 Learn [how to perform group-based test discovery in TestNG](/support/docs/hyperexecute-how-to-perform-group-based-test-discovery-in-testng)

## Sample Yaml Version 0.2
Expand Down
32 changes: 16 additions & 16 deletions docs/supported-appium-versions-on-emulator-simulator.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,27 +81,27 @@ The following table lists the iOS versions supported for app testing, along with
| 17 | ['2.2.1', '2.3.0'] |
| 18 | ['2.2.1', '2.3.0'] |

## 2. Web Testing on Android and iOS
For mobile web testing, LambdaTest supports various Android and iOS device versions, ensuring that your web applications are responsive and compatible with different browsers and devices. Below are the supported versions for web testing.
## 2. Web Testing on Android <!-- and iOS -->
For mobile web testing, LambdaTest supports various Android <!--and iOS device--> versions, ensuring that your web applications are responsive and compatible with different browsers and devices. Below are the supported versions for web testing.

### 2.1 Supported Android Versions for Web Testing
<!-- ### 2.1 Supported Android Versions for Web Testing -->
The following table lists the Android versions supported for web testing, along with the corresponding Appium versions.

| Android Versions | Appium Versions (Android) |
|------------------|-----------------------------------------|
| 7 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 7.1 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 8 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 8.1 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 9 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 10 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 11 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 12 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 13 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 14 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 15 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 7 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**] |
| 7.1 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**] |
| 8 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**] |
| 8.1 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**] |
| 9 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**] |
| 10 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**] |
| 11 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**] |
| 12 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3` **(default)**, `2.0.1`, `2.1.0`, `2.1.1`, `2.1.2`, `2.1.3`, `2.2.0`, `2.2.1`, `2.2.2`, `2.2.3`, `2.3.0`, `2.4.0`, `2.4.1`, `2.5.0`, `2.5.1`, `2.5.2`, `2.5.3`, `2.5.4`, `2.6.0`] |
| 13 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3`, `2.0.1`, `2.1.0`, `2.1.1`, `2.1.2`, `2.1.3`, `2.2.0`, `2.2.1`, `2.2.2`, `2.2.3`, `2.3.0`, `2.4.0`, `2.4.1`, `2.5.0`, `2.5.1`, `2.5.2`, `2.5.3`, `2.5.4`, `2.6.0` **(default)**] |
| 14 | [`1.17.0`, `1.17.1`, `1.18.0`, `1.19.0`, `1.19.1`, `1.20.0`, `1.20.1`, `1.20.2`, `1.21.0`, `1.22.0`, `1.22.1`, `1.22.2`, `1.22.3`, `2.0.1`, `2.1.0`, `2.1.1`, `2.1.2`, `2.1.3`, `2.2.0`, `2.2.1`, `2.2.2`, `2.2.3`, `2.3.0`, `2.4.0`, `2.4.1`, `2.5.0`, `2.5.1`, `2.5.2`, `2.5.3`, `2.5.4`, `2.6.0` **(default)**] |
| 15 | [`1.22.3`, `2.0.1`, `2.1.0`, `2.2.0`, `2.3.0`, `2.4.0`, `2.5.0`, `2.6.0` **(default)**] |

### 2.2 Supported iOS Versions for Web Testing
<!-- ### 2.2 Supported iOS Versions for Web Testing
The following table lists the iOS versions supported for web testing, along with the corresponding Appium versions.

| iOS Versions | Appium Versions (iOS) |
Expand All @@ -115,4 +115,4 @@ The following table lists the iOS versions supported for web testing, along with
| 15.0 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 16.0 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 17.0 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 18.0 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] |
| 18.0 | ['1.12.1', '1.17.0', '1.22.3', '2.6.0'] | -->
Loading