Mocha JavaScript Test Framework: Guide and Examples

javascript mocha javascript framework

Mocha is a JavaScript test framework for Node.js. It runs tests in sequence and shows results. It works with any assertion library and supports asynchronous tests.

Benefits of Mocha Framework for JavaScript Testing

Mocha helps you run JavaScript tests with control and order. It works with any assertion library, so you can pick the one you want.

Let’s look at an example to understand it:

const assert = require('assert');

describe('Math tests', function() {
  it('adds numbers', function() {
    assert.strictEqual(2 + 3, 5);
  });
});

This test checks if 2 + 3 equals 5.

Here is the output in the terminal:

mocha test in javascript

Install and Set Up the Mocha Framework to Test in JavaScript

Install Mocha with npm. Run this command in your project folder.

npm install --save-dev mocha

Add a test script package.json after installation in the same root of your code.

"scripts": {
  "test": "mocha"
}

Mocha with Assertion Libraries (Chai Example)

Create a file named test.js. Write a test inside it.

const assert = require('assert');

describe('Array', function() {
  it('returns -1 if value not found', function() {
    assert.strictEqual([1, 2, 3].indexOf(4), -1);
  });
});

This test checks if indexOf(4) gives -1 for an array with numbers 1, 2, 3. Here is an image that shows you the result:

mocha test in js

Run Test with the CLI of the Mocha Framework in JavaScript

Mocha works well with Chai. Chai gives different styles for writing assertions.

Install Chai with npm.

npm install chai --save-dev

Here’s how it works in practice.

const chai = require('chai');
const expect = chai.expect;

describe('Chai test', function() {
  it('checks type of value', function() {
    expect('hello').to.be.a('string');
  });
});

This test checks if 'hello' is a string.

Run tests with the Mocha CLI. Use the command below.

npx mocha

The command finds test files and runs them. It shows the results in your terminal.

Here is the result:

chai test

Organize Tests in Projects

Keep tests in a folder named test in your project. Mocha looks inside this folder by default. Place each test file inside it.

Use names that describe the test purpose.

Wrapping Up

You learned the role of Mocha and how to install it. Also, you understood how to write a test and how to run it.

Here is a quick recap:

  • Mocha runs JavaScript tests with sequence and control.
  • It works with assertion libraries like Chai.
  • It runs tests from the CLI with npx mocha.
  • It supports the test organization inside a test folder.

FAQs

What is Mocha JavaScript Test Framework?

Mocha JavaScript Test Framework is a flexible test tool for Node.js and browsers. It supports asynchronous tests and provides descriptive test reports.

How do I install Mocha JavaScript Test Framework?

Use npm to install Mocha in your project:
npm install --save-dev mocha
  • Install globally: npm install -g mocha
  • Install locally: npm install --save-dev mocha

How do I write my first Mocha test?

Create a test file like test.js with the following:
const assert = require('assert');
describe('Array', function() {
  it('should return -1 when value is not present', function() {
    assert.equal([1,2,3].indexOf(4), -1);
  });
});
  1. Create test file: test.js
  2. Run test: npx mocha

How to run Mocha tests from command line?

Use the Mocha command in your project: mocha
  • Run all tests: npx mocha
  • Run specific file: npx mocha test/test.js

Similar Reads

JavaScript Math atan: Arc Tangent of a Number in Radians

Math.atan() function in JavaScript helps you to solve math problems in your code. It turns a number into an angle.…

Code Structure: How to Structure JavaScript Code

You have to organize your JavaScript code structure. A clean layout helps you read and fix your code. Whether you…

JavaScript Math ceil: Round Numbers with Precision

Some numbers do not stay whole. You get decimal parts when you divide or calculate prices. You may need to…

JavaScript Nullish Coalescing Operator Guide with Examples

The JavaScript nullish coalescing operator (??) gives a default value when a variable is null or undefined. Understand the Nullish…

JavaScript: How to Add JS to HTML

The development of full-featured and interesting pages cannot be done without JavaScript which makes it possible to animate plain HTML…

How to Use the Ternary Operator in JavaScript

The ternary operator in JavaScript keeps your code short. It helps you write conditions inside one line. JavaScript lets you…

Arrow Function in JavaScript: How it Works with Examples

Arrow function gives you short code and keeps this in the right scope in JavaScript. Understand the Arrow Function in…

JavaScript for Loop: How to Iterate Arrays by Examples

JavaScript runs code in different ways, but the for loop stays one of the most common tools. You use it…

JavaScript Syntax: The Complete Cheat Sheet

JavaScript syntax is what you will use when writing and reading javascript code, it is the foundation of using this…

Understanding JavaScript Arithmetic Operators

JavaScript arithmetic operators let you add, subtract, multiply, or divide numbers. You can also use them to find remainders or…

Previous Article

How to Use sub Tag for Subscript Text in HTML

Next Article

JavaScript Nullish Coalescing Operator Guide with Examples

Write a Comment

Leave a Comment

Your email address will not be published. Required fields are marked *


Subscribe to Get Updates

Get the latest updates on Coding, Database, and Algorithms straight to your inbox.
No spam. Unsubscribe anytime.