如何在WebdriverIO及wdio测试运行器中集成自定义事件/错误？

嘿，你问的这个问题很实用！完全可以把Node.js的EventEmitter和WebdriverIO（包括WDIO测试运行器）无缝集成，来定义和触发自定义事件或错误。我来一步步给你拆解实现方式：

1. 封装自定义事件管理器 #

首先，我们可以单独创建一个模块来封装EventEmitter的逻辑，这样更便于复用和维护。比如创建src/utils/customEventEmitter.js：

const { EventEmitter } = require('events');

class CustomTestEmitter extends EventEmitter {
  // 定义自定义事件类型（可选，只是为了统一管理）
  static EVENTS = {
    TEST_STARTED: 'test:started',
    TEST_WARNING: 'test:warning',
    TEST_CUSTOM_ERROR: 'test:customError'
  };

  // 触发测试开始事件
  emitTestStarted(testInfo) {
    this.emit(CustomTestEmitter.EVENTS.TEST_STARTED, testInfo);
  }

  // 触发自定义错误事件
  emitCustomError(errorDetails) {
    this.emit(CustomTestEmitter.EVENTS.TEST_CUSTOM_ERROR, new Error(errorDetails.message), errorDetails.context);
  }
}

// 导出单例，确保整个测试环境共用同一个实例
module.exports = new CustomTestEmitter();

2. 在WDIO配置中初始化并挂载 #

接下来，在你的wdio.conf.js里，通过WDIO的钩子（比如beforeSession）把这个事件管理器挂载到全局的browser对象上，这样所有测试用例都能访问：

const customEmitter = require('./src/utils/customEventEmitter');

exports.config = {
  // ... 其他配置项
  beforeSession: function (config, capabilities, specs) {
    // 把自定义事件管理器挂载到browser对象
    browser.customEmitter = customEmitter;
  },

  // 也可以在全局钩子中监听通用事件，比如所有测试开始时的处理
  beforeTest: function (test, context) {
    browser.customEmitter.emitTestStarted({
      testName: test.title,
      startTime: new Date().toISOString()
    });
  }
};

3. 在测试用例中监听和触发事件 #

现在你就可以在任意测试用例里监听自定义事件，或者主动触发事件了。比如在某个测试文件test/specs/eventHandling.spec.js中：

describe('自定义事件测试', () => {
  before(() => {
    // 监听自定义错误事件
    browser.customEmitter.on(browser.customEmitter.EVENTS.TEST_CUSTOM_ERROR, (error, context) => {
      console.error(`捕获到自定义错误: ${error.message}，上下文:`, context);
      // 这里可以添加自定义逻辑，比如上报到测试平台、截图等
      browser.takeScreenshot();
    });

    // 监听测试开始事件
    browser.customEmitter.on(browser.customEmitter.EVENTS.TEST_STARTED, (testInfo) => {
      console.log(`测试[${testInfo.testName}]已启动，时间: ${testInfo.startTime}`);
    });
  });

  it('触发自定义事件示例', async () => {
    await browser.url('http://webdriver.io/guide/usage/eventhandling.html');
    
    // 模拟某个条件不满足，触发自定义错误
    const pageTitle = await browser.getTitle();
    if (!pageTitle.includes('Event Handling')) {
      browser.customEmitter.emitCustomError({
        message: '页面标题不符合预期',
        context: {
          actualTitle: pageTitle,
          expectedTitle: 'Event Handling'
        }
      });
    }

    // 主动触发自定义事件
    browser.customEmitter.emit('custom:action', { action: '页面加载完成' });
  });
});

4. 结合WDIO的错误处理机制 #

如果你想把自定义错误和WDIO本身的测试失败流程结合，可以在触发自定义错误时抛出异常，或者在事件监听函数里调用expect.fail()来标记测试失败：

browser.customEmitter.on(browser.customEmitter.EVENTS.TEST_CUSTOM_ERROR, (error, context) => {
  console.error(`自定义错误: ${error.message}`);
  // 直接让测试失败
  expect.fail(`测试失败: ${error.message}，实际标题: ${context.actualTitle}`);
});

注意事项 #

• 记得在afterTest或afterSession钩子中移除事件监听，避免内存泄漏：

  afterTest: function(test, context, { error, result, duration, passed, retries }) {
    browser.customEmitter.removeAllListeners();
  }
  

• 如果使用WDIO的并行测试模式，要确保事件实例的隔离性，或者用更细粒度的事件监听逻辑。

这样一套下来，就能完美把Node.js的EventEmitter和WebdriverIO、WDIO测试运行器集成起来，实现你想要的自定义事件和错误处理啦！

内容的提问来源于stack exchange，提问作者Leo Li