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

Updating readme #20

Merged
merged 2 commits into from
Feb 21, 2025
Merged
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
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ apply plugin: "io.github.lambdatest.gradle"

```
### Add LambdaTest parameters to `build.gradle`:
#### Configuration for running test and optionally uploading your apps

```
runLambdaTest {
username = 'yourLambdaTestUsername'
Expand All @@ -39,12 +41,25 @@ runLambdaTest {
testSuiteId = "lt//1223444" //provide this only if you have already uploaded the app
}
```

#### Configuration for only uploading your apps

```
uploadApkToLambdaTest {
username = 'yourLambdaTestUsername'
accessKey = 'yourLambdaTestAccessKey'
appFilePath = 'pathToYourAppFile'
testSuiteFilePath = 'pathToYourTestSuite'
}
```


### Supported Capabilities:

The following capabilities are supported:

- `app`: Enter the app id generated while uploading the app. Example:lt://APP123456789123456789
- `testSuite`: Enter the test suite id generated while uploading the test suite. Example: lt://APP123456789123456789
- `appId`: Enter the app id generated while uploading the app. Example:lt://APP123456789123456789
- `testSuiteId`: Enter the test suite id generated while uploading the test suite. Example: lt://APP123456789123456789
- `device`: Enter the name and os version of the device in “DeviceName-OSVersion” format. Example: Pixel 3 XL-9 or Galaxy S21 Ultra 5G-11.
- `video`: Generate video for all the tests that have run. Example: true.
- `queueTimeout`: Enter the time in seconds after which you want your build to timeout from queue. Example: 300.
Expand All @@ -54,12 +69,23 @@ The following capabilities are supported:
- `geoLocation`: Set the geolocation country code if you want to enable the same in your test. Example - FR.
- `tunnel`, `tunnelName`: Set tunnel as true and provide the tunnelName such as NewTunnel as needed if you are running a tunnel.

- `appFilePath` : Path of your app file (this will be uploaded to LambdaTest)

- `testSuiteFilePath` : Path of your test suite apk file (this will be uploaded to LambdaTest)

## Execution:
To run the plugin added in the project's `build.gradle`:
#### To run the test with the plugin added in the project's `build.gradle`:
```
./gradlew runLambdaTest
```

#### If you just want to upload apks and not run actual tests:

```
./gradlew uploadApkToLambdaTest
```


## About LambdaTest

[LambdaTest](https://www.lambdatest.com/) is a cloud based selenium grid infrastructure that can
Expand Down
Loading