[fix] #2457: Fix tests flakiness related to shut down on panic (#2474)

* [fix] #2457: Add shut down on panic configuration Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com> * [fix] #2457: Update docs Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com> * [fix] #2457: Fix linter checks Signed-off-by: Ales Tsurko <ales.tsurko@gmail.com>
hyperledger · Jul 14, 2022 · bf01205 · bf01205
1 parent 8c7d9d7
commit bf01205
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 2 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/cli/Cargo.toml b/cli/Cargo.toml
@@ -63,4 +63,5 @@ tokio = { version = "1.6.0", features = ["sync", "time", "rt", "io-util", "rt-mu
 warp = "0.3"
 
 [dev-dependencies]
+serial_test = "0.8.0"
 test_network = { version = "=2.0.0-pre-rc.5", path = "../core/test_network" }
diff --git a/cli/src/config.rs b/cli/src/config.rs
@@ -29,6 +29,8 @@ pub struct Configuration {
     pub private_key: PrivateKey,
     /// Disable coloring of the backtrace and error report on panic.
     pub disable_panic_terminal_colors: bool,
+    /// Iroha will shutdown on any panic if this option is set to `true`.
+    pub shutdown_on_panic: bool,
     /// `Kura` related configuration.
     #[config(inner)]
     pub kura: KuraConfiguration,
@@ -71,6 +73,7 @@ impl Default for Configuration {
             public_key,
             private_key,
             disable_panic_terminal_colors: bool::default(),
+            shutdown_on_panic: false,
             kura: KuraConfiguration::default(),
             sumeragi: sumeragi_configuration,
             torii: ToriiConfiguration::default(),

diff --git a/cli/src/lib.rs b/cli/src/lib.rs
@@ -252,7 +252,9 @@ where
 
         Self::start_listening_signal(Arc::clone(&notify_shutdown))?;
 
-        Self::prepare_panic_hook(notify_shutdown);
+        if config.shutdown_on_panic {
+            Self::prepare_panic_hook(notify_shutdown);
+        }
 
         let torii = Some(torii);
         Ok(Self {
@@ -367,10 +369,13 @@ fn domains(configuration: &config::Configuration) -> [Domain; 1] {
 mod tests {
     use std::{panic, thread};
 
+    use serial_test::serial;
+
     use super::*;
 
-    #[tokio::test]
     #[allow(clippy::panic)]
+    #[tokio::test]
+    #[serial]
     async fn iroha_should_notify_on_panic() {
         let notify = Arc::new(Notify::new());
         let hook = panic::take_hook();

diff --git a/docs/source/references/config.md b/docs/source/references/config.md
@@ -14,6 +14,7 @@ The following is the default configuration used by Iroha.
     "payload": "282ed9f3cf92811c3818dbc4ae594ed59dc1a2f78e4241e31924e101d6b1fb831c61faf8fe94e253b93114240394f79a607b7fa55f9e5a41ebec74b88055768b"
   },
   "DISABLE_PANIC_TERMINAL_COLORS": false,
+  "SHUTDOWN_ON_PANIC": false,
   "KURA": {
     "INIT_MODE": "strict",
     "BLOCK_STORE_PATH": "./blocks",
@@ -463,6 +464,16 @@ Has type `u64`. Can be configured via environment variable `QUEUE_TRANSACTION_TI
 86400000
 ```
 
+## `shutdown_on_panic`
+
+Iroha will shutdown on any panic if this option is set to `true`.
+
+Has type `bool`. Can be configured via environment variable `IROHA_SHUTDOWN_ON_PANIC`
+
+```json
+false
+```
+
 ## `sumeragi`
 
 `Sumeragi` related configuration.