Add golden test for all eras

lehins · lehins · commit 251ed05f0ab6 · 2025-08-21T17:47:38.000-06:00
diff --git a/eras/allegra/impl/cardano-ledger-allegra.cabal b/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.Era.Spec
     Test.Cardano.Ledger.Allegra.Examples
     Test.Cardano.Ledger.Allegra.Imp
     Test.Cardano.Ledger.Allegra.Imp.UtxowSpec
diff --git a/eras/allegra/impl/test/Main.hs b/eras/allegra/impl/test/Main.hs
@@ -5,6 +5,7 @@ module Main where
 import Cardano.Ledger.Allegra (AllegraEra)
 import qualified Test.Cardano.Ledger.Allegra.Binary.CddlSpec as CddlSpec
 import qualified Test.Cardano.Ledger.Allegra.BinarySpec as BinarySpec
+import Test.Cardano.Ledger.Allegra.Era.Spec (allegraEraSpec)
 import qualified Test.Cardano.Ledger.Allegra.Imp as Imp
 import Test.Cardano.Ledger.Allegra.ImpTest ()
 import Test.Cardano.Ledger.Common
@@ -13,7 +14,8 @@ import Test.Cardano.Ledger.Shelley.JSON (roundTripJsonShelleyEraSpec)
 
 main :: IO ()
 main =
-  ledgerTestMain $
+  ledgerTestMain $ do
+    allegraEraSpec @AllegraEra
     describe "Allegra" $ do
       BinarySpec.spec
       CddlSpec.spec
diff --git a/eras/alonzo/impl/cardano-ledger-alonzo.cabal b/eras/alonzo/impl/cardano-ledger-alonzo.cabal
@@ -116,6 +116,7 @@ library testlib
     Test.Cardano.Ledger.Alonzo.Binary.TxWitsSpec
     Test.Cardano.Ledger.Alonzo.CDDL
     Test.Cardano.Ledger.Alonzo.Era
+    Test.Cardano.Ledger.Alonzo.Era.Spec
     Test.Cardano.Ledger.Alonzo.Examples
     Test.Cardano.Ledger.Alonzo.Imp
     Test.Cardano.Ledger.Alonzo.Imp.UtxoSpec
diff --git a/eras/alonzo/impl/test/Main.hs b/eras/alonzo/impl/test/Main.hs
@@ -8,6 +8,7 @@ import qualified Test.Cardano.Ledger.Alonzo.Binary.CddlSpec as CddlSpec
 import qualified Test.Cardano.Ledger.Alonzo.Binary.CostModelsSpec as CostModelsSpec
 import qualified Test.Cardano.Ledger.Alonzo.Binary.TxWitsSpec as TxWitsSpec
 import qualified Test.Cardano.Ledger.Alonzo.BinarySpec as BinarySpec
+import Test.Cardano.Ledger.Alonzo.Era.Spec (alonzoEraSpec)
 import qualified Test.Cardano.Ledger.Alonzo.GoldenSpec as Golden
 import qualified Test.Cardano.Ledger.Alonzo.GoldenTranslation as GoldenTranslation
 import qualified Test.Cardano.Ledger.Alonzo.Imp as Imp
@@ -19,7 +20,8 @@ import Test.Cardano.Ledger.Shelley.JSON (roundTripJsonShelleyEraSpec)
 
 main :: IO ()
 main =
-  ledgerTestMain $
+  ledgerTestMain $ do
+    alonzoEraSpec @AlonzoEra
     describe "Alonzo" $ do
       BinarySpec.spec
       Canonical.spec
diff --git a/eras/babbage/impl/cardano-ledger-babbage.cabal b/eras/babbage/impl/cardano-ledger-babbage.cabal
@@ -107,6 +107,7 @@ library testlib
     Test.Cardano.Ledger.Babbage.Binary.Twiddle
     Test.Cardano.Ledger.Babbage.CDDL
     Test.Cardano.Ledger.Babbage.Era
+    Test.Cardano.Ledger.Babbage.Era.Spec
     Test.Cardano.Ledger.Babbage.Examples
     Test.Cardano.Ledger.Babbage.Imp
     Test.Cardano.Ledger.Babbage.Imp.UtxoSpec
diff --git a/eras/babbage/impl/test/Main.hs b/eras/babbage/impl/test/Main.hs
@@ -7,6 +7,7 @@ import qualified Test.Cardano.Ledger.Alonzo.Binary.CostModelsSpec as CostModelsS
 import qualified Test.Cardano.Ledger.Alonzo.Binary.TxWitsSpec as TxWitsSpec
 import qualified Test.Cardano.Ledger.Babbage.Binary.CddlSpec as CddlSpec
 import qualified Test.Cardano.Ledger.Babbage.BinarySpec as BinarySpec
