Merge pull request #3415 from input-output-hk/mhuesch/CDEC-506

[CDEC-506] Make JSON golden tests check `FromJSON` decoding in addition to `ToJSON` encoding

Author: mhuesch

Diff for: core/test/Test/Pos/Core/ExampleHelpers.hs

@@ -94,6 +94,7 @@ import           Data.Time.Units (Millisecond)
 import qualified Data.Vector as V
 import qualified Hedgehog as H
 import           Serokell.Data.Memory.Units (Byte)
+import qualified Serokell.Util.Base16 as B16
 
 import qualified Cardano.Crypto.Wallet as CC
 import           Pos.Binary.Class (Raw (..), asBinary)
@@ -636,31 +637,43 @@ exampleGenesisAvvmBalances =
                      ,Coin {getCoin = 37343863242999412})
                      ]) }
   where
-    fstRedKey = "\254\156\235\217{]\130W\183LfJ\240"
-    sndRedKey =
-        "\254\156\235\217{]\130W\183LfJ\240\RS\224"
+    fstRedKey = hexToBS "e2a1773a2a82d10c30890cbf84eccbdc1aaaee9204\
+                        \96424d36e868039d9cb519"
+    sndRedKey = hexToBS "9cdabcec332abbc6fdf883ca5bf3a8afddca69bfea\
+                        \c14c013304da88ac032fe6"
 
 exampleSharedSeed :: SharedSeed
 exampleSharedSeed = SharedSeed (getBytes 8 32)
 
 exampleGenesisDelegation :: GenesisDelegation
 exampleGenesisDelegation = UnsafeGenesisDelegation (HM.fromList
-    [(abstractHash (PublicKey (CC.XPub {CC.xpubPublicKey = pubKey1
-    , CC.xpubChaincode = CC.ChainCode "Test"}))
-    , UnsafeProxySecretKey {pskOmega = HeavyDlgIndex $ EpochIndex 68300481033
-    , pskIssuerPk = PublicKey (CC.XPub {CC.xpubPublicKey = pskPubKey
-    , CC.xpubChaincode = CC.ChainCode "Test"})
-    , pskDelegatePk = PublicKey (CC.XPub {CC.xpubPublicKey = pskDelPubKey
-    , CC.xpubChaincode = CC.ChainCode "Test"})
-    , pskCert = ProxyCert (fromRight (error "Something went wrong") $ sig)})])
+    [( addressHash issuePubKey
+     , UnsafeProxySecretKey
+         { pskOmega =
+             HeavyDlgIndex $ EpochIndex 68300481033
+         , pskIssuerPk = issuePubKey
+         , pskDelegatePk =
+             PublicKey (CC.XPub { CC.xpubPublicKey = pskDelPubKey
+                                , CC.xpubChaincode = pskDelChainCode})
+         , pskCert =
+             ProxyCert (fromRight (error "Something went wrong") $ sig)
+         }
+      )]
+    )
   where
-    sig = CC.xsignature "\186\229B*\245@^8\ETX\NAKJJ\217\134\218]\DC4\207\
-                        \bMg\SOH\197\199\138y\236sw\DELt\225\&9s\175\131\
-                        \u!\DC4\217\241\129f\bY\151\252\129\228\&\
-                        \2\202\183\254\233\154']\139\241\&8\173\EOT\225\ETX"
-    pubKey1 = "\145\&3\131kUF\226\131\253M\174\157;w>\156k"
-    pskPubKey = "\DC1\RS\145\&3\131kUF\226\131\253M\174\157;w>\156k"
-    pskDelPubKey = "\132\248\DC1\RS\145\&3\131kUF\226\131\253M\174\157;w>\156k"
+    issuePubKey = PublicKey (CC.XPub { CC.xpubPublicKey = pskPubKey
+                                     , CC.xpubChaincode = pskChainCode})
+    sig = CC.xsignature (hexToBS "bae5422af5405e3803154a4ad986da5d14cf624d670\
+                                 \1c5c78a79ec73777f74e13973af83752114d9f18166\
+                                 \085997fc81e432cab7fee99a275d8bf138ad04e103")
+    pskPubKey = hexToBS "e2a1773a2a82d10c30890cbf84eccbdc1aaaee920496424d36e8\
+                        \68039d9cb519"
+    pskChainCode = CC.ChainCode (hexToBS "21b25efe033d9b00d4f02ccd9cdabcec332\
+                                         \abbc6fdf883ca5bf3a8aff4aac27e")
+    pskDelPubKey = hexToBS "ddca69bfeac14c013304da88ac032ee63281ab036c1b1b918\
+                           \8e4b174b303f43e"
+    pskDelChainCode = CC.ChainCode (hexToBS "55163b178e999b9fd50637b2edab8c85\
+                                            \8a879ac3c4bd3e610095419a19696573")
 
 exampleProtocolConstants :: GenesisProtocolConstants
 exampleProtocolConstants = GenesisProtocolConstants
