Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

[CO-354] Fix ProtocolMagic Eq instance & related tests #3618

Merged
merged 1 commit into from
Sep 18, 2018
Merged

[CO-354] Fix ProtocolMagic Eq instance & related tests #3618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions core/test/Test/Pos/Core/ExampleHelpers.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ module Test.Pos.Core.ExampleHelpers
, exampleGenesisAvvmBalances0
, exampleGenesisAvvmBalances1
, exampleGenesisAvvmBalances2
, exampleGenesisConfiguration_GCSpec0YesNetworkMagic
, exampleGenesisConfiguration_GCSpec0
, exampleGenesisConfiguration_GCSpec1
, exampleGenesisConfiguration_GCSpec2
Expand All @@ -41,6 +42,7 @@ module Test.Pos.Core.ExampleHelpers
, exampleLightDlgIndices
, exampleOpening
, exampleOpeningsMap
, exampleGenesisProtocolConstants0YesNetworkMagic
, exampleGenesisProtocolConstants0
, exampleGenesisProtocolConstants1
, exampleGenesisProtocolConstants2
Expand Down Expand Up @@ -743,6 +745,16 @@ exampleGenesisConfiguration_GCSrc :: GenesisConfiguration
exampleGenesisConfiguration_GCSrc =
GCSrc "dRaMwdYsH3QA3dChe" (abstractHash (Raw "Test"))

exampleGenesisConfiguration_GCSpec0YesNetworkMagic :: GenesisConfiguration
exampleGenesisConfiguration_GCSpec0YesNetworkMagic =
GCSpec $ UnsafeGenesisSpec
exampleGenesisAvvmBalances0
exampleSharedSeed0
exampleGenesisDelegation
exampleBlockVersionData0
exampleGenesisProtocolConstants0YesNetworkMagic
exampleGenesisInitializer0

