Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LambdaTest/wdio-lambdatest-service
WebdriverIO LambdaTest Service
https://github.com/LambdaTest/wdio-lambdatest-service
hacktoberfest
Last synced: 2 months ago
JSON representation
WebdriverIO LambdaTest Service
- Host: GitHub
- URL: https://github.com/LambdaTest/wdio-lambdatest-service
- Owner: LambdaTest
- License: other
- Created: 2020-02-26T14:31:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T02:48:57.000Z (4 months ago)
- Last Synced: 2024-11-06T11:04:32.238Z (3 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 1.9 MB
- Stars: 7
- Watchers: 8
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-webdriverio - LambdaTest - Manage tunnel and job metadata for LambdaTest users. (Plugins / Services)
README
WebdriverIO LambdaTest Service
========================
[](https://github.com/LambdaTest/wdio-lambdatest-service/actions/workflows/healthcheck.yml)
> A WebdriverIO service that manages tunnel and job metadata for LambdaTest users.
## Installation
```bash
npm i wdio-lambdatest-service --save-dev
```
Instructions on how to install `WebdriverIO` can be found [here.](https://webdriver.io/docs/gettingstarted.html)
## Configuration
WebdriverIO has LambdaTest support out of the box. You should simply set `user` and `key` in your `wdio.conf.js` file. To enable the feature for app automation, set `product: 'appAutomation'` in your `wdio.conf.js` file. This service plugin provides supports for [LambdaTest Tunnel](https://www.lambdatest.com/support/docs/troubleshooting-lambda-tunnel/). Set `tunnel: true` also to activate this feature.
```js
// wdio.conf.js
exports.config = {
// ...
user: process.env.LT_USERNAME,
key: process.env.LT_ACCESS_KEY,
logFile : './logDir/api.log',
product : 'appAutomation',
services: [
['lambdatest', {
tunnel: true
}]
],
// ...
};
```
### To get test error remarks on automation dashboard
To get test error remarks on automation dashboard, simply add `ltErrorRemark: true` in your `wdio.conf.js`.
### To upload app from local or url
Upload `android` or `ios` apps from local or hosted app url by adding this required configuration in your `wdio.conf.js`. To use the uploaded app for testing along in the same run set `enableCapability = true` , this will set the app url value in the capabilities.
```js
// wdio.conf.js
services: [
[
"lambdatest",
{
tunnel: true,
app_upload: true,
app:{
app_name : "xyz", //provide your desired app name
app_path : "/path/to/your/app/file", //provide the local app location
// or
app_url : "https://example.test_android.apk", //provide the url where your app is horsted or stored
custom_id : "12345", //provide your desired custom id
enableCapability : true
}
}
]
]
```
## Options
In order to authorize to the LambdaTest service your config needs to contain a [`user`](https://webdriver.io/docs/options.html#user) and [`key`](https://webdriver.io/docs/options.html#key) option.
### tunnel
Set this to true to enable routing connections from LambdaTest cloud through your computer. You will also need to set `tunnel` to true in browser capabilities.
Type: `Boolean`
Default: `false`
### lambdatestOpts
Specified optional will be passed down to LambdaTest Tunnel. See [this list](https://www.lambdatest.com/support/docs/lambda-tunnel-modifiers/) for details.
Type: `Object`
Default: `{}`
### preferScenarioName
Cucumber only. Set the session name to the Scenario name if only a single Scenario ran.
Useful when running in parallel with [wdio-cucumber-parallel-execution](https://github.com/SimitTomar/wdio-cucumber-parallel-execution).
Type: `Boolean`
Default: `false`
### sessionNameFormat
Customize the session name format.
Type: `Function`
Default (Cucumber/Jasmine): `(config, capabilities, suiteTitle) => suiteTitle`
Default (Mocha): `(config, capabilities, suiteTitle, testTitle) => suiteTitle + ' - ' + testTitle`
### sessionNameOmitTestTitle
Mocha only. Do not append the test title to the session name.
Type: `Boolean`
Default: `false`
### sessionNamePrependTopLevelSuiteTitle
Mocha only. Prepend the top level suite title to the session name.
Type: `Boolean`
Default: `false`
### setSessionName
Automatically set the session name.
Type: `Boolean`
Default: `true`
### setSessionStatus
Automatically set the session status (passed/failed).
Type: `Boolean`
Default: `true`
### useScenarioName
To get test names as scenario names for cucumber specific tests, simply add `useScenarioName: true` in your `wdio.conf.js`.
## Steps to compile and publish
1. git clone this repository.
2. run "npm install"
3. run "npm run build"
4. Steps to Publish: run "npm login"
5. run "npm publish --access public"
----
For more information on WebdriverIO see the [homepage](https://webdriver.io).