hnix-store-tests: init

Split from `-core` so it doesn't depend on quickcheck,
generic-arbitrary and quickcheck-instances that could propagate downstrem.
Also allows users to defined their own.

With all roundtrip property tests.

Later this should also absorb test nix-store/daemon harness from
`-remote` so it can be reused by others.

Author: sorki

cabal.project

@@ -2,6 +2,7 @@ packages:
   ./hnix-store-core/hnix-store-core.cabal
   ./hnix-store-db/hnix-store-db.cabal
   ./hnix-store-remote/hnix-store-remote.cabal
+  ./hnix-store-tests/hnix-store-tests.cabal
 
 -- till https://github.com/obsidiansystems/dependent-sum/pull/80
 allow-newer:

cabal.project.local.ci

@@ -8,3 +8,6 @@ package hnix-store-db
 
 package hnix-store-remote
   ghc-options: -Wunused-packages -Wall -Werror
+
+package hnix-store-tests
+  ghc-options: -Wunused-packages -Wall -Werror

default.nix

@@ -22,7 +22,8 @@ in {
   inherit (haskellPackages)
     hnix-store-core
     hnix-store-db
-    hnix-store-remote;
+    hnix-store-remote
+    hnix-store-tests;
   haskellPackages = lib.dontRecurseIntoAttrs haskellPackages;
   pkgs = lib.dontRecurseIntoAttrs pkgs;
 }

hnix-store-core/hnix-store-core.cabal

@@ -89,7 +89,6 @@ library
     , data-default-class
     , dependent-sum > 0.7
     , dependent-sum-template > 0.1.1 && < 0.3
-    , generic-arbitrary < 1.1
     -- Required for cryptonite low-level type convertion
     , memory
     , cryptonite
@@ -100,8 +99,6 @@ library
     , monad-control
     , mtl
     , nix-derivation >= 1.1.1 && <2
-    , QuickCheck
-    , quickcheck-instances
     , saltine >= 0.2 && < 0.3
     , some > 1.0.5 && < 2
     , time
@@ -124,11 +121,8 @@ test-suite format-tests
   main-is: Driver.hs
   other-modules:
     Derivation
-    DerivedPath
-    ContentAddress
     NarFormat
     Hash
-    StorePath
   hs-source-dirs:
     tests
   build-tool-depends:
@@ -147,7 +141,6 @@ test-suite format-tests
     , directory
     , filepath
     , process
-    , nix-derivation >= 1.1.1 && <2
     , tasty
     , tasty-golden
     , hspec

hnix-store-core/src/System/Nix/Build.hs