@@ -684,3 +697,8 @@ exampleGenesisInitializer = GenesisInitializer
                  {getCoinPortion = 366832547637728}
                  , giUseHeavyDlg = False
                  , giSeed = 0}
+
+hexToBS :: Text -> ByteString
+hexToBS ts = case B16.decode ts of
+    Left err -> error $ "decode failed: " <> show err
+    Right bs -> bs

Diff for: core/test/golden/GenesisConfiguration_GCSpec

@@ -1 +1 @@
-{"spec":{"avvmDistr":{"_pzr2Xtdgle3TGZK8B7g":37343863242999412,"_pzr2Xtdgle3TGZK8A==":36524597913081152},"ftsSeed":"RTVTNGZTSDZldE5vdWlYZXpDeUVqS2MzdEc0amEwa0Y=","heavyDelegation":{"cae922c720ea93e5ead49b4652fb24caf4948e31eee378a4c4513f11":{"pskDelegatePk":"hPgRHpEzg2tVRuKD/U2unTt3PpxrVGVzdA==","pskOmega":68300481033,"pskCert":"bae5422af5405e3803154a4ad986da5d14cf624d6701c5c78a79ec73777f74e13973af83752114d9f18166085997fc81e432cab7fee99a275d8bf138ad04e103","pskIssuerPk":"ER6RM4NrVUbig/1Nrp07dz6ca1Rlc3Q="}},"blockVersionData":{"scriptVersion":999,"slotDuration":999,"maxBlockSize":999,"maxHeaderSize":999,"maxTxSize":999,"maxProposalSize":999,"mpcThd":9.9e-14,"heavyDelThd":9.9e-14,"updateVoteThd":9.9e-14,"updateProposalThd":9.9e-14,"updateImplicit":99,"softforkRule":{"initThd":9.9e-14,"minThd":9.9e-14,"thdDecrement":9.9e-14},"txFeePolicy":{"txSizeLinear":{"a":9.99e-7,"b":7.7e-8}},"unlockStakeEpoch":99},"protocolConstants":{"k":37,"protocolMagic":1783847074,"vssMaxTTL":1477558317,"vssMinTTL":744040476},"initializer":{"testBalance":{"poors":2448641325904532856,"richmen":14071205313513960321,"totalBalance":10953275486128625216,"richmenShare":4.2098713311249885,"useHDAddresses":true},"fakeAvvmBalance":{"count":17853231730478779264,"oneBalance":15087947214890024355},"avvmBalanceFactor":0.366832547637728,"useHeavyDlg":false,"seed":0}}}
+{"spec":{"avvmDistr":{"nNq87DMqu8b9-IPKW_Oor93Kab_qwUwBMwTaiKwDL-Y=":37343863242999412,"4qF3OiqC0QwwiQy_hOzL3Bqq7pIElkJNNuhoA52ctRk=":36524597913081152},"ftsSeed":"RTVTNGZTSDZldE5vdWlYZXpDeUVqS2MzdEc0amEwa0Y=","heavyDelegation":{"ed41bf35f4cd2109bdee27b0439942f6de3f55f0ac8d170de7136d3d":{"pskDelegatePk":"3cppv+rBTAEzBNqIrAMu5jKBqwNsGxuRiOSxdLMD9D5VFjsXjpmbn9UGN7Ltq4yFioeaw8S9PmEAlUGaGWllcw==","pskOmega":68300481033,"pskCert":"bae5422af5405e3803154a4ad986da5d14cf624d6701c5c78a79ec73777f74e13973af83752114d9f18166085997fc81e432cab7fee99a275d8bf138ad04e103","pskIssuerPk":"4qF3OiqC0QwwiQy/hOzL3Bqq7pIElkJNNuhoA52ctRkhsl7+Az2bANTwLM2c2rzsMyq7xv34g8pb86iv9KrCfg=="}},"blockVersionData":{"scriptVersion":999,"slotDuration":999,"maxBlockSize":999,"maxHeaderSize":999,"maxTxSize":999,"maxProposalSize":999,"mpcThd":9.9e-14,"heavyDelThd":9.9e-14,"updateVoteThd":9.9e-14,"updateProposalThd":9.9e-14,"updateImplicit":99,"softforkRule":{"initThd":9.9e-14,"minThd":9.9e-14,"thdDecrement":9.9e-14},"txFeePolicy":{"txSizeLinear":{"a":9.99e-7,"b":7.7e-8}},"unlockStakeEpoch":99},"protocolConstants":{"k":37,"protocolMagic":1783847074,"vssMaxTTL":1477558317,"vssMinTTL":744040476},"initializer":{"testBalance":{"poors":2448641325904532856,"richmen":14071205313513960321,"totalBalance":10953275486128625216,"richmenShare":4.2098713311249885,"useHDAddresses":true},"fakeAvvmBalance":{"count":17853231730478779264,"oneBalance":15087947214890024355},"avvmBalanceFactor":0.366832547637728,"useHeavyDlg":false,"seed":0}}}

