npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ddt-js

v2.0.1

Published

Simple but powerful JSON-like data-driven unit testing utility

Downloads

8

Readme

ddt.js

Simple but powerful JSON-like data-driven unit testing utility

Features

  • Optimized for testing synchronous functions
  • Tests are defined in JSON-like code data, alongside main code, enabling flexibility

Installation

npm install -g --save ddt-js

Module Usage

var ddt = require('ddt-js);

let sayHello = function(person){
    if (!person && person !== false)
        throw "invalid person";
    else
        return "Hello " + person;
}

ddt.test({
    title: "test sayHello() with actual person",
    unit: sayHello,
    getArgs: function() { return ["World"]; },
    getExpected: function() { return "Hello World"; }
})

output:

{
    title: "test sayHello with actual person",
    unit: "sayHello()",
    args: ["World"],
    expected: "Hello World",
    actual: "Hello World",
    passed: true
}

Command-Line Usage

ddt --src foo/bar/src --dest foo/bar/test --ext .test.result --test-info-key testInfo

The command line options are:

  • src: source module files directory; defaults to the current working directory
  • dest: destination directory for test results; defaults to the current working directory
  • ext: extension for test result files
  • test-info-key: specifies the property of each source module that contains the test information.

The ddt command-line assumes each file in the source glob defines a single module together with its test information. To be testable, the module definition must export a test information object (by default named "testInfo") that specifies the folowing members:

  • cases: An array of test cases of the form:
    { 
        title: "test title",
        description: "test description",
        unit: function(){}, // the function being tested
        getArgs: function(){ return []}, // return array of arguments to be passed to unit
        getConvertedActual: function(actual){ return actual }, // optional function to convert actual value before comparison
        getExpected: function(){}, // return expected value of test
        getComparison: function(expected, actual) { return expected === actual; } // optional function to compare expected and actual
    }
  • getContext(): a function that returns a global context object for all the test cases in the module
  • defaultUnit: the default function to be tested. Each test case in the module can specify its own unit to override this value, but in situations where most of the test cases are testing the same unit, that unit can be specified here

Example module for command-line ddt testing:

module.exports.sayHello = function(person){
    if (!person && person !== false)
        throw "invalid person";
    else
        return "Hello " + person;
}

module.exports.testInfo = {
    defaultUnit: sayHello,
    getContext: function() { return null; },
    cases: [
        {
            title: "sayHello() return correct output with actual person",
            getArgs: function() { return ["World"]; },
            getExpected: function() { return "Hello World"; }
        },
        {
            title: "sayHello() return correct error with null person",
            getArgs: function() { return [null]; },
            getExpected: function() { return "invalid person"; }
        }
    ]
    
})