Merge pull request #5166 from IntersectMBO/td/reorganize-examples

Reorganize Consensus `Examples`

Author: teodanciu

.github/workflows/haskell.yml

@@ -201,12 +201,10 @@ jobs:
         - cardano-ledger-alonzo-test
         - cardano-ledger-api
         - cardano-ledger-babbage
-        - cardano-ledger-babbage-test
         - cardano-ledger-binary
         - cardano-ledger-byron
         - cardano-ledger-conformance
         - cardano-ledger-conway
-        - cardano-ledger-conway-test
         - cardano-ledger-core
         - cardano-ledger-dijkstra
         - cardano-ledger-mary

CHANGELOG.md

@@ -284,8 +284,6 @@ Changes recorded below are for all of the package versions in the list:
   * `cardano-ledger-conway-1.0.0.0`
   * `cardano-ledger-shelley-ma-1.0.0.0`
   * `cardano-ledger-alonzo-test-1.0.0.0`
-  * `cardano-ledger-babbage-test-1.0.0.0`
-  * `cardano-ledger-conway-test-1.0.0.0`
   * `cardano-ledger-shelley-ma-test-1.0.0.0`
   * `cardano-ledger-shelley-test-1.0.0.0`
 

RELEASING.md

@@ -333,13 +333,11 @@ but the changelog _only_ needs to indicate if breaking changes have been made:
 * `cardano-ledger-shelley-test`
 * `cardano-ledger-shelley-ma-test`
 * `cardano-ledger-alonzo-test`
-* `cardano-ledger-babbage-test`
-* `cardano-ledger-conway-test`
 
 A changelog which indicates that no changes have been made will have the form:
 
 ```
-# Version history for `cardano-ledger-conway-test`
+# Version history for `cardano-ledger-conway`
 
 ## 1.2.0.1
 
@@ -349,7 +347,7 @@ A changelog which indicates that no changes have been made will have the form:
 A changelog which indicates that changes have been made will have the form:
 
 ```
-# Version history for `cardano-ledger-conway-test`
+# Version history for `cardano-ledger-conway`
 
 ## 1.3.0.0
 

REVISIONING.md

@@ -68,13 +68,11 @@ Next, you will add the actual revisions and test if you can build your packages
    '.#"ghc96/cardano-ledger-alonzo/1.6.0.0"' \
    '.#"ghc96/cardano-ledger-alonzo-test/1.2.0.0"' \
    '.#"ghc96/cardano-ledger-babbage/1.6.0.0"' \
-   '.#"ghc96/cardano-ledger-babbage-test/1.2.0.0"' \
    '.#"ghc96/byron-spec-chain/1.0.0.2"' \
    '.#"ghc96/byron-spec-ledger/1.0.0.2"' \
    '.#"ghc96/cardano-ledger-byron/1.0.0.4"' \
    '.#"ghc96/cardano-crypto-wrapper/1.5.1.1"' \
    '.#"ghc96/cardano-ledger-conway/1.12.0.0"' \
-   '.#"ghc96/cardano-ledger-conway-test/1.2.1.3"' \
    '.#"ghc96/cardano-ledger-mary/1.5.0.0"' \
    '.#"ghc96/cardano-ledger-shelley/1.9.0.0"' \
    '.#"ghc96/cardano-ledger-shelley-test/1.3.0.1"' \
@@ -114,13 +112,11 @@ Next, you will add the actual revisions and test if you can build your packages
    '.#"ghc96/cardano-ledger-alonzo/1.6.0.0"' \
    '.#"ghc96/cardano-ledger-alonzo-test/1.2.0.0"' \
    '.#"ghc96/cardano-ledger-babbage/1.6.0.0"' \
-   '.#"ghc96/cardano-ledger-babbage-test/1.2.0.0"' \
    '.#"ghc96/byron-spec-chain/1.0.0.2"' \
    '.#"ghc96/byron-spec-ledger/1.0.0.2"' \
    '.#"ghc96/cardano-ledger-byron/1.0.0.4"' \
    '.#"ghc96/cardano-crypto-wrapper/1.5.1.1"' \
    '.#"ghc96/cardano-ledger-conway/1.12.0.0"' \
-   '.#"ghc96/cardano-ledger-conway-test/1.2.1.3"' \
    '.#"ghc96/cardano-ledger-mary/1.5.0.0"' \
    '.#"ghc96/cardano-ledger-shelley/1.9.0.0"' \
    '.#"ghc96/cardano-ledger-shelley-test/1.3.0.1"' \
