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 Hoisting: How It Works with Examples

You will face hoisting early when you write JavaScript. It affects how your code runs, and it may confuse you…

How Does JavaScript Work to Run Code in the Web Browser

Click a button on a website. Something changes. A menu opens or a message pops up. That’s how JavaScript works.…

JavaScript Popup Boxes: How they Works with Examples

JavaScript uses popup boxes to show quick messages or ask for direct input. These boxes stop the flow of the…

JavaScript toSpliced Function Explained with Examples

The toSpliced function creates a new array without changing the original array in JavaScript. It returns a copy with new…

JavaScript “use strict” Mode: What It Is and Why You Should Use It

Code mistakes used to slip by without a warning. That made bugs hard to trace and fix. JavaScript "use strict"…

JavaScript Object References and Copying for Beginners

Object References in JavaScript mean that variables do not store full objects but only their references in memory. What is…

JavaScript Math log: How it Works with Examples

JavaScript Math.log() was added to help people find the natural log of a number. It solves real problems in science…

JavaScript valueOf Function: How it Works with Examples

You will learn what the JavaScript valueOf function does and how it works. It returns the primitive value of an…

JavaScript do while Loop: How it Works with Examples

The "do while" loop in JavaScript runs code once before checking the condition. Use it when the code must run…

JavaScript for…in Loop: Iterating Over Objects

You may need to loop through properties when you work with objects in JavaScript. The for...in loop helps you do…

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.