Local configuration of the E2E test suite uses local-cluster

cardano-foundation · Oct 23, 2023 · 47de832 · 47de832
1 parent 5b84767
commit 47de832
Show file tree

Hide file tree

Showing 16 changed files with 327 additions and 208 deletions.
diff --git a/justfile b/justfile
@@ -19,9 +19,9 @@ e2e-preprod:
 
 # run wallet-e2e suite against the local test cluster
 e2e-local:
-  nix run '.#cardano-wallet-e2e' -- local \
-    -s lib/wallet-e2e/test-state \
-    -c lib/wallet-e2e/config/cardano-node/local
+  nix shell \
+    '.#local-cluster' '.#cardano-node' '.#cardano-wallet' '.#cardano-wallet-e2e' '.#local-cluster' \
+    -c wallet-e2e local -s lib/wallet-e2e/test-state -c lib/local-cluster/test/data/cluster-configs
 
 # run wallet-e2e suite against the manually started node/wallet
 e2e-manual:

diff --git a/lib/local-cluster/exe/Main.hs b/lib/local-cluster/exe/Main.hs
@@ -1,6 +1,6 @@
-import qualified Service
+import qualified Cardano.Wallet.LocalCluster as LocalCluster
 
 import Prelude
 
 main :: IO ()
-main = Service.main
+main = LocalCluster.main
diff --git a/lib/local-cluster/lib/Service.hs → ...luster/lib/Cardano/Wallet/LocalCluster.hs b/lib/local-cluster/lib/Service.hs → ...luster/lib/Cardano/Wallet/LocalCluster.hs
@@ -10,7 +10,7 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TemplateHaskell #-}
 
-module Service where
+module Cardano.Wallet.LocalCluster where
 
 import Prelude
 
@@ -42,6 +42,10 @@ import Cardano.Wallet.Launch.Cluster
 import Cardano.Wallet.Primitive.Types.Coin
     ( Coin (..)
     )
