[CBR-430] setupTestLogging and setupTestTrace

Signed-off-by: Alexander Diemand <[email protected]>

Author: CodiePP

explorer/test/Test/Pos/Explorer/Socket/MethodsSpec.hs

@@ -37,8 +37,7 @@ import           Pos.Explorer.Socket.Methods (addrSubParam, addressSetByTxs,
                      unsubscribeTxs)
 import           Pos.Explorer.TestUtil (secretKeyToAddress)
 import           Pos.Explorer.Web.ClientTypes (CAddress (..), toCAddress)
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 
 import           Test.Pos.Explorer.MockFactory (mkTxOut)
 
@@ -50,7 +49,7 @@ import           Test.Pos.Explorer.MockFactory (mkTxOut)
 -- stack test cardano-sl-explorer --fast --test-arguments "-m Test.Pos.Explorer.Socket"
 
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
     describe "Methods" $ do
         describe "fromCAddressOrThrow" $
             it "throws an exception if a given CAddress is invalid" $

generator/test/Test/Pos/Binary/CommunicationSpec.hs

@@ -17,8 +17,7 @@ import           Pos.DB.Class (Serialized (..))
 import           Pos.Network.Block.Types (MsgBlock (..),
                      MsgSerializedBlock (..))
 import           Pos.Util.CompileInfo (withCompileInfo)
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 
 import           Test.Pos.Block.Logic.Mode (blockPropertyTestable)
 import           Test.Pos.Block.Logic.Util (EnableTxPayload (..),
@@ -72,7 +71,7 @@ deserializeSerilizedMsgSerializedBlockSpec = do
     descNoBlock = "deserialization of a serialized MsgNoSerializedBlock message should give back corresponding MsgNoBlock"
 
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
     withStaticConfigurations $ \_ _ -> withCompileInfo $
         describe "Pos.Binary.Communication" $ do
             describe "serializeMsgSerializedBlock" serializeMsgSerializedBlockSpec

generator/test/Test/Pos/Block/Logic/VarSpec.hs

@@ -41,8 +41,7 @@ import           Pos.Generator.BlockEvent.DSL (BlockApplyResult (..),
                      runBlockEventGenT)
 import qualified Pos.GState as GS
 import           Pos.Launcher (HasConfigurations)
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 
 import           Test.Pos.Block.Logic.Event (BlockScenarioResult (..),
                      DbNotEquivalentToSnapshot (..), runBlockScenario)
@@ -61,7 +60,7 @@ import           Test.Pos.Util.QuickCheck.Property (splitIntoChunks,
 spec :: Spec
 -- Unfortunatelly, blocks generation is quite slow nowdays.
 -- See CSL-1382.
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $ withStaticConfigurations $ \txpConfig _ ->
+spec = beforeAll_ setupTestLogging $ withStaticConfigurations $ \txpConfig _ ->
     describe "Block.Logic.VAR" $ modifyMaxSuccess (min 4) $ do
         describe "verifyBlocksPrefix" $ verifyBlocksPrefixSpec txpConfig
         describe "verifyAndApplyBlocks" $ verifyAndApplyBlocksSpec txpConfig

lib/test/Test/Pos/Diffusion/BlockSpec.hs

@@ -45,9 +45,7 @@ import           Pos.Infra.Network.Types (Bucket (..))
 import           Pos.Infra.Reporting.Health.Types (HealthStatus (..))
 import           Pos.Logic.Pure (pureLogic)
 import           Pos.Logic.Types as Logic (Logic (..))
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Trace (wlogTrace, wsetupLogging)
-import           Pos.Util.Wlog (Severity (Debug))
+import           Pos.Util.Trace (setupTestTrace, wlogTrace)
 
 import           Test.Pos.Chain.Block.Arbitrary.Generate (generateMainBlock)
 
@@ -122,7 +120,7 @@ clientLogic = pureLogic
 
 withServer :: Transport -> Logic IO -> (NodeId -> IO t) -> IO t
 withServer transport logic k = do
-    logTrace <- liftIO $ wsetupLogging "test" (defaultTestConfiguration Debug) ("server.outboundqueue")
+    logTrace <- liftIO $ setupTestTrace
     -- Morally, the server shouldn't need an outbound queue, but we have to
     -- give one.
     oq <- liftIO $ OQ.new

lib/test/Test/Pos/Launcher/ConfigurationSpec.hs

@@ -11,14 +11,13 @@ import           Pos.Core.Slotting (Timestamp (..))
 import           Pos.Launcher.Configuration (ConfigurationOptions (..),
                      defaultConfigurationOptions, withConfigurationsM)
 import           Pos.Util.Config (ConfigurationException)
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 
 spec :: Spec
 spec = describe "Pos.Launcher.Configuration" $ do
     describe "withConfigurationsM" $ do
         it "should parse `lib/configuration.yaml` file" $ do
-            liftIO $ setupLogging "test" (defaultTestConfiguration Debug)
+            liftIO $ setupTestLogging
             startTime <- Timestamp . round . (* 1000000) <$> liftIO getPOSIXTime
             let cfo = defaultConfigurationOptions
                         { cfoFilePath = "./configuration.yaml"

networking/test/Test/NodeSpec.hs

@@ -35,9 +35,7 @@ import           Test.QuickCheck.Modifiers (NonEmptyList (..), getNonEmpty)
 
 import           Node
 import           Node.Message.Binary (binaryPacking)
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Trace (wsetupLogging)
-import           Pos.Util.Wlog (Severity (Debug))
+import           Pos.Util.Trace (setupTestTrace)
 import           Test.Util (HeavyParcel (..), Parcel (..), Payload (..),
                      TestState, deliveryTest, expected, makeInMemoryTransport,
                      makeTCPTransport, mkTestState, modifyTestState,
@@ -46,7 +44,7 @@ import           Test.Util (HeavyParcel (..), Parcel (..), Payload (..),
 spec :: Spec
 spec = describe "Node" $ modifyMaxSuccess (const 50) $ do
 
-    logTrace <- runIO $ wsetupLogging "test" (defaultTestConfiguration Debug) "nodespec"
+    logTrace <- runIO $ setupTestTrace
 
         -- Take at most 25000 bytes for each Received message.
         -- We want to ensure that the MTU works, but not make the tests too

util/src/Pos/Util/Trace.hs

@@ -13,7 +13,7 @@ module Pos.Util.Trace
     , Wlog.Severity (..)
     -- * trace setup
     , setupLogging
-    , wsetupLogging
+    , setupTestTrace
     , logTrace
     -- * log messages
     , logDebug
@@ -26,6 +26,7 @@ module Pos.Util.Trace
 import           Data.Functor.Contravariant (Contravariant (..), Op (..))
 import qualified Data.Text.IO as TIO
 import qualified Pos.Util.Log as Log
+import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
 import qualified Pos.Util.Wlog as Wlog
 import           Universum hiding (trace)
 
@@ -60,6 +61,10 @@ wsetupLogging cfoKey lc ln = do
     Wlog.setupLogging cfoKey lc
     return $ wlogTrace ln
 
+setupTestTrace :: IO (Trace IO (Wlog.Severity, Text))
+setupTestTrace =
+    wsetupLogging "test" (defaultTestConfiguration Wlog.Debug) "testing"
+
 trace :: Trace m s -> s -> m ()
 trace = getOp . runTrace
 

util/src/Pos/Util/Wlog.hs

@@ -15,6 +15,7 @@ module Pos.Util.Wlog
         , runNamedPureLog
           -- * Setup
         , setupLogging
+        , setupTestLogging
           -- * Logging functions
         , logDebug
         , logError
@@ -55,4 +56,4 @@ import           Pos.Util.Wlog.Compatibility (CanLog (..), HasLoggerName (..),
                      launchNamedPureLog, logDebug, logError, logInfo, logMCond,
                      logMessage, logNotice, logWarning, productionB,
                      removeAllHandlers, retrieveLogContent, runNamedPureLog,
-                     setupLogging, usingLoggerName)
+                     setupLogging, setupTestLogging, usingLoggerName)

util/src/Pos/Util/Wlog/Compatibility.hs

@@ -9,6 +9,7 @@ module Pos.Util.Wlog.Compatibility
          , dispatchEvents
          , LogEvent (..)
          , setupLogging
+         , setupTestLogging
            -- * Logging functions
          , logDebug
          , logError
@@ -56,8 +57,8 @@ import qualified Pos.Util.Log as Log
 import qualified Pos.Util.Log.Internal as Internal
 import           Pos.Util.Log.LoggerConfig (LogHandler (..),
                      LogSecurityLevel (..), LoggerConfig (..),
-                     defaultInteractiveConfiguration, lcLoggerTree, lhName,
-                     ltHandlers)
+                     defaultInteractiveConfiguration, defaultTestConfiguration,
+                     lcLoggerTree, lhName, ltHandlers)
 import           System.IO.Unsafe (unsafePerformIO)
 
 import           Universum
@@ -226,6 +227,10 @@ loggingHandler :: MVar LoggingHandler
 loggingHandler = unsafePerformIO $ do
     newMVar $ error "LoggingHandler MVar is not initialized."
 
+-- | setup logging used in tests
+setupTestLogging :: IO ()
+setupTestLogging = setupLogging "test" (defaultTestConfiguration Debug)
+
 -- | setup logging according to configuration @LoggerConfig@
 --   the backends (scribes) will be registered with katip
 setupLogging :: MonadIO m => Text -> LoggerConfig -> m ()

wallet-new/test/InternalAPISpec.hs

@@ -20,8 +20,7 @@ import           Pos.Client.KeyStorage (getSecretKeysPlain)
 import           Pos.Wallet.Web.Account (genSaveRootKey)
 
 import           Pos.Launcher (HasConfigurations)
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 import           Test.Pos.Util.QuickCheck.Property (assertProperty)
 
 import           Test.Hspec (Spec, beforeAll_, describe)
@@ -37,7 +36,7 @@ import           Servant
 {-# ANN module ("HLint: ignore Reduce duplication" :: Text) #-}
 
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
     withDefConfigurations $ \_ _ _ ->
         describe "development endpoint" $
         describe "secret-keys" $ modifyMaxSuccess (const 10) deleteAllSecretKeysSpec

wallet/test/Test/Pos/Wallet/Web/AddressSpec.hs

@@ -20,8 +20,7 @@ import           Pos.Client.Txp.Addresses (getFakeChangeAddress, getNewAddress)
 import           Pos.Core.Common (Address)
 import           Pos.Crypto (PassPhrase)
 
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 import           Pos.Wallet.Web.Account (GenSeed (..), genUniqueAddress)
 import           Pos.Wallet.Web.ClientTypes (AccountId, CAccountInit (..), caId)
 import           Pos.Wallet.Web.Error (WalletError (..))
@@ -37,7 +36,7 @@ import           Test.Pos.Wallet.Web.Util (importSingleWallet,
                      mostlyEmptyPassphrases)
 
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
             withDefConfigurations $ \_ _ _ ->
                 describe "Fake address has maximal possible size" $
                 modifyMaxSuccess (const 10) $ do

wallet/test/Test/Pos/Wallet/Web/Methods/BackupDefaultAddressesSpec.hs

@@ -9,8 +9,7 @@ import           Universum
 
 import           Pos.Launcher (HasConfigurations)
 
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 import           Pos.Wallet.Web.ClientTypes (CWallet (..))
 import           Pos.Wallet.Web.Methods.Restore (restoreWalletFromBackup)
 import           Test.Hspec (Spec, beforeAll_, describe)
@@ -23,7 +22,7 @@ import           Test.QuickCheck (Arbitrary (..))
 import           Test.QuickCheck.Monadic (pick)
 
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
             withDefConfigurations $ \_ _ _ ->
                 describe "restoreAddressFromWalletBackup" $ modifyMaxSuccess (const 10) $ do
                     restoreWalletAddressFromBackupSpec

wallet/test/Test/Pos/Wallet/Web/Methods/LogicSpec.hs

@@ -10,8 +10,7 @@ import           Universum
 import           Test.Hspec (Spec, beforeAll_, describe)
 import           Test.Hspec.QuickCheck (prop)
 
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 import           Pos.Wallet.Web.Methods.Logic (getAccounts, getWallets)
 
 import           Test.Pos.Configuration (withDefConfigurations)
@@ -20,7 +19,7 @@ import           Test.Pos.Wallet.Web.Mode (WalletProperty)
 
 -- TODO remove HasCompileInfo when MonadWalletWebMode will be splitted.
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
             withDefConfigurations $ \_ _ _ ->
                 describe "Pos.Wallet.Web.Methods" $ do
                     prop emptyWalletOnStarts emptyWallet

wallet/test/Test/Pos/Wallet/Web/Methods/PaymentSpec.hs

@@ -44,9 +44,8 @@ import qualified Pos.Wallet.Web.State.State as WS
 import           Pos.Wallet.Web.State.Storage (AddressInfo (..), wamAddress)
 import           Pos.Wallet.Web.Util (decodeCTypeOrFail, getAccountAddrsOrThrow)
 
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
 import           Pos.Util.Servant (encodeCType)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 
 import           Test.Pos.Chain.Genesis.Dummy (dummyConfig, dummyGenesisData)
 import           Test.Pos.Configuration (withDefConfigurations)
@@ -63,7 +62,7 @@ deriving instance Eq CTx
 
 -- TODO remove HasCompileInfo when MonadWalletWebMode will be splitted.
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
     withCompileInfo $
        withDefConfigurations $ \_ txpConfig _ ->
        describe "Wallet.Web.Methods.Payment" $ modifyMaxSuccess (const 10) $ do

wallet/test/Test/Pos/Wallet/Web/Tracking/SyncSpec.hs

@@ -25,8 +25,7 @@ import           Pos.Core.Chrono (nonEmptyOldestFirst, toNewestFirst)
 import           Pos.Crypto (emptyPassphrase)
 import           Pos.DB.Block (rollbackBlocks)
 import           Pos.Launcher (HasConfigurations)
-import           Pos.Util.Log.LoggerConfig (defaultTestConfiguration)
-import           Pos.Util.Wlog (Severity (Debug), setupLogging)
+import           Pos.Util.Wlog (setupTestLogging)
 import qualified Pos.Wallet.Web.State as WS
 import           Pos.Wallet.Web.State.Storage (WalletStorage (..))
 import           Pos.Wallet.Web.Tracking.Decrypt (WalletDecrCredentialsKey (..),
@@ -51,7 +50,7 @@ import           Test.Pos.Wallet.Web.Mode (walletPropertySpec)
 import           Test.Pos.Wallet.Web.Util (importSomeWallets, wpGenBlocks)
 
 spec :: Spec
-spec = beforeAll_ (setupLogging "test" (defaultTestConfiguration Debug)) $
+spec = beforeAll_ setupTestLogging $
     withDefConfigurations $ \_ _ _ -> do
         describe "Pos.Wallet.Web.Tracking.BListener" $ modifyMaxSuccess (const 10) $ do
             describe "Two applications and rollbacks" twoApplyTwoRollbacksSpec