Skip to content

Commit e6f01fe

Browse files
Merge #4833
4833: Implement ADR-2: Restructure modules for generators r=newhoggy a=newhoggy Rename: * `Gen.Cardano.*` -> `Test.Gen.Cardano.*` * `Hedgehog.*` -> `Test.Hedgehog.*` See https://github.com/input-output-hk/cardano-node/wiki/ADR-2-Module-structure-for-generators Co-authored-by: John Ky <[email protected]>
2 parents 26ad4b5 + 46c2cb9 commit e6f01fe

File tree

22 files changed

+44
-37
lines changed

22 files changed

+44
-37
lines changed

cardano-api/cardano-api.cabal

+6-6
Original file line numberDiff line numberDiff line change
@@ -179,12 +179,12 @@ library gen
179179

180180
hs-source-dirs: gen
181181

182-
exposed-modules: Gen.Cardano.Api
183-
Gen.Cardano.Api.Metadata
184-
Gen.Cardano.Api.Typed
185-
Gen.Cardano.Crypto.Seed
186-
Gen.Hedgehog.Roundtrip.Bech32
187-
Gen.Hedgehog.Roundtrip.CBOR
182+
exposed-modules: Test.Gen.Cardano.Api
183+
Test.Gen.Cardano.Api.Metadata
184+
Test.Gen.Cardano.Api.Typed
185+
Test.Gen.Cardano.Crypto.Seed
186+
Test.Hedgehog.Roundtrip.Bech32
187+
Test.Hedgehog.Roundtrip.CBOR
188188

189189
build-depends: aeson >= 1.5.6.0
190190
, base16-bytestring

