Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

verify-it

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

verify-it

Randomised test property/data generation for NodeJS

  • 2.3.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2.2K
increased by1.29%
Maintainers
1
Weekly downloads
 
Created
Source

verify-it

Randomised test property/data generation for NodeJS.

JavaScript Style Guide Build Status dependencies Status devDependencies Status

This module provides:

  • Randomised property inputs for testing (delegating the actual testing to a global it or test function).
  • Global verify.it and verify.test functions (which are synonyms).
  • A global verify.describe function (delegating the actual testing to a global describe function).
  • A series of generator functions that can be used to generate properties.
  • Generators are simply functions that produce a value so custom generators are simple to create.

What it is not:

  • A property-based testing framework - each test scenario is only run once with the requested randomised inputs.

Usage

A global it or test function is required for verify-it to delegate testing to (it is used in preference to test). This could be provided by mocha, jest, jasmine or a similar testing framework.

A simple mocha example would be:

require('mocha')
const { Gen } = require('verify-it')

const myGenerator = () => `My custom generated value: ${Math.random()}`

describe('The verify-it library', () => {
  verify.it('should inject randomised properties',
    Gen.string, Gen.object, myGenerator,
    (someString, someObject, someCustomValue) => {
      // Write your tests here in the usual way using the supplied randomised values...
    }
  )

  verify.it('should allow testing of asynchronous callbacks if the test framework supports it', () => {
    Gen.string, Gen.object, myGenerator,
    (someString, someObject, someCustomValue, done) => {
      // Write some more tests here but call the done function when finished
      done()
    }
  )

  verify.describe('when verify.describe is used', Gen.object, (someObject) => {
    verify.it('allows the same generated value to be shared across multiple tests',
      Gen.object, (someOtherObject) => {
        // Write your tests here using both someObject and someOtherObject
      }
    )
  })
})

If your test framework has test.only or it.only and test.skip or test.skip then verify.it.only, verify.test.only, verify.it.skip, and verify.it.skip will also be available. Similarly, if describe.only or describe.skip exist, verify.describe.only and verify.describe.skip will be available.

Generators

Generators are simply functions that produce a value. Several built-in generators are supplied:

const { Gen } = require('verify-it')
FunctionProducesNotes
Gen.wordstringProduces an english word picked at random from a word list.
Gen.stringstringProduces a random string between 1 and 100 characters in length.
Gen.stringWithLength(length)stringProduces a random string with a fixed length.
Gen.stringNonNumericstringProduces a random string that does not contain numeric characters between 1 and 100 characters in length.
Gen.integernumberProduces a random integer in the inclusive range between Number.MIN_SAFE_INTEGER and Number.MAX_SAFE_INTEGER.
Gen.integerBetween(min, max)numberProduces a random integer in the inclusive range between min and max.
Gen.floatnumberProduces a random number in the inclusive range between -1E10 and 1E10
Gen.floatBetween(min, max)numberProduces a random number in the inclusive range between min and max
Gen.objectObjectProduces an object with random word keys and randomised string values.
Gen.objectWith(...keys)ObjectProduces an object with the supplied keys and randomised string values.
Gen.errorErrorProduces an Error with a random message string.
Gen.booleanbooleanProduces a random boolean value
Gen.array(generator, length)ArrayProduces an array with length elements (or between 1 and 100 elements if length is omitted) generated using generator. e.g. Gen.array(Gen.string) will produce an array of strings.
Gen.distinct(generator, length)ArrayProduces an array of length length with distinct values generated using generator. Equality is based on ===. If distinct values cannot be generated after 10 generation attempts, an error will be thrown.
Gen.pick(values)anyPicks a random element from the supplied values array.

Development

  • Install dependencies: yarn install.
  • Run all tests: yarn test.
  • Check dependencies for security vulnerabilities and licensing issues: yarn check-dependencies.

Contributing

See these notes for information for contributors.

License

verify-it is available to all via the Apache-2.0 license.

Copyright © 2017 BBC

Keywords

FAQs

Package last updated on 06 Jun 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc