feat: initial implementation

Author: vasco-santos

.gitignore

@@ -0,0 +1,42 @@
+**/node_modules/
+**/*.log
+test/repo-tests*
+**/bundle.js
+docs
+# Logs
+logs
+*.log
+
+coverage
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+build
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+
+lib
+dist
+test/test-data/go-ipfs-repo/LOCK
+test/test-data/go-ipfs-repo/LOG
+test/test-data/go-ipfs-repo/LOG.old
+
+# while testing npm5
+package-lock.json

.travis.yml

@@ -0,0 +1,33 @@
+language: node_js
+cache: npm
+stages:
+  - check
+  - test
+  - cov
+
+node_js:
+  - '10'
+
+os:
+  - linux
+  - osx
+  - windows
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - os: windows
+
+script: npx nyc -s npm run test:node -- --bail
+after_success: npx nyc report --reporter=text-lcov > coverage.lcov && npx codecov
+
+jobs:
+  include:
+    - stage: check
+      script:
+        - npx aegir commitlint --travis
+        - npx aegir dep-check
+        - npm run lint
+
+notifications:
+  email: false

README.md

@@ -1,33 +1,40 @@
-# Interoperability Compliance Test Stories for libp2p
+# Interoperability Tests for libp2p
 
-<a href="http://protocol.ai"><img src="https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square" /></a>
-<a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" /></a>
-<a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" /></a>
-<a href="https://waffle.io/libp2p/libp2p"><img src="https://img.shields.io/badge/pm-waffle-yellow.svg?style=flat-square" /></a>
+[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai/)
+[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
 
-> In this repo you will find the [PDD (Protocol Driven Development)](https://github.com/ipfs/pdd) stories that enable you to test a libp2p implementation against other implementations.
+> Interoperability tests for libp2p Implementations
 
-## ❗️ Important
+This repository will be used for interop tests.
 
-**The setup for these tests is still in flux, please make sure to read the latest update at: https://github.com/libp2p/interop/issues/1**
+## Lead Maintainer
 
-## PDD Compliance Test Stories
+[Vasco Santos](https://github.com/vasco-santos)
 
-Each Test Story has actors and a dramatization.
+## Usage
 
-- **Qualitative** - Test Stories that check feature interoperability and compliance.
-  - [Transports](./PDD-TRANSPORTS.md)
-  - [Protocol and Stream Multiplexing](./PDD-PROTOCOL-AND-STREAM-MULTIPLEXING.md)
-  - [Identify](./PDD-IDENTIFY.md)
-  - [Encrypted Communications](./PDD-ENCRYPTED-COMMUNICATIONS.md)
-  - [Peer Routing](./PDD-PEER-ROUTING.md)
-  - [Content Routing](./PDD-CONTENT-ROUTING.md)
-  - [PubSub](./PDD-PUBSUB.md)
-  - [Circuit Relay](./PDD-CIRCUIT-RELAY.md)
-  - [The IPFS bundle](./PDD-THE-IPFS-BUNDLE.md)
-- **Quantitative** - Test Stories focused on stress testing the implementations against each other.
-  - [Thousands of Muxed Streams](./PDD-THOUSANDS-OF-MUXED-STREAMS.md)
-  - [Hundreds of Peer Connections](./PDD-HUNDREDS-OF-PEER-CONNECTIONS.md)
+### Install
+
+```
+> git clone git@github.com:libp2p/interop.git
+> cd interop
+> npm install
+```
+
+### Run the tests
+
+```
+> npm test
+```
+
+### Test with a non yet released version of js-ipfs
+
+TODO
+
+### Test with a non yet released version of go-ipfs
+
+TODO
 
 ## Contribute
 

package.json

@@ -1,19 +1,44 @@
 {
-  "name": "libp2p-interop",
+  "name": "interop-libp2p",
   "version": "0.0.0",
-  "description": "",
-  "main": " ",
+  "description": "Interoperability Tests for libp2p",
+  "leadMaintainer": "Vasco Santos <santos.vasco10@gmail.com>",
+  "main": "",
+  "engines": {
+    "node": ">=10.0.0",
+    "npm": ">6.0.0"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "lint": "aegir lint",
+    "test": "cross-env IPFS_REUSEPORT=false aegir test -t node -f test/node.js",
+    "test:node": "cross-env IPFS_REUSEPORT=false aegir test -t node -f test/node.js",
+    "test:browser": "cross-env IPFS_REUSEPORT=false aegir test -t browser --no-cors -f test/browser.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/libp2p/interop.git"
   },
-  "author": "David Dias <daviddias@ipfs.io>",
+  "keywords": [
+    "libp2p"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/libp2p/interop/issues"
   },
-  "homepage": "https://github.com/libp2p/interop#readme"
+  "homepage": "https://github.com/libp2p/interop#readme",
+  "devDependencies": {
+    "aegir": "^17.0.1",
+    "chai": "^4.2.0",
+    "chai-checkmark": "^1.0.1",
+    "cross-env": "^5.2.0",
+    "dirty-chai": "^2.0.1",
+    "go-libp2p-dep": "^6.0.30",
+    "libp2p-daemon": "~0.1.2",
+    "libp2p-daemon-client": "~0.0.3",
+    "rimraf": "^2.6.3"
+  },
+  "contributors": [],
+  "dependencies": {
+    "execa": "^1.0.0"
+  }
 }

PDD-CIRCUIT-RELAY.md pdd/PDD-CIRCUIT-RELAY.md

@@ -0,0 +1,142 @@
+'use strict'
+
+const assert = require('assert')
+const execa = require('execa')
+const fs = require('fs')
+const os = require('os')
+const path = require('path')
+const rimraf = require('rimraf')
+
+const Client = require('libp2p-daemon-client')
+const { getSockPath } = require('./utils')
+
+const isWindows = os.platform() === 'win32'
+
+// process path
+const processPath = process.cwd()
+
+// go-libp2p defaults
+const goDaemon = {
+  defaultSock: getSockPath('/tmp/p2pd-go.sock'),
+  bin: path.join('go-libp2p-dep', 'go-libp2p', isWindows ? 'p2pd.exe' : 'p2pd')
+}
+
+// js-libp2p defaults
+const jsDaemon = {
+  defaultSock: getSockPath('/tmp/p2pd-js.sock'),
+  bin: path.join('libp2p-daemon', 'src', 'cli', 'bin.js')
+}
+
+class Daemon {
+  /**
+   * @constructor
+   * @param {String} type daemon implementation type ("go" or "js")
+   * @param {String} sock unix socket path
+   */
+  constructor (type, sock) {
+    assert(type === 'go' || type === 'js', 'invalid type received. Should be "go" or "js"')
+
+    this._client = undefined
+    this._type = type
+    this._binPath = this._getBinPath(type)
+    this._sock = sock && getSockPath(sock)
+
+    if (!this._sock) {
+      this._sock = type === 'go' ? goDaemon.defaultSock : jsDaemon.defaultSock
+    }
+  }
+
+  /**
+   * Get binary path according to implementation and OS
+   * @param {String} type daemon implementation type ("go" or "js")
+   * @returns {String}
+   */
+  _getBinPath (type) {
+    const depPath = type === 'go' ? goDaemon.bin : jsDaemon.bin
+    let npmPath = path.join(processPath, '../', depPath)
+
+    if (fs.existsSync(npmPath)) {
+      return npmPath
+    }
+
+    npmPath = path.join(processPath, 'node_modules', depPath)
+
+    if (fs.existsSync(npmPath)) {
+      return npmPath
+    }
+
+    throw new Error('Cannot find the libp2p executable')
+  }
+
+  /**
+   * @async
+   * Starts a daemon and a client associated with it.
+   * @returns {void}
+   */
+  async start () {
+    if (this._client) {
+      throw new Error('Daemon has already started')
+    }
+
+    // start daemon
+    await this._startDaemon()
+
+    // start client
+    this._client = new Client(this._sock)
+
+    await this._client.attach()
+  }
+
+  /**
+   * Starts the specifiec daemon and wait for its start.
+   * @returns {Promise}
+   */
+  _startDaemon () {
+    return new Promise((resolve, reject) => {
+      const options = this._type === 'go' ? ['-listen', `/unix${this._sock}`] : ['--sock', this._sock]
+      const daemon = execa(this._binPath, options)
+
+      daemon.stdout.once('data', () => {
+        return resolve()
+      })
+      daemon.stderr.once('data', (data) => {
+        return reject(data.toString())
+      })
+    })
+  }
+
+  /**
+   * @async
+   * Stops the daemon client and cleans the unix socket.
+   * @returns {void}
+   */
+  async stop () {
+    await this._client && this._client.close()
+    await this._cleanUnixSocket()
+  }
+
+  /**
+   * Cleans the unix socket.
+   * @returns {Promise}
+   */
+  _cleanUnixSocket () {
+    return new Promise((resolve, reject) => {
+      rimraf(this._sock, (err) => {
+        if (err) {
+          return reject(err)
+        }
+        resolve()
+      })
+    })
+  }
+
+  /**
+   * libp2p client instance
+   * @type {Client}
+   */
+  get client () {
+    return this._client
+  }
+}
+
+exports = module.exports = Daemon

PDD-CONTENT-ROUTING.md pdd/PDD-CONTENT-ROUTING.md

@@ -0,0 +1,9 @@
+'use strict'
+
+const os = require('os')
+const path = require('path')
+const isWindows = Boolean(os.type().match(/windows/gi))
+
+exports.getSockPath = (sockPath) => isWindows
+  ? path.join('\\\\?\\pipe', sockPath)
+  : path.resolve(os.tmpdir(), sockPath)

PDD-ENCRYPTED-COMMUNICATIONS.md pdd/PDD-ENCRYPTED-COMMUNICATIONS.md

@@ -0,0 +1,3 @@
+# Connect
+
+In this set of tests, we intend to guarantee that nodes implemented in a specific language are able to connect with nodes implemented in a different language.

PDD-HUNDREDS-OF-PEER-CONNECTIONS.md pdd/PDD-HUNDREDS-OF-PEER-CONNECTIONS.md

@@ -0,0 +1,47 @@
+/* eslint-env mocha */
+'use strict'
+
+const chai = require('chai')
+chai.use(require('dirty-chai'))
+chai.use(require('chai-checkmark'))
+const expect = chai.expect
+
+const Daemon = require('../../src/daemon')
+
+describe('connect', () => {
+  let goDaemon1
+  let goDaemon2
+
+  // Start Daemons
+  before(async function () {
+    this.timeout(20 * 1000)
+
+    goDaemon1 = new Daemon('go')
+    goDaemon2 = new Daemon('go', '/tmp/p2pd-go2.sock')
+
+    await goDaemon1.start()
+    await goDaemon2.start()
+  })
+
+  // Stop daemons
+  after(async function () {
+    await goDaemon1.stop()
+    await goDaemon2.stop()
+  })
+
+  it('go peer to go peer', async function () {
+    this.timeout(10 * 1000)
+
+    const identify1 = await goDaemon1.client.identify()
+
+    const knownPeersBeforeConnect = await goDaemon2.client.listPeers()
+    expect(knownPeersBeforeConnect).to.have.lengthOf(0)
+
+    // connect peers
+    await goDaemon2.client.connect(identify1.peerId, identify1.addrs)
+
+    const knownPeersAfterConnect = await goDaemon2.client.listPeers()
+    expect(knownPeersAfterConnect).to.have.lengthOf(1)
+    expect(knownPeersAfterConnect[0].toB58String()).to.equal(identify1.peerId.toB58String())
+  })
+})