@@ -1,5 +1,3 @@
--- due to recent generic-arbitrary
-{-# OPTIONS_GHC -fconstraint-solver-iterations=0 #-}
 {-|
 Description : Build related types
 Maintainer  : srk <[email protected]>
@@ -14,15 +12,11 @@ module System.Nix.Build
 import Data.Time (UTCTime)
 import Data.Text (Text)
 import GHC.Generics (Generic)
-import Test.QuickCheck (Arbitrary(..))
-import Test.QuickCheck.Arbitrary.Generic (GenericArbitrary(..))
-import Test.QuickCheck.Instances ()
 
 -- keep the order of these Enums to match enums from reference implementations
 -- src/libstore/store-api.hh
 data BuildMode = Normal | Repair | Check
   deriving (Eq, Generic, Ord, Enum, Show)
-  deriving Arbitrary via GenericArbitrary BuildMode
 
 data BuildStatus =
     Built
@@ -41,7 +35,6 @@ data BuildStatus =
   | ResolvesToAlreadyValid
   | NoSubstituters
   deriving (Eq, Generic, Ord, Enum, Show)
-  deriving Arbitrary via GenericArbitrary BuildStatus
 
 -- | Result of the build
 data BuildResult = BuildResult
@@ -59,7 +52,6 @@ data BuildResult = BuildResult
     stopTime           :: !UTCTime
   }
   deriving (Eq, Generic, Ord, Show)
-  deriving Arbitrary via GenericArbitrary BuildResult
 
 buildSuccess :: BuildResult -> Bool
 buildSuccess BuildResult {..} =

hnix-store-core/src/System/Nix/ContentAddress.hs

@@ -2,6 +2,8 @@
 
 module System.Nix.ContentAddress (
     ContentAddress
+  , ContentAddressMethod
+  , FileIngestionMethod
   , contentAddressBuilder
   , contentAddressParser
   , buildContentAddress
@@ -16,9 +18,6 @@ import Data.Text (Text)
 import Data.Text.Lazy.Builder (Builder)
 import GHC.Generics (Generic)
 import System.Nix.Hash (HashAlgo)
-import Test.QuickCheck (Arbitrary)
-import Test.QuickCheck.Arbitrary.Generic (GenericArbitrary(..))
-import Test.QuickCheck.Instances ()
 
 import qualified Data.Attoparsec.Text
 import qualified Data.Text.Lazy
@@ -30,9 +29,6 @@ data FileIngestionMethod
   | FileRecursive
   deriving (Eq, Bounded, Generic, Enum, Ord, Show)
 
-deriving via GenericArbitrary FileIngestionMethod
-  instance Arbitrary FileIngestionMethod
-
 data ContentAddressMethod
   = FileIngestionMethod !FileIngestionMethod
   -- ^ The path was added to the store via makeFixedOutputPath or
@@ -44,9 +40,6 @@ data ContentAddressMethod
   -- file contents.
   deriving (Eq, Generic, Ord, Show)
 
-deriving via GenericArbitrary ContentAddressMethod
-  instance Arbitrary ContentAddressMethod
-
 -- | An address for a content-addressable store path, i.e. one whose
 -- store path hash is purely a function of its contents (as opposed to
 -- paths that are derivation outputs, whose hashes are a function of
@@ -61,9 +54,6 @@ data ContentAddress = ContentAddress
   (DSum HashAlgo Digest)
   deriving (Eq, Generic, Ord, Show)
 
-deriving via GenericArbitrary ContentAddress
-  instance Arbitrary ContentAddress
-
 -- | Marshall `ContentAddressableAddress` to `Text`
 -- in form suitable for remote protocol usage.
 buildContentAddress :: ContentAddress -> Text

hnix-store-core/src/System/Nix/Derivation.hs

@@ -1,6 +1,3 @@
--- due to recent generic-arbitrary
-{-# OPTIONS_GHC -Wno-orphans -fconstraint-solver-iterations=0 #-}
-
 module System.Nix.Derivation
   ( parseDerivation
   , buildDerivation
@@ -12,9 +9,6 @@ module System.Nix.Derivation
 import Data.Attoparsec.Text.Lazy (Parser)
 import Data.Text (Text)
 import Data.Text.Lazy.Builder (Builder)
-import Test.QuickCheck (Arbitrary(..))
-import Test.QuickCheck.Arbitrary.Generic (GenericArbitrary(..))
-import Test.QuickCheck.Instances ()
 
 import Nix.Derivation (Derivation(..), DerivationOutput(..))
 import System.Nix.StorePath (StoreDir, StorePath)
@@ -27,11 +21,6 @@ import qualified Data.Text.Lazy.Builder
 import qualified Nix.Derivation
 import qualified System.Nix.StorePath
 
-deriving via GenericArbitrary (Derivation StorePath Text)
-  instance Arbitrary (Derivation StorePath Text)
-deriving via GenericArbitrary (DerivationOutput StorePath Text)
-  instance Arbitrary (DerivationOutput StorePath Text)
-
 parseDerivation :: StoreDir -> Parser (Derivation StorePath Text)
 parseDerivation expectedRoot =
   Nix.Derivation.parseDerivationWith

hnix-store-core/src/System/Nix/DerivedPath.hs

@@ -14,8 +14,6 @@ import GHC.Generics (Generic)
 import Data.Set (Set)
 import Data.Text (Text)
 import System.Nix.StorePath (StoreDir, StorePath, StorePathName, InvalidPathError)
-import Test.QuickCheck (Arbitrary)
-import Test.QuickCheck.Arbitrary.Generic (GenericArbitrary(..))
 
 import qualified Data.Set
 import qualified Data.Text
@@ -26,17 +24,11 @@ data OutputsSpec =
   | OutputsSpec_Names (Set StorePathName)
   deriving (Eq, Generic, Ord, Show)
 
-deriving via GenericArbitrary OutputsSpec
-  instance Arbitrary OutputsSpec
-
 data DerivedPath =
     DerivedPath_Opaque StorePath
   | DerivedPath_Built StorePath OutputsSpec
   deriving (Eq, Generic, Ord, Show)
 
-deriving via GenericArbitrary DerivedPath
-  instance Arbitrary DerivedPath
-
 data ParseOutputsError =
     ParseOutputsError_InvalidPath InvalidPathError
   | ParseOutputsError_NoNames

hnix-store-core/src/System/Nix/Hash.hs

@@ -37,8 +37,6 @@ import Data.Some (Some(Some))
 import Data.Text (Text)
 import Data.Text.Lazy.Builder (Builder)
 import System.Nix.Base (BaseEncoding(..))
-import Test.QuickCheck (Arbitrary(arbitrary), oneof)
-import Test.QuickCheck.Instances ()
 
 import qualified Crypto.Hash
 import qualified Data.ByteArray
@@ -64,20 +62,6 @@ instance NamedAlgo SHA256 where
 instance NamedAlgo SHA512 where
   algoName = "sha512"
 
--- * Arbitrary @Digest@s
-
-instance Arbitrary (Digest MD5) where
-  arbitrary = Crypto.Hash.hash @ByteString <$> arbitrary
-
-instance Arbitrary (Digest SHA1) where
-  arbitrary = Crypto.Hash.hash @ByteString <$> arbitrary
-
-instance Arbitrary (Digest SHA256) where
-  arbitrary = Crypto.Hash.hash @ByteString <$> arbitrary
-
-instance Arbitrary (Digest SHA512) where
-  arbitrary = Crypto.Hash.hash @ByteString <$> arbitrary
-
 data HashAlgo :: Type -> Type where
   HashAlgo_MD5 :: HashAlgo MD5
   HashAlgo_SHA1 :: HashAlgo SHA1
@@ -107,14 +91,6 @@ textToAlgo = \case
     "sha512" -> Right $ Some HashAlgo_SHA512
     name     -> Left $ "Unknown hash name: " <> Data.Text.unpack name
 
-instance Arbitrary (DSum HashAlgo Digest)  where
-  arbitrary = oneof
-    [ (HashAlgo_MD5 :=>)    <$> arbitrary
-    , (HashAlgo_SHA1 :=>)   <$> arbitrary
-    , (HashAlgo_SHA256 :=>) <$> arbitrary
-    , (HashAlgo_SHA512 :=>) <$> arbitrary
-    ]
-
 -- | Make @DSum HashAlgo Digest@ based on provided SRI hash name
 -- and its encoded form
 mkNamedDigest

hnix-store-core/src/System/Nix/StorePath.hs

@@ -1,5 +1,4 @@
 {-# LANGUAGE AllowAmbiguousTypes #-}
-{-# LANGUAGE CPP #-}
 {-# LANGUAGE DeriveAnyClass #-}
 {-# LANGUAGE OverloadedStrings #-}
 {-|
@@ -32,19 +31,15 @@ module System.Nix.StorePath
   , pathParser
   ) where
 
-#if !MIN_VERSION_base(4,18,0)
-import Control.Applicative (liftA2)
-#endif
 import Control.Monad.Reader.Class (MonadReader, asks)
-import Crypto.Hash (HashAlgorithm, SHA256)
+import Crypto.Hash (HashAlgorithm)
 import Data.Attoparsec.Text.Lazy (Parser, (<?>))
 import Data.ByteString (ByteString)
 import Data.Default.Class (Default(def))
 import Data.Hashable (Hashable(hashWithSalt))
 import Data.Text (Text)
 import GHC.Generics (Generic)
 import System.Nix.Base (BaseEncoding(NixBase32))
-import Test.QuickCheck (Arbitrary(arbitrary), listOf, elements)
 
 import qualified Data.Bifunctor
 import qualified Data.ByteString.Char8
@@ -81,12 +76,6 @@ instance Hashable StorePath where
   hashWithSalt s StorePath{..} =
     s `hashWithSalt` storePathHash `hashWithSalt` storePathName
 
-instance Arbitrary StorePath where
-  arbitrary =
-    liftA2 StorePath
-      arbitrary
-      arbitrary
-
 -- | The name portion of a Nix path.
 --
 -- 'unStorePathName' must only contain a-zA-Z0-9+._?=-, can't start
@@ -97,25 +86,13 @@ newtype StorePathName = StorePathName
     unStorePathName :: Text
   } deriving (Eq, Generic, Hashable, Ord, Show)
 
-instance Arbitrary StorePathName where
-  arbitrary = StorePathName . Data.Text.pack <$> ((:) <$> s1 <*> listOf sn)
-   where
-    alphanum = ['a' .. 'z'] <> ['A' .. 'Z'] <> ['0' .. '9']
-    s1       = elements $ alphanum <> "+-_?="
-    sn       = elements $ alphanum <> "+-._?="
-
 -- | The hash algorithm used for store path hashes.
 newtype StorePathHashPart = StorePathHashPart
   { -- | Extract the contents of the hash.
     unStorePathHashPart :: ByteString
   }
   deriving (Eq, Generic, Hashable, Ord, Show)
 
-instance Arbitrary StorePathHashPart where
-  arbitrary =
-    mkStorePathHashPart @SHA256
-    . Data.ByteString.Char8.pack <$> arbitrary
-
 -- | Make @StorePathHashPart@ from @ByteString@ (hash part of the @StorePath@)
 -- using specific @HashAlgorithm@
 mkStorePathHashPart
@@ -183,12 +160,6 @@ newtype StoreDir = StoreDir {
     unStoreDir :: RawFilePath
   } deriving (Eq, Generic, Hashable, Ord, Show)
 
-instance Arbitrary StoreDir where
-  arbitrary =
-    StoreDir
-    . ("/" <>) -- TODO(srk): nasty, see #237
-    . Data.ByteString.Char8.pack <$> arbitrary
-
 instance Default StoreDir where
   def = StoreDir "/nix/store"