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

lab-suite

v1.4.0

Published

A extremely simple tool for making lab testing suites

Downloads

20

Readme

lab-suite

Greenkeeper badge

Build Status

lab-suite is a simple tool to create reusable test suites. It's quite easy to get into a pattern of cutting and pasting existing tests and then manually replacing the things that have changed but this can be time consuming and create a real maintenance nightmare.

While it was created to work with lab it does not directly depend on it. In theory any testing framework can be used.

Installation

npm install lab-suite -D

Create a suite

To create a suite follow the example below.

You can also set the expectations for the usage of the suite to make it easier for someone to implement. These expectations will be checked when the suite is run.

suite.expect currently supports the following expectations:

  • string
  • function
  • number
  • date
  • object
  • array
  • error
  • boolean
  • anything (This doesn't perform an actual check but it's good for documenting the intended use of the suite)
import labSuite from "lab-suite";

const suite = labSuite.create();

// These expectations double as documentation for someone implementing the suite
suite.expect("SERVICE").to.be.a.function();
suite.expect("SERVICE_CALL").to.be.a.string();
suite.expect("SERVICE_INPUT").to.be.an.array();
suite.expect("SERVICE_RESULT").to.be.a.string();

suite.declare((lab, variables) => {

  const {
    SERVICE,
    SERVICE_CALL,
    SERVICE_INPUT,
    SERVICE_RESULT
  } = variables;

  lab.experiment(`The ${SERVICE_CALL} method`, () => {

    lab.test("succeeds when get called with good parameters", done => {

      const service = new SERVICE();

      return service[SERVICE_CALL](...SERVICE_INPUT)
        .then(result => {
          expect(result).to.equal(SERVICE_RESULT);
        });
    });
  });
});

export default suite;

Additionally, you can use or to allow more flexible inputs.


suite.expect("SERVICE_INPUT").to.be.an.array.or.an.object();

Run a suite

Import the suite into you test file and do away with boilerplate tests. You can still create normal too if the thing you are testing isn't generic.


import serviceTestSuite from "./serviceTestSuite";
import ServiceA from "./ServiceA";
import ServiceB from "./ServiceB";

const variablesA = {
  SERVICE: ServiceA, 
  SERVICE_CALL: "addNumbers", 
  SERVICE_INPUT: [1,2], 
  SERVICE_RESULT: 3 
  };

const variablesB = {
  SERVICE: ServiceB, 
  SERVICE_CALL: "countCharacters", 
  SERVICE_INPUT: ["abc","def", "ghi"], 
  SERVICE_RESULT: 9 
  };

serviceTestSuite.run(lab, variablesA);
serviceTestSuite.run(lab, variablesB);