配置文件
配置文件包含运行测试套件所需的所有必要信息。它是一个导出JSON的NodeJS模块。
这里是一个包含所有支持属性和附加信息的示例配置：
export const config = {
// ==================================
// 测试应该在哪里启动
// ==================================
//
runner: 'local',
//
// =====================
// 服务器配置
// =====================
// 运行Selenium服务器的主机地址。这些信息通常是过时的，因为
// WebdriverIO自动连接到localhost。此外，如果您使用的是
// 支持的云服务，如Sauce Labs、Browserstack、Testing Bot或LambdaTest，您也不需要
// 定义主机和端口信息（因为WebdriverIO可以从您的用户和密钥信息中
// 找出这些信息）。然而，如果您使用的是私有的Selenium
// 后端，您应该在这里定义`hostname`、`port`和`path`。
//
hostname: 'localhost',
port: 4444,
path: '/',
// 协议: http | https
// protocol: 'http',
//
// =================
// 服务提供商
// =================
// WebdriverIO支持Sauce Labs、Browserstack、Testing Bot和LambdaTest。（其他云提供商
// 也应该可以工作。）这些服务定义了特定的`user`和`key`（或访问密钥）
// 值，您必须在这里填写，以便连接到这些服务。
//
user: 'webdriverio',
key: 'xxxxxxxxxxxxxxxx-xxxxxx-xxxxx-xxxxxxxxx',
// 如果您在Sauce Labs上运行测试，您可以通过`region`属性指定要在哪个区域运行测试
// 可用的区域简写有`us`（默认）和`eu`。
// 这些区域用于Sauce Labs VM云和Sauce Labs真实设备云。
// 如果您不提供区域，它默认为`us`。
region: 'us',
//
// Sauce Labs提供了[无头测试](https://saucelabs.com/products/web-testing/sauce-headless-testing)
// 允许您无头运行Chrome和Firefox测试。
//
headless: false,
//
// ==================
// 指定测试文件
// ==================
// 定义应该运行哪些测试规范。模式相对于正在运行的配置文件的目录。
//
// 规范被定义为一个规范文件数组（可选使用通配符
// 将被展开）。每个规范文件的测试将在单独的
// 工作进程中运行。为了让一组规范文件在同一个工作
// 进程中运行，将它们包含在规范数组内的一个数组中。
//
// 规范文件的路径将相对于配置文件的目录解析，
// 除非它是绝对路径。
//
specs: [
'test/spec/**',
['group/spec/**']
],
// 要排除的模式。
exclude: [
'test/spec/multibrowser/**',
'test/spec/mobile/**'
],
//
// ============
// 能力
// ============
// 在这里定义您的能力。WebdriverIO可以同时运行多个能力。
// 根据能力的数量，WebdriverIO启动多个测试
// 会话。在您的`capabilities`中，您可以覆盖`spec`和`exclude`
// 选项，以便将特定的规范分组到特定的能力。
//
// 首先，您可以定义应该同时启动多少个实例。假设
// 您有3种不同的能力（Chrome、Firefox和Safari），并且您已经
// 将`maxInstances`设置为1。wdio将生成3个进程。
//
// 因此，如果您有10个规范文件，并且将`maxInstances`设置为10，所有规范文件
// 将同时测试，并将生成30个进程。
//
// 该属性处理来自同一测试的多少能力应该运行测试。
//
maxInstances: 10,
//
// 或者为具有特定能力的测试设置限制。
maxInstancesPerCapability: 10,
//
// 将WebdriverIO的全局变量（例如`browser`、`$`和`$$`）插入全局环境。
// 如果设置为`false`，您应该从`@wdio/globals`导入。注意：WebdriverIO不
// 处理测试框架特定全局变量的注入。
//
injectGlobals: true,
//
// 如果您在获取所有重要能力方面遇到困难，请查看
// Sauce Labs平台配置器 - 一个配置您能力的好工具：
// https://docs.saucelabs.com/basics/platform-configurator
//
capabilities: [{
browserName: 'chrome',
'goog:chromeOptions': {
// 要以无头模式运行chrome，需要以下标志
// （参见https://developers.google.com/web/updates/2017/04/headless-chrome）
// args: ['--headless', '--disable-gpu'],
}
//
// 忽略一些或所有默认标志的参数
// - 如果值为true：忽略所有DevTools的'默认标志'和Puppeteer的'默认参数'
// - 如果值是数组：DevTools过滤给定的默认参数
// 'wdio:devtoolsOptions': {
// ignoreDefaultArgs: true,
// ignoreDefaultArgs: ['--disable-sync', '--disable-extensions'],
// }
}, {
// maxInstances可以按能力被覆盖。所以如果您有一个内部Selenium
// 网格，只有5个firefox实例可用，您可以确保一次不会启动超过
// 5个实例。
'wdio:maxInstances': 5,
browserName: 'firefox',
'wdio:specs': [
'test/ffOnly/*'
],
'moz:firefoxOptions': {
// 激活Firefox无头模式的标志（有关moz:firefoxOptions的更多详情，请参见https://github.com/mozilla/geckodriver/blob/master/README.md#firefox-capabilities）
// args: ['-headless']
},
// 如果提供了outputDir，WebdriverIO可以捕获驱动程序会话日志
// 可以配置要排除哪些日志类型。
// excludeDriverLogs: ['*'], // 传递'*'以排除所有驱动程序会话日志
excludeDriverLogs: ['bugreport', 'server'],
//
// 忽略一些或所有Puppeteer默认参数的参数
// ignoreDefaultArgs: ['-foreground'], // 将值设置为true以忽略所有默认参数
}],
//
// 启动子进程时使用的额外节点参数列表
execArgv: [],
//
// ===================
// 测试配置
// ===================
// 在这里定义所有与WebdriverIO实例相关的选项
//
// 日志记录的详细级别：trace | debug | info | warn | error | silent
logLevel: 'info',
//
// 为每个记录器设置特定的日志级别
// 使用'silent'级别禁用记录器
logLevels: {
webdriver: 'info',
'@wdio/appium-service': 'info'
},
//
// 设置存储所有日志的目录
outputDir: __dirname,
//
// 如果您只想运行测试直到特定数量的测试失败，请使用
// bail（默认为0 - 不退出，运行所有测试）。
bail: 0,
//
// 设置基本URL以缩短`url()`命令调用。如果您的`url`参数以
// `/`开头，则会添加`baseUrl`，不包括`baseUrl`的路径部分。
//
// 如果您的`url`参数没有方案或`/`（如`some/path`），则直接
// 添加`baseUrl`。
baseUrl: 'http://localhost:8080',
//
// 所有waitForXXX命令的默认超时。
waitforTimeout: 1000,
//
// 使用`wdio`命令并带有`--watch`标志运行时添加要监视的文件（例如应用程序代码或页面对象）。
// 支持通配符。
filesToWatch: [
// 例如，如果我更改我的应用程序代码，则重新运行测试
// './app/**/*.js'
],
//
// 您想用来运行规范的框架。
// 支持以下框架：'mocha'、'jasmine'和'cucumber'
// 另见：https://webdriver.io/docs/frameworks.html
//
// 确保在运行任何测试之前，已安装特定框架的wdio适配器包。
framework: 'mocha',
//
// 当整个规范文件作为一个整体失败时，重试整个规范文件的次数
specFileRetries: 1,
// 规范文件重试尝试之间的延迟（秒）
specFileRetriesDelay: 0,
// 重试的规范文件是应立即重试还是推迟到队列末尾
specFileRetriesDeferred: false,
//
// 标准输出的测试报告器。
// 默认支持的唯一一个是'dot'
// 另见：https://webdriver.io/docs/dot-reporter.html，在左栏点击"Reporters"
reporters: [
'dot',
['allure', {
//
// 如果您使用"allure"报告器，您应该定义WebdriverIO应该保存所有allure报告的目录。
outputDir: './'
}]
],
//
// 传递给Mocha的选项。
// 在http://mochajs.org查看完整列表
mochaOpts: {
ui: 'bdd'
},
//
// 传递给Jasmine的选项。
// 另见：https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-jasmine-framework#jasmineopts-options
jasmineOpts: {
//
// Jasmine默认超时
defaultTimeoutInterval: 5000,
//
// Jasmine框架允许它拦截每个断言，以便根据结果记录应用程序
// 或网站的状态。例如，在每次断言失败时截取屏幕截图非常方便。
expectationResultHandler: function(passed, assertion) {
// 做些什么
},
//
// 使用Jasmine特定的grep功能
grep: null,
invertGrep: null
},
//
// 如果您使用Cucumber，您需要指定步骤定义的位置。
// 另见：https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-cucumber-framework#cucumberopts-options
cucumberOpts: {
require: [], // <string[]> (文件/目录) 在执行功能之前需要文件
backtrace: false, // <boolean> 显示错误的完整回溯
compiler: [], // <string[]> ("扩展名:模块") 在需要MODULE后需要具有给定EXTENSION的文件（可重复）
dryRun: false, // <boolean> 调用格式化程序而不执行步骤
failFast: false, // <boolean> 在第一次失败时中止运行
snippets: true, // <boolean> 为待处理步骤隐藏步骤定义片段
source: true, // <boolean> 隐藏源URI
strict: false, // <boolean> 如果有任何未定义或待处理的步骤，则失败
tagExpression: '', // <string> (表达式) 仅执行标签匹配表达式的功能或场景
timeout: 20000, // <number> 步骤定义的超时
ignoreUndefinedDefinitions: false, // <boolean> 启用此配置，将未定义的定义视为警告。
scenarioLevelReporter: false // 启用此功能，使webdriver.io表现得好像场景而不是步骤是测试。
},
// 指定自定义tsconfig路径 - WDIO使用`tsx`编译TypeScript文件
// 您的TSConfig会自动从当前工作目录检测
// 但您可以在此处指定自定义路径或通过设置TSX_TSCONFIG_PATH环境变量
// 参见`tsx`文档：https://tsx.is/dev-api/node-cli#custom-tsconfig-json-path
tsConfigPath: 'path/to/tsconfig.json',
//
// =====
// 钩子
// =====
// WebdriverIO提供了几个钩子，您可以用来干预测试过程，以增强
// 它并围绕它构建服务。您可以应用单个函数或
// 方法数组。如果其中一个返回承诺，WebdriverIO将等待该承诺
// 解决后再继续。
//
/**
* 在所有工作进程启动之前执行一次。
* @param {object} config wdio配置对象
* @param {Array.<Object>} capabilities 能力详情列表
*/
onPrepare: function (config, capabilities) {
},
/**
* 在工作进程生成之前执行，可用于初始化该工作进程的特定服务
* 并以异步方式修改运行时环境。
* @param {string} cid 能力id（例如0-0）
* @param {object} caps 包含将在工作进程中生成的会话能力的对象
* @param {object} specs 要在工作进程中运行的规范
* @param {object} args 一旦工作进程初始化，将与主配置合并的对象
* @param {object} execArgv 传递给工作进程的字符串参数列表
*/
onWorkerStart: function (cid, caps, specs, args, execArgv) {
},
/**
* 工作进程退出后执行。
* @param {string} cid 能力id（例如0-0）
* @param {number} exitCode 0 - 成功，1 - 失败
* @param {object} specs 要在工作进程中运行的规范
* @param {number} retries 使用的重试次数
*/
onWorkerEnd: function (cid, exitCode, specs, retries) {
},
/**
* 在初始化webdriver会话和测试框架之前执行。它允许您
* 根据能力或规范操作配置。
* @param {object} config wdio配置对象
* @param {Array.<Object>} capabilities 能力详情列表
* @param {Array.<String>} specs 要运行的规范文件路径列表
*/
beforeSession: function (config, capabilities, specs) {
},
/**
* 在测试执行开始之前执行。此时您可以访问所有全局
* 变量，如`browser`。这是定义自定义命令的完美位置。
* @param {Array.<Object>} capabilities 能力详情列表
* @param {Array.<String>} specs 要运行的规范文件路径列表
* @param {object} browser 创建的浏览器/设备会话实例
*/
before: function (capabilities, specs, browser) {
},
/**
* 在套件开始之前执行（仅在Mocha/Jasmine中）。
* @param {object} suite 套件详情
*/
beforeSuite: function (suite) {
},
/**
* 此钩子在套件内的每个钩子开始之前执行。
* （例如，在Mocha中，这在调用`before`、`beforeEach`、`after`、`afterEach`之前运行）。在Cucumber中，`context`是World对象。
*
*/
beforeHook: function (test, context, hookName) {
},
/**
* 在套件内的每个钩子结束后执行的钩子。
* （例如，在Mocha中，这在调用`before`、`beforeEach`、`after`、`afterEach`之后运行）。在Cucumber中，`context`是World对象。
*/
afterHook: function (test, context, { error, result, duration, passed, retries }, hookName) {
},
/**
* 在测试之前执行的函数（仅在Mocha/Jasmine中）
* @param {object} test 测试对象
* @param {object} context 测试执行的作用域对象
*/
beforeTest: function (test, context) {
},
/**
* 在执行WebdriverIO命令之前运行。
* @param {string} commandName 钩子命令名称
* @param {Array} args 命令将接收的参数
*/
beforeCommand: function (commandName, args) {
},
/**
* 在执行WebdriverIO命令后运行
* @param {string} commandName 钩子命令名称
* @param {Array} args 命令将接收的参数
* @param {number} result 0 - 命令成功，1 - 命令错误
* @param {object} error 错误对象，如果有的话
*/
afterCommand: function (commandName, args, result, error) {
},
/**
* 在测试后执行的函数（仅在Mocha/Jasmine中）
* @param {object} test 测试对象
* @param {object} context 测试执行的作用域对象
* @param {Error} result.error 测试失败时的错误对象，否则为`undefined`
* @param {*} result.result 测试函数的返回对象
* @param {number} result.duration 测试持续时间
* @param {boolean} result.passed 如果测试通过则为true，否则为false
* @param {object} result.retries 有关规范相关重试的信息，例如 `{ attempts: 0, limit: 0 }`
*/
afterTest: function (test, context, { error, result, duration, passed, retries }) {
},
/**
* 在套件结束后执行的钩子（仅在Mocha/Jasmine中）。
* @param {object} suite 套件详情
*/
afterSuite: function (suite) {
},
/**
* 在所有测试完成后执行。您仍然可以访问测试中的所有全局变量。
* @param {number} result 0 - 测试通过，1 - 测试失败
* @param {Array.<Object>} capabilities 能力详情列表
* @param {Array.<String>} specs 运行的规范文件路径列表
*/
after: function (result, capabilities, specs) {
},
/**
* 在终止webdriver会话后立即执行。
* @param {object} config wdio配置对象
* @param {Array.<Object>} capabilities 能力详情列表
* @param {Array.<String>} specs 运行的规范文件路径列表
*/
afterSession: function (config, capabilities, specs) {
},
/**
* 在所有工作进程关闭后执行，进程即将退出。
* 在`onComplete`钩子中抛出的错误将导致测试运行失败。
* @param {object} exitCode 0 - 成功，1 - 失败
* @param {object} config wdio配置对象
* @param {Array.<Object>} capabilities 能力详情列表
* @param {<Object>} results 包含测试结果的对象
*/
onComplete: function (exitCode, config, capabilities, results) {
},
/**
* 当刷新发生时执行。
* @param {string} oldSessionId 旧会话的会话ID
* @param {string} newSessionId 新会话的会话ID
*/
onReload: function(oldSessionId, newSessionId) {
},
/**
* Cucumber钩子
*
* 在Cucumber功能之前运行。
* @param {string} uri 功能文件的路径
* @param {GherkinDocument.IFeature} feature Cucumber功能对象
*/
beforeFeature: function (uri, feature) {
},
/**
*
* 在Cucumber场景之前运行。
* @param {ITestCaseHookParameter} world 包含关于pickle和测试步骤信息的world对象
* @param {object} context Cucumber World对象
*/
beforeScenario: function (world, context) {
},
/**
*
* 在Cucumber步骤之前运行。
* @param {Pickle.IPickleStep} step 步骤数据
* @param {IPickle} scenario 场景pickle
* @param {object} context Cucumber World对象
*/
beforeStep: function (step, scenario, context) {
},
/**
*
* 在Cucumber步骤之后运行。
* @param {Pickle.IPickleStep} step 步骤数据
* @param {IPickle} scenario 场景pickle
* @param {object} result 包含场景结果的结果对象
* @param {boolean} result.passed 如果场景通过则为true
* @param {string} result.error 如果场景失败则为错误堆栈
* @param {number} result.duration 场景持续时间（毫秒）
* @param {object} context Cucumber World对象
*/
afterStep: function (step, scenario, result, context) {
},
/**
*
* 在Cucumber场景之后运行。
* @param {ITestCaseHookParameter} world 包含关于pickle和测试步骤信息的world对象
* @param {object} result 包含场景结果的结果对象 `{passed: boolean, error: string, duration: number}`
* @param {boolean} result.passed 如果场景通过则为true
* @param {string} result.error 如果场景失败则为错误堆栈
* @param {number} result.duration 场景持续时间（毫秒）
* @param {object} context Cucumber World对象
*/
afterScenario: function (world, result, context) {
},
/**
*
* 在Cucumber功能之后运行。
* @param {string} uri 功能文件的路径
* @param {GherkinDocument.IFeature} feature Cucumber功能对象
*/
afterFeature: function (uri, feature) {
},
/**
* 在WebdriverIO断言库进行断言之前运行。
* @param commandName 命令名称
* @param args 命令将接收的参数
*/
beforeAssertion: function (params) {
},
/**
* 在WebdriverIO命令执行后运行
* @param commandName 命令名称
* @param args 命令将接收的参数
* @param result 命令的结果
* @param error 如果出错的错误
*/
afterAssertion: function (params) {
}
}
您还可以在示例文件夹中找到包含所有可能选项和变体的文件。
