LIB: add copyFileOverwrite

test/FileSystem/FileOperations/CopyFileOverwriteSpec.hs

@@ -0,0 +1,89 @@
+{-# LANGUAGE OverloadedStrings #-}
+
+module FileSystem.FileOperations.CopyFileOverwriteSpec where
+
+
+import Test.Hspec
+import System.IO.Error
+  (
+    ioeGetErrorType
+  )
+import GHC.IO.Exception
+  (
+    IOErrorType(..)
+  )
+import System.Exit
+import System.Process
+import Utils
+
+
+
+copyFileOverwriteSpec :: Spec
+copyFileOverwriteSpec =
+  describe "HSFM.FileSystem.FileOperations.copyFileOverwrite" $ do
+
+    -- successes --
+    it "copyFileOverwrite, everything clear" $ do
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+      removeFileIfExists "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+
+    it "copyFileOverwrite, output file already exists, all clear" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/alreadyExists"
+
+    it "copyFileOverwrite, output and input are same file" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+
+    it "copyFileOverwrite, and compare" $ do
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+      (system $ "cmp -s " ++ "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile" ++ " "
+                          ++ "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile")
+        `shouldReturn` ExitSuccess
+      removeFileIfExists "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+
+    -- posix failures --
+    it "copyFileOverwrite, input file does not exist" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/noSuchFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == NoSuchThing)
+
+    it "copyFileOverwrite, no permission to write to output directory" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputDirNoWrite/outputFile"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == PermissionDenied)
+
+    it "copyFileOverwrite, cannot open output directory" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/noPerms/outputFile"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == PermissionDenied)
+
+    it "copyFileOverwrite, cannot open source directory" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/noPerms/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == PermissionDenied)
+
+    it "copyFileOverwrite, wrong input type (symlink)" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFileSymL"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == InvalidArgument)
+
+    it "copyFileOverwrite, wrong input type (directory)" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/wrongInput"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/outputFile"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == InappropriateType)
+
+    it "copyFileOverwrite, output file already exists and is a dir" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/alreadyExistsD"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == InappropriateType)
+

test/FileSystem/FileOperations/copyFileOverwriteSpec/alreadyExists

@@ -0,0 +1,4 @@
+abc
+def
+
+dsadasdsa

test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile

@@ -0,0 +1,4 @@
+abc
+def
+
+dsadasdsa

test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFileSymL

@@ -0,0 +1 @@
+inputFile

test/Spec.hs

@@ -3,6 +3,7 @@
 import Test.Hspec
 
 import FileSystem.FileOperations.CopyDirRecursiveSpec
+import FileSystem.FileOperations.CopyFileOverwriteSpec
 import FileSystem.FileOperations.CopyFileSpec
 import FileSystem.FileOperations.CreateDirSpec
 import FileSystem.FileOperations.CreateRegularFileSpec
@@ -23,15 +24,16 @@ import Utils
 main :: IO ()
 main = hspec $ before_ fixPermissions $ after_ revertPermissions $ do
   let tests = [copyFileSpec
-              , copyDirRecursiveSpec
-              , createDirSpec
-              , createRegularFileSpec
-              , renameFileSpec
-              , moveFileSpec
-              , recreateSymlinkSpec
-              , deleteFileSpec
-              , deleteDirSpec
-              , deleteDirRecursiveSpec
+              ,copyFileOverwriteSpec
+              ,copyDirRecursiveSpec
+              ,createDirSpec
+              ,createRegularFileSpec
+              ,renameFileSpec
+              ,moveFileSpec
+              ,recreateSymlinkSpec
+              ,deleteFileSpec
+              ,deleteDirSpec
+              ,deleteDirRecursiveSpec
               ]
 
   -- run all stateful tests twice to catch missing cleanups or state skew
@@ -44,6 +46,7 @@ main = hspec $ before_ fixPermissions $ after_ revertPermissions $ do
 
   where
     noWriteDirs =  ["test/FileSystem/FileOperations/copyFileSpec/outputDirNoWrite"
+                   ,"test/FileSystem/FileOperations/copyFileOverwriteSpec/outputDirNoWrite"
                    ,"test/FileSystem/FileOperations/copyDirRecursiveSpec/noWritePerm"
                    ,"test/FileSystem/FileOperations/createDirSpec/noWritePerms"
                    ,"test/FileSystem/FileOperations/createRegularFileSpec/noWritePerms"
@@ -52,6 +55,7 @@ main = hspec $ before_ fixPermissions $ after_ revertPermissions $ do
                    ,"test/FileSystem/FileOperations/recreateSymlinkSpec/noWritePerm"
                    ]
     noPermsDirs =  ["test/FileSystem/FileOperations/copyFileSpec/noPerms"
+                   ,"test/FileSystem/FileOperations/copyFileOverwriteSpec/noPerms"
                    ,"test/FileSystem/FileOperations/copyDirRecursiveSpec/noPerms"
                    ,"test/FileSystem/FileOperations/createDirSpec/noPerms"
                    ,"test/FileSystem/FileOperations/createRegularFileSpec/noPerms"

test/Utils.hs

@@ -72,6 +72,11 @@ copyFile' inputFileP outputFileP =
   withPwd' inputFileP outputFileP copyFile
 
 
+copyFileOverwrite' :: ByteString -> ByteString -> IO ()
+copyFileOverwrite' inputFileP outputFileP =
+  withPwd' inputFileP outputFileP copyFileOverwrite
+
+
 copyDirRecursive' :: ByteString -> ByteString -> IO ()
 copyDirRecursive' inputDirP outputDirP =
   withPwd' inputDirP outputDirP copyDirRecursive