How can I run test files in order in Cypress

When using Cypress for end-to-end testing, you might sometimes need to run test files in a specific sequence. By default, Cypress executes test files in alphabetical order based on their filenames. This means that if you want to control the execution order of test files, you can achieve it through naming conventions.

Solutions

1. Naming Conventions

The simplest approach is to rename test files to control execution order. For example, you can add a numeric prefix to filenames to ensure they run in a specific sequence:

• 1-login.spec.js
• 2-dashboard.spec.js
• 3-settings.spec.js

This way, Cypress will execute 1-login.spec.js first, followed by 2-dashboard.spec.js, and finally 3-settings.spec.js.

2. Using Cypress Plugins

Beyond renaming, plugins can help manage test execution order. For instance, the cypress-ordered-tests plugin allows you to define order within test files rather than relying on filenames.

To implement this plugin, first install it:

bash
npm install --save-dev cypress-ordered-tests

Then, in your test files, use the order function to specify execution order:

javascript
// in cypress/integration/ordered-tests.spec.js
const { order } = require('cypress-ordered-tests');

describe('Ordered tests', () => {
  order(1).it('logs in', () => {
    // log in test
  });

  order(2).it('accesses the dashboard', () => {
    // dashboard test
  });

  order(3).it('changes settings', () => {
    // settings test
  });
});

3. Using Cypress Configuration

You can also specify the order of specific test files using the testFiles option in the cypress.json configuration file:

json
{
  "testFiles": ["1-login.spec.js", "2-dashboard.spec.js", "3-settings.spec.js"]
}

Conclusion

Although Cypress defaults to alphabetical execution based on filenames, you can effectively control test file order through naming conventions, plugins, or configuration files to meet specific testing needs. This is particularly useful when executing tests in a defined sequence, such as during user registration, login, and subsequent page navigation.