@@ -161,13 +157,11 @@ extra-packages:
   cardano-ledger-alonzo-1.6.0.0,
   cardano-ledger-alonzo-test-1.2.0.0,
   cardano-ledger-babbage-1.6.0.0,
-  cardano-ledger-babbage-test-1.2.0.0,
   byron-spec-chain-1.0.0.2,
   byron-spec-ledger-1.0.0.2,
   cardano-ledger-byron-1.0.0.4,
   cardano-crypto-wrapper-1.5.1.1,
   cardano-ledger-conway-1.12.0.0,
-  cardano-ledger-conway-test-1.2.1.3,
   cardano-ledger-mary-1.5.0.0,
   cardano-ledger-shelley-1.9.0.0,
   cardano-ledger-shelley-test-1.3.0.1,
@@ -201,13 +195,11 @@ library
    cardano-ledger-alonzo \
    cardano-ledger-alonzo-test \
    cardano-ledger-babbage \
-   cardano-ledger-babbage-test \
    byron-spec-chain \
    byron-spec-ledger \
    cardano-ledger-byron \
    cardano-crypto-wrapper \
    cardano-ledger-conway \
-   cardano-ledger-conway-test \
    cardano-ledger-mary \
    cardano-ledger-shelley \
    cardano-ledger-shelley-test \
@@ -248,13 +240,11 @@ library
    cardano-ledger-alonzo \
    cardano-ledger-alonzo-test \
    cardano-ledger-babbage \
-   cardano-ledger-babbage-test \
    byron-spec-chain \
    byron-spec-ledger \
    cardano-ledger-byron \
    cardano-crypto-wrapper \
    cardano-ledger-conway \
-   cardano-ledger-conway-test \
    cardano-ledger-mary \
    cardano-ledger-shelley \
    cardano-ledger-shelley-test \

cabal.project

@@ -40,9 +40,7 @@ packages:
   eras/alonzo/impl
   eras/alonzo/test-suite
   eras/babbage/impl
-  eras/babbage/test-suite
   eras/conway/impl
-  eras/conway/test-suite
   eras/dijkstra
   eras/mary/impl
   eras/shelley/impl

eras/allegra/impl/CHANGELOG.md

@@ -14,6 +14,7 @@
 
 ### `testlib`
 
+* Added `Examples` module with: `ledgerExamples`, `exampleAllegraTxBody`, `exampleAllegraTxAuxData`
 * Added `Arbitrary` instance for `TransitionConfig AllegraEra`
 * Added `Era` module with `AllegraEraTest` class
 

eras/allegra/impl/cardano-ledger-allegra.cabal

@@ -91,6 +91,7 @@ library testlib
     Test.Cardano.Ledger.Allegra.Binary.Cddl
     Test.Cardano.Ledger.Allegra.CDDL
     Test.Cardano.Ledger.Allegra.Era
+    Test.Cardano.Ledger.Allegra.Examples
     Test.Cardano.Ledger.Allegra.Imp
     Test.Cardano.Ledger.Allegra.Imp.UtxowSpec
     Test.Cardano.Ledger.Allegra.ImpTest
@@ -117,6 +118,7 @@ library testlib
     cardano-ledger-binary,
     cardano-ledger-core:{cardano-ledger-core, testlib},
     cardano-ledger-shelley:{cardano-ledger-shelley, testlib},
+    cardano-slotting,
     cardano-strict-containers,
     containers,
     cuddle >=0.4,

…Ledger/Api/Examples/Consensus/Allegra.hs …/Test/Cardano/Ledger/Allegra/Examples.hslibs/cardano-ledger-api/testlib/Test/Cardano/Ledger/Api/Examples/Consensus/Allegra.hs renamed to eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/Examples.hs libs/cardano-ledger-api/testlib/Test/Cardano/Ledger/Api/Examples/Consensus/Allegra.hs renamed to eras/allegra/impl/testlib/Test/Cardano/Ledger/Allegra/Examples.hs

@@ -5,10 +5,9 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE TypeOperators #-}
 
