Skip to content

Latest commit

 

History

History

mocha-ts-multi-reporters

README.md

📊 Mocha + TypeScript + Multi Reporters Example

This repo contains simple template for testing project with Multiple reports based on the stack = Mocha + TypeScript + Spec report & Testomat.io plugins.

Installation

This is a playground for your first steps in testing, so instead of installing it from NPM it is recommended to clone it from repo instead.

  1. Clone this repository:
git clone [email protected]:testomatio/examples.git && cd examples/mocha-ts-multi-reporters

Requirements:

in order to run this project, NodeJS (version 18+) must be installed

  1. Install dependencies via npm:
npm i

This will install mocha & typescript env + Testomat.io reporter

  1. Run tests localy without sending report to the Testomat.io:
npm tests

(if the tests are completed => you can start setting up the testomat.io reporter)

Loading Tests to Testomat.io

  1. Create empty project in Testomat.io
  2. Obtain API key from Testomat.io
  3. Run npx check-tests to upload tests data into testomat.io. Pass api key as TESTOMATIO environment variable:
TESTOMATIO={apiKey} npx check-tests@latest mocha "**/*{.,_}{test,spec}.ts" --typescript -d spec

Publishing Test Results to Testomat.io

  1. Get API key from a project in Testomat.io.

  2. Create a specific .env file:

Environment variables .env file using env.example as a template

SET key variable

(if you don't want to use the TESTOMATIO API key when running testomatIO, then you can store the token in the .env file (see env.example example))

  1. Run tests and generate reports(Testomat.io):
npx mocha

OR

npm test

reporterOptions additinal options

In our case, we use multiple reporters: spec & testomatio.

!! Pay Attantion on the rpConfgi.js file. Using key-name should be equal path to the testomatio adapter(testomatio/reporter/lib/adapter/mocha.js). Like:

testomatioReporterLibAdapterMochaJsReporterOptions