Merge pull request #414 from shutter-network/dev/third_party_messaging

ulope · web-flow · commit 67a063766bed · 2023-10-17T10:38:37.000+02:00
Third party messaging test
diff --git a/play/README.md b/play/README.md
@@ -16,6 +16,12 @@ export ROLLING_SHUTTER_BOOTSTRAP_SIGNING_KEY=479968ffa5ee4c84514a477a8f15f3db041
 export ROLLING_SHUTTER_CHAIN_GENESIS_KEYPER=0x440Dc6F164e9241F04d282215ceF2780cd0B755e
 ```
 
+## prepare psql (via docker)
+
+```
+docker run --rm -it -e POSTGRES_USER=$(whoami) -e POSTGRES_PASSWORD=password -e POSTGRES_DB=testdb -v /tmp:/tmp --net=host -v /tmp/projectdir:/home/circleci/project -v /tmp/datadir:/var/lib/postgresql/data cimg/postgres:13.9
+```
+
 ## keyper only test setup
 
 1. bb init; bb chain
@@ -49,3 +55,64 @@ Run `bb test-system`.
 
 Run `bb nitro` to start an arbitrum nitro test setup. This requires docker and
 docker-compose to be installed.
+
+## Running third party clients in a test
+
+There is an example test task `keyper-dkg-external`, that shows how a third
+party client can be addressed.
+
+Instead of three `keyper` instances, it starts only two and one external
+executable. That external executable can be defined with `BB_EXTERNAL_COMMAND`.
+For convenience, there is also the optional `BB_EXTERNAL_WD`, to manipulate the
+working directory of the external call.
+
+As an example, here is how one of the three original test keypers can be called
+manually:
+
+```
+BB_EXTERNAL_WD="$(pwd)" BB_EXTERNAL_COMMAND="../rolling-shutter/bin/rolling-shutter keyper --config work/keyper-dkg-external/keyper-2.toml" clojure -M:test keyper-dkg-external
+```
+
+### Parameters in the environment
+
+You can find the test system parameters in the environment of the
+`BB_EXTERNAL_COMMAND`, e.g.:
+
+```
+# run "/bin/sh -c env" as external command to dump the environment:
+BB_EXTERNAL_COMMAND="/bin/sh -c env" clojure -M:test keyper-dkg-external
+...
+# find the values in the test log:
+cat work/keyper-dkg-external/logs/keyper-external-*|grep KPR
+KPR_P2P_PORT=23102
+KPR_DKG_PHASE_LENGTH=8
+KPR_ENVIRONMENT=local
+KPR_ETHEREUM_URL=http://127.0.0.1:8545/
+KPR_DKG_START_BLOCK_DELTA=5
+KPR_HTTP_LISTEN_ADDRESS=:24003
+KPR_CONTRACTS_URL=http://127.0.0.1:8545/
+KPR_LISTEN_ADDRESSES=/ip4/127.0.0.1/tcp/23102
+```
+
+Here you see, that the keyper implementation under tests, should use port
+`23102` for its `p2p` connection, the ethereum node is running at
+`http://127.0.0.1:8545/` etc. Not all of these may be relevant to your
+implementation.
+
+### Self contained testrunner
+
+It is possible to compile the testrunner into a self contained `.jar` file, by
+running
+
+```
+clojure -T:build
+```
+
+If you have such a `sht-standalone.jar` you can run the above test (without the
+need to install clojure), by calling
+
+```
+BB_EXTERNAL_COMMAND="../rolling-shutter/bin/rolling-shutter keyper --config work/keyper-dkg-external/keyper-2.toml" java -jar sht-standalone.jar -M:test keyper-dkg-external
+```
+
+(The `circleci` integration tests make use of this.)
diff --git a/play/src/sht/build.clj b/play/src/sht/build.clj
@@ -98,6 +98,16 @@
   [{:keys [num-keypers]}]
   (mapv run-keyper (range num-keypers)))
 