+import Test.Cardano.Ledger.Babbage.Era.Spec (babbageEraSpec)
 import qualified Test.Cardano.Ledger.Babbage.GoldenSpec as Golden
 import qualified Test.Cardano.Ledger.Babbage.GoldenTranslation as GoldenTranslation
 import qualified Test.Cardano.Ledger.Babbage.Imp as Imp
@@ -18,7 +19,8 @@ import Test.Cardano.Ledger.Shelley.JSON (roundTripJsonShelleyEraSpec)
 
 main :: IO ()
 main =
-  ledgerTestMain $
+  ledgerTestMain $ do
+    babbageEraSpec @BabbageEra
     describe "Babbage" $ do
       TxInfo.spec @BabbageEra
       GoldenTranslation.spec
diff --git a/eras/conway/impl/cardano-ledger-conway.cabal b/eras/conway/impl/cardano-ledger-conway.cabal
@@ -134,6 +134,7 @@ library testlib
     Test.Cardano.Ledger.Conway.CommitteeRatifySpec
     Test.Cardano.Ledger.Conway.DRepRatifySpec
     Test.Cardano.Ledger.Conway.Era
+    Test.Cardano.Ledger.Conway.Era.Spec
     Test.Cardano.Ledger.Conway.Examples
     Test.Cardano.Ledger.Conway.Genesis
     Test.Cardano.Ledger.Conway.GenesisSpec
diff --git a/eras/conway/impl/test/Main.hs b/eras/conway/impl/test/Main.hs
@@ -7,6 +7,7 @@ import Cardano.Ledger.Conway (ConwayEra)
 import Cardano.Ledger.Conway.Tx (tierRefScriptFee)
 import Test.Cardano.Ledger.Common
 import qualified Test.Cardano.Ledger.Conway.Binary.CddlSpec as Cddl
+import Test.Cardano.Ledger.Conway.Era.Spec (conwayEraSpec)
 import qualified Test.Cardano.Ledger.Conway.GenesisSpec as Genesis
 import qualified Test.Cardano.Ledger.Conway.GoldenSpec as GoldenSpec
 import qualified Test.Cardano.Ledger.Conway.GoldenTranslation as GoldenTranslation
@@ -17,6 +18,7 @@ import Test.Cardano.Ledger.Shelley.JSON (roundTripJsonShelleyEraSpec)
 
 main :: IO ()
 main = ledgerTestMain $ do
+  conwayEraSpec @ConwayEra
   describe "Conway era-generic" $ ConwaySpec.spec @ConwayEra
   describe "Conway era-specific" $ do
     GoldenTranslation.spec
diff --git a/eras/dijkstra/cardano-ledger-dijkstra.cabal b/eras/dijkstra/cardano-ledger-dijkstra.cabal
@@ -111,6 +111,7 @@ library testlib
     Test.Cardano.Ledger.Dijkstra.Binary.RoundTrip
     Test.Cardano.Ledger.Dijkstra.CDDL
     Test.Cardano.Ledger.Dijkstra.Era
+    Test.Cardano.Ledger.Dijkstra.Era.Spec
     Test.Cardano.Ledger.Dijkstra.Examples
     Test.Cardano.Ledger.Dijkstra.ImpTest
     Test.Cardano.Ledger.Dijkstra.TreeDiff
diff --git a/eras/dijkstra/test/Main.hs b/eras/dijkstra/test/Main.hs
@@ -2,6 +2,7 @@
 
 module Main where
 
+import Test.Cardano.Ledger.Dijkstra.Era.Spec (dijkstraEraSpec)
 import Cardano.Ledger.Dijkstra (DijkstraEra)
 import Cardano.Ledger.Dijkstra.Rules ()
 import Test.Cardano.Ledger.Common
@@ -15,6 +16,7 @@ import Test.Cardano.Ledger.Shelley.JSON (roundTripJsonShelleyEraSpec)
 main :: IO ()
 main =
   ledgerTestMain $ do
+    dijkstraEraSpec @DijkstraEra
     describe "Dijkstra" $ do
       ConwaySpec.spec @DijkstraEra
     roundTripJsonShelleyEraSpec @DijkstraEra
diff --git a/eras/mary/impl/cardano-ledger-mary.cabal b/eras/mary/impl/cardano-ledger-mary.cabal
@@ -102,6 +102,7 @@ library testlib
     Test.Cardano.Ledger.Mary.Binary.Cddl
     Test.Cardano.Ledger.Mary.CDDL
     Test.Cardano.Ledger.Mary.Era