+import Control.Applicative
+    ( optional
+    , (<**>)
+    )
 import Control.Monad.Trans.Resource
     ( allocate
     , runResourceT
@@ -78,6 +82,7 @@ import qualified Cardano.Node.Cli.Launcher as NC
 import qualified Cardano.Wallet.Cli.Launcher as WC
 import qualified Cardano.Wallet.Faucet.Mnemonics as Mnemonics
 import qualified Cardano.Wallet.Launch.Cluster as Cluster
+import qualified Options.Applicative as O
 import qualified Path
 import qualified Path.IO as PathIO
 
@@ -213,7 +218,9 @@ main = withUtf8 $ do
         cfgNodeLogging <-
             Cluster.logFileConfigFromEnv
                 (Just (Cluster.clusterEraToString clusterEra))
-        cfgClusterConfigs <- getClusterConfigsPath
+        cfgClusterConfigs <- parseCommandLineOptions >>= \case
+            CommandLineOptions Nothing -> getClusterConfigsPathFromEnv
+            CommandLineOptions (Just path) -> pure path
         let clusterCfg = Cluster.Config
                 { cfgStakePools = Cluster.defaultPoolConfigs
                 , cfgLastHardFork = clusterEra
@@ -270,8 +277,25 @@ main = withUtf8 $ do
 -- | Returns a path to the local cluster configuration, which is usually relative to the
 -- package sources, but can be overridden by the @LOCAL_CLUSTER_CONFIGS@ environment
 -- variable.
-getClusterConfigsPath :: IO (Tagged "cluster-configs" FilePath)
-getClusterConfigsPath =
+getClusterConfigsPathFromEnv :: IO (Tagged "cluster-configs" FilePath)
+getClusterConfigsPathFromEnv =
     lookupEnvNonEmpty "LOCAL_CLUSTER_CONFIGS" <&> Tagged . \case
         Nothing -> $(getTestData) </> "cluster-configs"
         Just fp -> fp
+
+
+newtype CommandLineOptions = CommandLineOptions
+    { clusterConfigsDir :: Maybe (Tagged "cluster-configs" FilePath)
+    }
+
+parseCommandLineOptions :: IO CommandLineOptions
+parseCommandLineOptions = O.execParser $
+    O.info (parser <**> O.helper) (O.progDesc "Local Cluster for testing")
+  where
+    parser = CommandLineOptions <$> optional (
+        Tagged <$> O.strOption
+            ( O.long "cluster-configs"
+            <> O.metavar "LOCAL_CLUSTER_CONFIGS"
+            <> O.help "Path to the local cluster configuration directory"
+            )
+        )
diff --git a/lib/local-cluster/local-cluster.cabal b/lib/local-cluster/local-cluster.cabal
@@ -49,7 +49,7 @@ library
     Cardano.Wallet.Faucet.Mnemonics
     Cardano.Wallet.Faucet.Shelley
     Cardano.Wallet.Launch.Cluster
-    Service
+    Cardano.Wallet.LocalCluster
 
   hs-source-dirs:  lib
   build-depends:
@@ -91,6 +91,7 @@ library
     , memory                             ^>=0.18
     , network-uri                        ^>=2.6.4.2
     , OddWord                            ^>=1.0.1
+    , optparse-applicative
     , ouroboros-network                  ^>=0.8.1
     , ouroboros-network-api              ^>=0.5
     , path                               ^>=0.9.2

diff --git a/lib/wallet-e2e/cardano-wallet-e2e.cabal b/lib/wallet-e2e/cardano-wallet-e2e.cabal
@@ -105,11 +105,12 @@ library
     Cardano.Wallet.Spec.Effect.Trace
     Cardano.Wallet.Spec.Interpreters.Effectfully
     Cardano.Wallet.Spec.Interpreters.Pure
-    Cardano.Wallet.Spec.Network.Config
+    Cardano.Wallet.Spec.Network.Configured
     Cardano.Wallet.Spec.Network.Local
     Cardano.Wallet.Spec.Network.Manual
     Cardano.Wallet.Spec.Network.Node.Cli
     Cardano.Wallet.Spec.Network.Preprod
+    Cardano.Wallet.Spec.Network.Wait
     Cardano.Wallet.Spec.Network.Wallet.Cli
     Cardano.Wallet.Spec.Stories.Language
     Cardano.Wallet.Spec.Stories.Wallet

diff --git a/lib/wallet-e2e/exe/Main.hs b/lib/wallet-e2e/exe/Main.hs
@@ -69,11 +69,12 @@ testNetworkOptionsToConfig = \case
     TestNetworkOptionManual ->
         pure TestNetworkManual
     TestNetworkOptionLocal stateDir nodeConfigsDir -> do
-        absStateDir <- makeDirAbsolute (untag stateDir)
-        pure (TestNetworkLocal absStateDir)
+        absStateDir <- traverse makeDirAbsolute stateDir
+        absNodeConfigsDir <- traverse makeDirAbsolute nodeConfigsDir
+        pure (TestNetworkLocal absStateDir absNodeConfigsDir)
     TestNetworkOptionPreprod stateDir nodeConfigsDir -> do
-        absStateDir <- makeDirAbsolute (untag stateDir)
-        absNodeConfigsDir <- makeDirAbsolute (untag nodeConfigsDir)
+        absStateDir <- traverse makeDirAbsolute stateDir
+        absNodeConfigsDir <- traverse makeDirAbsolute nodeConfigsDir
         pure (TestNetworkPreprod absStateDir absNodeConfigsDir)
   where
     makeDirAbsolute = \case

diff --git a/lib/wallet-e2e/src/Cardano/Wallet/Spec.hs b/lib/wallet-e2e/src/Cardano/Wallet/Spec.hs
@@ -11,8 +11,8 @@ import qualified Cardano.Wallet.Spec.Network.Preprod as Preprod
 import Cardano.Wallet.Spec.Interpreters.Effectfully
     ( story
     )
-import Cardano.Wallet.Spec.Network.Config
-    ( NetworkConfig
+import Cardano.Wallet.Spec.Network.Configured
+    ( ConfiguredNetwork
     )
 import Cardano.Wallet.Spec.Stories.Wallet
     ( createdWalletHasZeroAda
@@ -22,6 +22,12 @@ import Cardano.Wallet.Spec.Stories.Wallet
 import Cardano.Wallet.Spec.TimeoutSpec
     ( timeoutSpec
     )
+import Control.Monad.Trans.Resource
+    ( runResourceT
+    )
+import Data.Tagged
+    ( Tagged
+    )
 import Path
     ( Abs
     , Dir
@@ -35,12 +41,11 @@ import Test.Syd
     )
 
 walletSpec :: TestNetworkConfig -> Spec
-walletSpec networkConfig =
-    aroundAll (setupForNetwork networkConfig) do
-        describe "Wallet Backend API" $ sequential do
-            story "Created wallet is listed" createdWalletListed
-            story "Created wallet can be retrieved by id" createdWalletRetrievable
-            story "Created wallet has zero ADA balance" createdWalletHasZeroAda
+walletSpec config = aroundAll (configureTestNet config) do
+    describe "Wallet Backend API" $ sequential do
+        story "Created wallet is listed" createdWalletListed
+        story "Created wallet can be retrieved by id" createdWalletRetrievable
+        story "Created wallet has zero ADA balance" createdWalletHasZeroAda
 
 effectsSpec :: Spec
 effectsSpec = describe "Effect interpreters" do
@@ -51,14 +56,20 @@ effectsSpec = describe "Effect interpreters" do
 
 data TestNetworkConfig
     = TestNetworkManual
-    | TestNetworkLocal !(Path Abs Dir)
-    | TestNetworkPreprod !(Path Abs Dir) !(Path Abs Dir)
+    | TestNetworkLocal
+        (Tagged "state" (Path Abs Dir))
+        (Tagged "config" (Path Abs Dir))
+    | TestNetworkPreprod
+        (Tagged "state" (Path Abs Dir))
+        (Tagged "config" (Path Abs Dir))
 
-setupForNetwork :: TestNetworkConfig -> (NetworkConfig -> IO ()) -> IO ()
-setupForNetwork = \case
-    TestNetworkManual ->
-        Manual.nodeWalletSetup
-    TestNetworkLocal stateDir ->
-        Local.nodeWalletSetup stateDir
-    TestNetworkPreprod stateDir nodeConfigDir ->
-        Preprod.nodeWalletSetup stateDir nodeConfigDir
+configureTestNet :: TestNetworkConfig -> (ConfiguredNetwork -> IO ()) -> IO ()
+configureTestNet testNetworkConfig withConfiguredNetwork = runResourceT $ do
+    config <- case testNetworkConfig of
+        TestNetworkManual ->
+            pure Manual.configuredNetwork
+        TestNetworkLocal stateDir nodeConfigDir ->
+            Local.configuredNetwork stateDir nodeConfigDir
+        TestNetworkPreprod stateDir nodeConfigDir ->
+            Preprod.configuredNetwork stateDir nodeConfigDir
+    liftIO $ withConfiguredNetwork config
diff --git a/lib/wallet-e2e/src/Cardano/Wallet/Spec/Effect/Query.hs b/lib/wallet-e2e/src/Cardano/Wallet/Spec/Effect/Query.hs
@@ -53,8 +53,8 @@ import Cardano.Wallet.Spec.Effect.Trace
     ( FxTrace
     , trace
     )
-import Cardano.Wallet.Spec.Network.Config
-    ( NetworkConfig (..)
+import Cardano.Wallet.Spec.Network.Configured
+    ( ConfiguredNetwork (..)
     )
 import Effectful
     ( (:>)
@@ -158,10 +158,10 @@ runQuery
        , FxAssert :> es
        , FxTrace :> es
        )
-    => NetworkConfig
+    => ConfiguredNetwork
     -> Eff (FxQuery : es) a
     -> Eff es a
-runQuery networkConfig = interpret \_ -> \case
+runQuery configuredNetwork = interpret \_ -> \case
     ListKnownWallets -> do
         resp <- runClient LW.listWallets
         assert "ListKnownWallets response status"
@@ -321,28 +321,28 @@ runQuery networkConfig = interpret \_ -> \case
             >>= \case
                 Left (e :: SomeException) ->
                     environmentException
-                        $ WalletNetworkInfoException networkConfig e
+                        $ WalletNetworkInfoException configuredNetwork e
                 Right resp | status <- responseStatus resp -> do
                     unless (status == ok200) do
                         environmentException
-                            $ WalletNetworkInfoStatus networkConfig status
+                            $ WalletNetworkInfoStatus configuredNetwork status
                     case responseBody resp of
                         W.GetNetworkInformationResponseError err ->
                             environmentException
-                                $ WalletNetworkInfoError networkConfig (toText err)
+                                $ WalletNetworkInfoError configuredNetwork (toText err)
                         W.GetNetworkInformationResponse406
                             W.GetNetworkInformationResponseBody406{..} ->
                                 environmentException
                                     $ WalletNetworkInfoError
-                                        networkConfig
+                                        configuredNetwork
                                         getNetworkInformationResponseBody406Message
                         W.GetNetworkInformationResponse200
                             W.GetNetworkInformationResponseBody200{..} -> do
                                 nodeStatus <-
                                     NodeStatus.fromClientResponse getNetworkInformationResponseBody200Sync_progress
                                         & maybe
                                             ( environmentException
-                                                $ WalletNetworkInfoUnknownNodeStatus networkConfig
+                                                $ WalletNetworkInfoUnknownNodeStatus configuredNetwork
                                             )
                                             pure
                                 pure NetworkInfo{nodeStatus}
@@ -352,7 +352,7 @@ runQuery networkConfig = interpret \_ -> \case
         WC.runWithConfiguration
             WC.Configuration
                 { WC.configBaseURL =
-                    walletInstanceApiUrl (networkConfigWallet networkConfig)
+                    walletInstanceApiUrl (configuredNetworkWallet configuredNetwork)
                 , WC.configSecurityScheme = WC.anonymousSecurityScheme
                 , WC.configIncludeUserAgent = False
                 , WC.configApplicationName = ""
@@ -362,33 +362,33 @@ environmentException :: (Fail :> es) => ExecutionEnvironmentException -> Eff es
 environmentException = fail . displayException
 
 data ExecutionEnvironmentException
-    = WalletNetworkInfoException NetworkConfig SomeException
-    | WalletNetworkInfoStatus NetworkConfig Http.Status
-    | WalletNetworkInfoError NetworkConfig Text
-    | NodeIsNotReady NetworkConfig
-    | WalletNetworkInfoUnknownNodeStatus NetworkConfig
+    = WalletNetworkInfoException ConfiguredNetwork SomeException
+    | WalletNetworkInfoStatus ConfiguredNetwork Http.Status
+    | WalletNetworkInfoError ConfiguredNetwork Text
+    | NodeIsNotReady ConfiguredNetwork
+    | WalletNetworkInfoUnknownNodeStatus ConfiguredNetwork
     deriving anyclass (Exception)
 
 instance Show ExecutionEnvironmentException where
     show = \case
-        WalletNetworkInfoException networkConfig se ->
-            requirement networkConfig
+        WalletNetworkInfoException configuredNetwork se ->
+            requirement configuredNetwork
                 <> "However, an exception happened when trying to retrieve \n\
                    \network information from the wallet backend: \n\n"
                 <> displayException se
-        WalletNetworkInfoUnknownNodeStatus networkConfig ->
-            requirement networkConfig
-        WalletNetworkInfoStatus networkConfig _ ->
-            requirement networkConfig
-        WalletNetworkInfoError networkConfig _ ->
-            requirement networkConfig
-        NodeIsNotReady networkConfig ->
-            requirement networkConfig
+        WalletNetworkInfoUnknownNodeStatus configuredNetwork ->
+            requirement configuredNetwork
+        WalletNetworkInfoStatus configuredNetwork _ ->
+            requirement configuredNetwork
+        WalletNetworkInfoError configuredNetwork _ ->
+            requirement configuredNetwork
+        NodeIsNotReady configuredNetwork ->
+            requirement configuredNetwork
       where
-        requirement :: NetworkConfig -> String
+        requirement :: ConfiguredNetwork -> String
         requirement configuration =
             "E2E test suite requires a running cardano-wallet instance \n\
             \connected to a running cardano-node and listenting on "
                 <> show
-                    (walletInstanceApiUrl (networkConfigWallet configuration))
+                    (walletInstanceApiUrl (configuredNetworkWallet configuration))
                 <> "\n\n"
diff --git a/lib/wallet-e2e/src/Cardano/Wallet/Spec/Interpreters/Effectfully.hs b/lib/wallet-e2e/src/Cardano/Wallet/Spec/Interpreters/Effectfully.hs
@@ -30,8 +30,8 @@ import Cardano.Wallet.Spec.Effect.Trace
     , recordTraceLog
     , runTracePure
     )
-import Cardano.Wallet.Spec.Network.Config
-    ( NetworkConfig
+import Cardano.Wallet.Spec.Network.Configured
+    ( ConfiguredNetwork
     )
 import Effectful
     ( Eff
@@ -73,7 +73,7 @@ type Story a =
         ]
         a
 
-story :: String -> Story () -> TestDefM '[NetworkConfig] () ()
+story :: String -> Story () -> TestDefM '[ConfiguredNetwork] () ()
 story label story' =
     itWithOuter label \network -> do
         interpretStory network story' >>= \(result, log) -> do
@@ -83,18 +83,18 @@ story label story' =
                 Right () -> pass
 
 interpretStory
-    :: NetworkConfig
+    :: ConfiguredNetwork
     -> Story a
     -> IO (Either String a, Seq Text)
-interpretStory networkConfig story' = do
+interpretStory configuredNetwork story' = do
     connectionManager <-
         Http.newManager
             Http.defaultManagerSettings
                 { managerResponseTimeout = Http.responseTimeoutNone
                 }
     stdGen <- initStdGen
     story'
-        & runQuery networkConfig
+        & runQuery configuredNetwork
         & runHttpClient connectionManager
         & runRandom stdGen
         & runTimeout

diff --git a/lib/wallet-e2e/src/Cardano/Wallet/Spec/Network/Configured.hs b/lib/wallet-e2e/src/Cardano/Wallet/Spec/Network/Configured.hs
@@ -0,0 +1,9 @@
+module Cardano.Wallet.Spec.Network.Configured where
+
+import Cardano.Wallet.Cli.Launcher
+    ( WalletApi
+    )
+
+newtype ConfiguredNetwork = ConfiguredNetwork
+  { configuredNetworkWallet :: WalletApi
+  }