Merge pull request #11 from orbitdb/refactor-update-deps

refactor: update deps, add tests, make more lightweight

Author: aphelionz

.circleci/config.yml

@@ -1,17 +1,17 @@
-version: 2.1
-orbs:
-  node: circleci/[email protected]
 jobs:
-  build-and-test:
+  test:
     executor:
       name: node/default
+      tag: 'lts'
     steps:
       - checkout
-      - node/with-cache:
-          steps:
-            - run: npm install
-            - run: npm test
+      - node/install-packages
+      - run:
+          command: npm run test
+orbs:
+  node: 'circleci/[email protected]'
+version: 2.1
 workflows:
-    build-and-test:
-      jobs:
-        - build-and-test
+  test_my_app:
+    jobs:
+      - test

.gitignore

@@ -1 +1,2 @@
 node_modules
+.nyc_output

README.md

@@ -1,5 +1,76 @@
-# OrbitDB Test Utils
+# OrbitDB Test Utils _(orbit-db-test-utils)_
+> Shared test utilities for OrbitDB-related projects
 
 [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/orbitdb/Lobby) [![Matrix](https://img.shields.io/badge/matrix-%23orbitdb%3Apermaweb.io-blue.svg)](https://riot.permaweb.io/#/room/#orbitdb:permaweb.io) [![Discord](https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord)](https://discord.gg/cscuf5T)
 
-- Readme TBD
+This repository contains utilities to spin up IPFS nodes and swarms, as well
+as different `abstract-leveldown` implementations to use with `orbit-db-keystore`
+and `orbit-db-cache`.
+
+For examples on how this would be used, see the `test` folder in this repo, or
+read on!
+
+## Install
+
+```bash
+$ npm install orbit-db-test-utils -D
+```
+
+## Usage
+
+### Spawn a single IPFS instance
+
+```JavaScript
+const {
+  connectPeers,
+  startIpfs,
+  stopIpfs,
+  testApis,
+  getIpfsPeerId,
+  waitForPeers
+} = require('../')
+
+;(async () => {
+  // Create JS and Go nodes
+  const ipfsd1 = await startIpfs('js-ipfs')
+  const ipfsd2 = await startIpfs('go-ipfs')
+
+  // Get the peer IDs
+  const id1 = await getIpfsPeerId(ipfsd1.api)
+  const id2 = await getIpfsPeerId(ipfsd2.api)
+
+  // Helper function to connect the nodes
+  await connectPeers(ipfsd1.api, ipfsd2.api)
+
+  // Test that the nodes are pubsubbing with each other
+  const topic = 'test-topic'
+  await ipfsd1.api.pubsub.subscribe(topic, () => {})
+  await ipfsd2.api.pubsub.subscribe(topic, () => {})
+  await waitForPeers(ipfsd1.api, [id2], topic)
+
+  // stop the nodes
+  await stopIpfs(ipfsd1)
+  await stopIpfs(ipfsd2)
+})()
+```
+
+**Note:** You may run into issues with `stopIpfs` hanging the script due to a `js-ipfs` bug
+
+### Spawn a swarm of connected IPFS instances
+
+```JavaScript
+const { swarm } = require('orbit-db-test-utils')
+
+// Enter an array of the node types you want, either 'js' or 'go'
+const nodeTypes = ['js', 'go', 'js']
+
+swarm(nodeTypes).then(nodes => /* ... do stuff  ... */)
+```
+
+## Contributing
+
+Issues and PRs are welcome.
+
+## License
+
+[MIT](./LICENSE) © OrbitDB Community

config/browser.js

@@ -53,7 +53,7 @@ module.exports = {
         webRTCStar: {
           Enabled: true
         }
-      },
+      }
     }
   },
   daemon2: {
@@ -66,7 +66,7 @@ module.exports = {
     config: {
       Addresses: {
         API: '/ip4/127.0.0.1/tcp/0',
-        "Swarm": ['/dns4/ws-star.discovery.libp2p.io/tcp/443/wss/p2p-websocket-star'],
+        Swarm: ['/dns4/ws-star.discovery.libp2p.io/tcp/443/wss/p2p-websocket-star'],
         Gateway: '/ip4/0.0.0.0/tcp/0'
       },
       Bootstrap: [],
@@ -78,7 +78,7 @@ module.exports = {
         webRTCStar: {
           Enabled: true
         }
-      },
+      }
     }
   }
 }

config/factory.js

@@ -0,0 +1,27 @@
+module.exports = {
+  defaults: {
+    type: 'proc',
+    test: true,
+    disposable: true,
+    ipfsModule: require('ipfs'),
+    init: false,
+    start: false,
+    ipfsOptions: {
+      config: {
+        Addresses: {
+          API: '/ip4/127.0.0.1/tcp/0',
+          Swarm: ['/ip4/0.0.0.0/tcp/0'],
+          Gateway: '/ip4/0.0.0.0/tcp/0'
+        },
+        Bootstrap: []
+      }
+    }
+  },
+  overrides: {
+    go: {
+      test: false,
+      ipfsHttpModule: require('ipfs-http-client'),
+      ipfsBin: require('go-ipfs-dep').path()
+    }
+  }
+}

implementations/node.js

@@ -1,4 +1,4 @@
-const mongoUnit = require('mongo-unit')
+// const mongoUnit = require('mongo-unit')
 const spawn = require('child_process').spawn
 const exec = require('child_process').exec
 

index.js

@@ -1,16 +1,18 @@
+exports.MemStore = require('./mem-store')
+exports.swarm = require('./swarm')
 exports.config = require('./config')
-exports.testAPIs = require('./test-apis')
+exports.connectPeers = require('./connect-peers')
+exports.getIpfsPeerId = require('./get-ipfs-peer-id')
 exports.startIpfs = require('./start-ipfs')
 exports.stopIpfs = require('./stop-ipfs')
+exports.testApis = require('./test-apis.js')
 exports.waitForPeers = require('./wait-for-peers')
-exports.connectPeers = require('./connect-peers')
-exports.getIpfsPeerId = require('./get-ipfs-peer-id')
-exports.MemStore = require('./mem-store')
 
+// Different abstract-leveldown implementations
 const implementations = require('./implementations')
-
-const properLevelModule = implementations.filter(i => i.key.indexOf('level') > -1).map(i => i.module)[0]
+const properLevelModule = implementations
+  .filter(i => i.key.indexOf('level') > -1)
+  .map(i => i.module)[0]
 const defaultStorage = require('orbit-db-storage-adapter')(properLevelModule)
-
-exports.implementations = implementations
 exports.defaultStorage = defaultStorage
+exports.implementations = implementations

mem-store.js

@@ -39,6 +39,8 @@ class MemStore {
     }
 
     const data = this._store.get(cid)
+
+    // TODO: Change this to refs
     const links = ['next', 'heads']
     links.forEach((prop) => {
       if (data[prop]) {