+    Test.Cardano.Ledger.Mary.Era.Spec
     Test.Cardano.Ledger.Mary.Examples
     Test.Cardano.Ledger.Mary.Imp
     Test.Cardano.Ledger.Mary.Imp.UtxoSpec
diff --git a/eras/mary/impl/test/Main.hs b/eras/mary/impl/test/Main.hs
@@ -7,14 +7,16 @@ import Test.Cardano.Ledger.Common
 import Test.Cardano.Ledger.Core.JSON (roundTripJsonEraSpec)
 import qualified Test.Cardano.Ledger.Mary.Binary.CddlSpec as CddlSpec
 import qualified Test.Cardano.Ledger.Mary.BinarySpec as BinarySpec
+import Test.Cardano.Ledger.Mary.Era.Spec (maryEraSpec)
 import qualified Test.Cardano.Ledger.Mary.Imp as Imp
 import Test.Cardano.Ledger.Mary.ImpTest ()
 import qualified Test.Cardano.Ledger.Mary.ValueSpec as ValueSpec
 import Test.Cardano.Ledger.Shelley.JSON (roundTripJsonShelleyEraSpec)
 
 main :: IO ()
 main =
-  ledgerTestMain $
+  ledgerTestMain $ do
+    maryEraSpec @MaryEra
     describe "Mary" $ do
       ValueSpec.spec
       BinarySpec.spec
diff --git a/eras/shelley/impl/cardano-ledger-shelley.cabal b/eras/shelley/impl/cardano-ledger-shelley.cabal
@@ -143,6 +143,7 @@ library testlib
     Test.Cardano.Ledger.Shelley.CDDL
     Test.Cardano.Ledger.Shelley.Constants
     Test.Cardano.Ledger.Shelley.Era
+    Test.Cardano.Ledger.Shelley.Era.Spec
     Test.Cardano.Ledger.Shelley.Examples
     Test.Cardano.Ledger.Shelley.Imp
     Test.Cardano.Ledger.Shelley.Imp.EpochSpec
diff --git a/eras/shelley/impl/test/Main.hs b/eras/shelley/impl/test/Main.hs
@@ -7,12 +7,14 @@ import Test.Cardano.Ledger.Common
 import Test.Cardano.Ledger.Core.JSON (roundTripJsonEraSpec)
 import qualified Test.Cardano.Ledger.Shelley.Binary.CddlSpec as Cddl
 import qualified Test.Cardano.Ledger.Shelley.BinarySpec as Binary
+import Test.Cardano.Ledger.Shelley.Era.Spec (shelleyEraSpec)
 import qualified Test.Cardano.Ledger.Shelley.Imp as Imp
 import Test.Cardano.Ledger.Shelley.JSON (roundTripJsonShelleyEraSpec)
 
 main :: IO ()
 main =
-  ledgerTestMain $
+  ledgerTestMain $ do
+    shelleyEraSpec @ShelleyEra
     describe "Shelley" $ do
       Binary.spec
       Cddl.spec
diff --git a/eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/ImpTest.hs b/eras/shelley/impl/testlib/Test/Cardano/Ledger/Shelley/ImpTest.hs
@@ -603,6 +603,7 @@ instance EraImp ShelleyEra where
                 & ppMinFeeAL .~ Coin 44
                 & ppMinFeeBL .~ Coin 155_381
                 & ppMaxBBSizeL .~ 65_536
+                & ppMaxBHSizeL .~ 1100
                 & ppMaxTxSizeL .~ 16_384
                 & ppKeyDepositL .~ Coin 2_000_000
                 & ppPoolDepositL .~ Coin 500_000_000
@@ -613,7 +614,7 @@ instance EraImp ShelleyEra where
                 & ppTauL .~ (2 %! 10)
                 & ppDL .~ (1 %! 1)
                 & ppExtraEntropyL .~ NeutralNonce
-                & ppMinUTxOValueL .~ Coin 2_000_000
+                & ppMinUTxOValueL .~ Coin 1_000_000
                 & ppMinPoolCostL .~ Coin 340_000_000
           , -- TODO: Add a top level definition and add private keys to ImpState:
             sgGenDelegs = mempty
diff --git a/libs/cardano-ledger-core/cardano-ledger-core.cabal b/libs/cardano-ledger-core/cardano-ledger-core.cabal
@@ -180,6 +180,7 @@ library testlib
     Test.Cardano.Ledger.Core.Rational
     Test.Cardano.Ledger.Core.Utils
     Test.Cardano.Ledger.Era
+    Test.Cardano.Ledger.Era.Spec
     Test.Cardano.Ledger.Imp.Common
     Test.Cardano.Ledger.ImpTest
     Test.Cardano.Ledger.Plutus
