vite-plugin-nightwatch

Component testing plugin that integrates Vite with Nightwatch.js. Supports Vue and React components.

npm install vite-plugin-nightwatch

Usage:

Update your Vite configuration:

1import nightwatchPlugin from 'vite-plugin-nightwatch'
2
3export default {
4  plugins: [
5    // ... other plugins, such as vue() or react()
6    nightwatchPlugin()
7  ]
8}

Nightwatch assumes the Vite dev server is already running and will be using http://localhost:3000 as base url. You can change that in your nightwatch.conf.js by setting either launchUrl or baseUrl properties.

To start the Vite dev server, in your project run:

1npm run dev

Configuration:

The plugin accepts a few config options:

- componentType:

Specify the type of component to be tested. Possible values:

• vue (default, if none specified)
• react

1export default {
2  plugins: [
3    // ... other plugins, such as vue() or react()
4    nightwatchPlugin({
5      componentType: 'vue'
6    })
7  ]
8}

- renderPage:

Specify the path to a custom test renderer to be used. Default renderers are included in the package for both Vue and React components, but this option can overwrite that value.

1export default {
2  plugins: [
3    // ... other plugins, such as vue() or react()
4    nightwatchPlugin({
5      renderPage: './src/test_renderer.html'
6    })
7  ]
8}

API Commands

This plugin includes a few Nightwatch commands which can be used while writing tests.

- browser.mountVueComponent(componentPath ,[options], [callback]):

Parameters:

• componentPath – location of the component file (.vue) to be mounted
• options – this can include:
  • props - properties to be passed to the Vue component, this will be serialized to JSON
  • plugins: if needed, a store (VueX or Pinia) and a router can be loaded together with the component
  • mocks: this can be a list of url calls that can be mocked (will be passed to sinon automatically); at the moment only Fetch API calls can be mocked, but XHR support will be added soon.
• callback – an optional callback function which will be called with the component element

Example:

1const component = await browser.mountVueComponent('/src/components/Form.vue', {
2  plugins: {
3    store: '/src/lib/store.js',
4    router: '/src/lib/router.js'
5  },
6
7  mocks: {
8    '/api/get-user': {
9      type: 'fetch',
10      body: {
11        data: {
12          "firstName": "Jimmy",
13          "lastName": "Hendrix"
14        }
15      }
16    }
17  }
18})

- browser.mountReactComponent(componentPath, [props], [callback]):

Parameters:

• componentPath – location of the component file (.jsx) to be mounted
• props – properties to be passed to the React component, this will be serialized to JSON
• callback – an optional callback function which will be called with the component element

Example:

1const component = await browser.mountReactComponent('/src/components/Form.jsx')

- browser.launchComponentRenderer():

This will call browser.navigateTo('/nightwatch/') and open the browser. Needs to be used before the .importScript() command, if used.

You can also set launchUrl as a global at runtime and then the url to be used will be ${browser.globals.launchUrl}/nightwatch, which makes it possible to set the launch url dynamically.

- browser.importScript(scriptPath, [options], [callback]):

Parameters:

• scriptPath – location of the script file to inject into the page which will render the component; needs to be written in ESM format
• options – this can include:
  • scriptType: the type attribute to be set on the <script> tag (default is module)
  • componentType: either vue or react (default is vue)
• callback – an optional callback function which will be called with the component element

Example:

1const formComponent = await browser
2  .launchComponentRenderer()
3  .importScript('/test/lib/scriptToImport.js');

Example scriptToImport.js:

1import {mount} from '/node_modules/@vue/test-utils/dist/vue-test-utils.esm-browser.js'
2import Component from '/test/components/vue/Form.vue'
3
4let element = mount(Component, {
5 attachTo: document.getElementById('app'),
6 global: {
7   plugins: []
8 }
9});
10
11// This will be used by Nightwatch to inspect properties of this component
12window['@@component_element'] = element;

Debugging Component Tests

Debugging component tests in Nightwatch isn't as straightforward as debugging a regular Node.js application or service, since Nightwatch needs to inject the code to render to component into the browser.

However, for when running the tests in Chrome, you can use the DevTools to do debugging directly in the browser. For this purpose, Nightwatch provide 2 CLI flags:

• --devtools - when this is on, the Chrome DevTools will open automatically
• --debug - this will cause the test execution to pause right after the component is rendered

Running the Vite dev-server programmatically from Nightwatch

It is also possible to start the Vite dev server from the Nightwatch global before hook and close it in the after hook.

We are doing that as part of the tests for this plugin. Here's how your external globals.js file should look like:

globals.js

1const path = require('path');
2const vite = require('./vite.js');
3
4const startViteForVue = function() {
5  return vite.start({
6    configFile: path.join(__dirname, 'vite.config-vue.js')
7  });
8}
9
10const startViteForReact = function() {
11  return vite.start({
12    configFile: path.join(__dirname, 'vite.config-react.js')
13  });
14}
15
16let viteServer;
17module.exports = {
18  async before() {
19    switch (this.componentType) {
20      case 'react':
21        viteServer = await startViteForReact();
22        break;
23      case 'vue':
24        viteServer = await startViteForVue();
25        break;
26    }
27
28    const port = viteServer.config.server.port;
29
30    // set the launch url dynamically
31    this.launchUrl = `http://localhost:${port}`;
32  },
33
34  async after() {
35    await viteServer.close();
36  }
37}

Also inspect the included nightwatch.conf.js and the vite dev server start up script.

Run tests:

Tests for this project are written in Nightwatch so you can inspect them as examples, located in the [tests/specs] folder.

To run the Vue component tests:

1npm test

To run the React component tests:

1npm run test-react

License

MIT