mirror of
https://github.com/appium/appium.git
synced 2026-05-03 17:00:32 -05:00
Edgars Eglītis
5070a34739
* docs: update universal-xml-plugin readme * chore: fix line lengths * docs: update relaxed-caps-plugin readme * docs: update images-plugin readme * docs: update fake-plugin readme * docs: add readme for execute-driver-plugin * docs: update base-plugin readme * docs: update test-support readme * docs: update support readme * docs: update opencv readme * docs: update fake-driver readme * docs: update docutils readme * docs: update doctor readme * docs: update base-driver readme * docs: fix badge for base-driver * docs: slightly improve base-driver/plugin readme * docs: fix title for eslint-config-appium-ts * docs: add badges for non-prerelease packages * docs: update appium readme * docs: update some readme links * chore: address review comments
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# @appium/execute-driver-plugin
|
|
|
|
> Appium plugin for running a driver script in a child process
|
|
|
|
[](https://npmjs.org/package/@appium/execute-driver-plugin)
|
|
[](https://npmjs.org/package/@appium/execute-driver-plugin)
|
|
|
|
This plugin adds a new driver command that allows executing scripts in a child process. Currently,
|
|
the only supported driver type is `webdriverio`, therefore the script must also be written in JS.
|
|
|
|
## Motivation
|
|
|
|
Running a driver script in a child process adds a degree of parallelisation, which may result in
|
|
faster test execution.
|
|
|
|
## Installation
|
|
|
|
```
|
|
appium plugin install execute-driver
|
|
```
|
|
|
|
The plugin must be explicitly activated when launching the Appium server. Since the input script
|
|
can be arbitrary JavaScript, this is an insecure feature, and must also be explicitly enabled:
|
|
|
|
```
|
|
appium --use-plugins=execute-driver --allow-insecure=execute_driver_script
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const script = `return await driver.getTimeouts();`;
|
|
const {result, logs} = await driver.executeDriverScript(script);
|
|
// 'result' contains the data returned by the script (in this case, the response to 'getTimeouts')
|
|
// 'logs' contains everything logged to console during script execution
|
|
```
|
|
|
|
Refer to your Appium client documentation for the exact syntax of this command.
|
|
|
|
## License
|
|
|
|
Apache-2.0
|