keyv-api-tests v1.2.0

keyv-api-tests

Test suite for Keyv API compliancy

Complete AVA test suite to test a Keyv storage adapter for API compliancy.

Usage

Install

Install AVA, Keyv and keyv-api-tests as development dependencies.

npm install --save-dev ava keyv keyv-api-tests

Then update keyv and keyv-api-tests versions to * in package.json to ensure you're always testing against the latest version.

Create Test File

test.js

import test from 'ava';
import keyvApiTests from 'keyv-api-tests';
import Keyv from 'keyv';
import KeyvStore from './';

const store = new KeyvStore();
keyvApiTests(test, Keyv, store);

Where KeyvStore is your storage adapter.

Set your test script in package.json to ava.

"scripts": {
  "test": "ava"
}

Test on all supported Node.js versions

An example configuration for Travis CI would look like this:

.travis.yml

language: node_js
node_js:
  - '8'
  - '6'
  - '4'
script: npm test

Example

Take a look at keyv-redis for an example of an existing storage adapter using keyv-api-tests.

License

MIT © Luke Childs