Nightwatch如何全局调用Setup与Teardown API技术问询

嘿，刚上手NightwatchJS对吧？我来帮你搞定全局的Setup和Teardown配置，正好对应你需要的测试前后调用API准备/清理数据的需求！

核心思路 #

Nightwatch的globals.js就是干这个的——它提供的before和after钩子，正好是所有测试套件执行前/后只跑一次的全局钩子，完全适合你说的创建测试许可证、用户，以及最后清理的场景。如果是每个测试用例前后要执行，才用beforeEach/afterEach，你现在的需求用全局的before/after就够了。

具体配置步骤 #

1. 找到/创建你的globals.js文件

这个文件一般放在项目根目录或者tests文件夹下，Nightwatch会自动加载它；如果找不到，你可以在nightwatch.conf.js里手动指定路径：

// nightwatch.conf.js
module.exports = {
  // 其他配置项...
  globals_path: './globals.js', // 这里写你的globals.js实际路径
};

2. 编写全局Setup与Teardown逻辑

在globals.js里，我们用异步函数来处理API调用（因为API请求是异步的，必须等它完成再继续测试）。下面是完整的示例代码，你可以根据自己的API接口调整：

// globals.js
module.exports = {
  // 全局前置操作：所有测试开始前执行一次
  async before(browser) {
    console.log('🚀 开始执行全局Setup，准备测试数据...');
    
    // 这里用node-fetch来调用API，你也可以用axios或者Nightwatch自带的request方法
    const fetch = require('node-fetch');
    try {
      // 调用你的Setup API，创建测试用户、许可证等
      const setupResponse = await fetch('https://your-test-api.com/test/setup', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
          // 如果API需要认证，在这里加你的测试环境token
          'Authorization': 'Bearer YOUR_TEST_API_AUTH_TOKEN'
        },
        body: JSON.stringify({
          // 传递Setup需要的参数，比如测试用户邮箱、许可证类型
          testUserEmail: 'nightwatch-test-user@example.com',
          licenseType: 'trial'
        })
      });

      // 检查API响应是否成功
      if (!setupResponse.ok) {
        throw new Error(`Setup API调用失败: ${setupResponse.statusText} (状态码: ${setupResponse.status})`);
      }

      // 把API返回的测试数据存在globals里，供后续测试用例调用
      const setupResult = await setupResponse.json();
      browser.globals.testUserId = setupResult.userId;
      browser.globals.testLicenseKey = setupResult.licenseKey;
      
      console.log('✅ 全局Setup完成，测试数据已准备好！');
    } catch (error) {
      console.error('❌ 全局Setup出错:', error.message);
      // 如果Setup失败，直接终止所有测试，避免无数据情况下跑测试
      throw error;
    }
  },

  // 全局后置操作：所有测试结束后执行一次
  async after(browser) {
    console.log('🧹 开始执行全局Teardown，清理测试数据...');
    
    const fetch = require('node-fetch');
    try {
      // 调用你的Teardown API，清理之前创建的用户、许可证
      const teardownResponse = await fetch('https://your-test-api.com/test/teardown', {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json',
          'Authorization': 'Bearer YOUR_TEST_API_AUTH_TOKEN'
        },
        body: JSON.stringify({
          // 传递需要清理的数据标识，比如之前存在globals里的用户ID
          userId: browser.globals.testUserId,
          licenseKey: browser.globals.testLicenseKey
        })
      });

      if (!teardownResponse.ok) {
        throw new Error(`Teardown API调用失败: ${teardownResponse.statusText} (状态码: ${teardownResponse.status})`);
      }

      console.log('✅ 全局Teardown完成，测试数据已清理！');
    } catch (error) {
      console.error('⚠️ 全局Teardown出错:', error.message);
      // 这里可以选择不抛出错误，因为测试已经执行完了，只是清理失败，不影响测试结果
    }
  }

  // 如果你需要每个测试用例前后执行操作，再打开下面的注释
  // async beforeEach(browser) {
  //   // 每个测试用例开始前执行的逻辑，比如重置页面状态
  // },
  // async afterEach(browser) {
  //   // 每个测试用例结束后执行的逻辑，比如清除cookie
  // }
};

一些关键注意点 #

• 依赖安装：如果用node-fetch，需要先安装它：npm install node-fetch --save-dev；如果想用axios，就装npm install axios --save-dev，然后替换代码里的fetch部分即可。
• 测试数据隔离：如果你的测试是并行执行的，全局Setup创建的共享数据可能会导致测试冲突，这时候可以改用beforeEach为每个用例创建独立的测试数据，用afterEach清理。
• 环境区分：一定要确保调用的是测试环境的API，绝对不要误操作生产数据！
• 数据复用：存在browser.globals里的测试数据，在后续测试用例里可以直接用，比如登录时用browser.globals.testUserId或者对应的邮箱。

这样配置后，每次你运行Nightwatch测试，都会自动先跑Setup准备数据，所有测试跑完后自动清理，完全符合你的需求啦～

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