lean4-htt/tests/elab/IO_test.lean

prelude
import Init.System.IO
import Init.Data.List.Control
import Init.Data.ToString


open IO.FS

#eval liftM (m := IO) do
  -- when run interactively in the server, the current working directory is `tests`
  -- whereas it is `elab` when run via the test suite; this normalizes both to `elab`
  if (← System.FilePath.pathExists "elab") then
    IO.Process.setCurrentDir "elab"

#eval createDirAll "IO_test.lean.dir"

def check_eq {α} [BEq α] [Repr α] (tag : String) (expected actual : α) : IO Unit :=
unless (expected == actual) do
  throw $ IO.userError $
    s!"assertion failure \"{tag}\":\n  expected: {repr expected}\n  actual:   {repr actual}"

def test : IO Unit := do
let xs : ByteArray := ⟨#[1,2,3,4]⟩;
let fn := "IO_test.lean.dir/foo.txt";
withFile fn Mode.write fun h => do
  h.write xs;
  h.write xs;
  pure ();
let ys ← withFile "IO_test.lean.dir/foo.txt" Mode.read $ fun h => h.read 10;
check_eq "1" (xs.toList ++ xs.toList) ys.toList;
withFile fn Mode.append fun h => do
  h.write ⟨#[5,6,7,8]⟩;
  pure ();
withFile "IO_test.lean.dir/foo.txt" Mode.read fun h => do
    let ys ← h.read 10
    check_eq "2" [1,2,3,4,1,2,3,4,5,6] ys.toList
    let ys ← h.read 2
    check_eq "3" [7,8] ys.toList
    let ys ← h.read 2
    check_eq "5" [] ys.toList
pure ()

#guard_msgs in
#eval test

def test2 : IO Unit := do
let fn1 := "bar2.txt";
let fn2 := "IO_test.lean.dir/foo2.txt";
let xs₀ : String := "⟨[₂,α]⟩";
let xs₁ := "⟨[6,8,@]⟩";
let xs₂ := "/* Handle.getLine : Handle → IO Unit                     */" ++
           "/*   The line returned by `lean_io_prim_handle_get_line` */" ++
           "/*   is truncated at the first \'\\0\' character and the    */" ++
           "/*   rest of the line is discarded.                      */";
    -- multi-buffer line
withFile fn1 Mode.write $ fun _h => pure ();

withFile fn1 Mode.write $ fun h => do
  h.putStr xs₀
  h.putStrLn xs₀
  h.putStrLn xs₂
  h.putStrLn xs₁
withFile fn2 Mode.write $ fun h => h.putStr "overwritten"
rename fn1 fn2
let ys ← withFile fn2 Mode.read $ fun h => h.getLine;
IO.println ys;
check_eq "1" (xs₀ ++ xs₀ ++ "\n") ys;
IO.println ys;
withFile fn2 Mode.append $ fun h => do
{ h.putStrLn xs₁;
  pure () };
let ys ← withFile fn2 Mode.read $ fun h => do
  { let ys ← (List.range 4).mapM $ fun i => do
    { let ln ← h.getLine;
      IO.println i;
      IO.println ∘ repr $ ln;
      pure ln };
    pure ys };
IO.println ys;
let rs := [xs₀ ++ xs₀ ++ "\n", xs₂ ++ "\n", xs₁ ++ "\n", xs₁ ++ "\n"];
check_eq "2" rs ys;
let ys ← readFile fn2;
check_eq "3" (String.join rs) ys;
pure ()

/--
info: ⟨[₂,α]⟩⟨[₂,α]⟩

⟨[₂,α]⟩⟨[₂,α]⟩

