Add a 'RunOnRepl' module #4358

dnadales · 2023-02-10T10:04:45Z

... which allows to (re-)test a counterexample found by the ChainDB.StateMachine tests by copying and pasting it in the GHC repl.

Part of #4183

Checklist

Branch
- Commit sequence broadly makes sense
- Commits have useful messages
- The documentation has been properly updated
- New tests are added if needed and existing tests are updated
- Any changes affecting Consensus packages must have an entry in the appropriate changelog.d directory created using scriv. If in doubt, see the Consensus release process.
- If this branch changes Network and has any consequences for downstream repositories or end users, said changes must be documented in interface-CHANGELOG.md
- If serialization changes, user-facing consequences (e.g. replay from genesis) are confirmed to be intentional.
Pull Request
- Self-reviewed the diff
- Useful pull request description at least containing the following information:
  - What does this PR change?
  - Why these changes were needed?
  - How does this affect downstream repositories and/or end-users?
  - Which ticket does this PR close (if any)? If it does, is it linked?
- Reviewer requested

ghost · 2023-02-10T10:19:40Z

ouroboros-consensus-test/test-storage/Test/Ouroboros/Storage/ChainDB/StateMachine/RunOnRepl.hs

+    -- * Running the counterexamples
+    quickCheckeCmdsLockStep
+    -- * Patterns needed to disambiguate the 'At' and 'Command' symbols printed
+    -- * by the 'ChainDB.StateMachine' tests.


typo: Remove leading * as I don't think you want another list item here

Ups, M-q 😁 Thanks.

bartfrenk · 2023-02-10T10:42:31Z

ouroboros-consensus-test/ouroboros-consensus-test.cabal

@@ -228,6 +228,7 @@ test-suite test-storage
                       Test.Ouroboros.Storage.ChainDB.Model.Test
                       Test.Ouroboros.Storage.ChainDB.Paths
                       Test.Ouroboros.Storage.ChainDB.StateMachine
+                       Test.Ouroboros.Storage.ChainDB.StateMachine.RunOnRepl


nitpick: Why not just Test.Ouroboros.Storage.ChainDB.StateMachine.REPL

My thought: it's not a REPL, but rather imports to allow the state machine to be run on the REPL. What do you think?

bartfrenk · 2023-02-10T10:47:19Z

ouroboros-consensus-test/test-storage/Test/Ouroboros/Storage/ChainDB/StateMachine/RunOnRepl.hs

+pattern Command cmd rsp xs =
+  StateMachine.Types.Command (StateMachine.At cmd) (StateMachine.At rsp) xs
+
+quickCheckeCmdsLockStep ::


Typo?

Suggested change

quickCheckeCmdsLockStep ::

quickCheckCmdsLockStep ::

bartfrenk · 2023-02-10T10:47:48Z

ouroboros-consensus-test/test-storage/Test/Ouroboros/Storage/ChainDB/StateMachine/RunOnRepl.hs

+  -> SmallChunkInfo
+  -> Commands (StateMachine.At Cmd TestBlock IO) (StateMachine.At Resp TestBlock IO)
+  -> IO ()
+quickCheckeCmdsLockStep maxClockSkew chunkInfo cmds =


Suggested change

quickCheckeCmdsLockStep maxClockSkew chunkInfo cmds =

quickCheckCmdsLockStep maxClockSkew chunkInfo cmds =

jasagredo

Perhaps we could name this module .Utils.RunOnRepl to convey that it is not a test in itself but utilities for the tests?

jasagredo · 2023-02-16T10:20:39Z

ouroboros-consensus-test/test-storage/Test/Ouroboros/Storage/ChainDB/StateMachine/RunOnRepl.hs

+--
+-- > quickCheckCmdsLockStep someClockSkew someChunkInfo counterexample
+--
+-- Where 'someClockSkew' and 'someChunkInfo' are the ones given by a the


Suggested change

-- Where 'someClockSkew' and 'someChunkInfo' are the ones given by a the

-- Where 'someClockSkew' and 'someChunkInfo' are the ones given by the

dnadales · 2023-02-16T14:38:53Z

Perhaps we could name this module .Utils.RunOnRepl to convey that it is not a test in itself but utilities for the tests?

Makes sense. I can rename the module.

... which allows to (re-)test a counterexample found by the `ChainDB.StateMachine` tests by copying and pasting it in the GHC repl.

dnadales · 2023-02-16T17:13:29Z

bors r+

4358: Add a 'RunOnRepl' module r=dnadales a=dnadales ... which allows to (re-)test a counterexample found by the `ChainDB.StateMachine` tests by copying and pasting it in the GHC repl. Part of #4183 Co-authored-by: Damian Nadales <damian.only@gmail.com>

iohk-bors · 2023-02-16T17:20:40Z

Build failed:

ci (x86_64-darwin)

dnadales · 2023-02-17T14:40:37Z

bors r+

4358: Add a 'RunOnRepl' module r=dnadales a=dnadales ... which allows to (re-)test a counterexample found by the `ChainDB.StateMachine` tests by copying and pasting it in the GHC repl. Part of #4183 Co-authored-by: Damian Nadales <damian.only@gmail.com>

iohk-bors · 2023-02-17T15:28:13Z

