测试全局变量

概述

Nightwatch 支持通过测试全局变量在测试套件和全局测试钩子定义之间进行数据持久化。在最简单的形式中，它是在您的配置文件中定义的名称-值对字典。

全局变量可以定义为配置文件中的 "globals" 属性，也可以定义为外部文件，该文件作为 "globals_path" 属性指定。

示例

以下是在 nightwatch.json 配置文件中使用 globals 属性的示例定义

nightwatch.json 
{
  "src_folders": [],

  "globals": {
    "myGlobalVar" : "some value",
    "otherGlobal" : "some other value"
  },

  "test_settings": {
    "default": {
      "launch_url": "https://nightwatch.node.org.cn",
    }
  }
}

globals 对象直接加载到 Nightwatch API 对象上，该对象传递给测试，并可通过 browser.globals 访问。

sampleTest.js 
describe('test globals example', function() {
  

  it('Demo test', function(browser) {
    console.log(browser.globals.myGlobalVar); // myGlobalVar == "some value"
  });
  

})

外部测试全局变量

测试全局变量也可以在外部文件中定义，该文件由配置文件中的 globals_path 设置指定，如下所示

nightwatch.json 
{
  "src_folders": [],
  "globals_path": "lib/globals.js",
  

  "test_settings": {
    "default": {
    "launch_url": "https://nightwatch.node.org.cn"
  }
}

外部全局文件还可以包含

  • 全局测试钩子
  • 自定义报告程序
  • 测试特定设置

预定义的全局变量

以下 globals 可用于控制测试运行器的行为，并使用以下提到的默认值定义。

您可以通过两种方式定义它们

  • 在您的外部全局文件中，由 globals_path 配置属性指定，例如 lib/globals.js
  • 直接在您的 nightwatch.conf.js 配置文件中
lib/globals.js 

module.exports = {
  // this controls whether to abort the test execution when an assertion failed and skip the rest
  // it's being used in waitFor commands and expect assertions
  abortOnAssertionFailure: true,

  // this will overwrite the default polling interval (currently 500ms) for waitFor commands
  // and expect assertions that use retry
  waitForConditionPollInterval: 500,

  // default timeout value in milliseconds for waitFor commands and implicit waitFor value for
  // expect assertions
  waitForConditionTimeout : 5000,

  // since 1.4.0 – this controls whether to abort the test execution when an element cannot be located; an error
  // is logged in all cases, but this also enables skipping the rest of the testcase;
  // it's being used in element commands such as .click() or .getText()
  abortOnElementLocateError: false,

  // this will cause waitFor commands on elements to throw an error if multiple
  // elements are found using the given locate strategy and selector
  throwOnMultipleElementsReturned: false,

  // By default a warning is printed if multiple elements are found using the given locate strategy
  // and selector; set this to true to suppress those warnings
  suppressWarningsOnMultipleElementsReturned: false,

  // controls the timeout value for async hooks. Expects the done() callback to be invoked within this time
  // or an error is thrown
  asyncHookTimeout : 10000,

  // controls the timeout value for when running async unit tests. Expects the done() callback to be invoked within this time
  // or an error is thrown
  unitTestsTimeout : 2000,

  // controls the timeout value for when executing the global async reporter. Expects the done() callback to be 
  // invoked within this time or an error is thrown
  customReporterCallbackTimeout: 20000,

  // Automatically retrying failed assertions - You can tell Nightwatch to automatically retry failed assertions 
  // until a given timeout is reached, before the test runner gives up and fails the test.
  retryAssertionTimeout: 5000,

  // use the same browser session to run the individual  test suites
  reuseBrowserSession: false,

  // Custom reporter
  reporter: function(results, done) {
    // do something with the results
    done(results);
  },

  // External before hook is ran at the beginning of the tests run, before creating the Selenium session
  before(done) {
    done();
  },

  // External after hook is ran at the very end of the tests run, after closing the Selenium session
  after(done) {
    done();
  },

  // This will be run before each test suite is started
  beforeEach(browser, done) {
    done();
  },

  // This will be run after each test suite is finished
  afterEach(browser, done) {
    done();
  },

  // Called right after the command .navigateTo() is finished
  async onBrowserNavigate(browser) {
    return Promise.resolve();
  },

  // Called right before the command .quit() is finished
  async onBrowserQuit(browser) {
    return Promise.resolve();
  }
}

环境特定的全局变量

与其他测试设置一样，globals 能够按测试环境覆盖。

请考虑以下配置

nightwatch.json 
{
  "src_folders": [],
  

  "test_settings": {
    "default": {
      "launch_url": "https://nightwatch.node.org.cn",
      

      "globals": {
        "myGlobalVar" : "some value",
        "otherGlobal" : "some other value"
      }
    },
    

    "integration": {
      "globals": {
        "myGlobalVar" : "integrated global"
      }
    }
  }
}

让我们使用一个非常基本的测试来试一试

sampleTest.js 
module.exports = {
  'Demo test' : function (browser) {
    console.log('myGlobalVar is: "', browser.globals.myGlobalVar, '"');
  }
};

将 --env integration 选项传递给运行器

npx nightwatch --env integration

然后，我们的全局变量对象将如下所示

myGlobalVar is: "integrated global"

推荐内容