Implement the peer simulator for Genesis tests #434

facundominguez · 2023-10-12T18:12:45Z

This PR introduces an initial implementation of a Peer Simulator for Genesis tests.

A simulated peer is told how to behave by a list of scheduled events that is generated for every test. In essence, it is an implementation of a ChainSync server and a BlockFetch server that behave as prescribed by the schedule.

The rest of the PR provides support infrastructure in the form of:

a Praos client node that plays the role of subject under test,
an example test for long range attacks, and
minimal definitions to generate a schedule from the chain schemas introduced in consensus-testlib: add chain generators #240.

This is a squash of the many commits in the integration branch of #367.

...oros-consensus-diffusion/test/consensus-test/Test/Consensus/Genesis/Tests/LongRangeAttack.hs

dnadales

Thanks. Some overall comments:

Do we want to address all the comments marked as REVIEW in this PR?
Do we want to address all the comments marked as FIXME in this PR?
We need to make sure no record wildcards are used.
It'd be great if we could use the same formatting style as the rest of the codebase. Also, at the moment the coding styles within this PR are mixed, eg leading vs trailing commas.

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/Genesis/Setup.hs

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/Genesis/Setup/Classifiers.hs

...os-consensus-diffusion/test/consensus-test/Test/Consensus/Network/AnchoredFragment/Extras.hs

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/BlockFetch.hs

dnadales · 2023-11-02T10:10:06Z

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/Run.hs

+  traceWith tracer "Schedule is:"
+  for_ ps  $ \tick -> traceWith tracer $ "  " ++ condense tick
+  traceWith tracer "--------------------------------------------------------------------------------"
+  traceWith tracer "» Time says “Let there be”"


Perhaps we should replace this with something that describes what these messages are delimiting.

@Niols do you have any preferences of text to use here? "Running point schedule ..."?

dnadales · 2023-11-02T10:10:20Z

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/Run.hs

+  traceWith tracer "--------------------------------------------------------------------------------"
+  for_ ps (dispatchTick tracer peers)
+  traceWith tracer "--------------------------------------------------------------------------------"
+  traceWith tracer "» A Clock stopped -"


ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/Trace.hs

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PointSchedule.hs

dnadales · 2023-11-02T10:56:02Z

ouroboros-consensus/src/unstable-consensus-testlib/Test/QuickCheck/Extras.hs

