Merge pull request #3281 from input-output-hk/jordan/CDEC-452

Jimbo4350 · web-flow · commit a32086e257fa · 2018-07-23T12:08:44.000-04:00
[CDEC-452] Implement ToJSON instance, golden test and round trip test for `AttackTarget` data type.
diff --git a/pkgs/default.nix b/pkgs/default.nix
@@ -17210,26 +17210,34 @@ license = stdenv.lib.licenses.mit;
 , array
 , base
 , bytestring
+, cardano-crypto
 , cardano-sl-binary
+, cardano-sl-binary-test
 , cardano-sl-core
+, cardano-sl-core-test
 , cardano-sl-crypto
+, cardano-sl-crypto-test
 , cardano-sl-db
 , cardano-sl-lrc
 , cardano-sl-util
+, cardano-sl-util-test
 , containers
 , cpphs
 , cryptonite
 , data-default
 , ether
 , exceptions
 , formatting
+, generic-arbitrary
+, hedgehog
 , lens
 , log-warper
 , memory
 , mmorph
 , mono-traversable
 , mtl
 , parsec
+, QuickCheck
 , reflection
 , rocksdb-haskell-ng
 , serokell-util
@@ -17291,6 +17299,26 @@ unordered-containers
 libraryToolDepends = [
 cpphs
 ];
+testHaskellDepends = [
+aeson
+base
+bytestring
+cardano-crypto
+cardano-sl-binary-test
+cardano-sl-core
+cardano-sl-core-test
+cardano-sl-crypto
+cardano-sl-crypto-test
+cardano-sl-util-test
+generic-arbitrary
+hedgehog
+parsec
+QuickCheck
+universum
+];
+testToolDepends = [
+cpphs
+];
 doHaddock = false;
 description = "Cardano SL - shared seed computation";
 license = stdenv.lib.licenses.mit;