@@ -221,6 +222,7 @@ library testlib
     cuddle >=0.4,
     data-default,
     deepseq,
+    filepath,
     generic-random,
     genvalidity,
     hedgehog-quickcheck,
diff --git a/libs/cardano-ledger-core/src/Cardano/Ledger/Genesis.hs b/libs/cardano-ledger-core/src/Cardano/Ledger/Genesis.hs
@@ -1,5 +1,6 @@
 {-# LANGUAGE AllowAmbiguousTypes #-}
 {-# LANGUAGE DerivingVia #-}
+{-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE LambdaCase #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
@@ -22,6 +23,7 @@ import Cardano.Ledger.Binary (
   ToCBOR (..),
  )
 import Cardano.Ledger.Core.Era (Era)
+import Control.DeepSeq (NFData (..), rwhnf)
 import Control.Monad (unless)
 import Data.Aeson (
   FromJSON (..),
@@ -32,14 +34,29 @@ import qualified Data.Aeson.KeyMap as KV
 import Data.Kind (Type)
 import Data.Typeable
 
-class Era era => EraGenesis era where
+class
+  ( Era era
+  , Eq (Genesis era)
+  , Show (Genesis era)
+  , Typeable (Genesis era)
+  , ToCBOR (Genesis era)
+  , FromCBOR (Genesis era)
+  , ToJSON (Genesis era)
+  , FromJSON (Genesis era)
+  , NFData (Genesis era)
+  ) =>
+  EraGenesis era
+  where
   type Genesis era :: Type
   type Genesis era = NoGenesis era
 
 data NoGenesis era = NoGenesis
   deriving (Eq, Show)
   deriving (ToJSON) via KeyValuePairs (NoGenesis era)
 
+instance NFData (NoGenesis era) where
+  rnf = rwhnf
+
 instance Era era => ToCBOR (NoGenesis era) where
   toCBOR _ = toCBOR ()
 
diff --git a/libs/cardano-ledger-core/testlib/Test/Cardano/Ledger/Core/JSON.hs b/libs/cardano-ledger-core/testlib/Test/Cardano/Ledger/Core/JSON.hs
@@ -10,11 +10,15 @@ module Test.Cardano.Ledger.Core.JSON (
   roundTripJsonProperty,
   goldenJsonPParamsSpec,
   goldenJsonPParamsUpdateSpec,
+  goldenJsonExpectation,
+  goldenToJsonExpectation,
+  goldenFromJsonExpectation,
 ) where
 
 import Cardano.Ledger.Core
 import Data.Aeson (FromJSON, ToJSON, eitherDecode, eitherDecodeFileStrict, encode)
 import Data.Aeson.Encode.Pretty (encodePretty)
+import qualified Data.ByteString as BS
 import qualified Data.ByteString.Lazy as BSL
 import Data.Function ((&))
 import qualified Data.Text as T
@@ -78,7 +82,22 @@ goldenJsonPParamsUpdateSpec ::
   SpecWith FilePath
 goldenJsonPParamsUpdateSpec =
   it "Golden JSON specs for PParamsUpdate" $ \file -> do
-    let ppu = runGen 100 100 (arbitrary @(PParamsUpdate era))
-    let encoded = T.decodeUtf8 (BSL.toStrict (encodePretty ppu)) <> "\n"
-    fileContent <- T.decodeUtf8 . BSL.toStrict <$> BSL.readFile file
-    encoded `shouldBe` fileContent
+    goldenToJsonExpectation file $ runGen 100 100 (arbitrary @(PParamsUpdate era))
+
+goldenToJsonExpectation :: (HasCallStack, ToJSON a) => FilePath -> a -> Expectation
+goldenToJsonExpectation filePath value = do
+  let encoded = T.decodeUtf8 (BSL.toStrict (encodePretty value)) <> "\n"
+  fileContent <- T.decodeUtf8 <$> BS.readFile filePath
+  fileContent `shouldBe` encoded
+
+goldenFromJsonExpectation ::
+  (HasCallStack, FromJSON a, Show a, Eq a) => FilePath -> a -> Expectation
+goldenFromJsonExpectation filePath expectedValue = do
+  decodedValue <- expectRight =<< eitherDecodeFileStrict filePath
+  decodedValue `shouldBe` expectedValue
+
+goldenJsonExpectation ::
+  (HasCallStack, ToJSON a, FromJSON a, Show a, Eq a) => FilePath -> a -> Expectation
+goldenJsonExpectation filePath expectedValue = do
+  decodedValue <- expectRight =<< eitherDecodeFileStrict filePath
+  decodedValue `shouldBe` expectedValue
