Test Observability on WebdriverIO

Update to the latest version of the browserstack-service npm package

Go to your WebdriverIO project’s root directory and run the following commands to update the installed version of @wdio/browserstack-service and later check the installed version:

npm update @wdio/browserstack-service
npm list @wdio/browserstack-service

# Please ensure that you have @wdio/browserstack-service v7.36.0 or above (if using WDIO v7) or v8.33.1 or above (if using WDIO v8)

Please ensure that you now have @wdio/browserstack-service v7.36.0 or above (if using WDIO v7) or v8.33.1 or above (if using WDIO v8), before proceeding.

Set up the config file

Your wdio.conf.js file should include the Username and Access Key as in the following code snippet:

  exports.config = {
    //...
    user: 'YOUR_USERNAME' || process.env.BROWSERSTACK_USERNAME,
    key: 'YOUR_ACCESS_KEY' || process.env.BROWSERSTACK_ACCESS_KEY,
    services: [
        ['browserstack', {
            testObservability: true,
            testObservabilityOptions: {
                'projectName': 'Specify your project name here. It should not be dynamic',
                'buildName': 'Specify your job name here. For e.g. `Nightly regression`. It should not be dynamic',
                'buildTag': 'Any build tag goes here. For e.g. ["Tag1","Tag2"]'
            },
        }]
    ],
    //...
  };

Any other config parameters that are already existing can exist as it is.

Run your suite with BrowserStack Test Observability

Use your existing command that you use to trigger a run and data will automatically start getting sent to BrowserStack Test Observability.

Post build run completion, you will see the build URL of Test Observability. Alternatively, you can also navigate to your build run using Build Runs.

Visit Test Observability

Install the @wdio/browserstack-service npm package

You can use BrowserStack Test Observability even if your tests are running locally or on any other cloud service provider. All you’d need to do is add the @wdio/browserstack-service dependency to your project’s package.json as follows:

npm install @wdio/browserstack-service@^7.36.0 --save-dev

npm install @wdio/browserstack-service@^8.33.1 --save-dev

Set up your BrowserStack credentials in environment variables

Your BrowserStack account credentials need to be specified as environment variables. You can find your account credentials in Account Profile. Even a free trial account on BrowserStack is good enough to use Test Observability for now.

# Set these values in your ~/.zprofile (zsh) or ~/.profile (bash)
  export BROWSERSTACK_USERNAME="YOUR_USERNAME"
  export BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

# setx.exe does not set the environment variable in the current command prompt, but it will be available in subsequent command prompts
  setx BROWSERSTACK_USERNAME="YOUR_USERNAME"
  setx BROWSERSTACK_ACCESS_KEY="YOUR_ACCESS_KEY"

# Verify whether the variables have been set
echo BROWSERSTACK_USERNAME
echo BROWSERSTACK_ACCESS_KEY

Set up the webdriverIO config for Test Observability

Your wdio.conf.js should include the Username and the Access Key as in the following code snippet:

  exports.config = {
    //...
    services: [
        ['browserstack', {
            testObservability: true,
            testObservabilityOptions: {
                user: 'YOUR_USERNAME' || process.env.BROWSERSTACK_USERNAME,
                key: 'YOUR_ACCESS_KEY' || process.env.BROWSERSTACK_ACCESS_KEY,
                projectName: 'Specify your project name here. It should not be dynamic',
                buildName: 'Specify your job name here. For e.g. `Nightly regression`. It should not be dynamic',
                buildTag: 'Any build tag goes here. For e.g. ["Tag1","Tag2"]'
            },
        }]
    ],
    //...
  };

Any other config parameters that are already existing can exist as it is. Please note that the user and key variables need to be specified inside the browserstack service config. If you specify the user and key outside, then BrowserStack Automate / App Automate infrastructure will be used to run the tests.

Run your suite with BrowserStack Test Observability

Use your existing command that you use to trigger a run and data will automatically start getting sent to BrowserStack Test Observability.

Post build run completion, you will see the build URL of Test Observability. Alternatively, you can also navigate to your build run using Build Runs.

Visit Test Observability