Merge pull request #43 from relekang/adapter-tests

Add unit tests for adapters

Author: mxstbr

adapter-tests/unit-tests.js

@@ -0,0 +1,94 @@
+module.exports = function testAdapter(options) {
+  describe('micro-analytics adapter ' + options.name, () => {
+    const adapter = require(options.modulePath);
+
+    if (typeof options.beforeEach === 'function') {
+      beforeEach(async () => { await options.beforeEach(adapter); });
+    }
+
+    if (typeof options.afterEach === 'function') {
+      afterEach(async () => { await options.afterEach(adapter); });
+    }
+
+    if (typeof options.beforeAll === 'function') {
+      beforeAll(async () => { await options.beforeAll(adapter); });
+    }
+
+    if (typeof options.afterAll === 'function') {
+      afterAll(async () => {
+        await options.afterAll(adapter);
+        if (typeof adapter.close === 'function') {
+          await adapter.close();
+        }
+      });
+    }
+
+    it('should save and read', async () => {
+      await adapter.put('/a-key', { views: [{ time: 1490623474639 }] });
+
+      expect(await adapter.get('/a-key')).toEqual({
+        views: [{ time: 1490623474639 }],
+      });
+    });
+
+    it('should return all saves on getAll', async () => {
+      await adapter.put('/a-key', { views: [{ time: 1490623474639 }] });
+      await adapter.put('/another-key', { views: [{ time: 1490623474639 }] });
+
+      expect(await adapter.getAll({ pathname: '/' })).toEqual({
+        '/a-key': { views: [{ time: 1490623474639 }] },
+        '/another-key': { views: [{ time: 1490623474639 }] },
+      });
+    });
+
+    it('should have check whether a key is stored with has', async () => {
+      await adapter.put('/a-key', { views: [{ time: 1490623474639 }] });
+
+      expect(await adapter.has('/a-key')).toEqual(true);
+      expect(await adapter.has('/non-existing-key')).toEqual(false);
+    });
+
+    if (typeof adapter.subscribe === "function") {
+
+      it('should allow subscription with observables', async () => {
+        const listener = jest.fn();
+        const unsubscribe = adapter.subscribe(listener);
+
+        await adapter.put('/a-key', { views: [{ time: 1490623474639 }] });
+
+        expect(listener).toHaveBeenCalledWith({
+          key: '/a-key',
+          value: { views: [{ time: 1490623474639 }] },
+        });
+      });
+
+      it('should allow multiple subscription with observables and handle unsubscribption', async () => {
+        const listener1 = jest.fn();
+        const listener2 = jest.fn();
+        const subscription = adapter.subscribe(listener1);
+        adapter.subscribe(listener2);
+
+        await adapter.put('/a-key', { views: [{ time: 1490623474639 }] });
+        subscription.unsubscribe();
+        await adapter.put('/b-key', { views: [{ time: 1490623474639 }] });
+
+        expect(listener1).toHaveBeenCalledWith({
+          key: '/a-key',
+          value: { views: [{ time: 1490623474639 }] },
+        });
+        expect(listener1).not.toHaveBeenCalledWith({
+          key: '/b-key',
+          value: { views: [{ time: 1490623474639 }] },
+        });
+        expect(listener2).toHaveBeenCalledWith({
+          key: '/a-key',
+          value: { views: [{ time: 1490623474639 }] },
+        });
+        expect(listener2).toHaveBeenCalledWith({
+          key: '/b-key',
+          value: { views: [{ time: 1490623474639 }] },
+        });
+      });
+    }
+  });
+};

adapter-tests/unit-tests.test.js

@@ -0,0 +1,13 @@
+const { mockDb } = require('../tests/utils')
+
+jest.mock('flat-file-db', () => mockDb)
+
+const test = require('./unit-tests')
+
+test({
+  name: 'flat-file-db',
+  modulePath: 'micro-analytics-adapter-flat-file-db',
+  beforeEach: async () => {
+    mockDb._reset()
+  },
+})

package.json

@@ -33,11 +33,11 @@
   },
   "devDependencies": {
     "async-to-gen": "^1.3.0",
-    "babel-jest": "^18.0.0",
+    "babel-jest": "^19.0.0",
     "babel-plugin-transform-async-to-generator": "^6.16.0",
     "babel-polyfill": "^6.20.0",
     "babel-preset-node6": "^11.0.0",
-    "jest": "^18.1.0",
+    "jest": "^19.0.2",
     "request-promise": "^4.1.1"
   },
   "execMap": {

writing-adapters.md

@@ -184,3 +184,26 @@ subscription.unsubscribe()
 ```
 
 > **Note:** If your database of choice does not support subscriptions, it is fine not to have `adapter.subscribe` as long as you mention that visibly in your documentation.
+
+## Tests
+
+There is pre-written tests for adapters that you can use to make sure you adapter is implemented
+correctly. These can be easily used by adding jest and micro-analytics-cli as a dev dependency to your adapter(e.g. `npm install --save-dev micro-analytics-cli jest`). Then create a test file like the one below.
+
+```js
+const test = require('micro-analytics-cli/adapter-tests/unit-tests')
+
+test({
+ name: 'adapter-name',
+ modulePath: path.resolve(__dirname, './index.js'),
+})
+```
+
+The option object takes the following properties.
+
+* `name` - The name of the adapter
+* `modulePath` - The absolute path to the file you refer to in main in package.json
+* `beforeEach` - Will be called in jest beforeEach hook, return a promise if it needs to do something async. We recommend cleaning the database here.
+* `afterEach` - Will be called in jest afterEach hook, return a promise if it needs to do something async.
+* `beforeAll` - Will be called in jest beforeAll hook, return a promise if it needs to do something async.
+* `afterAll` - Will be called in jest afterAll hook, return a promise if it needs to do something async.