tme

tme is a testing app that can test nodejs and web applications. I wrote this app by following this tutorial by Stephen Grider.

Requirements

Node version 14.x and above
npm version 6.x and above

Installation

clone this repo.
go to the tme directory.
install dependencies using npm.

npm install

link this repo to your local computer using npm so you can access tme everywhere on your terminal.

npm link

Usage

The test files that you make should follow this pattern :

*.test.js

Inside those test file you can use it and beforeEach function to define you tests.

it

The it function is the core part of this testing app. It accepts two arguments, a description of the test that will be shown on terminal and a callback function that is your actual test!

it("DESCRIPTION", testFunction);

beforeEach

This pre-defined function accepts just a callback function that will execute before each test that was defined by it.

beforeEach(callbackFunction);

But before defining your test with it and beforeEach, you must to add some other code to your *.test.js files in order to work correctly and that depends on which platform your app is written in.

Nodejs

If you are testing a node application, do these instructions :

require in each function that you want to test.

const { foo } = require("../index");

require assert that is a pre-defined nodejs module.

const assert = require("assert");

define your test using it and beforeEach
at the end of each test, use assert module to check what the test return and what do you expect it to return.

Web Apps

require assert that is a pre-defined nodejs module.

const assert = require("assert");

use async key word for it callback function.
at each test you should first render your main html file to the app.

const dom = await render("index.html");

also if you want to dispatch action to dom then test something with it, use this syntax in your callback function : (For more information see jsdom documentation)

dom.window.document
  .querySelector("form")
  .dispatchEvent(new dom.window.Event("submit"));

Caution

Please take note that this app will run every thing that is writen in those *.test.js files. If there is some bad code that mess with your system via nodejs, it can cause many problems as jsdom says.

So just test and run test files that you wrote yourself. In that case there is absolutely nothing to be worry about.

Examples

You can find some examples by looking at tests in 'sampleNodeProject' and 'sampleWebProject' directories in this repo.

epicmet / tme

tme