Add env_logger and add force-debug feature (#1205)

* add env_logger and add force-debug feature * taplo fmt, fix copyrights * Update zrml/styx/src/mock.rs Co-authored-by: Malte Kliemann <[email protected]> * Update zrml/rikiddo/src/mock.rs Co-authored-by: Malte Kliemann <[email protected]> * update comment to clarify logging --------- Co-authored-by: Malte Kliemann <[email protected]>
zeitgeistpm · Dec 12, 2023 · 8790095 · 8790095
1 parent 53b0f64
commit 8790095
Show file tree

Hide file tree

Showing 31 changed files with 86 additions and 5 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -190,6 +190,7 @@ sp-arithmetic = { git = "https://github.com/paritytech/substrate", branch = "pol
 sp-block-builder = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.38", default-features = false }
 sp-consensus-aura = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.38", default-features = false }
 sp-core = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.38", default-features = false }
+sp-debug-derive = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.38", default-features = false }
 sp-finality-grandpa = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.38", default-features = false }
 sp-inherents = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.38", default-features = false }
 sp-io = { git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.38", default-features = false }
@@ -246,6 +247,7 @@ zrml-swaps-runtime-api = { path = "zrml/swaps/runtime-api", default-features = f
 
 # Other (client)
 clap = "4.0.32"
+env_logger = "0.10.1"
 jsonrpsee = "0.16.2"
 libfuzzer-sys = "0.4.7"
 more-asserts = "0.3.1"

diff --git a/runtime/battery-station/Cargo.toml b/runtime/battery-station/Cargo.toml
@@ -37,6 +37,7 @@ scale-info = { workspace = true, features = ["derive"] }
 sp-api = { workspace = true }
 sp-block-builder = { workspace = true }
 sp-core = { workspace = true }
+sp-debug-derive = { workspace = true }
 sp-inherents = { workspace = true }
 sp-offchain = { workspace = true }
 sp-runtime = { workspace = true }
@@ -412,6 +413,8 @@ try-runtime = [
     "cumulus-pallet-xcmp-queue?/try-runtime",
     "parachain-info?/try-runtime",
 ]
+# Allow to print logs details (no wasm:stripped)
+force-debug = ["sp-debug-derive/force-debug"]
 
 [package]
 authors = ["Zeitgeist PM <[email protected]>"]

diff --git a/runtime/zeitgeist/Cargo.toml b/runtime/zeitgeist/Cargo.toml
@@ -36,6 +36,7 @@ scale-info = { workspace = true, features = ["derive"] }
 sp-api = { workspace = true }
 sp-block-builder = { workspace = true }
 sp-core = { workspace = true }
+sp-debug-derive = { workspace = true }
 sp-inherents = { workspace = true }
 sp-offchain = { workspace = true }
 sp-runtime = { workspace = true }
@@ -401,6 +402,8 @@ try-runtime = [
     "cumulus-pallet-xcmp-queue?/try-runtime",
     "parachain-info?/try-runtime",
 ]
+# Allow to print logs details (no wasm:stripped)
+force-debug = ["sp-debug-derive/force-debug"]
 
 [package]
 authors = ["Zeitgeist PM <[email protected]>"]

diff --git a/scripts/benchmarks/quick_check.sh b/scripts/benchmarks/quick_check.sh
@@ -25,6 +25,7 @@ export PROFILE=release
 export PROFILE_DIR=release
 export ADDITIONAL_PARAMS=--detailed-log-output
 export EXECUTION=native
-export ADDITIONAL_FEATURES=""
+# force-debug for no <wasm::stripped> output
+export ADDITIONAL_FEATURES="force-debug"
 
 source ./scripts/benchmarks/run_benchmarks.sh
diff --git a/zrml/authorized/Cargo.toml b/zrml/authorized/Cargo.toml
@@ -9,6 +9,7 @@ zeitgeist-primitives = { workspace = true }
 zrml-market-commons = { workspace = true }
 
 [dev-dependencies]
+env_logger = { workspace = true }
 pallet-balances = { workspace = true, features = ["default"] }
 pallet-timestamp = { workspace = true, features = ["default"] }
 sp-io = { workspace = true, features = ["default"] }

diff --git a/zrml/authorized/src/mock.rs b/zrml/authorized/src/mock.rs
@@ -201,6 +201,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         pallet_balances::GenesisConfig::<Runtime> { balances: self.balances }
             .assimilate_storage(&mut t)
             .unwrap();

diff --git a/zrml/court/Cargo.toml b/zrml/court/Cargo.toml
@@ -13,6 +13,7 @@ zeitgeist-primitives = { workspace = true }
 zrml-market-commons = { workspace = true }
 
 [dev-dependencies]
+env_logger = { workspace = true }
 pallet-balances = { workspace = true, features = ["default"] }
 pallet-randomness-collective-flip = { workspace = true, features = ["default"] }
 pallet-timestamp = { workspace = true, features = ["default"] }

diff --git a/zrml/court/src/mock.rs b/zrml/court/src/mock.rs
@@ -257,6 +257,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         pallet_balances::GenesisConfig::<Runtime> { balances: self.balances }
             .assimilate_storage(&mut t)
             .unwrap();

diff --git a/zrml/global-disputes/Cargo.toml b/zrml/global-disputes/Cargo.toml
@@ -14,6 +14,7 @@ num-traits = { workspace = true, optional = true }
 
 
 [dev-dependencies]
+env_logger = { workspace = true }
 pallet-balances = { workspace = true, features = ["default"] }
 pallet-timestamp = { workspace = true, features = ["default"] }
 sp-io = { workspace = true, features = ["default"] }

diff --git a/zrml/global-disputes/src/mock.rs b/zrml/global-disputes/src/mock.rs
@@ -199,6 +199,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         pallet_balances::GenesisConfig::<Runtime> { balances: self.balances }
             .assimilate_storage(&mut t)
             .unwrap();

diff --git a/zrml/liquidity-mining/Cargo.toml b/zrml/liquidity-mining/Cargo.toml
@@ -10,6 +10,7 @@ zeitgeist-primitives = { workspace = true }
 zrml-market-commons = { workspace = true }
 
 [dev-dependencies]
+env_logger = { workspace = true }
 pallet-balances = { workspace = true, features = ["default"] }
 pallet-timestamp = { workspace = true, features = ["default"] }
 sp-io = { workspace = true, features = ["default"] }

diff --git a/zrml/liquidity-mining/src/mock.rs b/zrml/liquidity-mining/src/mock.rs
@@ -138,6 +138,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         crate::GenesisConfig::<Runtime> {
             initial_balance: self.initial_balance,
             per_block_distribution: self.per_block_incentives,

diff --git a/zrml/market-commons/Cargo.toml b/zrml/market-commons/Cargo.toml
@@ -8,6 +8,7 @@ sp-runtime = { workspace = true }
 zeitgeist-primitives = { workspace = true }
 
 [dev-dependencies]
+env_logger = { workspace = true }
 pallet-balances = { workspace = true, features = ["default"] }
 pallet-timestamp = { workspace = true, features = ["default"] }
 sp-io = { workspace = true, features = ["default"] }

diff --git a/zrml/market-commons/src/mock.rs b/zrml/market-commons/src/mock.rs
@@ -106,6 +106,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         pallet_balances::GenesisConfig::<Runtime> { balances: vec![] }
             .assimilate_storage(&mut t)
             .unwrap();

diff --git a/zrml/neo-swaps/Cargo.toml b/zrml/neo-swaps/Cargo.toml
@@ -14,6 +14,7 @@ zrml-market-commons = { workspace = true }
 
 # Mock
 
+env_logger = { workspace = true, optional = true }
 orml-asset-registry = { workspace = true, optional = true }
 orml-currencies = { workspace = true, optional = true }
 orml-tokens = { workspace = true, optional = true }
@@ -38,7 +39,6 @@ zrml-rikiddo = { workspace = true, optional = true }
 zrml-simple-disputes = { workspace = true, optional = true }
 zrml-swaps = { workspace = true, optional = true }
 
-
 [dev-dependencies]
 more-asserts = { workspace = true }
 test-case = { workspace = true }
@@ -77,6 +77,7 @@ mock = [
     "zrml-prediction-markets/mock",
     "zrml-prediction-markets/default",
     "serde/default",
+    "env_logger/default",
 ]
 parachain = ["zrml-prediction-markets/parachain"]
 runtime-benchmarks = [

diff --git a/zrml/neo-swaps/src/mock.rs b/zrml/neo-swaps/src/mock.rs
@@ -480,6 +480,8 @@ impl Default for ExtBuilder {
 impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
         pallet_balances::GenesisConfig::<Runtime> { balances: self.balances }
             .assimilate_storage(&mut t)
             .unwrap();

diff --git a/zrml/orderbook/Cargo.toml b/zrml/orderbook/Cargo.toml
@@ -10,6 +10,7 @@ sp-runtime = { workspace = true }
 zeitgeist-primitives = { workspace = true }
 
 # Mock
+env_logger = { workspace = true, optional = true }
 orml-currencies = { workspace = true, optional = true }
 orml-tokens = { workspace = true, optional = true }
 pallet-balances = { workspace = true, optional = true }
@@ -31,6 +32,7 @@ mock = [
     "orml-currencies/default",
     "sp-io/default",
     "zeitgeist-primitives/mock",
+    "env_logger/default",
 ]
 runtime-benchmarks = [
     "frame-benchmarking/runtime-benchmarks",

diff --git a/zrml/orderbook/src/mock.rs b/zrml/orderbook/src/mock.rs
@@ -150,6 +150,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         pallet_balances::GenesisConfig::<Runtime> { balances: self.balances }
             .assimilate_storage(&mut t)
             .unwrap();

diff --git a/zrml/parimutuel/Cargo.toml b/zrml/parimutuel/Cargo.toml
@@ -10,6 +10,7 @@ zeitgeist-primitives = { workspace = true }
 zrml-market-commons = { workspace = true }
 
 [dev-dependencies]
+env_logger = { workspace = true }
 orml-currencies = { workspace = true, features = ["default"] }
 orml-tokens = { workspace = true, features = ["default"] }
 pallet-balances = { workspace = true, features = ["default"] }

diff --git a/zrml/parimutuel/src/mock.rs b/zrml/parimutuel/src/mock.rs
@@ -199,6 +199,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         pallet_balances::GenesisConfig::<Runtime> { balances: self.balances }
             .assimilate_storage(&mut t)
             .unwrap();

diff --git a/zrml/prediction-markets/Cargo.toml b/zrml/prediction-markets/Cargo.toml
@@ -18,6 +18,7 @@ zrml-simple-disputes = { workspace = true }
 
 # Mock
 
+env_logger = { workspace = true, optional = true }
 orml-asset-registry = { workspace = true, optional = true }
 orml-currencies = { workspace = true, optional = true }
 orml-tokens = { workspace = true, optional = true }
@@ -57,6 +58,7 @@ mock = [
     "zrml-swaps/default",
     "xcm/default",
     "orml-asset-registry/default",
+    "env_logger/default",
 ]
 parachain = []
 runtime-benchmarks = [

diff --git a/zrml/prediction-markets/src/mock.rs b/zrml/prediction-markets/src/mock.rs
@@ -480,6 +480,9 @@ impl ExtBuilder {
     pub fn build(self) -> sp_io::TestExternalities {
         let mut t = frame_system::GenesisConfig::default().build_storage::<Runtime>().unwrap();
 
+        // see the logs in tests when using `RUST_LOG=debug cargo test -- --nocapture`
+        let _ = env_logger::builder().is_test(true).try_init();
+
         pallet_balances::GenesisConfig::<Runtime> { balances: self.balances }
             .assimilate_storage(&mut t)
             .unwrap();