+(defn run-external-command
+  [n]
+  (let [external (play/external-command n)]
+    {:run :process/run
+     :process/id (keyword "keyper-external")
+     :process/cmd (str (System/getenv "BB_EXTERNAL_COMMAND"))
+     :process/opts (:process/opts external)
+     :process/port (:process/p2p-port external)
+     :process/port-timeout 3000}))
+
 (defn run-p2pnode
   [n]
   (let [p2pnode (play/p2pnode-subcommand n)]
diff --git a/play/src/sht/dkg_test.clj b/play/src/sht/dkg_test.clj
@@ -507,13 +507,60 @@
                    {:check :keyper/ordered-eons-match
                     :keyper/num keyper
                     :keyper/ordered-eons [1201 1202]}])]})
+
+(defn test-keypers-dkg-with-external
+  [{:keys [num-keypers] :as conf}]
+  {:test/id :keyper-dkg-external
+   :test/conf conf
+   :test/description "distributed key generation with external keyper should work"
+   :test/steps [{:run :init/init
+                 :init/conf conf}
+                (for [keyper (range num-keypers 1)]
+                  {:check :keyper/meta-inf
+                   :keyper-num keyper})
+
+                (build/run-chain)
+                (build/run-node conf)
+                (build/run-p2pnodes conf)
+                (mapv build/run-keyper (range (- num-keypers 1)))
+                (build/run-external-command num-keypers)
+
+                {:run :process/run
+                 :process/id :boot
+                 :process/cmd '[bb boot]
+                 :process/wait true}
+
+                {:check :loop/until
+                 :loop/description "eon should exist for all keypers"
+                 :loop/timeout-ms (* 60 1000)
+                 :loop/checks (for [keyper (range (- num-keypers 1))]
+                                {:check :keyper/eon-exists
+                                 :keyper/num keyper
+                                 :keyper/eon 1})}
+
+                {:check :loop/until
+                 :loop/description "all keypers should succeed with the dkg process"
+                 :loop/timeout-ms (* 60 1000)
+                 :loop/checks (for [keyper (range (- num-keypers 1))]
+                                {:check :keyper/dkg-success
+                                 :keyper/eon 1
+                                 :keyper/num keyper})}
+
+                (for [keyper (range (- num-keypers 1))]
+                  [{:check :keyper/non-zero-activation-block
+                    :keyper/num keyper}
+                   {:check :keyper/ordered-eons-match
+                    :keyper/num keyper
+                    :keyper/ordered-eons [1]}])]})
+
 (defn generate-tests
   []
   (concat
    [(test-change-keyper-set)]
    (for [conf [{:num-keypers 3, :num-bootstrappers 2, :threshold 2}]
          f [test-keypers-dkg-generation
-            test-dkg-keypers-join-late]]
+            test-dkg-keypers-join-late
+            test-keypers-dkg-with-external]]
      (f conf))))
 
 (def tests (delay (generate-tests)))
diff --git a/play/src/sht/play.clj b/play/src/sht/play.clj
@@ -219,6 +219,28 @@
                               "EthereumURL" (format "http://127.0.0.1:%d/" ethereum-rpc-port)
                               "ContractsURL" (format "http://127.0.0.1:%d/" contracts-rpc-port)}}))
 
+;; -- external-command
+(defn external-command
+  [n]
+  (let [p2p-port (dec (+ keyper-base-port n))
+        work-dir (or (System/getenv "BB_EXTERNAL_WD")
+                     (System/getenv "PWD"))
+        ]
+    #:process{:cmd 'external-cmd
+              :p2p-port p2p-port
+              :opts {:dir work-dir
+                     :extra-env {
+                 "KPR_P2P_PORT" p2p-port
+                 "KPR_DKG_PHASE_LENGTH" 8
+                 "KPR_DKG_START_BLOCK_DELTA" 5
+                 "KPR_LISTEN_ADDRESSES" (format "/ip4/127.0.0.1/tcp/%d" p2p-port)
+                 "KPR_ENVIRONMENT" "local"
+                 "KPR_HTTP_LISTEN_ADDRESS" (format ":%d" (+ 24000 n))
+                 "KPR_ETHEREUM_URL" (format "http://127.0.0.1:%d/" ethereum-rpc-port)
+                 "KPR_CONTRACTS_URL" (format "http://127.0.0.1:%d/" contracts-rpc-port)}}
+              }
+    ))
+
 ;; -- mocknode-subcommand
 (defn mocknode-subcommand
   []
