Add deprecation warnings, add formatting for fs-api and fs-sim

Author: jorisdral

fs-sim/src/System/FS/Sim/Error.hs

@@ -49,9 +49,9 @@ import qualified Data.ByteString as BS
 import qualified Data.ByteString.Char8 as C8
 import qualified Data.ByteString.Lazy as BL
 import qualified Data.ByteString.Lazy.Char8 as LC8
-import Data.Foldable (for_)
-import qualified Data.List as List
+import           Data.Foldable (for_)
 import           Data.List (dropWhileEnd, intercalate)
+import qualified Data.List as List
 import           Data.Maybe (catMaybes, isNothing)
 import           Data.String (IsString (..))
 import           Data.Word (Word64)

ouroboros-consensus-test/ouroboros-consensus-test.cabal

@@ -35,13 +35,19 @@ library
                        Test.ThreadNet.Util.NodeTopology
                        Test.ThreadNet.Util.Seed
 
+                       Test.Util.Blob
                        Test.Util.BoolProps
                        Test.Util.ChainDB
                        Test.Util.ChainUpdates
                        Test.Util.ChunkInfo
                        Test.Util.Classify
                        Test.Util.Corruption
                        Test.Util.FileLock
+                       Test.Util.FS.Sim.Error
+                       Test.Util.FS.Sim.FsTree
+                       Test.Util.FS.Sim.MockFS
+                       Test.Util.FS.Sim.Pure
+                       Test.Util.FS.Sim.STM
                        Test.Util.HardFork.Future
                        Test.Util.HardFork.OracularClock
                        Test.Util.InvertedMap
@@ -255,7 +261,6 @@ test-suite test-storage
                      , cborg
                      , containers
                      , contra-tracer
-                     , directory
                      , generics-sop
                      , hashable
                      , mtl
@@ -268,7 +273,6 @@ test-suite test-storage
                      , tasty
                      , tasty-hunit
                      , tasty-quickcheck
-                     , temporary
                      , text
                      , time
                      , tree-diff

ouroboros-consensus-test/src/Test/Util/Blob.hs

@@ -0,0 +1,7 @@
+module Test.Util.Blob {-# DEPRECATED "Use System.FS.Sim.Error instead" #-} (
+    Blob (..)
+  , blobFromBS
+  , blobToBS
+  ) where
+
+import           System.FS.Sim.Error

ouroboros-consensus-test/src/Test/Util/FS/Sim/Error.hs

@@ -0,0 +1,32 @@
+module Test.Util.FS.Sim.Error {-# DEPRECATED "Use System.FS.Sim.Error from fs-sim" #-} (
+    -- * Simulate Errors monad
+    mkSimErrorHasFS
+  , runSimErrorFS
+  , withErrors
+    -- * Streams
+  , ErrorStream
+  , ErrorStreamGetSome
+  , ErrorStreamPutSome
+  , Stream (..)
+  , always
+  , mkStream
+  , mkStreamGen
+  , null
+  , runStream
+    -- * Generating partial reads/writes
+  , Partial (..)
+  , hGetSomePartial
+  , hPutSomePartial
+    -- * Generating corruption for 'hPutSome'
+  , PutCorruption (..)
+  , corrupt
+    -- * Error streams for 'HasFS'
+  , Errors (..)
+  , allNull
+  , genErrors
+  , simpleErrors
+  ) where
+
+import           Prelude hiding (null)
+
+import           System.FS.Sim.Error

ouroboros-consensus-test/src/Test/Util/FS/Sim/FsTree.hs

@@ -0,0 +1,23 @@
+module Test.Util.FS.Sim.FsTree {-# DEPRECATED "Use System.FS.Sim.FsTree from fs-sim" #-} (
+    -- * FsTree type and indexing functions
+    FsTree (..)
+  , FsTreeError (..)
+  , example
+    -- * Construction
+  , empty
+    -- * Indexing
+  , getDir
+  , getFile
+  , index
+    -- * File system operations
+  , createDirIfMissing
+  , createDirWithParents
+  , openFile
+  , removeFile
+  , renameFile
+  , replace
+    -- * Pretty-printing
+  , pretty
+  ) where
+
+import           System.FS.Sim.FsTree

ouroboros-consensus-test/src/Test/Util/FS/Sim/MockFS.hs

@@ -0,0 +1,40 @@
+module Test.Util.FS.Sim.MockFS {-# DEPRECATED "Use System.FS.Sim.MockFS from fs-sim" #-} (
+    empty
+  , example
+  , handleIsOpen
+  , numOpenHandles
+  , pretty
+    -- * Debugging
+  , dumpState
+    -- * Operations on files
+  , hClose
+  , hGetSize
+  , hGetSome
+  , hGetSomeAt
+  , hIsOpen
+  , hOpen
+  , hPutSome
+  , hSeek
+  , hTruncate
+    -- * Operations on directories
+  , createDirectory
+  , createDirectoryIfMissing
+  , doesDirectoryExist
+  , doesFileExist
+  , listDirectory
+  , removeFile
+  , renameFile
+    -- * Exported for the benefit of tests only
+  , Files
+  , mockFiles
+    -- ** opaque
+  , ClosedHandleState
+  , FilePtr
+  , HandleState
+  , OpenHandleState
+    -- * opaque
+  , HandleMock
+  , MockFS
+  ) where
+
+import           System.FS.Sim.MockFS

ouroboros-consensus-test/src/Test/Util/FS/Sim/Pure.hs

@@ -0,0 +1,8 @@
+module Test.Util.FS.Sim.Pure {-# DEPRECATED "Use System.FS.Sim.Pure from fs-sim" #-}(
+    PureSimFS
+    -- opaque
+  , pureHasFS
+  , runPureSimFS
+  ) where
+
+import           System.FS.Sim.Pure

ouroboros-consensus-test/src/Test/Util/FS/Sim/STM.hs

@@ -0,0 +1,6 @@
+module Test.Util.FS.Sim.STM {-# DEPRECATED "Use System.FS.Sim.STM from fs-sim" #-} (
+    runSimFS
+  , simHasFS
+  ) where
+
+import           System.FS.Sim.STM

ouroboros-consensus/ouroboros-consensus.cabal

@@ -200,6 +200,12 @@ library
                        Ouroboros.Consensus.Storage.ChainDB.Impl.Types
                        Ouroboros.Consensus.Storage.ChainDB.Init
                        Ouroboros.Consensus.Storage.Common
+                       Ouroboros.Consensus.Storage.FS.API
+                       Ouroboros.Consensus.Storage.FS.API.Types
+                       Ouroboros.Consensus.Storage.FS.CRC
+                       Ouroboros.Consensus.Storage.FS.Handle
+                       Ouroboros.Consensus.Storage.FS.IO
+                       Ouroboros.Consensus.Storage.IO
                        Ouroboros.Consensus.Storage.ImmutableDB
                        Ouroboros.Consensus.Storage.ImmutableDB.API
                        Ouroboros.Consensus.Storage.ImmutableDB.Chunks

ouroboros-consensus/src/Ouroboros/Consensus/Storage/FS/API.hs

@@ -0,0 +1,16 @@
+module Ouroboros.Consensus.Storage.FS.API {-# DEPRECATED "Use System.FS.API from fs-api" #-} (
+    Handle (..)
+  , HasFS (..)
+  , SomeHasFS (..)
+  , hClose'
+  , hGetAll
+  , hGetAllAt
+  , hGetExactly
+  , hGetExactlyAt
+  , hPut
+  , hPutAll
+  , hPutAllStrict
+  , withFile
+  ) where
+
+import           System.FS.API