@@ -17299,14 +17327,19 @@ license = stdenv.lib.licenses.mit;
 "cardano-sl-ssc-test" = callPackage
 ({
   mkDerivation
+, aeson
 , base
+, bytestring
+, cardano-crypto
+, cardano-sl-binary-test
 , cardano-sl-core
 , cardano-sl-core-test
 , cardano-sl-crypto
 , cardano-sl-crypto-test
 , cardano-sl-ssc
 , cardano-sl-util-test
 , generic-arbitrary
+, hedgehog
 , QuickCheck
 , stdenv
 , universum
@@ -17317,14 +17350,19 @@ pname = "cardano-sl-ssc-test";
 version = "1.3.0";
 src = ./../ssc/test;
 libraryHaskellDepends = [
+aeson
 base
+bytestring
+cardano-crypto
+cardano-sl-binary-test
 cardano-sl-core
 cardano-sl-core-test
 cardano-sl-crypto
 cardano-sl-crypto-test
 cardano-sl-ssc
 cardano-sl-util-test
 generic-arbitrary
+hedgehog
 QuickCheck
 universum
 ];
diff --git a/ssc/cardano-sl-ssc.cabal b/ssc/cardano-sl-ssc.cabal
@@ -123,3 +123,46 @@ library
 
   build-tools: cpphs >= 1.19
   ghc-options: -pgmP cpphs -optP --cpp
+
+test-suite test
+  main-is:             test.hs
+  hs-source-dirs:      test
+  default-language:    Haskell2010
+  type:                exitcode-stdio-1.0
+
+  other-modules:
+                       Test.Pos.Ssc.Arbitrary
+                       Test.Pos.Ssc.Gen
+                       Test.Pos.Ssc.Json
+
+
+  build-depends:       QuickCheck
+                     , aeson
+                     , base
+                     , bytestring
+                     , cardano-crypto
+                     , cardano-sl-binary-test
+                     , cardano-sl-core
+                     , cardano-sl-core-test
+                     , cardano-sl-crypto
+                     , cardano-sl-crypto-test
+                     , cardano-sl-ssc
+                     , cardano-sl-util-test
+                     , generic-arbitrary
+                     , hedgehog
+                     , parsec
+                     , universum
+
+  ghc-options:
+                       -threaded
+                       -rtsopts
+                       -Wall
+
+  -- linker speed up for linux
+  if os(linux)
+    ghc-options:       -optl-fuse-ld=gold
+    ld-options:        -fuse-ld=gold
+
+  build-tools: cpphs >= 1.19
+  ghc-options: -pgmP cpphs -optP --cpp
+
diff --git a/ssc/src/Pos/Security/Params.hs b/ssc/src/Pos/Security/Params.hs
@@ -12,6 +12,7 @@ import qualified Data.Aeson as A
 import           Data.Aeson.Options (defaultOptions)
 import qualified Data.Aeson.Types as A
 import           Data.Default (Default (..))
+import qualified Data.Text as T
 import qualified Text.Parsec as Parsec
 
 import           Pos.Core.Common (StakeholderId)
@@ -67,6 +68,16 @@ data AttackTarget
     | PubKeyAddressTarget  !StakeholderId
     deriving (Eq, Show)
 
+instance A.ToJSON AttackTarget where
+    toJSON = A.object . \case
+                 NetworkAddressTarget attNetworkAddr ->
+                    ["Network" A..=
+                        ((decodeUtf8 @Text $ fst attNetworkAddr)
+                            `T.append` ":"
+                            `T.append` (T.pack . show $ snd attNetworkAddr))
+                    ]
+                 PubKeyAddressTarget attPkAddr -> ["PubKey" A..= attPkAddr]
+
 instance A.FromJSON AttackTarget where
     parseJSON = A.withObject "AttackTarget" $ \o ->
         asum [ NetworkAddressTarget <$>
diff --git a/ssc/test/Test/Pos/Ssc/Gen.hs b/ssc/test/Test/Pos/Ssc/Gen.hs
@@ -0,0 +1,28 @@
+module Test.Pos.Ssc.Gen
+       ( genAttackTarget
+       ) where
+
+import           Universum
+
+import qualified Data.ByteString.Char8 as BC
+import           Hedgehog
+import qualified Hedgehog.Gen as Gen
+import qualified Hedgehog.Range as Range
+import           Pos.Security.Params (AttackTarget (..))
+import           Test.Pos.Core.Gen (genStakeholderId)
+
+
+----------------------------------------------------------------------------
+-- Pos.Ssc.Security Generators
+----------------------------------------------------------------------------
+
+genAttackTarget :: Gen AttackTarget
+genAttackTarget = do
+    netHostAddr <- genHost
+    port <- Gen.word16 (Range.constant 1 65535)
+    Gen.choice [ pure $ NetworkAddressTarget (netHostAddr, port)
+               , PubKeyAddressTarget <$> genStakeholderId
+               ]
+
+genHost :: Gen ByteString
+genHost = BC.pack <$> Gen.string (Range.constant 1 10) Gen.alphaNum
diff --git a/ssc/test/Test/Pos/Ssc/Json.hs b/ssc/test/Test/Pos/Ssc/Json.hs
@@ -0,0 +1,55 @@
+{-# LANGUAGE NoImplicitPrelude #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TemplateHaskell   #-}
+
+module Test.Pos.Ssc.Json
+       ( tests
+       ) where
+import           Universum
+
+import qualified Cardano.Crypto.Wallet as CC
+import           Hedgehog (Property)
+import qualified Hedgehog as H
+import           Pos.Crypto.Hashing (abstractHash)
+import           Pos.Crypto.Signing (PublicKey (..))
+import           Pos.Security.Params (AttackTarget (..))
+import           Test.Pos.Ssc.Gen (genAttackTarget)
+import           Test.Pos.Util.Golden (discoverGolden, eachOf, goldenTestJSON)
+import           Test.Pos.Util.Tripping (discoverRoundTrip, roundTripsAesonShow)
+
+-------------------------------------------------------------------------------
+-- AttackTarget
+-------------------------------------------------------------------------------
+golden_AttackTarget_NetworkAddressTarget :: Property
+golden_AttackTarget_NetworkAddressTarget =
+    goldenTestJSON exampleAttackTarget_NetworkAddressTarget
+        "test/golden/AttackTarget_NetworkAddressTarget"
+  where
+    exampleAttackTarget_NetworkAddressTarget =
+        NetworkAddressTarget ("ggv", 32313)
+
+
+golden_AttackTarget_PubKeyAddressTarget :: Property
+golden_AttackTarget_PubKeyAddressTarget =
+    goldenTestJSON exampleAttackTarget_PubKeyAddressTarget
+        "test/golden/AttackTarget_PubKeyAddressTarget"
+
+exampleAttackTarget_PubKeyAddressTarget :: AttackTarget
+exampleAttackTarget_PubKeyAddressTarget =
+    PubKeyAddressTarget
+        $ abstractHash (PublicKey (CC.XPub {CC.xpubPublicKey = pubKey1
+          , CC.xpubChaincode = CC.ChainCode "Test"}))
+  where
+    pubKey1 = "\145\&3\131kUF\226\131\253M\174\157;w>\156k"
+
+roundTripAttackTarget :: Property
+roundTripAttackTarget =
+    eachOf 1000 genAttackTarget roundTripsAesonShow
+
+-------------------------------------------------------------------------------
+-- Main test export
+-------------------------------------------------------------------------------
+
+tests :: IO Bool
+tests = (&&) <$> H.checkSequential $$discoverGolden
+             <*> H.checkParallel $$discoverRoundTrip
diff --git a/ssc/test/cardano-sl-ssc-test.cabal b/ssc/test/cardano-sl-ssc-test.cabal
@@ -15,16 +15,23 @@ cabal-version:       >=1.10
 library
   exposed-modules:
                        Test.Pos.Ssc.Arbitrary
+                       Test.Pos.Ssc.Gen
+                       Test.Pos.Ssc.Json
 
   build-depends:       QuickCheck
+                     , aeson
                      , base
+                     , bytestring
+                     , cardano-crypto
+                     , cardano-sl-binary-test
                      , cardano-sl-core
                      , cardano-sl-core-test
                      , cardano-sl-crypto
                      , cardano-sl-crypto-test
                      , cardano-sl-ssc
                      , cardano-sl-util-test
                      , generic-arbitrary
+                     , hedgehog
                      , universum
 
   default-language:    Haskell2010
diff --git a/ssc/test/golden/AttackTarget_NetworkAddressTarget b/ssc/test/golden/AttackTarget_NetworkAddressTarget
@@ -0,0 +1 @@
+{"Network":"ggv:32313"}
diff --git a/ssc/test/golden/AttackTarget_PubKeyAddressTarget b/ssc/test/golden/AttackTarget_PubKeyAddressTarget
@@ -0,0 +1 @@
+{"PubKey":"cae922c720ea93e5ead49b4652fb24caf4948e31eee378a4c4513f11"}
diff --git a/ssc/test/test.hs b/ssc/test/test.hs
@@ -0,0 +1,8 @@
+import           Test.Pos.Binary.Helpers (runTests)
+import qualified Test.Pos.Ssc.Json
+
+main :: IO ()
+main = do
+    runTests
+        [ Test.Pos.Ssc.Json.tests
+        ]

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"PubKey":"cae922c720ea93e5ead49b4652fb24caf4948e31eee378a4c4513f11"}`