Merge pull request #247 from haskell-nix/srk/split2

Split part 2

Author: sorki

cabal.project

@@ -1,6 +1,8 @@
 packages:
   ./hnix-store-core/hnix-store-core.cabal
   ./hnix-store-db/hnix-store-db.cabal
+  ./hnix-store-nar/hnix-store-nar.cabal
+  ./hnix-store-readonly/hnix-store-readonly.cabal
   ./hnix-store-remote/hnix-store-remote.cabal
   ./hnix-store-tests/hnix-store-tests.cabal
 
@@ -11,5 +13,8 @@ allow-newer:
 package hnix-store-db
   flags: +build-readme +build-bench
 
+package hnix-store-nar
+  flags: +bounded_memory
+
 package hnix-store-remote
   flags: +build-readme +io-testsuite

cabal.project.local.ci

@@ -6,6 +6,12 @@ package hnix-store-core
 package hnix-store-db
   ghc-options: -Wunused-packages -Wall -Werror
 
+package hnix-store-nar
+  ghc-options: -Wunused-packages -Wall -Werror
+
+package hnix-store-readonly
+  ghc-options: -Wunused-packages -Wall -Werror
+
 package hnix-store-remote
   ghc-options: -Wunused-packages -Wall -Werror
 

default.nix

@@ -22,6 +22,8 @@ in {
   inherit (haskellPackages)
     hnix-store-core
     hnix-store-db
+    hnix-store-nar
+    hnix-store-readonly
     hnix-store-remote
     hnix-store-tests;
   haskellPackages = lib.dontRecurseIntoAttrs haskellPackages;

hie.yaml

@@ -4,7 +4,25 @@ cradle:
       component: "lib:hnix-store-core"
 
     - path: "./hnix-store-core/tests"
-      component: "hnix-store-core:test:format-tests"
+      component: "hnix-store-core:test:core"
+
+    - path: "./hnix-store-db/src"
+      component: "lib:hnix-store-db"
+
+    - path: "./hnix-store-db/tests"
+      component: "hnix-store-db:test:db"
+
+    - path: "./hnix-store-nar/src"
+      component: "lib:hnix-store-nar"
+
+    - path: "./hnix-store-nar/tests"
+      component: "hnix-store-nar:test:nar"
+
+    - path: "./hnix-store-readonly/src"
+      component: "lib:hnix-store-readonly"
+
+    - path: "./hnix-store-readonly/tests"
+      component: "hnix-store-readonly:test:readonly"
 
     - path: "./hnix-store-remote/src"
       component: "lib:hnix-store-remote"
@@ -14,3 +32,9 @@ cradle:
 
     - path: "./hnix-store-remote/tests-io"
       component: "hnix-store-remote:test:remote-io"
+
+    - path: "./hnix-store-tests/src"
+      component: "lib:hnix-store-tests"
+
+    - path: "./hnix-store-tests/tests"
+      component: "hnix-store-tests:test:props"

hnix-store-core/CHANGELOG.md

@@ -1,16 +1,25 @@
 # Next
 
 * Changes:
+   * `System.Nix.ReadOnlyStore` moved to `hnix-store-readonly` package
+     and renamed to `System.Nix.Store.ReadOnly` [#247](https://github.com/haskell-nix/hnix-store/pull/247)
+   * `System.Nix.Nar*` moved to `hnix-store-nar` package [#247](https://github.com/haskell-nix/hnix-store/pull/247)
+   * `Arbitrary` instances moved to `hnix-store-tests` package [#241](https://github.com/haskell-nix/hnix-store/pull/241)
    * `System.Nix.Internal` namespaces was removed [#236](https://github.com/haskell-nix/hnix-store/pull/236)
    * `StorePathMetadata` converted to `Metadata a` [#231](https://github.com/haskell-nix/hnix-store/pull/231)
      * Moved to `System.Nix.StorePath.Metadata` [#236](https://github.com/haskell-nix/hnix-store/pull/236)
    * Constructors of `StorePathName` and `StorePathHashPart` are no longer
      exported. Use respective `mkStorePath..` functions. [#230](https://github.com/haskell-nix/hnix-store/pull/230)
+   * `StorePath` constructor is no longer exported.
+     Prefer `parsePath` or `parsePathFromText`.
+     If needed to construct a path directly, use `unsafeMakeStorePath` [#247](https://github.com/haskell-nix/hnix-store/pull/247)
    * `StorePathSet` type alias is no more, use `HashSet StorePath` [#230](https://github.com/haskell-nix/hnix-store/pull/230)
    * `makeStorePath` and `parsePath` now returns `Either InvalidPathError StorePath` [#231](https://github.com/haskell-nix/hnix-store/pull/231)
    * `BuildResult`s `timesBuild` field changes type from `Integer` to `Int` [#231](https://github.com/haskell-nix/hnix-store/pull/231)
 
 * Additions:
+   * `System.Nix.Store.Types` with `FileIngestionMethod`, `PathFilter`, `RepairMode` types  [#247](https://github.com/haskell-nix/hnix-store/pull/247)
+     `FileIngestionMethod` was previously called `NarHashMode`
    * `System.Nix.StorePath.parsePathFromText` [#236](https://github.com/haskell-nix/hnix-store/pull/236)
    * `Default StoreDir` instance [#231](https://github.com/haskell-nix/hnix-store/pull/231)
    * `System.Nix.StorePath.storePathHashPartToText` [#231](https://github.com/haskell-nix/hnix-store/pull/231)

hnix-store-core/README.md

@@ -1,14 +1,5 @@
 # hnix-store-core
 
-Core effects for interacting with the Nix store.
+Core types and functions for interacting with the Nix store.
 
-See `NarEffects` in [System.Nix.Nar.Effects] and the [System.Nix.StorePath] for the available operations
-on the store.
-
-[System.Nix.Nar.Effects]: ./src/System/Nix/Nar/Effects.hs
 [System.Nix.StorePath]: ./src/System/Nix/StorePath.hs
-
-
-# Tests
-
- - `ghcid --command "cabal repl test-suite:format-tests" --test="Main.main"`

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

@@ -1,16 +1,15 @@
 cabal-version:       2.2
 name:                hnix-store-core
 version:             0.8.0.0
-synopsis:            Core effects for interacting with the Nix store.
+synopsis:            Core types used for interacting with the Nix store.
 description:
   This package contains types and functions needed to describe
-  interactions with the Nix store abstracted away from
-  specific effectful context.
+  interactions with the Nix store.
 homepage:            https://github.com/haskell-nix/hnix-store
 license:             Apache-2.0
 license-file:        LICENSE
 author:              Shea Levy
-maintainer:          [email protected]
+maintainer:          [email protected]
 copyright:           2018 Shea Levy
 category:            Nix
 build-type:          Simple
@@ -19,7 +18,6 @@ extra-source-files:
   , README.md
   , tests/samples/example0.drv
   , tests/samples/example1.drv
-  , tests/fixtures/case-conflict.nar
 
 common commons
   ghc-options:  -Wall
@@ -66,62 +64,41 @@ library
     , System.Nix.DerivedPath
     , System.Nix.Hash
     , System.Nix.Hash.Truncation
-    , System.Nix.Nar
-    , System.Nix.Nar.Parser
-    , System.Nix.Nar.Streamer
-    , System.Nix.Nar.Effects
-    , System.Nix.Nar.Options
-    , System.Nix.ReadonlyStore
     , System.Nix.Signature
+    , System.Nix.Store.Types
     , System.Nix.StorePath
     , System.Nix.StorePath.Metadata
   build-depends:
       base >=4.12 && <5
     , attoparsec
-    , algebraic-graphs >= 0.5 && < 0.8
     , base16-bytestring >= 1.0
     , base64-bytestring >= 1.2.1
     , bytestring
-    , case-insensitive
-    , cereal
     , containers
     , constraints-extras
+    , cryptonite
     , data-default-class
     , dependent-sum > 0.7
     , dependent-sum-template > 0.1.1 && < 0.3
-    -- Required for cryptonite low-level type convertion
-    , memory
-    , cryptonite
-    , directory
     , filepath
     , hashable
-    , lifted-base
-    , monad-control
-    , mtl
+    -- Required for cryptonite low-level type convertion
+    , memory
     , nix-derivation >= 1.1.1 && <2
     , saltine >= 0.2 && < 0.3
     , some > 1.0.5 && < 2
     , time
     , text
-    , unix
     , unordered-containers
     , vector
   hs-source-dirs:      src
 
-Flag bounded_memory
-  description: Run tests of constant memory use (requires +RTS -T)
-  default: False
-
-test-suite format-tests
+test-suite core
   import: commons
-  if flag(bounded_memory)
-    cpp-options: -DBOUNDED_MEMORY
-    ghc-options: -rtsopts -fprof-auto
   type: exitcode-stdio-1.0
   main-is: Driver.hs
   other-modules:
     Derivation
-    NarFormat
     Hash
   hs-source-dirs:
     tests
@@ -133,20 +110,11 @@ test-suite format-tests
     , base
     , base16-bytestring
     , base64-bytestring
-    , binary
     , bytestring
-    , containers
     , cryptonite
     , data-default-class
-    , directory
-    , filepath
-    , process
+    , hspec
     , tasty
     , tasty-golden
-    , hspec
     , tasty-hspec
-    , tasty-hunit
-    , tasty-quickcheck
-    , temporary
     , text
-    , unix

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

@@ -18,17 +18,13 @@ import Data.Text (Text)
 import Data.Text.Lazy.Builder (Builder)
 import GHC.Generics (Generic)
 import System.Nix.Hash (HashAlgo)
+import System.Nix.Store.Types (FileIngestionMethod(..))
 
 import qualified Data.Attoparsec.Text
 import qualified Data.Text.Lazy
 import qualified Data.Text.Lazy.Builder
 import qualified System.Nix.Hash
 
-data FileIngestionMethod
-  = Flat
-  | FileRecursive
-  deriving (Eq, Bounded, Generic, Enum, Ord, Show)
-
 data ContentAddressMethod
   = FileIngestionMethod !FileIngestionMethod
   -- ^ The path was added to the store via makeFixedOutputPath or
@@ -74,8 +70,8 @@ contentAddressBuilder (ContentAddress method digest) = case method of
 
 fileIngestionMethodBuilder :: FileIngestionMethod -> Builder
 fileIngestionMethodBuilder = \case
-  Flat -> ""
-  FileRecursive -> "r:"
+  FileIngestionMethod_Flat -> ""
+  FileIngestionMethod_FileRecursive -> "r:"
 
 -- | Parse `ContentAddressableAddress` from `ByteString`
 parseContentAddress
@@ -95,7 +91,9 @@ contentAddressParser = do
 parseContentAddressMethod :: Parser ContentAddressMethod
 parseContentAddressMethod =
       TextIngestionMethod <$ "text:"
-  <|> FileIngestionMethod <$ "fixed:" <*> (FileRecursive <$ "r:" <|> pure Flat)
+  <|> FileIngestionMethod <$ "fixed:"
+  <*> (FileIngestionMethod_FileRecursive <$ "r:" 
+       <|> pure FileIngestionMethod_Flat)
 
 parseTypedDigest :: Parser (Either String (DSum HashAlgo Digest))
 parseTypedDigest = System.Nix.Hash.mkNamedDigest <$> parseHashType <*> parseHash

hnix-store-core/src/System/Nix/Store/Types.hs

@@ -0,0 +1,24 @@
+module System.Nix.Store.Types
+  ( FileIngestionMethod(..)
+  , PathFilter(..)
+  , RepairMode(..)
+  ) where
+
+import GHC.Generics (Generic)
+
+-- | Add path recursively or not
+data FileIngestionMethod
+  = FileIngestionMethod_Flat
+  | FileIngestionMethod_FileRecursive
+  deriving (Bounded, Eq, Generic, Enum, Ord, Show)
+
+-- | Path filtering function
+newtype PathFilter = PathFilter
+  { pathFilterFunction :: FilePath -> Bool
+  }
+
+-- | Repair mode
+data RepairMode
+  = RepairMode_DoRepair
+  | RepairMode_DontRepair
+  deriving (Bounded, Eq, Generic, Enum, Ord, Show)

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

@@ -9,11 +9,14 @@ module System.Nix.StorePath
   ( -- * Basic store path types
     StoreDir(..)
   , HasStoreDir(..)
-  , getStoreDir
-  , StorePath(..)
-  , StorePathName(..)
-  , StorePathHashPart(..)
+  , StorePath
+  , storePathHash
+  , storePathName
+  , StorePathName
+  , unStorePathName
+  , StorePathHashPart
   , mkStorePathHashPart
+  , unStorePathHashPart
   , -- * Manipulating 'StorePathName'
     makeStorePathName
   , validStorePathName
@@ -29,9 +32,10 @@ module System.Nix.StorePath
     parsePath
   , parsePathFromText
   , pathParser
+    -- * Utilities for tests
+  , unsafeMakeStorePath
   ) where
 
-import Control.Monad.Reader.Class (MonadReader, asks)
 import Crypto.Hash (HashAlgorithm)
 import Data.Attoparsec.Text.Lazy (Parser, (<?>))
 import Data.ByteString (ByteString)
@@ -70,12 +74,18 @@ data StorePath = StorePath
     -- hello-1.2.3).
     storePathName :: !StorePathName
   }
-  deriving (Eq, Generic, Ord, Show)
+  deriving (Eq, Generic, Ord)
 
 instance Hashable StorePath where
   hashWithSalt s StorePath{..} =
     s `hashWithSalt` storePathHash `hashWithSalt` storePathName
 
+instance Show StorePath where
+  show s =
+    "StorePath"
+    <> " "
+    <> storePathToFilePath (StoreDir mempty) s
+
 -- | The name portion of a Nix path.
 --
 -- 'unStorePathName' must only contain a-zA-Z0-9+._?=-, can't start
@@ -166,10 +176,6 @@ instance Default StoreDir where
 class HasStoreDir r where
   hasStoreDir :: r -> StoreDir
 
--- | Ask for a @StoreDir@
-getStoreDir :: (HasStoreDir r, MonadReader r m) => m StoreDir
-getStoreDir = asks hasStoreDir
-
 -- | Render a 'StorePath' as a 'RawFilePath'.
 storePathToRawFilePath :: StoreDir -> StorePath -> RawFilePath
 storePathToRawFilePath storeDir StorePath{..} =
@@ -291,3 +297,13 @@ pathParser expectedRoot = do
     (fail . show)
     pure
     (StorePath <$> hashPart <*> name)
+
+-- * Utilities for tests
+
+-- | Paths rarely need to be constructed directly.
+-- Prefer @parsePath@ or @parsePathFromText@
+unsafeMakeStorePath
+  :: StorePathHashPart
+  -> StorePathName
+  -> StorePath
+unsafeMakeStorePath = StorePath