0
"⟨[₂,α]⟩⟨[₂,α]⟩\n"
1
"/* Handle.getLine : Handle → IO Unit                     *//*   The line returned by `lean_io_prim_handle_get_line` *//*   is truncated at the first '\\0' character and the    *//*   rest of the line is discarded.                      */\n"
2
"⟨[6,8,@]⟩\n"
3
"⟨[6,8,@]⟩\n"
[⟨[₂,α]⟩⟨[₂,α]⟩
, /* Handle.getLine : Handle → IO Unit                     *//*   The line returned by `lean_io_prim_handle_get_line` *//*   is truncated at the first '\0' character and the    *//*   rest of the line is discarded.                      */
, ⟨[6,8,@]⟩
, ⟨[6,8,@]⟩
]
-/
#guard_msgs in
#eval test2

def test3 : IO Unit := do
let fn3 := "IO_test.lean.dir/foo3.txt"
let xs₀ := "abc"
let xs₁ := ""
let xs₂ := "hello"
let xs₃ := "world"
withFile fn3 Mode.write $ fun _h => do {
  pure ()
}
let ys ← lines fn3
IO.println $ repr ys
check_eq "1" ys #[]
withFile fn3 Mode.write $ fun h => do
  h.putStrLn xs₀
  h.putStrLn xs₁
  h.putStrLn xs₂
  h.putStrLn xs₃
let ys ← lines fn3
IO.println $ repr ys
check_eq "2" ys #[xs₀, xs₁, xs₂, xs₃]
pure ()

/--
info: #[]
#["abc", "", "hello", "world"]
-/
#guard_msgs in
#eval test3

def test4 : IO Unit := do
let fn4 := "IO_test.lean.dir/foo4.txt"
withFile fn4 Mode.write fun _h => do pure ();
let ys ← withFile fn4 Mode.read $ fun h => h.read 1;
check_eq "1" [] ys.toList
let ys ← withFile fn4 Mode.read $ fun h => h.read 1;
check_eq "2" [] ys.toList

#guard_msgs in
#eval test4

/-! `removeDirAll` should remove all contents but not follow symlinks. -/

def testRemoveDirAll : IO Unit := do
  createDirAll "IO_test.lean.dir/dir/sub"
  createDirAll "IO_test.lean.dir/symlink_target"
  writeFile "IO_test.lean.dir/dir/file" ""
  writeFile "IO_test.lean.dir/dir/sub/file" ""
  unless System.Platform.isWindows do
    let _ ← IO.Process.run { cmd := "ln", args := #["-s", "../symlink_target", "IO_test.lean.dir/dir/symlink"] }
  removeDirAll "IO_test.lean.dir/dir"
  assert! !(← System.FilePath.pathExists "IO_test.lean.dir/dir")
  unless System.Platform.isWindows do
    assert! (← System.FilePath.pathExists "IO_test.lean.dir/symlink_target")

#eval testRemoveDirAll

def testHardLink : IO Unit := do
  let fn : System.FilePath := "IO_test.lean.dir/hardLinkTarget.txt"
  let contents := "foo"
  writeFile fn contents
  let linkFn : System.FilePath := "IO_test.lean.dir/hardLink.txt"
  if (← System.FilePath.pathExists linkFn) then
    removeFile linkFn
  check_eq "1" 1 (← fn.metadata).numLinks
  hardLink fn linkFn
  check_eq "2" 2 (← fn.metadata).numLinks
  check_eq "3" 2 (← linkFn.metadata).numLinks
  removeFile fn
  assert! !(← System.FilePath.pathExists fn)
  assert! (← System.FilePath.pathExists linkFn)
  let linkContents ← readFile linkFn
  check_eq "4" contents linkContents

#guard_msgs in
#eval testHardLink

def testRemoveFile : IO Unit := do
  -- `removeFile` should remove read-only files
  -- even on Windows where `std::remove` cannot
  let fn : System.FilePath := "IO_test.lean.dir/readonly.txt"
  let contents := "foo"
  if (← fn.pathExists) then
    removeFile fn
  writeFile fn contents
  let r := {read := true}
  IO.setAccessRights fn ⟨r, r, r⟩
  assert! (← fn.pathExists)
  removeFile fn
  assert! !(← fn.pathExists)

#guard_msgs in
#eval testRemoveFile