Merge pull request #54 from holochain/emit-signal

signal handling

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
    matrix:
     os: [
      ubuntu-latest,
-     macos-latest
+#     macos-latest
     ]
 #    node: [ '10', '12', '14' ]
     node: [ '14' ]
@@ -22,7 +22,7 @@ jobs:
      with:
       # borrowed from
       # https://github.com/holochain/holochain/blob/6b47b136bc419be6e85000a08a59f67b4c46226c/docs/core_testing.md#requirements
-      toolchain: stable-2020-08-03
+      toolchain: stable #-2020-12-18
       target: wasm32-unknown-unknown
       default: true
   # todo: this install holochain step can be removed/simplified

Cargo.toml

@@ -1,6 +1,6 @@
 [workspace]
 members = [
-  "test/e2e/fixture/zomes/link"
+  "test/e2e/fixture/zomes/test"
 ]
 
 [profile.dev]

README.md

@@ -9,7 +9,7 @@ An end-to-end/scenario testing framework for Holochain applications, written in
 
 Tryorama allows you to write test suites about the behavior of multiple Holochain nodes which are networked together, while ensuring that test nodes in different tests do not accidentally join a network together.
 
-Note: this version of tryorama is tested against holochain rev cf4e72416e5afbf29b86d66a3d47ab2f9f6a65d2.  Please see [testing Readme](test/README.md) for details on how to run tryorama's own tests.
+Note: this version of tryorama is tested against holochain rev 60a906212c17ee067b31511e6b2957746d86297b.  Please see [testing Readme](test/README.md) for details on how to run tryorama's own tests.
 
 ```bash
 npm install @holochain/tryorama
@@ -120,6 +120,22 @@ const report = await orchestrator.run()
 console.log(report)
 ```
 
+### Signals:
+You can add signal handling to your tryorama tests by calling `setSignalHandler` on a player.  Here is an example from tryorama's own test suite with a zome that emits a signal with value it's called:
+
+``` javascript
+        orchestrator.registerScenario('loopback signal zome call', async (s: ScenarioApi) => {
+            const sentPayload = {value: "foo"};
+            const [alice] = await s.players([conductorConfig])
+            alice.setSignalHandler((signal) => {
+                console.log("Received Signal:",signal)
+                t.deepEqual(signal.data.payload, sentPayload)
+            })
+            const [[alice_happ]] = await alice.installAgentsHapps(installApps)
+            await alice_happ.cells[0].call('test', 'signal_loopback', sentPayload);
+        })
+```
+
 ### Networking and tests:
 
 By default tryorama assumes un-bootstrapped `Quic` networking.

ci_scripts/install-holochain.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-REV=cf4e72416e5afbf29b86d66a3d47ab2f9f6a65d2
+REV=60a906212c17ee067b31511e6b2957746d86297b
 
 cargo install --force holochain \
   --git https://github.com/holochain/holochain.git \

ci_scripts/run-test.sh

@@ -1,10 +1,10 @@
 #!/bin/bash
 echo `pwd`
-cd test/e2e/fixture/zomes/link
+cd test/e2e/fixture/zomes/test
 cargo build --release --target wasm32-unknown-unknown --target-dir ./target
-cp target/wasm32-unknown-unknown/release/test_wasm_link.wasm ../../../link.dna.workdir
+cp target/wasm32-unknown-unknown/release/test_wasm.wasm ../../../test.dna.workdir/test.wasm
 cd ../../..
-dna-util -c link.dna.workdir
+dna-util -c test.dna.workdir
 cd ../..
 npm install
 npm run test

package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/holochain/tryorama"
   },
-  "version": "0.4.0-dev.2",
+  "version": "0.4.0-dev.3",
   "description": "test framework for holochain hApps",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/api.ts

