使用Nightwatch编写ui自动化测试

介绍

Write End-to-End tests in Node.js quickly and effortlessly that run against a Selenium/WebDriver server.

安装Nightwatch

# 在当前项目中安装
npm i -D nightwatch

# 或者全局安装
npm i -g nightwatch

安装webDriver

Nightwatch有两种方式去调起浏览器跑测试

1. 通过Selenium，调各个浏览器的webDriver唤起浏览器。这个需要安装java、Selenium、webDriver
2. 直接通过各家浏览器的webDriver调起对应的浏览器。

我选择了第二种，这里就需要去安装的chrome的webDriver，有个npm包帮我们做了这个事

npm i -D chromedriver

安装的时候可能会遇到'网络问题'，在根目录下新建一个.npmrc文件,指定一下下载路径

chromedriver_cdnurl=https://npm.taobao.org/mirrors/chromedriver

配置文件nightwatch.json

Nightwatch启动的时候默认会去加载nightwatch.json配置文件，nightwatch.js也行，这里贴上我的配置文件，并对一些常用的字段做一下说明，其余看文档就行

{
  "src_folders": ["test/ui"],
  "output_folder": "reports",
  "custom_commands_path": "",
  "custom_assertions_path": "",
  "page_objects_path": "",
  "globals_path": "./webDriver.js",

  "selenium": {
    "start_process": false
  },

  "test_settings": {
    "default": {
      "selenium_port": 9515,
      "selenium_host": "localhost",
      "default_path_prefix": "",

      "desiredCapabilities": {
        "browserName": "chrome",
        "chromeOptions": {
          "args": [
            "--no-sandbox",
            "user-data-dir=/Users/shenshuaijia/Library/Application Support/Google/Chrome"
          ]
        },
        "acceptSslCerts": true
      },
      "globals": {
        "domain": "http://xxx.com"
      }
    }
  }
}

• src_folders: 指定测试用例的文件夹，里面所有的js文件测试的时候都会被执行
• output_folder： 指定产生报告存放的路径

• globals_path： 全局模块路径，nightwatch启动时还会去加载这个路径下的模块，比如我们刚刚下载了Chromedriver，我们需要写个模块文件，简单包装一下暴露出来被nightwatch加载。 这是我根目录下的webDriver.js文件，这样的话，nightwatch就能通过这个文件调webdriver然后启动浏览器了

  const chromedriver = require('chromedriver')
  
  module.exports = {
    before: function(done) {
      chromedriver.start()
      done()
    },
  
    after: function(done) {
      chromedriver.stop()
      done()
    }
  }

• selenium： selenium的配置，因为我选择了第二中安装方式，所以要禁用掉selenium
• test_settings：启动测试时的一些配置，每一个key对应一套配置，比如通过命令nightwatch --env default使用default那一套配置，也可以用nightwatch --env integration来运行integration那套配置，但需要事先在test_settings中有配置
• desiredCapabilities：这个是对Chromdriver能力配置，具体的话，就需要查看Chromdriver的文档

  这里我遇到了一个比较特殊的情况，我需要使用平时使用chrome留下的cookie，而不是完全的沙盒模式，所以，我这里需要启动chromedriver的时候，指定加载chrome用户数据的文件夹"user-data-dir=/Users/xxx/Library/Application Support/Google/Chrome"，这样所有的登录信息都能在测试的时候被使用。

• globals： 在测试的时候，也可以定义一下全局变量，方便测试的时候使用,这里我定义了一个domain，写测试的时候可以在browser.globals.domain获取

编写测试

在test/ui文件夹下新建一个测试文件page.test.js

module.exports = {
  'Demo test Google' : function (browser) {
    browser
      .url('http://www.google.com')
      .waitForElementVisible('body', 1000)
      .setValue('input[type=text]', 'nightwatch')
      .waitForElementVisible('button[name=btnG]', 1000)
      .click('button[name=btnG]')
      .pause(1000)
      .assert.containsText('#main', 'Night Watch')
      .end();
  }
}

nightwatch拥有比较优雅的测试写法。这里就是简单打开一个谷歌页面，往输入框输入nightwatch然后点击按钮。记住所有的测试完成后需要调end方法来退出浏览量。nightwatch也可以定义一些钩子函数

module.exports = {
  before : function(browser) {
    console.log('Setting up...');
  },

  after : function(browser) {
    console.log('Closing down...');
  },

  beforeEach : function(browser) {

  },

  afterEach : function() {

  },

  'step one' : function (browser) {
    browser
     // ...
  },

  'step two' : function (browser) {
    browser
    // ...
      .end();
  }
};

运行测试

nightwatch

这里我遇到了一个奇怪的问题，可能是由于我指定了用户目录的关系，我需要先完全退出chrome，在跑测试，不然跑测试新打开的窗口不会按代码里写的测试去走

总结

这里我只是简单介绍一下nightwatch，更加详细具体的使用还是需要参考官方文档。有了ui自动化测试以后，我们可以简单的做一些回归测试，比如，改了某些代码以后，把所有的页面都跑一遍，看看控制台有没有报错，比点点点方便多了

​