@@ -0,0 +1,16 @@
+module Test.QuickCheck.Extras (


Perhaps these functions could be upstreamed to QC eventually ...

facundominguez

Do we want to address all the comments marked as REVIEW in this PR?

At this point, the REVIEW comments are notes for the Genesis team. Should we use a different tag for these?

Do we want to address all the comments marked as FIXME in this PR?

Likely the same as the previous item, but I'll ask.

We need to make sure no record wildcards are used.
It'd be great if we could use the same formatting style as the rest of the codebase.

Yes, I think at least I should be paying some more attention to the style guide than I've been doing so far.

...os-consensus-diffusion/test/consensus-test/Test/Consensus/Network/AnchoredFragment/Extras.hs

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/BlockFetch.hs

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PointSchedule.hs

facundominguez · 2023-11-03T15:12:06Z

ouroboros-consensus/src/unstable-consensus-testlib/Test/QuickCheck/Extras.hs

@@ -0,0 +1,16 @@
+module Test.QuickCheck.Extras (


facundominguez · 2023-11-06T13:13:30Z

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/BlockFetch.hs

+        blockFetchCfg = BlockFetchConfiguration
+          { bfcMaxConcurrencyBulkSync = 2
+          , bfcMaxConcurrencyDeadline = 2
+          , bfcMaxRequestsInflight = 4
+          , bfcDecisionLoopInterval = 0
+          , bfcSalt = 0
+          }


The threadnet tests use hardcoded values as well.

One option would be to factor the hardcoded configuration and use it in both places.

Another alternative would be to make blockFetchCfg a function argument, and generate it with some randomness for all fields except bfcDecisionLoopInterval which could interfere with the scheduling during tests and should remain set to 0.

Please, let us know if you have any preferences.

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/PeerSimulator/BlockFetch.hs

…nt as suggested in #434

Co-authored-by: Nicolas “Niols” Jeannerod <nicolas.jeannerod@tweag.io> Co-authored-by: Torsten Schmits <torsten.schmits@tweag.io> Co-authored-by: Facundo Domínguez <facundo.dominguez@tweag.io>

…nt as suggested in #434

…le run

facundominguez · 2023-12-04T17:49:01Z

I brought almost all of the changes in response to comments to this PR. The only exception is the documentation of point schedules which I left in #501. Also merged the latest changes from main and signed all the commits.

If there are no more requests, this is good to merge.

facundominguez added the Genesis PRs related to Genesis testing and implementation label Oct 12, 2023

facundominguez force-pushed the fd/peer-simulator branch from 283545a to 5340e69 Compare October 13, 2023 17:08

facundominguez marked this pull request as ready for review October 13, 2023 17:38

facundominguez requested a review from a team as a code owner October 13, 2023 17:38

facundominguez mentioned this pull request Oct 13, 2023

wip: genesis tests #367

Closed

nc6 reviewed Oct 26, 2023

View reviewed changes

...oros-consensus-diffusion/test/consensus-test/Test/Consensus/Genesis/Tests/LongRangeAttack.hs Outdated Show resolved Hide resolved

dnadales reviewed Nov 2, 2023

View reviewed changes

facundominguez commented Nov 3, 2023

View reviewed changes

facundominguez commented Nov 7, 2023

View reviewed changes

dnadales approved these changes Nov 15, 2023

View reviewed changes

facundominguez mentioned this pull request Nov 30, 2023

A generator of schedules for Genesis tests #536

Merged

facundominguez added a commit that referenced this pull request Dec 1, 2023

Eliminate record wildcards as requested in #434

77fec68

facundominguez added a commit that referenced this pull request Dec 1, 2023

Note long-range attack test on Praos as requested in #434

2c52d15

facundominguez added a commit that referenced this pull request Dec 1, 2023

Edit slotLength documentation as requested in #434

8157965

facundominguez added a commit that referenced this pull request Dec 1, 2023

Stage intersectWith for inclusion in Ouroboros.Network.AnchoredFragme…

80f1c75

…nt as suggested in #434

facundominguez added a commit that referenced this pull request Dec 1, 2023

Use NumericUnderscores to split integers as requested in #434

ab796ee

facundominguez added a commit that referenced this pull request Dec 4, 2023

Eliminate record wildcards as requested in #434

975a64f

facundominguez added a commit that referenced this pull request Dec 4, 2023

Note long-range attack test on Praos as requested in #434

2e3975c

facundominguez added a commit that referenced this pull request Dec 4, 2023

Edit slotLength documentation as requested in #434

475cf8e

facundominguez added a commit that referenced this pull request Dec 4, 2023

Stage intersectWith for inclusion in Ouroboros.Network.AnchoredFragme…

27e852b

…nt as suggested in #434

facundominguez added a commit that referenced this pull request Dec 4, 2023

Use NumericUnderscores to split integers as requested in #434

d122603

facundominguez added the no changelog label Dec 4, 2023

facundominguez force-pushed the fd/peer-simulator branch from f4ab0d0 to 3bd3be5 Compare December 4, 2023 14:42

nfrisby and others added 7 commits December 4, 2023 14:07

Implement the Peer Simulator for Genesis tests

70e999e

Co-authored-by: Nicolas “Niols” Jeannerod <nicolas.jeannerod@tweag.io> Co-authored-by: Torsten Schmits <torsten.schmits@tweag.io> Co-authored-by: Facundo Domínguez <facundo.dominguez@tweag.io>

Add idleTimeout

934a38c

Eliminate record wildcards as requested in #434

820a5cd

Note long-range attack test on Praos as requested in #434

a6d82ea

Edit slotLength documentation as requested in #434

cb489e2

Explain purpose of Test.Consensus.Network.AnchoredFragment.Extras

2826796

Explain provenance of hardcoded configuration values

75f3d1e

facundominguez added 8 commits December 4, 2023 14:08

Generalize intersectWith

259f4da

Simplify intersectWith

869c170

Stage intersectWith for inclusion in Ouroboros.Network.AnchoredFragme…

bfeb9bc

…nt as suggested in #434

Use NumericUnderscores to split integers as requested in #434

606559e

Comment the purpose of Test.Consensus.Genesis.Setup.runTest

32785da

Replace poetry with messages describing the start and end of a schedu…

88055fa

…le run

Run stylish

d3dd9a5

Pass a dummy future check to chainSyncClient

2076bac

facundominguez force-pushed the fd/peer-simulator branch from 2f37f76 to 2076bac Compare December 4, 2023 17:08

facundominguez requested review from dnadales and nc6 December 4, 2023 17:45

facundominguez added this pull request to the merge queue Dec 5, 2023

github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Dec 5, 2023

facundominguez added this pull request to the merge queue Dec 5, 2023

Merged via the queue into main with commit d866659 Dec 5, 2023
12 checks passed

facundominguez deleted the fd/peer-simulator branch December 5, 2023 18:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement the peer simulator for Genesis tests #434

Implement the peer simulator for Genesis tests #434

facundominguez commented Oct 12, 2023 •

edited

Loading

dnadales left a comment

dnadales Nov 2, 2023

facundominguez Dec 1, 2023

dnadales Nov 2, 2023

dnadales Nov 2, 2023

facundominguez Nov 3, 2023

facundominguez left a comment

facundominguez Nov 3, 2023

facundominguez Nov 6, 2023

facundominguez commented Dec 4, 2023

Implement the peer simulator for Genesis tests #434

Implement the peer simulator for Genesis tests #434

Conversation

facundominguez commented Oct 12, 2023 • edited Loading

dnadales left a comment

Choose a reason for hiding this comment

dnadales Nov 2, 2023

Choose a reason for hiding this comment

facundominguez Dec 1, 2023

Choose a reason for hiding this comment

dnadales Nov 2, 2023

Choose a reason for hiding this comment

dnadales Nov 2, 2023

Choose a reason for hiding this comment

facundominguez Nov 3, 2023

Choose a reason for hiding this comment

facundominguez left a comment

Choose a reason for hiding this comment

facundominguez Nov 3, 2023

Choose a reason for hiding this comment

facundominguez Nov 6, 2023

Choose a reason for hiding this comment

facundominguez commented Dec 4, 2023

facundominguez commented Oct 12, 2023 •

edited

Loading