cardano-api/gen/Gen/Cardano/Api.hs renamed to cardano-api/gen/Test/Gen/Cardano/Api.hs

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{-# LANGUAGE RankNTypes #-}
44
{-# LANGUAGE ScopedTypeVariables #-}
55

6-
module Gen.Cardano.Api
6+
module Test.Gen.Cardano.Api
77
( genMetadata
88
, genAlonzoGenesis
99
) where
@@ -17,7 +17,7 @@ import qualified Data.Text as Text
1717
import Data.Word (Word64)
1818

1919
--TODO: why do we have this odd split? We can get rid of the old name "typed"
20-
import Gen.Cardano.Api.Typed (genCostModel, genRational)
20+
import Test.Gen.Cardano.Api.Typed (genCostModel, genRational)
2121

2222
import qualified Cardano.Ledger.Alonzo.Genesis as Alonzo
2323
import qualified Cardano.Ledger.Alonzo.Language as Alonzo

cardano-api/gen/Gen/Cardano/Api/Metadata.hs renamed to cardano-api/gen/Test/Gen/Cardano/Api/Metadata.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{-# LANGUAGE OverloadedStrings #-}
22

3-
module Gen.Cardano.Api.Metadata
3+
module Test.Gen.Cardano.Api.Metadata
44
( genTxMetadata
55
, genTxMetadataValue
66
, genJsonForTxMetadata

cardano-api/gen/Gen/Cardano/Api/Typed.hs renamed to cardano-api/gen/Test/Gen/Cardano/Api/Typed.hs

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
{-# LANGUAGE TupleSections #-}
77
{-# LANGUAGE TypeApplications #-}
88

9-
module Gen.Cardano.Api.Typed
9+
module Test.Gen.Cardano.Api.Typed
1010
( genAddressByron
1111
, genAddressInEra
1212
, genAddressShelley
@@ -146,9 +146,9 @@ import Cardano.Ledger.Alonzo.Language (Language (..))
146146
import qualified Cardano.Ledger.Alonzo.Scripts as Alonzo
147147
import Cardano.Ledger.SafeHash (unsafeMakeSafeHash)
148148

149-
import Gen.Cardano.Api.Metadata (genTxMetadata)
150149
import Test.Cardano.Chain.UTxO.Gen (genVKWitness)
151150
import Test.Cardano.Crypto.Gen (genProtocolMagicId)
151+
import Test.Gen.Cardano.Api.Metadata (genTxMetadata)
152152

153153
{- HLINT ignore "Reduce duplication" -}
154154

cardano-api/gen/Gen/Cardano/Crypto/Seed.hs renamed to cardano-api/gen/Test/Gen/Cardano/Crypto/Seed.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module Gen.Cardano.Crypto.Seed
1+
module Test.Gen.Cardano.Crypto.Seed
22
( genSeed
33
, genSeedForKey
44
) where

cardano-api/gen/Gen/Hedgehog/Roundtrip/Bech32.hs renamed to cardano-api/gen/Test/Hedgehog/Roundtrip/Bech32.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module Gen.Hedgehog.Roundtrip.Bech32
1+
module Test.Hedgehog.Roundtrip.Bech32
22
( roundtrip_Bech32
33
) where
44

cardano-api/gen/Gen/Hedgehog/Roundtrip/CBOR.hs renamed to cardano-api/gen/Test/Hedgehog/Roundtrip/CBOR.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{-# LANGUAGE FlexibleContexts #-}
22

3-
module Gen.Hedgehog.Roundtrip.CBOR
3+
module Test.Hedgehog.Roundtrip.CBOR
44
( roundtrip_CBOR
55
, roundtrip_CDDL_Tx
66
) where

cardano-api/test/Test/Cardano/Api/Json.hs

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ import Cardano.Api.Orphans ()
1010
import Cardano.Api.Shelley
1111
import Data.Aeson (FromJSON (parseJSON), ToJSON (toJSON), eitherDecode, encode)
1212
import Data.Aeson.Types (Parser, parseEither)
13-
import Gen.Cardano.Api (genAlonzoGenesis)
14-
import Gen.Cardano.Api.Typed
1513
import Hedgehog (Property, forAll, tripping)
14+
import Test.Gen.Cardano.Api (genAlonzoGenesis)
15+
import Test.Gen.Cardano.Api.Typed
1616
import Test.Tasty (TestTree, testGroup)
1717
import Test.Tasty.Hedgehog (testPropertyNamed)
1818

cardano-api/test/Test/Cardano/Api/KeysByron.hs

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ module Test.Cardano.Api.KeysByron
55
) where
66

77
import Cardano.Api (AsType (AsByronKey, AsSigningKey), Key (deterministicSigningKey))
8-
import Gen.Hedgehog.Roundtrip.CBOR (roundtrip_CBOR)
8+
99
import Hedgehog (Property)
1010
import Test.Cardano.Api.Typed.Orphans ()
11+
import Test.Hedgehog.Roundtrip.CBOR (roundtrip_CBOR)
1112
import Test.Tasty (TestTree, testGroup)
1213
import Test.Tasty.Hedgehog (testPropertyNamed)
1314

14-
import qualified Gen.Cardano.Crypto.Seed as Gen
15+
import qualified Test.Gen.Cardano.Crypto.Seed as Gen
1516

1617
{- HLINT ignore "Use camelCase" -}
1718

cardano-api/test/Test/Cardano/Api/Metadata.hs

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ module Test.Cardano.Api.Metadata
88

99
import Cardano.Api
1010

11-
import Gen.Cardano.Api.Metadata
12-
1311
import Data.ByteString (ByteString)
1412
import Data.Word (Word64)
1513
import Hedgehog (Property, property, (===))
14+
import Test.Gen.Cardano.Api.Metadata
1615
import Test.Tasty (TestTree, testGroup)
1716
import Test.Tasty.Hedgehog (testPropertyNamed)
1817

cardano-api/test/Test/Cardano/Api/Typed/Address.hs

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ module Test.Cardano.Api.Typed.Address
55
) where
66

77
import Cardano.Api
8-
import Gen.Cardano.Api.Typed (genAddressByron, genAddressShelley)
8+
99
import Hedgehog (Property)
1010
import Test.Cardano.Api.Typed.Orphans ()
11+
import Test.Gen.Cardano.Api.Typed (genAddressByron, genAddressShelley)
1112
import Test.Tasty (TestTree, testGroup)
1213
import Test.Tasty.Hedgehog (testPropertyNamed)
1314

cardano-api/test/Test/Cardano/Api/Typed/Bech32.hs

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ module Test.Cardano.Api.Typed.Bech32
22
( tests
33
) where
44

5-
import Cardano.Api (AsType(AsStakeAddress, AsShelleyAddress))
6-
import Gen.Cardano.Api.Typed( genAddressShelley, genStakeAddress)
7-
import Gen.Hedgehog.Roundtrip.Bech32 (roundtrip_Bech32)
5+
import Cardano.Api (AsType (AsShelleyAddress, AsStakeAddress))
86
import Hedgehog (Property)
7+
import Test.Gen.Cardano.Api.Typed (genAddressShelley, genStakeAddress)
8+
import Test.Hedgehog.Roundtrip.Bech32 (roundtrip_Bech32)
99
import Test.Tasty (TestTree, testGroup)
1010
import Test.Tasty.Hedgehog (testPropertyNamed)
1111

cardano-api/test/Test/Cardano/Api/Typed/CBOR.hs

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ import Cardano.Api
1010

1111
import Data.Proxy (Proxy (..))
1212
import Data.String (IsString (..))
13-
import Gen.Cardano.Api.Typed
14-
import Gen.Hedgehog.Roundtrip.CBOR (roundtrip_CBOR, roundtrip_CDDL_Tx)
1513
import Hedgehog (Property, forAll, property, success, tripping)
1614
import Test.Cardano.Api.Typed.Orphans ()
15+
import Test.Gen.Cardano.Api.Typed
16+
import Test.Hedgehog.Roundtrip.CBOR (roundtrip_CBOR, roundtrip_CDDL_Tx)
1717
import Test.Tasty (TestTree, testGroup)
1818
import Test.Tasty.Hedgehog (testPropertyNamed)
1919

cardano-api/test/Test/Cardano/Api/Typed/Envelope.hs

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ module Test.Cardano.Api.Typed.Envelope
55
) where
66

77
import Cardano.Api
8-
import Gen.Cardano.Api.Typed
8+
99
import Hedgehog (Property)
1010
import Test.Cardano.Api.Typed.Orphans ()
11+
import Test.Gen.Cardano.Api.Typed
1112
import Test.Tasty (TestTree, testGroup)
1213
import Test.Tasty.Hedgehog (testPropertyNamed)
1314

cardano-api/test/Test/Cardano/Api/Typed/JSON.hs

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ module Test.Cardano.Api.Typed.JSON
99
) where
1010

1111
import Data.Aeson (eitherDecode, encode)
12-
import Gen.Cardano.Api.Typed (genMaybePraosNonce, genProtocolParameters)
12+
1313
import Hedgehog (Property, forAll, tripping)
1414
import Test.Cardano.Api.Typed.Orphans ()
15+
import Test.Gen.Cardano.Api.Typed (genMaybePraosNonce, genProtocolParameters)
1516
import Test.Tasty (TestTree, testGroup)
1617
import Test.Tasty.Hedgehog (testPropertyNamed)
1718

cardano-api/test/Test/Cardano/Api/Typed/Ord.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ module Test.Cardano.Api.Typed.Ord
55
import Cardano.Api
66
import Cardano.Api.Shelley
77

8-
import Gen.Cardano.Api.Typed
98
import Hedgehog (Property, (===))
109
import Test.Cardano.Api.Metadata (genTxMetadataValue)
10+
import Test.Gen.Cardano.Api.Typed
1111
import Test.Tasty (TestTree, testGroup)
1212
import Test.Tasty.Hedgehog (testPropertyNamed)
1313

cardano-api/test/Test/Cardano/Api/Typed/RawBytes.hs

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ module Test.Cardano.Api.Typed.RawBytes
55
) where
66

77
import Cardano.Api
8-
import Gen.Cardano.Api.Typed
8+
99
import Hedgehog (Property)
1010
import Test.Cardano.Api.Typed.Orphans ()
11+
import Test.Gen.Cardano.Api.Typed
1112
import Test.Tasty (TestTree, testGroup)
1213
import Test.Tasty.Hedgehog (testPropertyNamed)
1314

cardano-api/test/Test/Cardano/Api/Typed/Script.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ module Test.Cardano.Api.Typed.Script
55
import Cardano.Api
66
import Cardano.Api.Shelley
77
import Data.Aeson
8-
import Gen.Cardano.Api.Typed
98
import Hedgehog (Property, (===))
109
import Hedgehog.Extras.Aeson
10+
import Test.Gen.Cardano.Api.Typed
1111
import Test.Tasty (TestTree, testGroup)
1212
import Test.Tasty.Hedgehog (testPropertyNamed)
1313

cardano-api/test/Test/Cardano/Api/Typed/TxBody.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ import Cardano.Api
88
import Cardano.Api.Shelley (ReferenceScript (..), refScriptToShelleyScript)
99
import Data.Maybe (isJust)
1010
import Data.Type.Equality (TestEquality (testEquality))
11-
import Gen.Cardano.Api.Typed (genTxBodyContent)
1211
import Hedgehog (MonadTest, Property, annotateShow, failure, (===))
1312
import Test.Cardano.Api.Typed.Orphans ()
13+
import Test.Gen.Cardano.Api.Typed (genTxBodyContent)
1414
import Test.Tasty (TestTree, testGroup)
1515
import Test.Tasty.Hedgehog (testPropertyNamed)
1616

cardano-api/test/Test/Cardano/Api/Typed/Value.hs

+6-3
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@ module Test.Cardano.Api.Typed.Value
22
( tests
33
) where
44

5+
import Prelude
6+
57
import Cardano.Api (ValueNestedBundle (..), ValueNestedRep (..), valueFromNestedRep,
68
valueToNestedRep)
9+
710
import Data.Aeson (eitherDecode, encode)
811
import Data.List (groupBy, sort)
9-
import Gen.Cardano.Api.Typed (genAssetName, genValueDefault, genValueNestedRep)
12+
import qualified Data.Map.Strict as Map
13+
1014
import Hedgehog (Property, forAll, property, tripping, (===))
15+
import Test.Gen.Cardano.Api.Typed (genAssetName, genValueDefault, genValueNestedRep)
1116
import Test.Tasty (TestTree, testGroup)
1217
import Test.Tasty.Hedgehog (testPropertyNamed)
1318

14-
import qualified Data.Map.Strict as Map
15-
1619
prop_roundtrip_Value_JSON :: Property
1720
prop_roundtrip_Value_JSON =
1821
property $ do v <- forAll genValueDefault

cardano-cli/test/Test/Cli/JSON.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ module Test.Cli.JSON where
66
import Cardano.Prelude hiding (filter)
77

88
import Cardano.Api.Shelley
9-
import Gen.Cardano.Api.Typed (genLovelace, genSlotNo, genStakeAddress,
9+
import Test.Gen.Cardano.Api.Typed (genLovelace, genSlotNo, genStakeAddress,
1010
genVerificationKeyHash)
1111

1212
import Data.Aeson

cardano-cli/test/Test/Cli/MultiAssetParsing.hs

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import Hedgehog.Gen (filter)
1313

1414
import Cardano.Api (parseValue, renderValue, renderValuePretty, valueToList)
1515

16-
import Gen.Cardano.Api.Typed (genValueDefault)
16+
import Test.Gen.Cardano.Api.Typed (genValueDefault)
1717

1818
prop_roundtrip_Value_parse_render :: Property
1919
prop_roundtrip_Value_parse_render =

0 commit comments

Comments
 (0)