LIB: refactor FileOperation and related Errors

* move FileOperation/Copy/Move types to its own UtilTypes module * remove runFileOp, since it's hard to really do the correct thing here for all possible exceptions... instead, let the GUI logic handle this * introduce copyDirRecursiveOverwrite, copyFileOverwrite and easyCopyOverwrite * use our own throwSameFile on functions to distinguish between "same file" and "file already exists" * don't follow destination in copyFile* either * improve throwSameFile, by examining device and file ids * add isWritable * improve documentation * adjust and fix tests
2016-05-08 18:48:17 +02:00
parent d58fd6e6f0
commit 9c6cf51825
26 changed files with 427 additions and 103 deletions
--- a/test/FileSystem/FileOperations/CopyDirRecursiveOverwriteSpec.hs
+++ b/test/FileSystem/FileOperations/CopyDirRecursiveOverwriteSpec.hs
@@ -0,0 +1,99 @@
+{-# LANGUAGE OverloadedStrings #-}
+
+module FileSystem.FileOperations.CopyDirRecursiveOverwriteSpec where
+
+
+import Test.Hspec
+import HSFM.FileSystem.Errors
+import System.IO.Error
+  (
+    ioeGetErrorType
+  )
+import GHC.IO.Exception
+  (
+    IOErrorType(..)
+  )
+import System.Exit
+import System.Process
+import Utils
+
+
+
+copyDirRecursiveOverwriteSpec :: Spec
+copyDirRecursiveOverwriteSpec =
+  describe "HSFM.FileSystem.FileOperations.copyDirRecursiveOverwrite" $ do
+
+    -- successes --
+    it "copyDirRecursiveOverwrite, all fine" $ do
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir"
+      removeDirIfExists "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir"
+
+    it "copyDirRecursiveOverwrite, all fine and compare" $ do
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir"
+      (system $ "diff -r --no-dereference "
+                          ++ "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir" ++ " "
+                          ++ "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir")
+        `shouldReturn` ExitSuccess
+      removeDirIfExists "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir"
+
+    it "copyDirRecursiveOverwrite, destination dir already exists" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD"
+
+    -- posix failures --
+    it "copyDirRecursiveOverwrite, source directory does not exist" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/doesNotExist"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == NoSuchThing)
+
+    it "copyDirRecursiveOverwrite, no write permission on output dir" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noWritePerm/foo"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == PermissionDenied)
+
+    it "copyDirRecursiveOverwrite, cannot open output dir" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/foo"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == PermissionDenied)
+
+    it "copyDirRecursiveOverwrite, cannot open source dir" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/foo"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == PermissionDenied)
+
+    it "copyDirRecursiveOverwrite, destination already exists and is a file" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExists"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == InappropriateType)
+
+    it "copyDirRecursiveOverwrite, wrong input (regular file)" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/wrongInput"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == InappropriateType)
+
+    it "copyDirRecursiveOverwrite, wrong input (symlink to directory)" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/wrongInputSymL"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/outputDir"
+        `shouldThrow`
+        (\e -> ioeGetErrorType e == InvalidArgument)
+
+    -- custom failures
+    it "copyDirRecursiveOverwrite, destination in source" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir/foo"
+        `shouldThrow`
+        isDestinationInSource
+
+    it "copyDirRecursiveOverwrite, destination and source same directory" $
+      copyDirRecursiveOverwrite' "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+                                 "test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir"
+        `shouldThrow`
+        isSameFile
--- a/test/FileSystem/FileOperations/CopyDirRecursiveSpec.hs
+++ b/test/FileSystem/FileOperations/CopyDirRecursiveSpec.hs
@@ -75,12 +75,6 @@ copyDirRecursiveSpec =
        `shouldThrow`
        (\e -> ioeGetErrorType e == AlreadyExists)

-    it "copyDirRecursive, destination and source same directory" $
-      copyDirRecursive' "test/FileSystem/FileOperations/copyDirRecursiveSpec/inputDir"
-                        "test/FileSystem/FileOperations/copyDirRecursiveSpec/inputDir"
-        `shouldThrow`
-        (\e -> ioeGetErrorType e == AlreadyExists)
-
    it "copyDirRecursive, wrong input (regular file)" $
      copyDirRecursive' "test/FileSystem/FileOperations/copyDirRecursiveSpec/wrongInput"
                        "test/FileSystem/FileOperations/copyDirRecursiveSpec/outputDir"
@@ -100,3 +94,8 @@ copyDirRecursiveSpec =
        `shouldThrow`
        isDestinationInSource

+    it "copyDirRecursive, destination and source same directory" $
+      copyDirRecursive' "test/FileSystem/FileOperations/copyDirRecursiveSpec/inputDir"
+                        "test/FileSystem/FileOperations/copyDirRecursiveSpec/inputDir"
+        `shouldThrow`
+        isSameFile
--- a/test/FileSystem/FileOperations/CopyFileOverwriteSpec.hs
+++ b/test/FileSystem/FileOperations/CopyFileOverwriteSpec.hs
@@ -4,6 +4,7 @@ module FileSystem.FileOperations.CopyFileOverwriteSpec where


 import Test.Hspec
+import HSFM.FileSystem.Errors
 import System.IO.Error
  (
    ioeGetErrorType
@@ -32,10 +33,6 @@ copyFileOverwriteSpec =
      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"
@@ -87,3 +84,8 @@ copyFileOverwriteSpec =
        `shouldThrow`
        (\e -> ioeGetErrorType e == InappropriateType)

+    -- custom failures --
+    it "copyFileOverwrite, output and input are same file" $
+      copyFileOverwrite' "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileOverwriteSpec/inputFile"
+        `shouldThrow` isSameFile
--- a/test/FileSystem/FileOperations/CopyFileSpec.hs
+++ b/test/FileSystem/FileOperations/CopyFileSpec.hs
@@ -4,6 +4,7 @@ module FileSystem.FileOperations.CopyFileSpec where


 import Test.Hspec
+import HSFM.FileSystem.Errors
 import System.IO.Error
  (
    ioeGetErrorType
@@ -73,12 +74,6 @@ copyFileSpec =
        `shouldThrow`
        (\e -> ioeGetErrorType e == InappropriateType)

-    it "copyFile, output and input are same file" $
-      copyFile' "test/FileSystem/FileOperations/copyFileSpec/inputFile"
-                "test/FileSystem/FileOperations/copyFileSpec/inputFile"
-        `shouldThrow`
-        (\e -> ioeGetErrorType e == AlreadyExists)
-
    it "copyFile, output file already exists" $
      copyFile' "test/FileSystem/FileOperations/copyFileSpec/inputFile"
                "test/FileSystem/FileOperations/copyFileSpec/alreadyExists"
@@ -91,3 +86,9 @@ copyFileSpec =
        `shouldThrow`
        (\e -> ioeGetErrorType e == AlreadyExists)

+    -- custom failures --
+    it "copyFile, output and input are same file" $
+      copyFile' "test/FileSystem/FileOperations/copyFileSpec/inputFile"
+                "test/FileSystem/FileOperations/copyFileSpec/inputFile"
+        `shouldThrow`
+        isSameFile
--- a/test/FileSystem/FileOperations/RecreateSymlinkSpec.hs
+++ b/test/FileSystem/FileOperations/RecreateSymlinkSpec.hs
@@ -4,6 +4,7 @@ module FileSystem.FileOperations.RecreateSymlinkSpec where


 import Test.Hspec
+import HSFM.FileSystem.Errors
 import System.IO.Error
  (
    ioeGetErrorType
@@ -73,9 +74,10 @@ recreateSymlinkSpec =
        `shouldThrow`
        (\e -> ioeGetErrorType e == AlreadyExists)

+    -- custom failures --
    it "recreateSymLink, source and destination are the same file" $
      recreateSymlink' "test/FileSystem/FileOperations/recreateSymlinkSpec/myFileL"
                       "test/FileSystem/FileOperations/recreateSymlinkSpec/myFileL"
        `shouldThrow`
-        (\e -> ioeGetErrorType e == AlreadyExists)
+        isSameFile

--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExists
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExists
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/.keep
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/.keep
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/bar/inputFile3
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/bar/inputFile3
@@ -0,0 +1,8 @@
+dadasasddas
+sda
+
+!!1
+sda
+
+
+11
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/foo/inputFile1
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/foo/inputFile1
@@ -0,0 +1 @@
+dadasasddas
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/inputFile2
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/alreadyExistsD/inputFile2
@@ -0,0 +1,4 @@
+dadasasddas
+das
+sda
+sda
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir/bar/inputFile3
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir/bar/inputFile3
@@ -0,0 +1,8 @@
+dadasasddas
+sda
+
+!!1
+sda
+
+
+11
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir/foo/inputFile1
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir/foo/inputFile1
@@ -0,0 +1 @@
+dadasasddas
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir/inputFile2
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/inputDir/inputFile2
@@ -0,0 +1,4 @@
+dadasasddas
+das
+sda
+sda
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/inputDir/bar/inputFile3
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/inputDir/bar/inputFile3
@@ -0,0 +1,8 @@
+dadasasddas
+sda
+
+!!1
+sda
+
+
+11
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/inputDir/foo/inputFile1
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/inputDir/foo/inputFile1
@@ -0,0 +1 @@
+dadasasddas
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/inputDir/inputFile2
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms/inputDir/inputFile2
@@ -0,0 +1,4 @@
+dadasasddas
+das
+sda
+sda
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noWritePerm/.keep
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noWritePerm/.keep
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/wrongInput
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/wrongInput
--- a/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/wrongInputSymL
+++ b/test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/wrongInputSymL
@@ -0,0 +1 @@
+inputDir/
--- a/test/FileSystem/FileOperations/copyFileOverwriteSpec/alreadyExists
+++ b/test/FileSystem/FileOperations/copyFileOverwriteSpec/alreadyExists
@@ -1,4 +1,16 @@
-abc
-def
+adaöölsdaöl
+dsalö
+ölsda
+ääödsf
+äsdfä
+öä453
+öä
+435
+ä45343
+5
+453
+453453453
+das
+asd
+das

-dsadasdsa
--- a/test/Spec.hs
+++ b/test/Spec.hs
@@ -3,6 +3,7 @@
 import Test.Hspec

 import FileSystem.FileOperations.CopyDirRecursiveSpec
+import FileSystem.FileOperations.CopyDirRecursiveOverwriteSpec
 import FileSystem.FileOperations.CopyFileOverwriteSpec
 import FileSystem.FileOperations.CopyFileSpec
 import FileSystem.FileOperations.CreateDirSpec
@@ -26,6 +27,7 @@ main = hspec $ before_ fixPermissions $ after_ revertPermissions $ do
  let tests = [copyFileSpec
              ,copyFileOverwriteSpec
              ,copyDirRecursiveSpec
+              ,copyDirRecursiveOverwriteSpec
              ,createDirSpec
              ,createRegularFileSpec
              ,renameFileSpec
@@ -48,6 +50,7 @@ main = hspec $ before_ fixPermissions $ after_ revertPermissions $ do
    noWriteDirs =  ["test/FileSystem/FileOperations/copyFileSpec/outputDirNoWrite"
                   ,"test/FileSystem/FileOperations/copyFileOverwriteSpec/outputDirNoWrite"
                   ,"test/FileSystem/FileOperations/copyDirRecursiveSpec/noWritePerm"
+                   ,"test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noWritePerm"
                   ,"test/FileSystem/FileOperations/createDirSpec/noWritePerms"
                   ,"test/FileSystem/FileOperations/createRegularFileSpec/noWritePerms"
                   ,"test/FileSystem/FileOperations/renameFileSpec/noWritePerm"
@@ -57,6 +60,7 @@ main = hspec $ before_ fixPermissions $ after_ revertPermissions $ do
    noPermsDirs =  ["test/FileSystem/FileOperations/copyFileSpec/noPerms"
                   ,"test/FileSystem/FileOperations/copyFileOverwriteSpec/noPerms"
                   ,"test/FileSystem/FileOperations/copyDirRecursiveSpec/noPerms"
+                   ,"test/FileSystem/FileOperations/copyDirRecursiveOverwriteSpec/noPerms"
                   ,"test/FileSystem/FileOperations/createDirSpec/noPerms"
                   ,"test/FileSystem/FileOperations/createRegularFileSpec/noPerms"
                   ,"test/FileSystem/FileOperations/renameFileSpec/noPerms"
--- a/test/Utils.hs
+++ b/test/Utils.hs
@@ -82,6 +82,11 @@ copyDirRecursive' inputDirP outputDirP =
  withPwd' inputDirP outputDirP copyDirRecursive


+copyDirRecursiveOverwrite' :: ByteString -> ByteString -> IO ()
+copyDirRecursiveOverwrite' inputDirP outputDirP =
+  withPwd' inputDirP outputDirP copyDirRecursiveOverwrite
+
+
 createDir' :: ByteString -> IO ()
 createDir' dest = withPwd dest createDir