exampleGenesisConfiguration_GCSpec0 :: GenesisConfiguration
exampleGenesisConfiguration_GCSpec0 =
GCSpec $ UnsafeGenesisSpec
Expand Down Expand Up @@ -950,11 +962,20 @@ exampleGenesisDelegation = UnsafeGenesisDelegation (HM.fromList
pskDelChainCode = CC.ChainCode (hexToBS "55163b178e999b9fd50637b2edab8c85\
\8a879ac3c4bd3e610095419a19696573")

exampleGenesisProtocolConstants0YesNetworkMagic :: GenesisProtocolConstants
exampleGenesisProtocolConstants0YesNetworkMagic = GenesisProtocolConstants
{ gpcK = 37
, gpcProtocolMagic = ProtocolMagic { getProtocolMagicId = ProtocolMagicId 1783847074
, getRequiresNetworkMagic = NMMustBeNothing
}
, gpcVssMaxTTL = VssMaxTTL {getVssMaxTTL = 1477558317}
, gpcVssMinTTL = VssMinTTL {getVssMinTTL = 744040476}}

exampleGenesisProtocolConstants0 :: GenesisProtocolConstants
exampleGenesisProtocolConstants0 = GenesisProtocolConstants
{ gpcK = 37
, gpcProtocolMagic = ProtocolMagic { getProtocolMagicId = ProtocolMagicId 1783847074
, getRequiresNetworkMagic = NMMustBeNothing
, getRequiresNetworkMagic = NMMustBeJust
}
, gpcVssMaxTTL = VssMaxTTL {getVssMaxTTL = 1477558317}
, gpcVssMinTTL = VssMinTTL {getVssMinTTL = 744040476}}
Expand All @@ -963,7 +984,7 @@ exampleGenesisProtocolConstants1 :: GenesisProtocolConstants
exampleGenesisProtocolConstants1 = GenesisProtocolConstants
{ gpcK = 64
, gpcProtocolMagic = ProtocolMagic { getProtocolMagicId = ProtocolMagicId 135977977
, getRequiresNetworkMagic = NMMustBeNothing
, getRequiresNetworkMagic = NMMustBeJust
}
, gpcVssMaxTTL = VssMaxTTL {getVssMaxTTL = 126106167}
, gpcVssMinTTL = VssMinTTL {getVssMinTTL = 310228653}}
Expand All @@ -972,7 +993,7 @@ exampleGenesisProtocolConstants2 :: GenesisProtocolConstants
exampleGenesisProtocolConstants2 = GenesisProtocolConstants
{ gpcK = 2
, gpcProtocolMagic = ProtocolMagic { getProtocolMagicId = ProtocolMagicId 1780893186
, getRequiresNetworkMagic = NMMustBeNothing
, getRequiresNetworkMagic = NMMustBeJust
}
, gpcVssMaxTTL = VssMaxTTL {getVssMaxTTL = 402296078}
, gpcVssMinTTL = VssMinTTL {getVssMinTTL = 1341799941}}
Expand Down
10 changes: 6 additions & 4 deletions core/test/Test/Pos/Core/Json.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@ import Pos.Aeson.Genesis ()
import Test.Pos.Core.ExampleHelpers (exampleAddress, exampleAddress1, exampleAddress2,
exampleAddress3, exampleAddress4,
exampleGenesisConfiguration_GCSpec0,
exampleGenesisConfiguration_GCSpec0YesNetworkMagic,
exampleGenesisConfiguration_GCSpec1,
exampleGenesisConfiguration_GCSpec2,
exampleGenesisConfiguration_GCSrc,
exampleGenesisData0, exampleGenesisData1,
exampleGenesisData2,
exampleGenesisProtocolConstants0,
exampleGenesisProtocolConstants0YesNetworkMagic,
exampleGenesisProtocolConstants1,
exampleGenesisProtocolConstants2, feedPM)
import Test.Pos.Core.Gen (genAddress, genBlockVersionData, genByte, genCoin,
Expand Down Expand Up @@ -82,8 +84,8 @@ roundTripAddressBuildable =
golden_GenesisConfiguration_GCSpec0 :: Property
golden_GenesisConfiguration_GCSpec0 =
goldenTestJSON
exampleGenesisConfiguration_GCSpec0
"test/golden/json/GenesisConfiguration_GCSpec0"
exampleGenesisConfiguration_GCSpec0YesNetworkMagic
"test/golden/json/GenesisConfiguration_GCSpec0_YesNetworkMagic"

-- Test only decoding (for ensuring backwards compatibility with
-- old GenesisConfiguration format).
Expand Down Expand Up @@ -240,8 +242,8 @@ roundTripEpochIndex = eachOf 1000 genEpochIndex roundTripsAesonBuildable
golden_GenesisProtocolConstants0 :: Property
golden_GenesisProtocolConstants0 =
goldenTestJSON
exampleGenesisProtocolConstants0
"test/golden/json/GenesisProtocolConstants0"
exampleGenesisProtocolConstants0YesNetworkMagic
"test/golden/json/GenesisProtocolConstants0_YesNetworkMagic"

-- Test only decoding (for ensuring backwards compatibility with
-- old GenesisProtocolConstants format).
Expand Down
0 .../golden/json/GenesisConfiguration_GCSpec0 → ...esisConfiguration_GCSpec0_YesNetworkMagic
View file
Open in desktop
File renamed without changes.
0 ...est/golden/json/GenesisProtocolConstants0 → ...GenesisProtocolConstants0_YesNetworkMagic
View file
Open in desktop
File renamed without changes.
9 changes: 1 addition & 8 deletions crypto/Pos/Crypto/Configuration.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import Universum
import Data.Aeson ((.:), (.=))
import qualified Data.Aeson as A
import Data.Aeson.Types (typeMismatch)
import Data.Function (on)
import Text.JSON.Canonical (FromJSON (..), JSValue (..), ReportSchemaErrors, ToJSON (..),
expected)

Expand Down Expand Up @@ -81,19 +80,13 @@ newtype ProtocolMagicId = ProtocolMagicId
data ProtocolMagic = ProtocolMagic
{ getProtocolMagicId :: !ProtocolMagicId
, getRequiresNetworkMagic :: !RequiresNetworkMagic
} deriving (Show, Generic)
} deriving (Eq, Show, Generic)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


-- mhueschen: For backwards-compatibility reasons, I redefine this function
-- in terms of the two record accessors.
getProtocolMagic :: ProtocolMagic -> Int32
getProtocolMagic = unProtocolMagicId . getProtocolMagicId

-- Since ProtocolMagic is widely used and we want to maintain backwards
-- compatibility of equality checks between the Int32 identifier, we only
-- compare Eq on `getProtocolMagicId`.
instance Eq ProtocolMagic where
(==) = (==) `on` getProtocolMagicId

instance NFData ProtocolMagic

instance A.ToJSON ProtocolMagic where
Expand Down