Is there a way to integrate Nightmare with testing frameworks like Mocha or Jest?

Yes, you can integrate Nightmare, a high-level browser automation library, with testing frameworks like Mocha or Jest. Below, I'll provide examples of how you can set up Nightmare with both Mocha and Jest.

Integrating Nightmare with Mocha

Mocha is a feature-rich JavaScript test framework that runs on Node.js and in the browser, making asynchronous testing simple and fun. Here's how you can use Nightmare with Mocha:

Step 1: Install the necessary packages using npm:

npm install --save-dev mocha nightmare

Step 2: Create a test file with your Nightmare and Mocha code:

// test.js
const Nightmare = require('nightmare');
const chai = require('chai');
const expect = chai.expect;

describe('Test Suite', function () {
  this.timeout('10s'); // Set timeout if necessary

  let nightmare = null;
  beforeEach(() => {
    nightmare = new Nightmare();
  });

  describe('Some page test', () => {
    it('should find the title of the page', (done) => {
      nightmare
        .goto('https://example.com')
        .evaluate(() => document.title)
        .end()
        .then((title) => {
          expect(title).to.equal('Example Domain');
          done();
        })
        .catch(done);
    });
  });
});

Step 3: Run your tests using the Mocha command:

mocha test.js

Integrating Nightmare with Jest

Jest is a delightful JavaScript testing framework with a focus on simplicity. It works well with projects using Babel, TypeScript, Node.js, React, Angular, Vue.js, and more. To use Nightmare with Jest, follow these steps:

Step 1: Install the necessary packages using npm:

npm install --save-dev jest nightmare

Step 2: If you are using Jest version 27 or newer, you'll need to install jest-environment-node since the default environment was changed to a browser-like environment using jsdom.

npm install --save-dev jest-environment-node

Step 3: Configure Jest to use the Node environment. In your package.json, add the following Jest configuration:

"jest": {
  "testEnvironment": "node"
}

Or in a separate jest.config.js file:

module.exports = {
  testEnvironment: "node",
};

Step 4: Create a test file with your Nightmare and Jest code:

// test.js
const Nightmare = require('nightmare');

describe('Test Suite', () => {
  let nightmare = null;
  beforeEach(() => {
    nightmare = Nightmare({ show: false });
  });

  afterEach(async () => {
    await nightmare.end();
  });

  test('should find the title of the page', async () => {
    const title = await nightmare.goto('https://example.com').evaluate(() => document.title);
    expect(title).toBe('Example Domain');
  });
});

Step 5: Run your tests using the Jest command:

jest test.js

When integrating Nightmare with testing frameworks like Mocha or Jest, it's important to properly handle the asynchronous nature of browser automation. Both examples above demonstrate handling promises returned by Nightmare's API. For Jest, you can use async/await syntax for a cleaner and more modern approach, while for Mocha, you can use the done callback to handle asynchronous operations.