DorukC / salep

Platform independent Javascript testing framework

Home Page:https://mhalitk.github.io/salep/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

salep

Build Status codecov dependencies GitHub version license

salep is platform independent Javascript testing framework. It basically puts itself into global scope and runs while your code is running. It gives all collected test informations as JS object whenever you requested.

Install

Node.js

npm install salep

Smartface

If you are developing a Smartface application go to scripts folder of your workspace and install salep.

cd ~/workspace/scripts && npm install salep

Other Platforms

You can get standalone Javascript distribution from releases and run on your Javascript system before salep test codes.

Usage

Here is a sample test code using salep, for more information you can check api documentation.

require('salep');

function add(a, b) {
  return a + b;
}

// This function has bug
function fibonacci(n) {
  if (n <= 2) {
    return 0;
  } else {
    return fibonacci(n - 1) + fibonacci(n - 2);
  }
}

// Set event handlers
salep.on("fail", function(testCase) {
  console.log("Case [" + testCase.name + "] finished with fail: " + testCase.reason);
});

salep.on("success", function(testCase) {
  console.log("Case [" + testCase.name + "] finished with success");
});

// Write tests and cases
salep.test("Add/Fibonacci Functions Test", function() {
  // This will be recorded as success
  this.case("add(3,5) should return 8", function() {
    var result = add(3,5);
    if (result !== 8) {
      throw "add(3,5) returned '" + result + "', expected value was '8'";
    }
  });
  
  // This will be recorded as fail
  this.case("fibonacci(7) should be equal to 13", function() {
    var result = fibonacci(7);
    if (result !== 13) {
      throw "fibonacci(7) returned '" + result + "', expected value was '13'";
    }
  });
});

// Get results
var result = salep.getResults();
console.log(result.fail + " Failed");
console.log(result.success + " Succeeded");
console.log(result.skip + " Skipped");
console.log(result.total + " Total");

License

MIT

About

Platform independent Javascript testing framework

https://mhalitk.github.io/salep/

License:MIT License


Languages

Language:JavaScript 100.0%