docs: add more examples

bamboo-integration/config-parallel.js

@@ -0,0 +1,15 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    reporters: [
+        'dot',
+        ['junit', {
+            outputDir: './testresults/',
+            outputFileFormat: function (options) {
+                return `results-${options.cid}.xml`;
+            }
+        }]
+    ],
+    // ...
+})

bamboo-integration/config.js

@@ -0,0 +1,12 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    reporters: [
+        'dot',
+        ['junit', {
+            outputDir: './testresults/'
+        }]
+    ],
+    // ...
+})

browser/mobile-flags.js

@@ -0,0 +1,13 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    capabilities: {
+        platformName: 'iOS',
+        app: 'net.company.SafariLauncher',
+        udid: '123123123123abc',
+        deviceName: 'iPhone',
+        // ...
+    }
+    // ...
+})

browserstack/config.js

@@ -0,0 +1,29 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+  //...
+  user: '<browserstack_username>' || process.env.BROWSERSTACK_USERNAME,
+  key: '<browserstack_access_key>' || process.env.BROWSERSTACK_ACCESS_KEY,
+  commonCapabilities: {
+    'bstack:options': {
+      projectName: "Your static project name goes here",
+      buildName: "Your static build/job name goes here"
+    }
+  },
+  services: [
+    ['browserstack', {
+      accessibility: true,
+      // Optional configuration options
+      accessibilityOptions: {
+        'wcagVersion': 'wcag21a',
+        'includeIssueType': {
+          'bestPractice': false,
+          'needsReview': true
+        },
+        'includeTagsInTestingScope': ['Specify tags of test cases to be included'],
+        'excludeTagsInTestingScope': ['Specify tags of test cases to be excluded']
+      },
+    }]
+  ],
+  //...
+});

capabilities/config.js

@@ -0,0 +1,11 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    capabilities: [{
+        browserName: 'chrome',
+        'custom:caps': {
+            // custom configurations
+        }
+    }]
+})

cloud-services/config-env-variables.js

@@ -0,0 +1,10 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+})
+
+if (process.env.CI) {
+    config.user = process.env.SAUCE_USERNAME
+    config.key = process.env.SAUCE_ACCESS_KEY
+}

cloud-services/config-perfecto.js

@@ -0,0 +1,13 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+  hostname: "your_cloud_name.perfectomobile.com",
+  path: "/nexperience/perfectomobile/wd/hub",
+  port: 443,
+  protocol: "https",
+  // ...
+  capabilities: [{
+    // ...
+    securityToken: "your security token"
+  }],
+})

component-testing/config-selenium-grid.js

@@ -0,0 +1,8 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    runner: ['browser', {
+        // network IP of the machine that runs the WebdriverIO process
+        host: 'http://172.168.0.2'
+    }]
+})

component-testing/config.js

@@ -0,0 +1,11 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    mochaOpts: {
+        ui: 'tdd',
+        // provide a setup script to run in the browser
+        require: './__fixtures__/setup.js'
+    },
+    // ...
+})

configuration-file/config.js

@@ -0,0 +1,30 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    runner: 'local',
+    specs: [
+        'test/spec/**',
+        ['group/spec/**']
+    ],
+    maxInstances: 10,
+    capabilities: [
+        {
+            browserName: 'chrome',
+        },
+        {
+        browserName: 'firefox',
+        }
+    ],
+    logLevel: 'info',
+    outputDir: './logs',
+    baseUrl: 'http://localhost:8080',
+    waitforTimeout: 30000,
+    framework: 'mocha',
+    reporters: [
+        'dot',
+        'allure'
+    ],
+    mochaOpts: {
+        ui: 'bdd'
+    },
+})

configuration/config-headers.js

@@ -0,0 +1,19 @@
+import { Buffer } from 'buffer';
+import { defineConfig } from '@wdio/config'
+
+// Read the username and password from environment variables
+const username = process.env.SELENIUM_GRID_USERNAME;
+const password = process.env.SELENIUM_GRID_PASSWORD;
+
+// Combine the username and password with a colon separator
+const credentials = `${username}:${password}`;
+// Encode the credentials using Base64
+const encodedCredentials = Buffer.from(credentials).toString('base64');
+
+export const config = defineConfig({
+    // ...
+    headers: {
+        Authorization: `Basic ${encodedCredentials}`
+    }
+    // ...
+})

configuration/config-resolve-snapshot-path.js

@@ -0,0 +1,5 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    resolveSnapshotPath: (testPath, snapExtension) => testPath + snapExtension,
+})

