sinae v0.0.1-beta.0

sinae

A light-weight testing framework. Made using pure JavaScript.

User Stories

As a Maker,
So I can group all my tests,
It should have a way to group tests under a main title

As a Maker,
So I can see what the test is about,
It should have a way to title tests

As a Maker,
So I can test my code is working correctly,
It should have a way to evaluate values

As a Maker,
So I can check my tests,
It should print out to the console if they pass or fail

As a Maker,
So I can check what wrong with my test,
It should print out what was expected and what actually happened

As a Maker,
So I can test my software is working correctly,
It should have a way to evaluate values in different ways

As a Maker,
So I can read the console output easily,
It should indent the output

Instructions

Installation

 npm install -D sinae

 yarn add -D sinae

Usage

Require the framework in your test file:

const sinae = require('sinae')

// add required functionality (see API)
const describe = sinae.describe
const it = sinae.it
const expect = sinae.expect

API

describe(description: String, fn: Function)

Creates a block that groups several tests together.

• description: identifies the group of tests in the console.
• fnfunction declaration, inside which you can further organise your test suite using describe blocks, or, set up a test inside an it block.

it(description: String, fn: Function)

Creates a block where you can set up and run a test.

• description: identifies the test in the console
• fn: function decleration, inside which the test is set up and an expectation is defined

expect(value: any).<matcher>(condition: any)

Stores a value, which is passed onto a matcher for evaluation.

• value: the variable, returned value, or object passed in for evaluation
• condition: the expectation the value will be compared to

Matchers

Equality

Evaluate value against condition.

• toEqual(condition: any): normal comparision
• toNotEqual(condition: any): normal comparision
• toBe(condition: any): strict comparision
• toNotBe(condition: any): strict comparision

Inclusion

Evaluate whether an array (value) contains the condition.

• toContain(condition: any): passes if condition array contains condition one level deep
• toContain(condition: any): passes if condition array doesn't contain condition one level deep

Note: useage of expect is expect(value: Array) for inclusion matchers.

Style

Logs inside describe and it blocks are indented:

Makers
  #culture
    has an awesome culture

Passing tests are green and failing tests are red. Failing tests display what was expected and what was received:

Programming Languages
  Python rocks // green output
  JavaScript is better than Ruby // red output
    
    Expected: true
    Got: false