@@ -141,21 +141,22 @@ export class ScenarioApi {
   _createLocalPlayerBuilder = async (playerName: string, configSeed: T.ConfigSeed): Promise<PlayerBuilder> => {
     return async () => {
       const partialConfigSeedArgs = await localConfigSeedArgs()
-      const configJson = this._generateConfigFromSeed(partialConfigSeedArgs, playerName, configSeed)
+      const configYaml = this._generateConfigFromSeed(partialConfigSeedArgs, playerName, configSeed)
       const { adminInterfacePort, configDir } = partialConfigSeedArgs
-      await fs.writeFile(getConfigPath(configDir), YAML.stringify(configJson))
+      await fs.writeFile(getConfigPath(configDir), YAML.stringify(configYaml))
+
       logger.debug('api.players: player config committed for %s', playerName)
         return new Player({
-        scenarioUUID: this._uuid,
-        name: playerName,
-        config: configJson,
-        configDir,
-        adminInterfacePort,
-        spawnConductor: spawnLocal,
-        onJoin: () => console.log("FIXME: ignoring onJoin"),//instances.forEach(instance => this._waiter.addNode(instance.dna, playerName)),
-        onLeave: () => console.log("FIXME: ignoring onLeave"),//instances.forEach(instance => this._waiter.removeNode(instance.dna, playerName)),
-        onActivity: () => this._restartTimer(),
-        onSignal: (signal_data) => {},
+          scenarioUUID: this._uuid,
+          name: playerName,
+          config: configYaml,
+          configDir,
+          adminInterfacePort,
+          spawnConductor: spawnLocal,
+          onJoin: () => console.log("FIXME: ignoring onJoin"),//instances.forEach(instance => this._waiter.addNode(instance.dna, playerName)),
+          onLeave: () => console.log("FIXME: ignoring onLeave"),//instances.forEach(instance => this._waiter.removeNode(instance.dna, playerName)),
+          onActivity: () => this._restartTimer(),
+          onSignal: (signal) => {console.info("got signal, doing nothing with it: %o", signal)},
       })
     }
   }

src/conductor.ts

@@ -25,7 +25,7 @@ export type CallAdminFunc = (method: string, params: Record<string, any>) => Pro
 export class Conductor {
 
   name: string
-  onSignal: ({ instanceId: string, signal: Signal }) => void
+  onSignal: (Signal) => void
   logger: any
   kill: KillFn
   adminClient: AdminWebsocket | null
@@ -120,8 +120,8 @@ export class Conductor {
     const { port: appInterfacePort } = await this.adminClient.attachAppInterface({ port: 0 })
     const appWsUrl = `ws://${this._machineHost}:${appInterfacePort}`
     this.appClient = await AppWebsocket.connect(appWsUrl, (signal) => {
-      this._onActivity()
-      console.info("got signal, doing nothing with it: %o", signal)
+      this._onActivity();
+      this.onSignal(signal);
     })
     this.logger.debug(`connectInterfaces :: connected app interface at ${appWsUrl}`)
   }

src/config/spawn.ts

@@ -69,7 +69,7 @@ export const spawnLocal: T.SpawnConductorFn = async (player: Player, { handleHoo
         handle.kill(...args)
         return killPromise
       },
-      onSignal: player.onSignal.bind(player),
+      onSignal: player.onSignal,//player.onSignal.bind(player),
       onActivity: player.onActivity,
       machineHost: `localhost`,
       adminPort: player._adminInterfacePort,

src/player.ts

@@ -17,7 +17,7 @@ type ConstructorArgs = {
   config: RawConductorConfig,
   configDir: string,
   adminInterfacePort: number,
-  onSignal: ({ instanceId: string, signal: Signal }) => void,
+  onSignal: (Signal) => void,
   onJoin: () => void,
   onLeave: () => void,
   onActivity: () => void,
@@ -39,7 +39,7 @@ export class Player {
   config: RawConductorConfig
   onJoin: () => void
   onLeave: () => void
-  onSignal: ({ instanceId: string, signal: Signal }) => void
+  onSignal: (Signal) => void
   onActivity: () => void
   scenarioUUID: string
 
@@ -158,6 +158,13 @@ export class Player {
     return this._conductor!._installHapp(happ)
   }
 
+  setSignalHandler = (handler) => {
+    this.onSignal = handler
+    if (this._conductor) {
+      this._conductor.onSignal = handler
+    }
+  }
+
   _conductorGuard = (context) => {
     if (this._conductor === null) {
       const msg = `Attempted conductor action when no conductor is running! You must \`.startup()\` first.\nAction: ${context}`

test/README.md

@@ -29,7 +29,7 @@ When updating tryorama against a new version of holochain please replace the old
 
 ```
 ./README.md
- test/e2e/fixture/zomes/link/Cargo.toml
+ test/e2e/fixture/zomes/test/Cargo.toml
 ci_scripts/install-holochain.sh
 ```
 

test/e2e/fixture/zomes/link/Cargo.toml → test/e2e/fixture/zomes/test/Cargo.toml

@@ -1,14 +1,14 @@
 [package]
-name = "test_wasm_link"
+name = "test_wasm"
 version = "0.0.1"
 authors = [ "thedavidmeister", "thedavidmeister@gmail.com" ]
 edition = "2018"
 
 [lib]
-name = "test_wasm_link"
+name = "test_wasm"
 crate-type = [ "cdylib", "rlib" ]
 
 [dependencies]
-hdk3 = { git = "https://github.com/holochain/holochain", rev = "cf4e72416e5afbf29b86d66a3d47ab2f9f6a65d2", package = "hdk3" }
+hdk3 = { git = "https://github.com/holochain/holochain", rev = "60a906212c17ee067b31511e6b2957746d86297b", package = "hdk3" }
 serde = "1.0.104"
-test_wasm_common = { git = "https://github.com/holochain/holochain", rev = "cf4e72416e5afbf29b86d66a3d47ab2f9f6a65d2", package = "test_wasm_common" }
+test_wasm_common = { git = "https://github.com/holochain/holochain", rev = "60a906212c17ee067b31511e6b2957746d86297b", package = "test_wasm_common" }

test/e2e/fixture/zomes/link/src/lib.rs → test/e2e/fixture/zomes/test/src/lib.rs

@@ -38,3 +38,14 @@ fn delete_all_links(_: ()) -> ExternResult<()> {
     }
     Ok(())
 }
+
+#[derive(Serialize, Deserialize, SerializedBytes, Debug)]
+pub struct LoopBack {
+    value: String,
+}
+
+#[hdk_extern]
+fn signal_loopback(value: LoopBack) -> ExternResult<()> {
+    emit_signal(&value)?;
+    Ok(())
+}

test/e2e/index.ts

@@ -10,7 +10,7 @@ process.on('unhandledRejection', error => {
   console.error('****************************');
 });
 
-const dnaLocationLocal = path.join(__dirname, 'link.dna.gz')
+const dnaLocationLocal = path.join(__dirname, 'test.dna.gz')
 
 const localOrchestrator = (extra = {}) => new Orchestrator({
   middleware: compose(runSeries(), localOnly),
@@ -21,3 +21,4 @@ const localOrchestrator = (extra = {}) => new Orchestrator({
 require('./test-always-on')(localOrchestrator, () => testConfig(dnaLocationLocal))
 // require('./test-always-on')(singleConductorOrchestrator, () => testConfig(dnaLocationLocal))
 require('./test-dynamic-on')(localOrchestrator, () => testConfig(dnaLocationLocal))
+require('./test-signal')(localOrchestrator, () => testConfig(dnaLocationLocal))