Diff for: util/test/Test/Pos/Util/Golden.hs

@@ -2,13 +2,13 @@ module Test.Pos.Util.Golden where
 
 import           Universum
 
-import           Data.Aeson (ToJSON, encode)
-import qualified Data.ByteString as BS
+import           Data.Aeson (FromJSON, ToJSON, eitherDecode, encode)
 import qualified Data.ByteString.Lazy as LB
 import           Data.FileEmbed (embedStringFile)
 import qualified Data.List as List
 import           Hedgehog (Gen, Group, Property, PropertyT, TestLimit,
                      discoverPrefix, forAll, property, withTests, (===))
+import           Hedgehog.Internal.Property (failWith)
 import           Hedgehog.Internal.TH (TExpQ)
 import           Language.Haskell.TH (ExpQ, Q, loc_filename, runIO)
 import           Language.Haskell.TH.Syntax (qLocation)
@@ -28,11 +28,15 @@ embedGoldenTest :: FilePath -> ExpQ
 embedGoldenTest path =
     makeRelativeToTestDir ("golden/" <> path) >>= embedStringFile
 
-goldenTestJSON :: (ToJSON a, HasCallStack) => a -> FilePath -> Property
+goldenTestJSON :: (Eq a, FromJSON a, HasCallStack, Show a, ToJSON a)
+               => a -> FilePath -> Property
 goldenTestJSON x path = withFrozenCallStack $ do
     withTests 1 . property $ do
-        goldenJSON <- liftIO $ BS.readFile path
-        (LB.toStrict $ encode x) === goldenJSON
+        bs <- liftIO (LB.readFile path)
+        encode x === bs
+        case eitherDecode bs of
+            Left err -> failWith Nothing $ "could not decode: " <> show err
+            Right x' -> x === x'
 
 makeRelativeToTestDir :: FilePath -> Q FilePath
 makeRelativeToTestDir rel = do