Nearly Perfect Mediocracy
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

kinesis-test

1.0.1 • Public • Published

kinesis-test

Create and destroy Kinesis and Kinesalite streams for use in tape tests

Usage

var tape = require('tape');
var kinesis = require('kinesis-test')(tape, 'my-project', 1, 'us-east-1');
 
kinesis.test('my test', function(assert) {
  // creates a stream with 1 shard for you
  assert.end();
  // cleans up the stream after your test is over
});
 
kinesis.test('another test', function(assert) {
  // new stream!
  assert.end();
});

API

var kinesis = require('kinesis-test')(tape, projectName, shards, [region])

Provide your own tape object, then provide an arbitrary projectName (used in your stream's name) and number of shards. If you specify a region, then real-life Kinesis used. If not, then it will work locally using kinesalite.

kinesis.streamName

Provides the name of your test stream.

kinesis.kinesis

Provides an AWS.Kineis object configured to communicate with your stream (real-life or kinesalite).

kinesis.start()

Creates a kinesis stream for you to test against.

kinesis.shards

Once your stream is created, shards will provide you an array of functions, one for each shard. Pass an options object to this function in order to create a kinesis-readable streams.

kinesis.load(fixtures)

Loads records into your stream. fixtures must be an array of objects which each provde a Data and PartitionKey property.

kinesis.delete()

Deletes the stream.

kinesis.test(name, [fixtures], callback)

A wrapper around tape that:

  • creates a fresh stream
  • optionally, loads fixtures that you provide
  • runs your tests by providing an assertion object to your callback function
  • deletes your stream

kinesis.close()

If you're working in a mock test environment, use this call to shut down kinesalite.

install

npm i kinesis-test

Downloadsweekly downloads

29

version

1.0.1

license

ISC

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar