https://github.com/awslabs/wdio-aws-device-farm-service

AWS Device Farm service for WebdriverIO
https://github.com/awslabs/wdio-aws-device-farm-service

aws aws-devicefarm typescript wdio webdriverio-service

Last synced: about 3 hours ago
JSON representation

AWS Device Farm service for WebdriverIO

• Host: GitHub
• URL: https://github.com/awslabs/wdio-aws-device-farm-service
• Owner: awslabs
• License: apache-2.0
• Created: 2021-01-12T15:21:40.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-30T08:02:51.000Z (about 2 months ago)
• Last Synced: 2024-11-10T09:05:00.443Z (6 days ago)
• Topics: aws, aws-devicefarm, typescript, wdio, webdriverio-service
• Language: TypeScript
• Homepage: https://aws.amazon.com/device-farm/
• Size: 1.03 MB
• Stars: 23
• Watchers: 14
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-webdriverio - AWS Device Farm - AWS Device Farm service. (Plugins / Services)

README

        
## AWS Device Farm Service for WebdriverIO

[AWS Device Farm](https://aws.amazon.com/device-farm/) service for WebdriverIO.

This service only supports desktop browser testing.

## Upgrading to WebDriverIO v8

The package now provides support for [WebDriverIO v8](https://webdriver.io/blog/2022/12/01/webdriverio-v8-released/) starting from version v8.0.0. However, please note that WebDriverIO v7 will continue to be supported until the end of its [LTS support](https://webdriver.io/versions/) in October 2023.

With the major version upgrade to v8, this package has transitioned to the ES module system. And it now emits both CommonJS (CJS-) and ECMAScript Modules (ESM-) compatible modules.

## Installation

```

npm install --save-dev wdio-aws-device-farm-service

```

## Example

You can run the provided example with `npm run example`. It requires:

1. An AWS Device Farm project ARN as an environment variable `PROJECT_ARN`

2. AWS Credentials ([see docs](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html)). Note that AWS Device Farm only supports `us-west-2`. You can force an AWS region with the `AWS_REGION` environment variable.

For example, this is how it would look like using AWS temporary credentials:

```sh

export PROJECT_ARN=""

export AWS_ACCESS_KEY_ID=""

export AWS_SECRET_ACCESS_KEY=""

export AWS_SESSION_TOKEN=""

export AWS_REGION="us-west-2"

npm run example

```

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## Getting Help

The best way to interact with our team is through GitHub. You can [open an issue](https://github.com/awslabs/wdio-aws-device-farm-service/issues/new) to get help or to report any issues you experience.

## License

This project is licensed under the Apache-2.0 License.