saucelabs plugin

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-saucelabs, add it to your project by running:

fastlane add_plugin saucelabs

fastlane v2.96.0 or higher is required for all plugin-actions to function properly.

About Sace Labs

With Sauce Labs you can continuously test your code best. This plugin provides a set of actions to interact with Sauce Labs.

saucelabs_upload allows you to push build artifacts to Sauce Lab (useful for test automation) and update its description.

Usage

To get started, first, obtain an API token in App Center. The API Token is used to authenticate with the App Center API in each call.

saucelabs_upload(
    user_name: "sauce username",
    api_key:  "sauce api name",
    app_name: "Android.MyCustomApp.apk",
    file: 'app/build/outputs/apk/debug/app-debug.apk',
    region: 'eu'
)

saucelabs_upload(
    user_name: "sauce username",
    api_key:  "sauce api name",
    app_name: "iOS.MyCustomApp.ipa",
    app_description: "my iOS build description",
    file: 'app.ipa',
    region: 'us-west-1'
)

Help

Once installed, information and help for an action can be printed out with this command:

fastlane action saucelabs_upload # or any action included with this plugin

Parameters

The action parameters api_token, user_name, region, and others can also be omitted when their values are set as environment variables.

saucelabs_upload

Key & Env Var	Description
api_token SAUCE_ACCESS_KEY	API Token for Sauce Labs
user_name SAUCE_USERNAME	User name, as found in the Sauce Labs
region SAUCE_REGION	Sauce Labs API region. Valid values are us, eu, us-west-1, eu-central-1
app_name	Build app name
file	Build filesystem location
app_desciription	(Optional) build description

Run tests for this plugin

To run both the tests, and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

Issues and Feedback

For any other issues and feedback about this plugin, please open a GitHub issue.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out fastlane.tools.

Resources

• SauceLabs Status page
• SauceLabs API

TODO

• Support folders
• Configure uploaded version
• Support mulitple regions to upload
• Retry logic
• Timeout logic
• Update description
• Test key functionality