Add e2eConfigs helper function

Author: errfrom

doc/e2e-testing.md

@@ -252,7 +252,7 @@ eternl:http://localhost:4008/?eternl:Contract
 "
 ```
 
-The `nami:` prefix specifies which browser extension to load for the test, and the query parameter is for the router to be able to find the appropriate config.
+The `eternl:` prefix specifies which browser extension to load for the test, and the query parameter is for the router to be able to find the appropriate config.
 
 Refer to the docs for `Contract.Test.E2E.route` function for an overview of the URL structure.
 

src/Contract/Test/E2E.purs

@@ -4,5 +4,11 @@ module Contract.Test.E2E
 
 import Ctl.Internal.Test.E2E.Feedback.Hooks (e2eFeedbackHooks) as X
 import Ctl.Internal.Test.E2E.Options (parseCliArgs) as X
-import Ctl.Internal.Test.E2E.Route (E2EConfigName, E2ETestName, addLinks, route) as X
+import Ctl.Internal.Test.E2E.Route
+  ( E2EConfigName
+  , E2ETestName
+  , addLinks
+  , e2eConfigs
+  , route
+  ) as X
 import Ctl.Internal.Test.E2E.Runner (runE2ECommand, runE2ETests) as X

src/Internal/Test/E2E/Route.purs

@@ -1,10 +1,11 @@
 module Ctl.Internal.Test.E2E.Route
   ( E2ETestName
   , E2EConfigName
-  , route
-  , parseRoute
   , Route
   , addLinks
+  , e2eConfigs
+  , parseRoute
+  , route
   ) where
 
 import Prelude
@@ -13,12 +14,14 @@ import Cardano.Types (NetworkId(TestnetId))
 import Cardano.Types.PrivateKey (PrivateKey)
 import Cardano.Types.PrivateKey as PrivateKey
 import Cardano.Types.RawBytes (RawBytes(RawBytes))
-import Contract.Config (ContractParams)
+import Contract.Config (ContractParams, testnetConfig)
 import Contract.Monad (Contract, runContract)
 import Contract.Test.Cip30Mock (withCip30Mock)
 import Contract.Wallet
-  ( PrivatePaymentKey(PrivatePaymentKey)
+  ( KnownWallet(Gero, Eternl, Lode, Lace)
+  , PrivatePaymentKey(PrivatePaymentKey)
   , PrivateStakeKey(PrivateStakeKey)
+  , walletName
   )
 import Contract.Wallet.Key (privateKeysToKeyWallet)
 import Control.Alt ((<|>))
@@ -33,15 +36,17 @@ import Data.Array (last)
 import Data.Array as Array
 import Data.Bifunctor (lmap)
 import Data.ByteArray (hexToByteArray)
-import Data.Either (Either(Left), note)
+import Data.Either (Either(Left, Right), note)
 import Data.Foldable (fold)
 import Data.Map (Map)
 import Data.Map as Map
-import Data.Maybe (Maybe(Just, Nothing), maybe)
+import Data.Maybe (Maybe(Just, Nothing), fromMaybe, maybe)
 import Data.Newtype (wrap)
-import Data.String (stripPrefix)
+import Data.String (stripPrefix, stripSuffix)
 import Data.String.Common (split)
 import Data.String.Pattern (Pattern(Pattern))
+import Data.Traversable (traverse)
+import Data.Tuple (Tuple(Tuple))
 import Data.Tuple.Nested (type (/\), (/\))
 import Effect (Effect)
 import Effect.Aff (Aff, delay, launchAff_)
@@ -55,6 +60,47 @@ type E2ETestName = String
 -- | CIP-30 mock). Used in the URL for routing
 type E2EConfigName = String
 
+e2eConfigs
+  :: Array E2EConfigName
+  -> Either String (Map E2EConfigName (ContractParams /\ Maybe String))
+e2eConfigs =
+  map Map.fromFoldable
+    <<< traverse (\env -> Tuple env <$> resolveConfigName env)
+  where
+  resolveConfigName
+    :: E2EConfigName
+    -> Either String (ContractParams /\ Maybe String)
+  resolveConfigName configName = do
+    let
+      walletSpec =
+        fromMaybe configName $ stripPrefix (Pattern "localnet-")
+          configName
+      wallet' /\ isMock =
+        maybe (walletSpec /\ false) (flip Tuple true) $ stripSuffix
+          (Pattern "-mock")
+          walletSpec
+    wallet <- resolveWallet wallet'
+    pure $
+      Tuple
+        (mkContractParams wallet)
+        (if isMock then Just wallet else Nothing)
+
+  resolveWallet :: String -> Either String String
+  resolveWallet =
+    case _ of
+      "gero" -> Right $ walletName Gero
+      "eternl" -> Right $ walletName Eternl
+      "lode" -> Right $ walletName Lode
+      "lace" -> Right $ walletName Lace
+      wallet -> Left $ "e2eConfigs: unsupported wallet: " <> wallet
+
+  mkContractParams :: String -> ContractParams
+  mkContractParams wallet =
+    testnetConfig
+      { walletSpec =
+          Just $ ConnectToGenericCip30 wallet { cip95: false }
+      }
+
 -- | Router state - parsed from URL by `parseRoute`
 type Route =
   { configName :: E2EConfigName

templates/ctl-scaffold/test/E2E.purs

@@ -3,43 +3,40 @@ module Scaffold.Test.E2E.Serve where
 
 import Contract.Prelude
 
-import Contract.Config
-  ( ContractParams
-  , KnownWallet(Gero, Eternl, Lode)
-  , WalletSpec(ConnectToGenericCip30)
-  , testnetConfig
-  , walletName
-  )
+import Contract.Config (ContractParams)
 import Contract.Monad (Contract)
-import Contract.Test.E2E (E2EConfigName, E2ETestName, addLinks, route)
+import Contract.Test.E2E
+  ( E2EConfigName
+  , E2ETestName
+  , addLinks
+  , e2eConfigs
+  , route
+  )
+import Data.Bifunctor (lmap)
 import Data.Map (Map)
 import Data.Map as Map
+import Effect.Exception (error)
 import Scaffold as Scaffold
 
 main :: Effect Unit
 main = do
+  configs <- liftEither $ lmap error mkConfigs
   addLinks configs tests
   route configs tests
 
-configs :: Map E2EConfigName (ContractParams /\ Maybe String)
-configs = map (map walletName) <$> Map.fromFoldable
-  [ "gero" /\ testnetConfig' Gero /\ Nothing
-  , "eternl" /\ testnetConfig' Eternl /\ Nothing
-  , "lode" /\ testnetConfig' Lode /\ Nothing
-  , "gero-mock" /\ testnetConfig' Gero /\ Just Gero
-  , "lode-mock" /\ testnetConfig' Lode /\ Just Lode
-  , "eternl-mock" /\ testnetConfig' Eternl /\ Just Eternl
-  , "localnet-eternl-mock" /\ testnetConfig' Eternl /\ Just Eternl
-  , "localnet-gero-mock" /\ testnetConfig' Gero /\ Just Gero
-  , "localnet-lode-mock" /\ testnetConfig' Lode /\ Just Lode
-  ]
-  where
-  testnetConfig' :: KnownWallet -> ContractParams
-  testnetConfig' wallet =
-    testnetConfig
-      { walletSpec =
-          Just $ ConnectToGenericCip30 (walletName wallet) { cip95: false }
-      }
+mkConfigs :: Either String (Map E2EConfigName (ContractParams /\ Maybe String))
+mkConfigs =
+  e2eConfigs
+    [ "gero"
+    , "eternl"
+    , "lode"
+    , "gero-mock"
+    , "lode-mock"
+    , "eternl-mock"
+    , "localnet-eternl-mock"
+    , "localnet-gero-mock"
+    , "localnet-lode-mock"
+    ]
 
 tests :: Map E2ETestName (Contract Unit)
 tests = Map.fromFoldable