Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmgogo/mocha-js
A demo for unit testing with the Mocha.js framework.
https://github.com/jmgogo/mocha-js
assertion-framework devcontainer javascript mocha-js node-js unit-testing
Last synced: about 17 hours ago
JSON representation
A demo for unit testing with the Mocha.js framework.
- Host: GitHub
- URL: https://github.com/jmgogo/mocha-js
- Owner: jmgogo
- Created: 2024-02-27T16:02:43.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-02-28T22:38:33.000Z (8 months ago)
- Last Synced: 2024-09-21T01:33:46.660Z (about 2 months ago)
- Topics: assertion-framework, devcontainer, javascript, mocha-js, node-js, unit-testing
- Language: JavaScript
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Testing with Mocha.js ☕
Foreword
A demo for unit testing with the Mocha.js framework.
Report Bug
·
Request Feature
## Table of Contents
- [Testing with Mocha.js ☕](#testing-with-mochajs-)
- [Table of Contents](#table-of-contents)
- [Setup](#setup)
- [About](#about)
- [Prerequisites](#prerequisites)
- [Getting started](#getting-started)
- [License](#license)
## Setup
This project includes a Dev Container for Visual Studio Code. It serves as a full-featured development environment with everything needed to run the test framework. Dev Containers separate tools, libraries, or runtimes needed for working with a codebase. They aid in continuous integration and testing. Dev containers can be run locally or remotely, in a private or public cloud, in a variety of supporting tools and editors.
[This DevContainer](.devcontainer) is built IAW the [DevContainers specification](https://containers.dev/implementors/spec/) and tailored for a development environment that runs Debian GNU/Linux 12 (bookworm). JavaScript dependencies are versioned in accordance with `package-lock.json` and project configurations are detailed in `package.json`. The devcontainer also has git for version control and several extensions installed for Visual Studio Code as IDE utilities.
## About
[This project](https://github.com/jgome284/mocha-js) provides several [examples](./test/) of how to setup unit tests for JavaScript code. It leverages Mocha.js, is a widely adopted JavaScript testing framework that runs on both Node.js and in the browser. It’s highly regarded among developers for its versatility in testing applications across the front end and back end.
## Prerequisites
To start, you need to have Docker Engine and Docker Compose on your machine. You can either:
- Install Docker Desktop which includes both Docker Engine and Docker Compose
- Install Docker Engine and Docker Compose as standalone binaries
This devcontainer is setup for development on Visual Studio Code. You should have it installed along with the [remote development pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack) to enable the IDE's DevContainers functionality.
## Getting started
First, git clone this project to a local repository. Then, open Docker Desktop to run the Docker daemon, a background process that manages and coordinates Docker containers on your system. On VS Code, open your local copy of the project and start the development container by running `Dev Containers: Rebuild and Reopen In Container` in the command palette. It can be accessed with the keyboard shortcut `ctrl + shift + P` on your keyboard.
When the Dev Container launches successfully, install Mocha.js along with its dependencies via npm by executing the following command. If successful, a `node_modules` folder should appear in your directory.
```sh
npm install
```
With dependencies installed, try running tests with Mocha! Our `package.json` file includes the right script to run all our tests. It's aliased to the following command via npm as such.
```sh
npm test
```
If successful, you should see the following output from Mocha.js for the tests. With so many tests, the value of automated testing becomes especially apparent. Manual re-runs during development can be imperfect, and they can lead to missed test cases. Automated testing helps catch issues early, ensuring code quality and reliability.
Test Output
Think you've got what it takes? Take testing with Mocha.js into your own hands and improve on what these tests offer by expanding test cases into the edge! (⌐■_■)
## License
Distributed under the MIT License. See `LICENSE` for more information.