segmentio-integration-tester v2.2.0

integration-tester

Integration tester.

Installation

$ npm install segmentio/integration-tester

Example

assert(integration)
  .identify(identify)
  .sends('content-type', 'application/json')
  .sends({ baz: 'foo' })
  .expects({ users: { name: 'baz' } })
  .expects(200, end);

assert(integration)
  .sends('content-type', 'text/plain')
  .sends('x-baz', /foo/)
  .sends(/key=111/)
  .sends(/type=identify/)
  .expects(/success=true/)
  .expects(200, done);

API

Assertion(integration)

Initialize new Assertion with integration.

.requests(n)

Assert requests are n.

.retries(n)

Assert retries are n.

.timeout(ms)

Assert timeout is ms, where ms can be either a string (2s) or a number (2000).

.name(name)

Assert name is n.

.request(n)

Test assertions for the nth request (0-indexed). For integrations which make multiple requests, it's necessary to test the multiple requests for their output individually.

test
  .set(settings)
  .requests(2);

test
  .request(0)
  .sends(firstPayload)
  .expects(200);

test
  .request(1)
  .sends(secondPayload)
  .expects(200);

test.end(done);

.endpoint(url)

Assert endpoint is url.

.pathname(url)

Assert request pathname is url.

.valid(msg, settings)

Assert the integration is valid with msg, settings.

.invalid(msg, settings)

Assert the integration is invalid with msg, settings.

query(obj)

Add query.

Example:

Assertion(integration)
  .set('token', 'e16481cb')
  .identify({ userId: 1 })
  .query({ identify: true })
  .query({ userid: 1 })
  .expects(200, done);

set(key, value)

Set object key or key, value settings.

sends(...)

Assert integration sends ...

// examples
sends({ baz: 'foo' });
sends(/baz=foo/);
sends('?query=string');
sends('baz=foo');

sendsAlmost(obj, options)

Assert integration sends obj -- modulo some options. options can include

• ignored: Array of keys to ignore if they are also sent

// examples
sendsAlmost({ baz: 'foo' }, {'ignored': ['foo']});
// this will be fine if we send { baz: 'foo', foo: 'bar'};

queryAmost(obj || key, value, parse)

Checks to see if the request query string contained key/value (pairs). A parse function can be passed to be run on the query string value before comparison.

// examples
Assertion(segment)
  .set({ query: 'foo=baz&baz=foo' })
  .set({ key: 'baz' })
  .identify({})
  .queryAlmost({ foo: 'baz' })
  .expects(200, done);

expects(...)

Assert integration expects ...

// examples
expects({ success: true });
expects(/success=true/);
expects('success=true');
expects(200);

end(fn)

End assertions with fn.

error(fn)

Assert integration calls fn(err).

enabled(msg)

throws if the integration isn't enabled on msg.

disabled(msg)

throws if the integration isn't disabled on msg.

CHANNEL(msg)

throws if the integration isn't enabled on channel with optional msg.

// examples
server();
client();
mobile();

all()

throws if the integration isn't enabled on all channels.

License

(MIT)