DEV Community: Ivan

Run Cypress autotests in parallel for Allure report

Ivan — Sun, 30 Nov 2025 10:15:04 +0000

Hello everyone! I want to show you how to run Cypress autotests in parallel if you use Allure reports for your project.

Content

Cypress installation
Allure reports installation
Add parallel running for Cypress autotests
Difference between multiple threads and one thread

Cypress installation

Install Cypress: npm install cypress
Open Cypress: npx cypress open
Set up Cypress and add started pack with autotests (or use your own autotests)
Close Cypress

Allure reports installation

Install Allure reports for Cypress: npm install --save-dev allure-cypress
Add settings for Allure reports to cypress.config.js

const { defineConfig } = require("cypress");

import { allureCypress } from "allure-cypress/reporter";

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      allureCypress(on, config, {
        resultsDir: "allure-results",
      });
      return config;
    },
  },
});

Add import to e2e.js file:

import "./commands";
import "allure-cypress";

Add parallel running for Cypress autotests

Install concurrently package for running commands in parallel: npm i concurrently
Create a file which allows running Cypress autotests in parallel (1 thread = 1 Cypress run). It doesn't help you, if you want to run parallel specs in the same Cypress run.

const fs = require("fs");
const { exec } = require("child_process");
const os = require("os");

/**
 * Get all arguments with values from command line in 1 object
 * @returns command line arguments in object
 */
function getCommandLineArgs() {
  const args = {};
  let currentArgument;
  process.argv.forEach((argument) => {
    if (args.additional) {
      args.additional.push(argument);
    } else if (currentArgument) {
      args[currentArgument] = argument;
    }

    switch (argument) {
      // Directory with your autotests
      case "-d":
      case "-directory":
        currentArgument = "d";
        break;
      // Number of threads (depends on your processor)
      case "-t":
      case "-threads":
        currentArgument = "t";
        break;
      // Extension for Cypress spec files
      case "-ext":
        currentArgument = "ext";
        break;
      // Additional parameters for Cypress autotests
      case "--":
        currentArgument = "additional";
        args.additional = [];
        break;
      default:
        currentArgument = undefined;
    }
  });
  return args;
}

/**
 * Get all Cypress spec files
 * @param {string} directory directory where your cypress autotests are located
 * @param {string} ext extension for cypress autotests
 * @returns all Cypress spec files in array
 */
function getFiles(directory, ext = "cy.js") {
  try {
    const files = fs.readdirSync(`${directory}`, { recursive: true });
    const directoryPathForFiles =
      os.platform === "win32" ? directory.replace("/", "\\") : directory;
    const separator = os.platform() === "win32" ? "\\" : "/";
    const cypressFiles = files
      .filter((f) => ~f.indexOf(ext))
      .map((f) => `.${separator}${directoryPathForFiles}${separator}${f}`);
    return cypressFiles;
  } catch (err) {
    console.error(err);
  }
}

/**
 * Divide files to chunks and return as array of arrays
 * @param {string[]} files array with Cypress spec files
 * @param {number} numOfThreads number of threads (depends on your processor)
 * @returns array of arrays with Cypress spec files
 */
function getChunks(files, numOfThreads) {
  const result = [];
  const chunkSize = Math.ceil(files.length / numOfThreads);
  for (let i = 0; i < files.length; i += chunkSize) {
    result.push(files.slice(i, i + chunkSize));
  }
  return result;
}

function main() {
  const args = getCommandLineArgs();
  const files = getFiles(args.d, args.ext);
  const numOfThreads = args.t;
  const chunks = getChunks(files, numOfThreads);
  const commands = [];
  chunks.forEach((chunk) => {
    commands.push(
      `"npx cypress run --spec ${chunk.join(",")} ${
        args.additional ? args.additional.join(" ") : ""
      }"`
    );
  });
  const concurrentlyCommand = `npx concurrently ${commands.join(" ")}`;
  exec(concurrentlyCommand, (error, stdout, stderr) => {
    console.log(`stdout: ${stdout}`);
    console.log(`stderr: ${stderr}`);
    if (error !== null) {
      console.log(`exec error: ${error}`);
    }
  });
}

main();

Add scripts for different runs to package.json:

{
  // ...
  "scripts": {
    "one-thread-run": "npx cypress run --browser chrome",
    "multi-threads-run": "node cypress-parallel.js -t 4 -d cypress/e2e -ext cy.js -- --browser chrome"
  }
  // ...
}

one-thread-run allows to run all autotests as usual (in 1 thread)
multi-threads-run allows to run all autotests using multiple threads (in this example - 4)

Run scripts: npm run one-thread-run or npm run multi-threads-run

Difference between multiple threads and one thread

You should have allure before running allure generate command.

When we run all Cypress autotests in 1 thread, it spends ~1 minute 46 seconds and creates allure results. For creating allure report you can use allure generate allure-results-1 command. Result: allure-report:

When we run all Cypress autotests in multiple threads, it spends ~39 seconds and creates allure results. For creating allure report you can use allure generate allure-results command. Result: allure-report

You spend approximately 2 times less time, but get the same report.

Full code you can find in this github repo.

Thanks for reading this article! I hope it helps you to run your Cypress autotests in parallel with Allure reports. If something went wrong, let me know here, or you can create an issue in github repo, and I will try to help you.

How to run autotests for several environments and apps separate in one cypress project. Cypress project monorepo

Ivan — Mon, 06 Nov 2023 09:48:59 +0000

Hello everyone! I want to show you how to run autotests for several environments separate in one cypress project.

If you have several environments or apps and you don't want to create several cypress projects, you can use this tutorial. It helps to create one project which can run autotests separately for each environment or app.

