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

json-schema-test-data-generator

v0.1.1

Published

Generate sample test data based on JSON schema

Downloads

988

Readme

json-schema-test-data-generator

Not overly sophisticated utility that generates sample test data based on JSON schema.

Installation

npm install json-schema-test-data-generator

Usage

Module exports a single function that takes a JSON schema and outputs an array of test data objects based on the JSON schema covering various (but not all) combinations to check against. The output objects are in format:

{
  valid:    // boolean: whether the test data is valid against the schema or not
  data:     // object: the actual data
  message:  // string: a descriptive message for the test data
  property: // string|undefined: if available, the key / property at test
}

Sample usage:

var generate = require('json-schema-test-data-generator');

var schema = {
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength:": 5
    },
    "active": {
      "type": "boolean"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "accountNumber": {
      "type": "number"
    }
  },
  "required": ["name", "email"]
}

console.dir(generate(schema));

Output:

[ { valid: true,
    data: { name: 'Lorem', email: '[email protected]' },
    message: 'should work with all required properties' },
  { valid: true,
    data:
     { name: 'in Excepteur',
       email: '[email protected]',
       accountNumber: -45141884.82426107 },
    message: 'should work without optional property: active',
    property: 'active' },
  { valid: true,
    data:
     { name: 'consectetur amet dolor',
       email: '[email protected]' },
    message: 'should work without optional property: accountNumber',
    property: 'accountNumber' },
  { valid: false,
    data: { email: '[email protected]' },
    message: 'should not work without required property: name',
    property: 'name' },
  { valid: false,
    data: { name: 'labore', active: true },
    message: 'should not work without required property: email',
    property: 'email' },
  { valid: false,
    data: { name: true, email: '[email protected]' },
    message: 'should not work with \'name\' of type \'boolean\'',
    property: 'name' },
  { valid: false,
    data:
     { name: '4x%u',
       email: '[email protected]' },
    message: 'should not pass validation for minLength of property: name',
    property: 'name' },
  { valid: false,
    data:
     { name: 'deserunt nostrud dolore ea',
       email: '[email protected]',
       active: 5313786068074496 },
    message: 'should not work with \'active\' of type \'integer\'',
    property: 'active' },
  { valid: false,
    data:
     { name: 'cillum ',
       email: null,
       accountNumber: 67113212.30977774 },
    message: 'should not work with \'email\' of type \'null\'',
    property: 'email' },
  { valid: false,
    data: { name: 'anim laborum quis occaecat', email: '8WruHF' },
    message: 'should not pass validation for format of property: email',
    property: 'email' },
  { valid: false,
    data:
     { name: 'veniam nulla ut',
       email: '[email protected]',
       accountNumber: 'sn0S2H9j)]' },
    message: 'should not work with \'accountNumber\' of type \'string\'',
    property: 'accountNumber' } ]

API Reference

generate(schema) ⇒ Array

Generates test data based on JSON schema

Kind: global function
Returns: Array - Array of test data objects

| Param | Type | Description | | --- | --- | --- | | schema | Object | Fully expanded (no $ref) JSON Schema |

CLI

jstdgen schema.json > testdata.json