如何扩展Nightwatch内部Logger以对接Cucumber-js的attach功能？

当然可以扩展Nightwatch的Logger类，而且有几种靠谱的方案能帮你把Nightwatch的日志附加到Cucumber-js的报告里。下面我给你详细拆解可行的实现思路和步骤：

方案一：自定义Logger类替换默认实现 #

这是最直接的方式——继承Nightwatch原生的Logger类，重写日志输出方法，在保留原有日志行为的同时，把消息转发给Cucumber的attach函数。

步骤1：创建自定义Logger类 #

新建一个customLogger.js文件，内容如下：

const { Logger } = require('nightwatch/lib/core/logger');

class CustomLogger extends Logger {
  constructor(options) {
    super(options);
    // 用来存储Cucumber的attach函数引用
    this.cucumberAttach = null;
  }

  // 重写所有日志级别方法，确保捕获所有类型的日志
  log(message, ...args) {
    super.log(message, ...args);
    this.sendToCucumber(message);
  }

  info(message, ...args) {
    super.info(message, ...args);
    this.sendToCucumber(`INFO: ${message}`);
  }

  warn(message, ...args) {
    super.warn(message, ...args);
    this.sendToCucumber(`WARN: ${message}`);
  }

  error(message, ...args) {
    super.error(message, ...args);
    this.sendToCucumber(`ERROR: ${message}`);
  }

  // 把日志消息传给Cucumber的attach函数
  sendToCucumber(message) {
    if (this.cucumberAttach) {
      // 指定日志类型为纯文本，适配Cucumber报告格式
      this.cucumberAttach(message, 'text/plain');
    }
  }

  // 提供方法让外部设置Cucumber的attach函数
  setCucumberAttach(attach) {
    this.cucumberAttach = attach;
  }
}

module.exports = CustomLogger;

步骤2：在Nightwatch配置中启用自定义Logger #

修改你的nightwatch.conf.js，指定使用上面创建的自定义Logger：

module.exports = {
  // 其他配置项（比如测试环境、浏览器设置等）...
  logger: {
    className: require('./customLogger'),
    options: {
      level: 'info' // 保持和原有日志级别一致，可根据需要调整
    }
  }
};

步骤3：关联Cucumber的attach函数到自定义Logger #

在Cucumber的World构造函数里，把attach函数传递给自定义Logger。新建或修改hooks.js文件：

const { setWorldConstructor } = require('@cucumber/cucumber');
const nightwatch = require('nightwatch');

class CustomWorld {
  constructor({ attach }) {
    this.attach = attach;
    // 获取Nightwatch的自定义Logger实例，绑定attach函数
    const logger = nightwatch.client.logger;
    logger.setCucumberAttach(attach);
  }
}

setWorldConstructor(CustomWorld);

方案二：利用自定义Nightwatch Reporter捕获日志 #

如果你不想直接修改Logger，也可以通过自定义Nightwatch Reporter来捕获测试过程中的日志事件，再转发给Cucumber。

步骤1：创建自定义Reporter #

新建cucumberReporter.js：

class CucumberReporter {
  constructor(options) {
    this.options = options;
    this.cucumberAttach = null;
  }

  // 设置Cucumber的attach函数
  setCucumberAttach(attach) {
    this.cucumberAttach = attach;
  }

  // 监听Nightwatch的日志事件
  onLog(message) {
    if (this.cucumberAttach) {
      this.cucumberAttach(message, 'text/plain');
    }
  }

  // 可选：还可以监听其他测试事件，比如测试通过/失败，附加更多信息到报告
  onTestPass(test) {
    this.cucumberAttach(`✅ 测试通过: ${test.name}`, 'text/plain');
  }

  onTestFail(test) {
    this.cucumberAttach(`❌ 测试失败: ${test.name}，错误信息: ${test.error.message}`, 'text/plain');
  }
}

module.exports = CucumberReporter;

步骤2：在Nightwatch配置中注册Reporter #

修改nightwatch.conf.js：

module.exports = {
  // 其他配置项...
  reporters: [
    {
      name: 'cucumber-integration',
      className: require('./cucumberReporter'),
      options: {}
    }
  ]
};

步骤3：关联Cucumber的attach函数 #

同样在Cucumber的World构造函数里绑定attach函数：

const { setWorldConstructor } = require('@cucumber/cucumber');
const nightwatch = require('nightwatch');

class CustomWorld {
  constructor({ attach }) {
    this.attach = attach;
    // 找到自定义Reporter实例并绑定attach
    const reporter = nightwatch.client.reporters.find(r => r.name === 'cucumber-integration');
    reporter.setCucumberAttach(attach);
  }
}

setWorldConstructor(CustomWorld);

注意事项 #

• 确保你的Nightwatch版本是2.x及以上，这两个方案都依赖Nightwatch 2.x的自定义Logger和Reporter API。
• 如果在Cucumber的World初始化时，Nightwatch客户端还未完全创建，可以把绑定逻辑放到Cucumber的Before钩子中，确保客户端已就绪。
• 可以根据需求调整日志格式，比如添加时间戳、日志级别标识等，让Cucumber报告更清晰。

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