Result you can find in this github repo

Content

Install Cypress project
Set up config file for using multiple environments and apps
Run autotests for multiple environments and apps
Conclusion

Install Cypress project

Move to the next section if you have installed Cypress project with autotests

1.Install cypress package and dotenv package (for working with .env file) in your project:

npm install cypress
npm install dotenv

2.If you use Github, create .gitignore file:

node_modules
cypress/videos
cypress/screenshots
cypress/downloads
.DS_Store

3.If you use Cypress for the first time, use the next steps. If you used Cypress before, go to step 4.

3.1.Open Cypress:

npx cypress open

3.2.Click on the Continue button in opened window:

3.3.Click on the E2E testing (if you use this type of testing):

3.4.Click on the Continue button for creating necessary files:

3.5.Close window and check that files are created:

3.6.Create files with tests cypress/e2e/tests. If you don't have tests, you can use these examples:

cypress/e2e/tests/bing/bing_test.spec.js:

describe('Test for Bing', () => {
  it('Test login/password data for different environments', () => {
    cy.visit('/');
    cy.get("input[type='search']").type(`${Cypress.env('login')} + ${Cypress.env('password')}`);
  });
});

cypress/e2e/tests/google/google_test.spec.js:

describe('Test for Google', () => {
  it('Test login/password data for different environments', () => {
    cy.visit('/');
    cy.get('textarea[type="search"]').type(`${Cypress.env('login')} + ${Cypress.env('password')}`);
  });
});

Result after creating autotests:

Set up config file for using multiple environments and apps

1.Change your cypress.config.js file with this code:

const { defineConfig } = require("cypress");

require("dotenv").config(); // line for working with .env file

module.exports = defineConfig({
  e2e: {
    setupNodeEvents(on, config) {
      // -----config part-------
      // dynamic path to settings
      const settings = require(`./settings/${config.env.envName.toLowerCase()}.settings.json`);

      // add base.Url from file to current config
      if (settings.baseUrl) {
        config.baseUrl = settings.baseUrl;
      }

      // add pattern for autotests from file to current config
      if (settings.specPattern) {
        config.specPattern = settings.specPattern;
      }

      // add all settings from file to current config
      if (settings.env) {
        config.env = {
          ...config.env,
          ...settings.env,
        };

        // add login and password variables from file to current config
        // you can add what ever you want with the same way to current cypress config
        config.env.login = process.env[`${settings.env.login}`];
        config.env.password = process.env[`${settings.env.password}`];
      }
      // -----config part-------

      return config;
    },
  },
});

2.Create settings folder in your project:

3.Add settings for several environments or apps in settings folder with this template: fileName.settings.json or you can use your own template, but change this line in cypress.config.js file:

const settings = require(`./settings/${config.env.envName.toLowerCase()}.settings.json`);

Let's create these files for our example:

local.settings.json:

{
  "baseUrl": "https://www.google.com/",
  "specPattern": "cypress/e2e/tests/google/**/*.spec.{js, jsx, ts, tsx}",
  "env": {
    "login": "GOOGLE_LOCAL_LOGIN",
    "password": "GOOGLE_LOCAL_PASSWORD"
  }
}

newApp.settings.json:

{
  "baseUrl": "https://www.bing.com/",
  "specPattern": "cypress/e2e/tests/bing/**/*.spec.{js, jsx, ts, tsx}",
  "env": {
    "login": "BING_LOGIN",
    "password": "BING_PASSWORD"
  }
}

prod.settings.json:

{
  "baseUrl": "https://www.google.com/",
  "specPattern": "cypress/e2e/tests/google/**/*.spec.{js, jsx, ts, tsx}",
  "env": {
    "login": "GOOGLE_PROD_LOGIN",
    "password": "GOOGLE_PROD_PASSWORD"
  }
}

We created 3 files for different environments and apps. The first environment is local, the next - another app newApp and the last is another environment prod. They have different baseUrl, specPattern and data for our autotests.

Result:

Also, we should create .env file with actual data, because we use login and password, and it's private data. Our cypress.config.js file use these lines for getting data from .env file:

config.env.login = process.env[`${settings.env.login}`];
config.env.password = process.env[`${settings.env.password}`];

Let's create .env file:

GOOGLE_LOCAL_LOGIN=google_local_login
GOOGLE_LOCAL_PASSWORD=google_local_password
GOOGLE_PROD_LOGIN=google_prod_login
GOOGLE_PROD_PASSWORD=google_prod_password
BING_LOGIN=bing_login
BING_PASSWORD=bing_password

Result:

4.We set up our project for using different environments and apps, let's start to run our autotests.

Run autotests for multiple environments and apps

For our example we have these environments and apps:

local
newApp
prod

The same names we have for our settings. How to run it? It's simple. Use this template in command line:

npx cypress run --env envName=nameForYourEnvronment

Run for local environment:

npx cypress run --env envName=local

Run for newApp app:

npx cypress run --env envName=newApp

Run for prod environment:

npx cypress run --env envName=prod

Conclusion

If you completed all steps, you can use your Cypress project with different environments and apps. Let's repeat steps:

Create settings folder with your settings files, e.g. local.settings.json
Update your cypress.config.js file and add necessary part of code
Add private information into your .env file
Use this command for using your environments and apps separately: npx cypress run -- --env envName=nameForYourEnvronment. You can use all cypress terminal commands with it, e.g. npx cypress open -- --env envName=nameForYourEnvronment (open all autotests in UI mode with settings from settings folder) and others

Full code you can find in this github repo

Thanks for reading this article! I hope it helps you to create a monorepo for your Cypress project. If you have any questions, or you get some errors, ping me in comments section.