feat: export binary from @helia/interop (#384)

To prevent things like transient deps breaking Kubo interop tests, export a bin to allow installing the interop tests from npm and running them in an easy-to-digest way.
ipfs · Jan 17, 2024 · 3477b27 · 3477b27
1 parent c8d2fac
commit 3477b27
Show file tree

Hide file tree

Showing 28 changed files with 50 additions and 6 deletions.
diff --git a/packages/interop/.aegir.js b/packages/interop/.aegir.js
@@ -5,6 +5,7 @@ import * as kuboRpcClient from 'kubo-rpc-client'
 /** @type {import('aegir').PartialOptions} */
 export default {
   test: {
+    files: './dist/src/*.spec.js',
     before: async (options) => {
       if (options.runner !== 'node') {
         const ipfsdPort = await getPort()

diff --git a/packages/interop/README.md b/packages/interop/README.md
@@ -11,6 +11,17 @@
 
 > Interop tests for Helia
 
+# About
+
+Runs interop tests between Helia and Kubo.
+
+## Example - Testing a new Kubo release
+
+```console
+$ npm i @helia/interop
+$ KUBO_BINARY=/path/to/kubo helia-interop
+```
+
 # Install
 
 ```console

diff --git a/packages/interop/package.json b/packages/interop/package.json
@@ -18,6 +18,9 @@
   "keywords": [
     "IPFS"
   ],
+  "bin": {
+    "helia-interop": "./dist/src/bin.js"
+  },
   "type": "module",
   "types": "./dist/src/index.d.ts",
   "files": [
@@ -52,7 +55,7 @@
     "test:node": "aegir test -t node --cov",
     "test:electron-main": "aegir test -t electron-main"
   },
-  "devDependencies": {
+  "dependencies": {
     "@helia/block-brokers": "^1.0.0",
     "@helia/car": "^2.0.1",
     "@helia/dag-cbor": "^2.0.1",
@@ -88,8 +91,9 @@
     "wherearewe": "^2.0.1"
   },
   "browser": {
-    "./dist/test/fixtures/create-helia.js": "./dist/test/fixtures/create-helia.browser.js",
-    "./dist/test/fixtures/create-kubo.js": "./dist/test/fixtures/create-kubo.browser.js",
+    "./dist/src/fixtures/create-helia.js": "./dist/src/fixtures/create-helia.browser.js",
+    "./dist/src/fixtures/create-kubo.js": "./dist/src/fixtures/create-kubo.browser.js",
+    "./dist/src/bin.js": "./dist/src/index.js",
     "kubo": false
   }
 }
diff --git a/packages/interop/src/bin.ts b/packages/interop/src/bin.ts
@@ -0,0 +1,18 @@
+#! /usr/bin/env node
+/* eslint-disable no-console */
+
+import { spawn } from 'node:child_process'
+
+const test = spawn('npx', ['aegir', 'test'])
+
+test.stdout.on('data', (data) => {
+  process.stdout.write(data)
+})
+
+test.stderr.on('data', (data) => {
+  process.stderr.write(data)
+})
+
+test.on('close', (code) => {
+  process.exit(code ?? 0)
+})
diff --git a/packages/interop/test/car.spec.ts → packages/interop/src/car.spec.ts b/packages/interop/test/car.spec.ts → packages/interop/src/car.spec.ts
diff --git a/packages/interop/test/dag-cbor.spec.ts → packages/interop/src/dag-cbor.spec.ts b/packages/interop/test/dag-cbor.spec.ts → packages/interop/src/dag-cbor.spec.ts
diff --git a/packages/interop/test/dag-json.spec.ts → packages/interop/src/dag-json.spec.ts b/packages/interop/test/dag-json.spec.ts → packages/interop/src/dag-json.spec.ts
diff --git a/packages/interop/test/fixtures/connect.ts → packages/interop/src/fixtures/connect.ts b/packages/interop/test/fixtures/connect.ts → packages/interop/src/fixtures/connect.ts
diff --git a/...rop/test/fixtures/create-helia.browser.ts → ...erop/src/fixtures/create-helia.browser.ts b/...rop/test/fixtures/create-helia.browser.ts → ...erop/src/fixtures/create-helia.browser.ts
diff --git a/...ges/interop/test/fixtures/create-helia.ts → ...ages/interop/src/fixtures/create-helia.ts b/...ges/interop/test/fixtures/create-helia.ts → ...ages/interop/src/fixtures/create-helia.ts
diff --git a/...erop/test/fixtures/create-kubo.browser.ts → ...terop/src/fixtures/create-kubo.browser.ts b/...erop/test/fixtures/create-kubo.browser.ts → ...terop/src/fixtures/create-kubo.browser.ts
diff --git a/...ages/interop/test/fixtures/create-kubo.ts → packages/interop/src/fixtures/create-kubo.ts b/...ages/interop/test/fixtures/create-kubo.ts → packages/interop/src/fixtures/create-kubo.ts
diff --git a/.../interop/test/fixtures/create-peer-ids.ts → ...s/interop/src/fixtures/create-peer-ids.ts b/.../interop/test/fixtures/create-peer-ids.ts → ...s/interop/src/fixtures/create-peer-ids.ts
diff --git a/packages/interop/test/fixtures/key-types.ts → packages/interop/src/fixtures/key-types.ts b/packages/interop/test/fixtures/key-types.ts → packages/interop/src/fixtures/key-types.ts
diff --git a/packages/interop/test/fixtures/memory-car.ts → packages/interop/src/fixtures/memory-car.ts b/packages/interop/test/fixtures/memory-car.ts → packages/interop/src/fixtures/memory-car.ts
diff --git a/packages/interop/test/fixtures/wait-for.ts → packages/interop/src/fixtures/wait-for.ts b/packages/interop/test/fixtures/wait-for.ts → packages/interop/src/fixtures/wait-for.ts
diff --git a/...ges/interop/test/helia-blockstore.spec.ts → ...ages/interop/src/helia-blockstore.spec.ts b/...ges/interop/test/helia-blockstore.spec.ts → ...ages/interop/src/helia-blockstore.spec.ts
diff --git a/packages/interop/test/helia-hashes.spec.ts → packages/interop/src/helia-hashes.spec.ts b/packages/interop/test/helia-hashes.spec.ts → packages/interop/src/helia-hashes.spec.ts
diff --git a/packages/interop/test/helia-pins.spec.ts → packages/interop/src/helia-pins.spec.ts b/packages/interop/test/helia-pins.spec.ts → packages/interop/src/helia-pins.spec.ts
diff --git a/packages/interop/src/index.ts b/packages/interop/src/index.ts
@@ -1 +1,14 @@
+/**
+ * @packageDocumentation
+ *
+ * Runs interop tests between Helia and Kubo.
+ *
+ * @example Testing a new Kubo release
+ *
+ * ```console
+ * $ npm i @helia/interop
+ * $ KUBO_BINARY=/path/to/kubo helia-interop
+ * ```
+ */
+
 export {}
diff --git a/packages/interop/test/ipns-libp2p.spec.ts → packages/interop/src/ipns-libp2p.spec.ts b/packages/interop/test/ipns-libp2p.spec.ts → packages/interop/src/ipns-libp2p.spec.ts
diff --git a/packages/interop/test/ipns-pubsub.spec.ts → packages/interop/src/ipns-pubsub.spec.ts b/packages/interop/test/ipns-pubsub.spec.ts → packages/interop/src/ipns-pubsub.spec.ts
diff --git a/packages/interop/test/json.spec.ts → packages/interop/src/json.spec.ts b/packages/interop/test/json.spec.ts → packages/interop/src/json.spec.ts
diff --git a/packages/interop/test/mfs.spec.ts → packages/interop/src/mfs.spec.ts b/packages/interop/test/mfs.spec.ts → packages/interop/src/mfs.spec.ts
diff --git a/packages/interop/test/strings.spec.ts → packages/interop/src/strings.spec.ts b/packages/interop/test/strings.spec.ts → packages/interop/src/strings.spec.ts
diff --git a/packages/interop/test/unixfs-bitswap.spec.ts → packages/interop/src/unixfs-bitswap.spec.ts b/packages/interop/test/unixfs-bitswap.spec.ts → packages/interop/src/unixfs-bitswap.spec.ts
diff --git a/packages/interop/test/unixfs-files.spec.ts → packages/interop/src/unixfs-files.spec.ts b/packages/interop/test/unixfs-files.spec.ts → packages/interop/src/unixfs-files.spec.ts
diff --git a/packages/interop/tsconfig.json b/packages/interop/tsconfig.json
@@ -23,9 +23,6 @@
     {
       "path": "../helia"
     },
-    {
-      "path": "../interface"
-    },
     {
       "path": "../ipns"
     },
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,9 +23,6 @@ @@
         {
           "path": "../helia"
         },
-        {
-          "path": "../interface"
-        },
         {
           "path": "../ipns"
         },
@@ Expand Down @@