custom-reporter/config-npm.js

@@ -0,0 +1,7 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    reporter: ['custom'],
+    // ...
+})

custom-reporter/config.js

@@ -0,0 +1,21 @@
+import { defineConfig } from '@wdio/config'
+import CustomReporter from './reporter/my.custom.reporter'
+
+export const config = defineConfig({
+    // ...
+    reporters: [
+        /**
+         * use imported reporter class
+         */
+        [CustomReporter, {
+            someOption: 'foobar'
+        }],
+        /**
+         * use absolute path to reporter
+         */
+        ['/path/to/reporter.js', {
+            someOption: 'foobar'
+        }]
+    ],
+    // ...
+})

custom-service/config-npm.js

@@ -0,0 +1,7 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    services: ['custom'],
+    // ...
+})

custom-service/config.js

@@ -0,0 +1,21 @@
+import { defineConfig } from '@wdio/config'
+import CustomService from './service/my.custom.service'
+
+export const config = defineConfig({
+    // ...
+    services: [
+        /**
+         * use imported service class
+         */
+        [CustomService, {
+            someOption: true
+        }],
+        /**
+         * use absolute path to service
+         */
+        ['/path/to/service.js', {
+            someOption: true
+        }]
+    ],
+    // ...
+})

debugging/config-dynamic.js

@@ -0,0 +1,17 @@
+import { defineConfig } from '@wdio/config'
+
+const debug = process.env.DEBUG
+const defaultCapabilities = ...
+const defaultTimeoutInterval = ...
+const defaultSpecs = ...
+
+export const config = defineConfig({
+    // ...
+    maxInstances: debug ? 1 : 100,
+    capabilities: debug ? [{ browserName: 'chrome' }] : defaultCapabilities,
+    execArgv: debug ? ['--inspect'] : [],
+    jasmineOpts: {
+      defaultTimeoutInterval: debug ? (24 * 60 * 60 * 1000) : defaultTimeoutInterval
+    }
+    // ...
+})

debugging/config.js

@@ -0,0 +1,13 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    maxInstances: 1,
+    specs: [
+        '**/myspec.spec.js'
+    ],
+    capabilities: [{
+        browserName: 'firefox'
+    }],
+    // ...
+})

docker/config.js

@@ -0,0 +1,19 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    capabilities: [{
+        maxInstances: 1,
+        browserName: 'chrome',
+        'goog:chromeOptions': {
+            args: [
+                '--no-sandbox',
+                '--disable-infobars',
+                '--headless',
+                '--disable-gpu',
+                '--window-size=1440,735'
+            ],
+        }
+    }],
+    // ...
+})

electron/config.js

@@ -0,0 +1,9 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    // ...
+    services: [['electron', {
+        appEntryPoint: './path/to/bundled/electron/main.bundle.js',
+        appArgs: [/** ... */],
+    }]]
+})

frameworks/publish-report.js

@@ -0,0 +1,17 @@
+import { v4 as uuidv4 } from 'uuid'
+import { defineConfig } from '@wdio/config'
+import { publishCucumberReport } from '@wdio/cucumber-framework';
+
+export const config = defineConfig({
+    // ... Other Configuration Options
+    cucumberOpts: {
+        // ... Cucumber Options Configuration
+        format: [
+            ['message', `./reports/${uuidv4()}.ndjson`],
+            ['json', './reports/test-report.json']
+        ]
+    },
+    async onComplete() {
+        await publishCucumberReport('./reports');
+    }
+})

getting-started/ocr.js

@@ -0,0 +1,16 @@
+import { defineConfig } from '@wdio/config'
+
+export const config = defineConfig({
+    //...
+    services: [
+        // your other services
+        [
+            "ocr",
+            {
+                contrast: 0.25,
+                imagesFolder: ".tmp/",
+                language: "eng",
+            },
+        ],
+    ],
+});

getting-started/run-in-script.js

@@ -1,14 +1,16 @@
 import fs from 'node:fs'
 import { remote } from 'webdriverio'
+import { defineConfig } from '@wdio/config'
 
-const browser = await remote({
+const config = defineConfig({
     capabilities: {
         browserName: 'chrome',
         'goog:chromeOptions': {
             args: process.env.CI ? ['headless', 'disable-gpu', 'window-size=1200,800'] : []
         }
     }
 })
+const browser = await remote(config)
 
 await browser.url('https://webdriver.io')
 const apiLink = await browser.$('=API')