@libp2p/interop 0.0.1 → 0.0.2

package/README.md

@@ -9,44 +9,52 @@
 
 This repository will be used for interop tests.
 
-## Lead Maintainer
-
-[Vasco Santos](https://github.com/vasco-santos)
-
 ## Usage
 
 ### Install
 
 ```
-> git clone git@github.com:libp2p/interop.git
-> cd interop
-> npm install
+> npm install @libp2p/interop
 ```
 
-### Run the tests
+### Running the tests
 
-```
-> npm test
-```
+Create a js file that configures the different types of daemon:
 
-#### Testing local daemons
+```js
+import { interopTests } from '@libp2p/interop'
+import type { Daemon, DaemonFactory } from '@libp2p/interop'
 
-It is possible to test local versions of the go and js daemons exporting the respective path before running the tests.
+async function createGoPeer (options: SpawnOptions): Promise<Daemon> {
+  // your implementation here
+}
 
-**Specifying the go-libp2p daemon**
-See the go-libp2p-daemon [install instructions](https://github.com/libp2p/go-libp2p-daemon#install) for building the local binary.
+async function createJsPeer (options: SpawnOptions): Promise<Daemon> {
+  // your implementation here
+}
 
-```sh
-$ LIBP2P_GO_BIN=$GOPATH/bin/p2pd npm run test
-```
+async function main () {
+  const factory: DaemonFactory = {
+    async spawn (options: SpawnOptions) {
+      if (options.type === 'go') {
+        return createGoPeer(options)
+      }
+
+      return createJsPeer(options)
+    }
+  }
 
-**Specifying the js-libp2p daemon**
-From the js-libp2p-daemon local repo checkout you can perform an `npm link` to create a binary, `jsp2pd` in the global npm space.
+  interopTests(factory)
+}
 
-```sh
-$ LIBP2P_JS_BIN=$(which jsp2pd) npm run test
+main().catch(err => {
+  console.error(err)
+  process.exit(1)
+})
 ```
 
+For an example, see the js-libp2p interop test runner.
+
 ## Contribute
 
 Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/ipfs-interop/issues)!
@@ -57,4 +65,7 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
 
 ## License
 
-MIT
+Licensed under either of
+
+ * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
+ * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)

package/dist/src/index.d.ts

@@ -16,5 +16,5 @@ export interface SpawnOptions {
 export interface DaemonFactory {
     spawn: (options: SpawnOptions) => Promise<Daemon>;
 }
-export default function interopTests(factory: DaemonFactory): Promise<void>;
+export declare function interopTests(factory: DaemonFactory): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,MAAM,EAAE,YAAY,CAAA;CACrB;AAED,oBAAY,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAA;AAClC,oBAAY,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,WAAW,CAAA;AAExD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,QAAQ,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,IAAI,CAAA;IACZ,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,WAAW,GAAG,UAAU,CAAA;CACxC;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;CAClD;AAED,wBAA8B,YAAY,CAAE,OAAO,EAAE,aAAa,iBAIjE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACzB,MAAM,EAAE,YAAY,CAAA;CACrB;AAED,oBAAY,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAA;AAClC,oBAAY,UAAU,GAAG,KAAK,GAAG,SAAS,GAAG,WAAW,CAAA;AAExD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,QAAQ,CAAA;IACd,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,IAAI,CAAA;IACZ,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,WAAW,GAAG,UAAU,CAAA;CACxC;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;CAClD;AAED,wBAAsB,YAAY,CAAE,OAAO,EAAE,aAAa,iBAIzD"}

package/dist/src/index.js

@@ -1,7 +1,7 @@
 import { connectTests } from './connect.js';
 import { dhtTests } from './dht/index.js';
 import { pubsubTests } from './pubsub/index.js';
-export default async function interopTests(factory) {
+export async function interopTests(factory) {
     await connectTests(factory);
     await dhtTests(factory);
     await pubsubTests(factory);

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAwB/C,MAAM,CAAC,OAAO,CAAC,KAAK,UAAU,YAAY,CAAE,OAAsB;IAChE,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;IAC3B,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAA;IACvB,MAAM,WAAW,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAwB/C,MAAM,CAAC,KAAK,UAAU,YAAY,CAAE,OAAsB;IACxD,MAAM,YAAY,CAAC,OAAO,CAAC,CAAA;IAC3B,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAA;IACvB,MAAM,WAAW,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interop",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Interoperability Tests for libp2p",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/interop#readme",