add flag to run indexing tests

docs/catalyst_milestone_reports.md

@@ -3,9 +3,12 @@
 ## Summary
 
 * L1 indexing:
-  * [pr]()
-  * [source]()
-  * [tests]()
+  * [Basic indexing support PR #98](https://github.com/mlabs-haskell/cem-script/pull/98)
+  * [Oura config generation PR #100](https://github.com/mlabs-haskell/cem-script/pull/100)
+  * [Source](https://github.com/mlabs-haskell/cem-script/blob/master/src/Cardano/CEM/Indexing.hs)
+  * [Tests for Auction example](https://github.com/mlabs-haskell/cem-script/blob/master/test/OuraFilter/Auction.hs)
+* Final code clean-up
+* Final tutorial and docs
 
 # Milestone 4
 

src/Cardano/CEM/Indexing.hs

@@ -14,7 +14,9 @@ import Cardano.Ledger.BaseTypes qualified as Ledger
 import Data.Data (Proxy)
 import Data.String (IsString)
 import Data.Text qualified as T
+import Toml (Table)
 import Toml qualified
+import Toml.Pretty qualified
 import Toml.Schema ((.=))
 import Toml.Schema.ToValue qualified as Toml.ToValue
 import Prelude
@@ -62,7 +64,7 @@ ouraMonitoringScript p network sourcePath sinkPath =
     . pure
     . selectByAddress
     . Address.cardanoAddressBech32
-    <$> Address.scriptC2ardanoAddress p network
+    <$> Address.scriptCardanoAddress p network
 
 cursor :: Toml.Table
 cursor =

test/Main.hs

@@ -7,17 +7,25 @@ import Prelude
 import Test.Hspec (hspec, runIO)
 
 import Auction (auctionSpec)
+import Data.Maybe (isJust)
 import Dynamic (dynamicSpec)
 import OffChain (offChainSpec)
 import OuraFilters (ouraFiltersSpec)
+import System.Environment (lookupEnv)
 import Utils (clearLogs)
 import Voting (votingSpec)
 
 main :: IO ()
-main = hspec do
-  auctionSpec
-  votingSpec
-  offChainSpec
-  dynamicSpec
-  runIO clearLogs
-  ouraFiltersSpec
+main = do
+  runIndexing <- isJust <$> lookupEnv "INDEXING_TEST"
+  hspec do
+    auctionSpec
+    votingSpec
+    offChainSpec
+    dynamicSpec
+    if runIndexing
+      then do
+        -- These tests are not currently supported on CI
+        runIO clearLogs
+        ouraFiltersSpec
+      else pure mempty

test/Oura.hs

@@ -10,7 +10,7 @@ module Oura (
 
 import Prelude
 
-import Cardano.CEM.Indexing qualified as Config
+import Cardano.CEM.Indexing qualified as Indexing
 import Control.Concurrent (threadDelay)
 import Control.Concurrent.Async (Async)
 import Control.Concurrent.Async qualified as Async
@@ -45,7 +45,7 @@ newtype WorkDir = MkWorkDir {unWorkDir :: T.Text}
 withOura ::
   WorkDir ->
   Utils.SpotGarbage IO Process.ProcessHandle ->
-  (Config.SourcePath -> Config.SinkPath -> Table) ->
+  (Indexing.SourcePath -> Indexing.SinkPath -> Table) ->
   (Oura IO -> IO r) ->
   IO r
 withOura spotHandle workdir makeConfig =
@@ -54,25 +54,25 @@ withOura spotHandle workdir makeConfig =
 runOura ::
   WorkDir ->
   Utils.SpotGarbage IO Process.ProcessHandle ->
-  (Config.SourcePath -> Config.SinkPath -> Table) ->
+  (Indexing.SourcePath -> Indexing.SinkPath -> Table) ->
   Maybe Communication.Interval ->
   ContT r IO (Oura IO)
 runOura (MkWorkDir (T.unpack -> workdir)) spotHandle makeConfig outputCheckingInterval = do
   writerPath <-
     ContT $
       withNewFile "writer.socket" workdir
-  sinkPath :: Config.SinkPath <-
+  sinkPath :: Indexing.SinkPath <-
     fmap fromString $
       ContT $
         withNewFile "sink.socket" workdir
-  sourcePath :: Config.SourcePath <-
+  sourcePath :: Indexing.SourcePath <-
     fmap fromString $
       ContT $
         withNewFile "source.socket" workdir
-  lift $ removeFile $ T.unpack $ Config.unSourcePath sourcePath
+  lift $ removeFile $ T.unpack $ Indexing.unSourcePath sourcePath
   let
-    config = configToText $ makeConfig sourcePath sinkPath
-  configPath <- ContT $ withNewFile "config.toml" workdir
+    config = Indexing.configToText $ makeConfig sourcePath sinkPath
+  configPath <- ContT $ withNewFile "Indexing.toml" workdir
   lift $ T.IO.writeFile configPath config
   (ouraHandle, waitingForClose) <- launchOura configPath spotHandle
   lift $ Async.link waitingForClose