datagen

Multi-process test data files generator

npm install datagen
1 downloads in the last week
41 downloads in the last month

Avatar

Build Status Dependencies Status Published Version
npm Badge

DataGen

DataGen is a multi-process test data files generator.

This is handy when you want to generate large test data files (e.g. XMLs, JSONs, CSVs, etc), over multiple processes, utilising available CPU cores on your machine. It's also very easy to generate random numbers, dates, and strings as test data. You only need to create template files, no scripting involved.

Installation

npm install -g datagen 

Usage

Create example header, segment, and footer template files:

datagen init

Generate 8 data files containing 1 million segments in each file, written to data1 ... data8 output files, running over 8 processes, each process is used to generate 1 file:

datagen gen -s 1000000 -w 8 -o data

Limit the number of worker processes that can run concurrently to just 3:

datagen gen -s 1000000 -w 8 -m 3

Templates

DataGen uses three template files: header, segment, and footer. These templates are simple text files which are used to construct a data file in this format:

header
segment 1
segment 2
...
segment N (number of segments)
footer

Example header:

<?xml version="1.0" encoding="UTF-8"?>
<data>

Example segment:

<segment>
  <id>{gen_id}-{worker_id}-{segment_id}</id>
  <name>{first_name()} {last_name()}</name>
  <dob>{date('dd-mm-yyyy')}</dob>
</segment>

Example footer:

</data>

The above templates will generate an XML like this:

<?xml version="1.0" encoding="UTF-8"?>
<data>
<segment>
  <id>1-1-1</id>
  <name>Niels Bryant</name>
  <dob>12-08-1992</dob>
</segment>
<segment>
  <id>1-1-2</id>
  <name>John Bohr</name>
  <dob>01-11-1970</dob>
</segment>
...
</data>

Curly brackets in templates (e.g. JSON format) need to be escaped with double brackets:

{{ "id": "{gen_id}-{worker_id}-{segment_id}", "name": "{first_name()} {last_name()}", "dob": "{date('dd-mm-yyyy')}" }}

Templates can contain the following parameters:

{gen_id}Unique to each datagen execution. Default value is master process PID, can be overridden via -i flag.
{worker_id}Unique to each worker. Value from 1 to number of workers.
{segment_id}Unique to each segment within the generated data file, repeated in each file. Value from 1 to number of segments. Not available in header and footer templates.
{integer()}Random integer.
{integer(100, 200)}Random integer between 100 and 200.
{float()}random float.
{float(1.23, 5.67)}Random float between 1.23 and 5.67 .
{date()}random date between 1970 and 2020 in ISO format.
{date('yyyy-mm-dd')}Random date between 1970 and 2020 in yyyy-mm-dd format.
Check out felixge/node-dateformat for more date formats.
{date(2000, 2010)}Random date between 2000 and 2010 in ISO format.
{date('yyyy-mm-dd', 2000, 2010)}Random date between 2000 and 2010 in yyyy-mm-dd format.
{select('apple', 'orange', ..., 'kiwi')}Select one item from the arguments. You can have as many arguments as you want.
{word()}Random word from Lorem Ipsum.
{word(3)}Random 3 words from Lorem Ipsum.
{first_name()}Random first name.
{last_name()}Random last name.
{email()}Random email address.
{phone()}Random phone number. Default format #### ####.
{phone('(###) ####-####')}Random phone number with a custom format. Each '#' will be replaced by a random number.

Screenshots

Command init Command gen with flags

Colophon

npm loves you