Build failed:

build (9.2.5, windows-latest)

dnadales · 2023-02-17T15:36:03Z

bors r+

4358: Add a 'RunOnRepl' module r=dnadales a=dnadales ... which allows to (re-)test a counterexample found by the `ChainDB.StateMachine` tests by copying and pasting it in the GHC repl. Part of #4183 Co-authored-by: Damian Nadales <damian.only@gmail.com>

iohk-bors · 2023-02-17T15:45:48Z

Build failed:

ci (x86_64-darwin)

dnadales · 2023-02-17T15:46:52Z

bors retry

4358: Add a 'RunOnRepl' module r=dnadales a=dnadales ... which allows to (re-)test a counterexample found by the `ChainDB.StateMachine` tests by copying and pasting it in the GHC repl. Part of #4183 Co-authored-by: Damian Nadales <damian.only@gmail.com>

iohk-bors · 2023-02-17T15:58:46Z

Build failed:

ci (x86_64-linux)

... to distinguish this module from a test suite.

dnadales · 2023-02-20T10:02:09Z

bors r+

iohk-bors · 2023-02-20T12:18:45Z

Build succeeded:

dnadales requested a review from nfrisby as a code owner February 10, 2023 10:04

dnadales requested review from a user, bartfrenk and jorisdral and removed request for nfrisby and jorisdral February 10, 2023 10:05

ghost approved these changes Feb 10, 2023

View reviewed changes

bartfrenk reviewed Feb 10, 2023

View reviewed changes

dnadales force-pushed the dnadales/4183-module-to-run-cmds-in-repl branch 2 times, most recently from 94fbac3 to 9654bfe Compare February 15, 2023 17:02

Remove unused BlockNo constructor in ChainDB.StateMachine

e5be165

dnadales force-pushed the dnadales/4183-module-to-run-cmds-in-repl branch from 9654bfe to b4f9fbf Compare February 16, 2023 10:12

jasagredo approved these changes Feb 16, 2023

View reviewed changes

Add a 'RunOnRepl' module

4c12fdf

... which allows to (re-)test a counterexample found by the `ChainDB.StateMachine` tests by copying and pasting it in the GHC repl.

dnadales force-pushed the dnadales/4183-module-to-run-cmds-in-repl branch from b4f9fbf to f4909bd Compare February 16, 2023 17:13

Prefix RunOnRepl by Utils

f2802c3

... to distinguish this module from a test suite.

dnadales force-pushed the dnadales/4183-module-to-run-cmds-in-repl branch from f4909bd to f2802c3 Compare February 20, 2023 10:01

iohk-bors bot merged commit 18ea4c3 into master Feb 20, 2023

iohk-bors bot deleted the dnadales/4183-module-to-run-cmds-in-repl branch February 20, 2023 12:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a 'RunOnRepl' module #4358

Add a 'RunOnRepl' module #4358

dnadales commented Feb 10, 2023

ghost Feb 10, 2023

dnadales Feb 13, 2023

bartfrenk Feb 10, 2023

dnadales Feb 13, 2023

bartfrenk Feb 10, 2023

bartfrenk Feb 10, 2023

jasagredo left a comment

jasagredo Feb 16, 2023

dnadales commented Feb 16, 2023

dnadales commented Feb 16, 2023

iohk-bors bot commented Feb 16, 2023

dnadales commented Feb 17, 2023

iohk-bors bot commented Feb 17, 2023

dnadales commented Feb 17, 2023

iohk-bors bot commented Feb 17, 2023

dnadales commented Feb 17, 2023

iohk-bors bot commented Feb 17, 2023

dnadales commented Feb 20, 2023

iohk-bors bot commented Feb 20, 2023

	quickCheckeCmdsLockStep maxClockSkew chunkInfo cmds =
	quickCheckCmdsLockStep maxClockSkew chunkInfo cmds =

	-- Where 'someClockSkew' and 'someChunkInfo' are the ones given by a the
	-- Where 'someClockSkew' and 'someChunkInfo' are the ones given by the

Add a 'RunOnRepl' module #4358

Add a 'RunOnRepl' module #4358

Conversation

dnadales commented Feb 10, 2023

Checklist

ghost Feb 10, 2023

Choose a reason for hiding this comment

dnadales Feb 13, 2023

Choose a reason for hiding this comment

bartfrenk Feb 10, 2023

Choose a reason for hiding this comment

dnadales Feb 13, 2023

Choose a reason for hiding this comment

bartfrenk Feb 10, 2023

Choose a reason for hiding this comment

bartfrenk Feb 10, 2023

Choose a reason for hiding this comment

jasagredo left a comment

Choose a reason for hiding this comment

jasagredo Feb 16, 2023

Choose a reason for hiding this comment

dnadales commented Feb 16, 2023

dnadales commented Feb 16, 2023

iohk-bors bot commented Feb 16, 2023

dnadales commented Feb 17, 2023

iohk-bors bot commented Feb 17, 2023

dnadales commented Feb 17, 2023

iohk-bors bot commented Feb 17, 2023

dnadales commented Feb 17, 2023

iohk-bors bot commented Feb 17, 2023

dnadales commented Feb 20, 2023

iohk-bors bot commented Feb 20, 2023