-module Test.Cardano.Ledger.Api.Examples.Consensus.Allegra (
-  ledgerExamplesAllegra,
+module Test.Cardano.Ledger.Allegra.Examples (
+  ledgerExamples,
   exampleAllegraTxBody,
-  exampleTimelock,
   exampleAllegraTxAuxData,
 ) where
 
@@ -25,14 +24,26 @@ import Cardano.Slotting.Slot
 import Data.Proxy
 import qualified Data.Sequence.Strict as StrictSeq
 import Lens.Micro
-import Test.Cardano.Ledger.Api.Examples.Consensus.Shelley
 import Test.Cardano.Ledger.Core.KeyPair (mkAddr)
 import Test.Cardano.Ledger.Core.Utils (mkDummySafeHash)
+import Test.Cardano.Ledger.Shelley.Examples (
+  LedgerExamples,
+  exampleAuxDataMap,
+  exampleCerts,
+  exampleCoin,
+  examplePayKey,
+  exampleProposedPPUpdates,
+  exampleStakeKey,
+  exampleTxIns,
+  exampleWithdrawals,
+  mkKeyHash,
+  mkLedgerExamples,
+  mkWitnessesPreAlonzo,
+ )
 
--- | ShelleyLedgerExamples for Allegra era
-ledgerExamplesAllegra :: ShelleyLedgerExamples AllegraEra
-ledgerExamplesAllegra =
-  defaultShelleyLedgerExamples
+ledgerExamples :: LedgerExamples AllegraEra
+ledgerExamples =
+  mkLedgerExamples
     (mkWitnessesPreAlonzo (Proxy @AllegraEra))
     exampleCoin
     (exampleAllegraTxBody exampleCoin)

eras/alonzo/impl/CHANGELOG.md

@@ -48,6 +48,8 @@
 
 ### `testlib`
 
+* Added `Examples` module with: `ledgerExamples`, `mkLedgerExamples`, `exampleTx`, `exampleDatum`, `exampleAlonzoGenesis`
+* Added `Twiddle` instances for Alonzo core types
 * Add `Arbitrary` instance for `LangDepView`
 * Add `computeScriptIntegrityPure`, `computeScriptIntegrity` and `computeScriptIntegrityHash`
 * Added `TxInfoPV4` to `VersionedTxInfo`

eras/alonzo/impl/cardano-ledger-alonzo.cabal

@@ -112,9 +112,11 @@ library testlib
     Test.Cardano.Ledger.Alonzo.Binary.Cddl
     Test.Cardano.Ledger.Alonzo.Binary.CostModelsSpec
     Test.Cardano.Ledger.Alonzo.Binary.RoundTrip
+    Test.Cardano.Ledger.Alonzo.Binary.Twiddle
     Test.Cardano.Ledger.Alonzo.Binary.TxWitsSpec
     Test.Cardano.Ledger.Alonzo.CDDL
     Test.Cardano.Ledger.Alonzo.Era
+    Test.Cardano.Ledger.Alonzo.Examples
     Test.Cardano.Ledger.Alonzo.Imp
     Test.Cardano.Ledger.Alonzo.Imp.UtxoSpec
     Test.Cardano.Ledger.Alonzo.Imp.UtxosSpec
@@ -148,14 +150,16 @@ library testlib
     cardano-data:{cardano-data, testlib},
     cardano-ledger-allegra,
     cardano-ledger-alonzo,
-    cardano-ledger-binary,
+    cardano-ledger-binary:{cardano-ledger-binary, testlib},
     cardano-ledger-core:{cardano-ledger-core, testlib},
     cardano-ledger-mary:{cardano-ledger-mary, testlib},
     cardano-ledger-shelley:{cardano-ledger-shelley, testlib},
     cardano-slotting,
     cardano-strict-containers,
+    cborg,
     containers,
     cuddle >=0.4,
+    data-default,
     generic-random,
     heredoc,
     microlens,
@@ -213,10 +217,12 @@ test-suite tests
   hs-source-dirs: test
   other-modules:
     Paths_cardano_ledger_alonzo
+    Test.Cardano.Ledger.Alonzo.Binary.CanonicalSpec
     Test.Cardano.Ledger.Alonzo.Binary.CddlSpec
     Test.Cardano.Ledger.Alonzo.BinarySpec
     Test.Cardano.Ledger.Alonzo.GoldenSpec
     Test.Cardano.Ledger.Alonzo.GoldenTranslation
+    Test.Cardano.Ledger.Alonzo.TxInfoSpec
 
   default-language: Haskell2010
   ghc-options:
@@ -233,10 +239,18 @@ test-suite tests
 
   build-depends:
     HUnit,
+    QuickCheck,
     base,
+    base16-bytestring,
+    bytestring,
     cardano-ledger-allegra,
     cardano-ledger-alonzo,
-    cardano-ledger-binary:testlib,
+    cardano-ledger-binary:{cardano-ledger-binary, testlib},
     cardano-ledger-core:{cardano-ledger-core, testlib},
     cardano-ledger-shelley:testlib,
+    cardano-slotting,
+    cardano-strict-containers,
+    containers,
+    plutus-ledger-api,
     testlib,
+    time,