Mocha Tests framework

Mocha test framework

SeaLights integrates with Mocha through the slnodejs mocha wrapper, which runs SeaLights as a Mocha reporter and reports test results to the server.

Remove any existing --reporter configuration from your Mocha setup — SeaLights runs as a reporter internally and conflicting reporters can break reporting. To keep other reporters, use the multiple reporters setup below.

Basic command

Everything after -- is passed straight to Mocha.

Bash

npx slnodejs mocha \
  --tokenFile ./sltoken.txt \
  --buildSessionIdFile buildSessionId \
  --testStage "Unit Tests" \
  --useSlNode2 \
  -- --recursive test

GitHub Actions

- name: Mocha tests with SeaLights
  env:
    SL_TOKEN: ${{ secrets.SL_TOKEN }}
  run: |
    npx slnodejs mocha \
      --token "$SL_TOKEN" \
      --buildSessionIdFile buildSessionId \
      --testStage "Unit Tests" \
      --useSlNode2 \
      -- --recursive test

PowerShell

npx slnodejs mocha `
  --tokenFile .\sltoken.txt `
  --buildSessionIdFile buildSessionId `
  --testStage "Unit Tests" `
  --useSlNode2 `
  -- --recursive test

Azure DevOps

- script: |
    npx slnodejs mocha \
      --token "$(SL_TOKEN)" \
      --buildSessionIdFile buildSessionId \
      --testStage "Unit Tests" \
      --useSlNode2 \
      -- --recursive test
  displayName: Mocha tests with SeaLights

Replace --recursive test with your actual Mocha arguments.

Parameters

Parameter	Purpose
--tokenFile / --token	SeaLights authentication
--buildSessionIdFile / --buildSessionId	Build session identifier
--testStage	Stage name (e.g. "Unit Tests")
--useSlNode2	Use the v2 Node agent runtime
--	Separates SeaLights options from Mocha arguments

Multiple reporters

To run SeaLights alongside other reporters (e.g. Allure, JUnit), install mocha-multi-reporters and create a config.json:

{
    "reporterEnabled": "slnodejs/tsOutputs/mocha-reporter/index, allure-mocha, mocha-junit-reporter",
    "seaLightsReporterReporterOptions": {},
    "mochaJunitReporterReporterOptions": {
        "mochaFile": "results/junit-custom.xml"
    },
    "allureMochaReporterOptions": {
        "resultsDir": "results/allure"
    }
}

Then run:

npx slnodejs mocha \
  --tokenFile ./sltoken.txt --buildSessionIdFile buildSessionId \
  --testStage "Unit Tests" --useSlNode2 \
  -- --reporter-options configFile=config.json

Suite mapping

To map functional tests to Mocha suites instead of individual tests:

npx slnodejs mocha ... -- --reporter-options reportSuites=true

---

Back to → Capturing Tests