Consolidate updates to fs.md

Author: webbunivAdmin

lib_eio/path.ml

@@ -214,17 +214,18 @@ let symlink ~link_to source =
   let (Resource.T (dir, ops), path) = source in
   let module X = (val (Resource.get ops Fs.Pi.Dir)) in
   try X.symlink dir path ~link_to
-with Exn.Io _ as ex ->
-  let bt = Printexc.get_raw_backtrace () in
-  Exn.reraise_with_context ex bt "creating symlink %a -> %s" pp source link_to
-    
-  let chmod ~follow ~perm t =
-    let (Resource.T (dir, ops), path) = t in
-    let module X = (val (Resource.get ops Fs.Pi.Dir)) in
-    try X.chmod dir ~follow ~perm path
-    with Exn.Io _ as ex ->
-      let bt = Printexc.get_raw_backtrace () in
-      Exn.reraise_with_context ex bt "chmoding file %a" pp t
+  with Exn.Io _ as ex ->
+    let bt = Printexc.get_raw_backtrace () in
+    Exn.reraise_with_context ex bt "creating symlink %a -> %s" pp source link_to
+
+let chmod ~follow ~perm t =
+  let (Resource.T (dir, ops), path) = t in
+  let module X = (val (Resource.get ops Fs.Pi.Dir)) in
+  try
+    X.chmod dir ~follow ~perm path
+  with Exn.Io _ as ex ->
+    let bt = Printexc.get_raw_backtrace () in
+    Exn.reraise_with_context ex bt "chmoding file %a" pp t
 
 let rec mkdirs ?(exists_ok=false) ~perm t =
   (* Check parent exists first. *)

lib_eio_linux/low_level.ml

@@ -486,12 +486,12 @@ let symlink ~link_to dir path =
   with_parent_dir "symlinkat-new" dir path @@ fun parent leaf ->
   try
     eio_symlinkat link_to parent leaf
-    with Unix.Unix_error (code, name, arg) -> raise @@ Err.wrap_fs code name arg
+  with Unix.Unix_error (code, name, arg) -> raise @@ Err.wrap_fs code name arg
 
   let chmod ~follow ~perm dir path =
     let module X = Uring.Statx in
     with_parent_dir "chmodat" dir path @@ fun parent leaf ->
-    let flags = if follow then 0 else (* at_symlink_nofollow *) 0x100 in
+    let flags = if follow then 0 else  0x100 in
     try
       eio_fchmodat parent leaf perm flags
       with Unix.Unix_error (code, name, arg) -> raise @@ Err.wrap_fs code name arg

lib_eio_posix/low_level.mli

@@ -82,7 +82,7 @@ val symlink : link_to:string -> dir_fd -> string -> unit
 (** [symlink ~link_to dir path] will create a new symlink at [dir / path]
     linking to [link_to]. *)
 
-    val chmod : follow:bool -> mode:int -> dir_fd -> string -> unit
+val chmod : follow:bool -> mode:int -> dir_fd -> string -> unit
 
 val readdir : dir_fd -> string -> string array
 

lib_eio_windows/eio_windows_stubs.c

@@ -257,6 +257,9 @@ CAMLprim value caml_eio_windows_symlinkat(value v_old_path, value v_new_fd, valu
   uerror("symlinkat is not supported on windows yet", Nothing);
 }
 
+CAMLprim value eio_windows_chmod(value path, value perm) {
+    caml_failwith("chmod is not implemented on Windows");
+}
 
 CAMLprim value caml_eio_windows_spawn(value v_errors, value v_actions)
 {

lib_eio_windows/fs.ml

@@ -89,6 +89,11 @@ end = struct
 
   let v ~label ~sandbox dir_path = { dir_path; sandbox; label; closed = false }
 
+  let chmod (_t : t) ~(follow : bool) ~(perm : int) (_path : string) : unit =
+    ignore (follow);
+    ignore (perm);
+    failwith "chmod not implemented on Windows yet"
+  
   (* Sandboxes use [O_NOFOLLOW] when opening files ([resolve] already removed any symlinks).
      This avoids a race where symlink might be added after [realpath] returns.
      TODO: Emulate [O_NOFOLLOW] here. *)

tests/fs.md

@@ -14,10 +14,12 @@ module Path = Eio.Path
 let () = Eio.Exn.Backend.show := false
 
 open Eio.Std
+open Eio.Exn
 
 let ( / ) = Path.( / )
 
 let run ?clear:(paths = []) fn =
+  Eio_main.run @@ fun env ->
   let cwd = Eio.Stdenv.cwd env in
   List.iter (fun p -> Eio.Path.rmtree ~missing_ok:true (cwd / p)) paths;
   fn env
@@ -76,12 +78,13 @@ let chdir path =
   traceln "chdir %S" path;
   Unix.chdir path
 
-let try_stat path =
+let try_stat ?(info_type=`Kind) path =
   let stat ~follow =
-    match Eio.Path.stat ~follow path with
-    | info -> Fmt.str "@[<h>%a@]" Eio.File.Stat.pp_kind info.kind
-    | exception Eio.Io (e, _) -> Fmt.str "@[<h>%a@]" Eio.Exn.pp_err e
-  in
+    match Eio.Path.stat ~follow path, info_type with
+      | info, `Perm -> Fmt.str "@[<h>%o@]" info.perm
+      | info, `Kind -> Fmt.str "@[<h>%a@]" Eio.File.Stat.pp_kind info.kind
+      | exception Eio.Io (e, _) -> Fmt.str "@[<h>%a@]" Eio.Exn.pp_err e
+   in
   let a = stat ~follow:false in
   let b = stat ~follow:true in
   if a = b then
@@ -94,10 +97,10 @@ let try_symlink ~link_to path =
   | s -> traceln "symlink %a -> %S" Path.pp path link_to
   | exception ex -> traceln "@[<h>%a@]" Eio.Exn.pp ex
 
-let try_chmod ~perm path =
-  match Path.chmod ~perm path with
-  | () -> Eio.traceln "chmod %o -> %a" perm Path.pp path
-  | exception ex -> Eio.traceln "@[<h>%a@]" Eio.Exn.pp ex
+let try_chmod path ~follow ~perm =
+  match Eio.Path.chmod ~follow path ~perm with
+  | () -> traceln "chmod %a to %o -> ok" Path.pp path perm
+  | exception ex -> traceln "@[<h>%a@]" Eio.Exn.pp ex
 
 ```
 
@@ -834,6 +837,7 @@ Unconfined:
   try_stat cwd;
   try_stat (cwd / "..");
   try_stat (cwd / "stat_subdir2/..");
+
   Path.symlink ~link_to:".." (cwd / "parent-symlink");
   try_stat (cwd / "parent-symlink");
   try_stat (cwd / "missing1" / "missing2");
@@ -849,7 +853,6 @@ Unconfined:
 - : unit = ()
 ```
 
-
 # read_link
 
 ```ocaml
@@ -1019,21 +1022,34 @@ Exception: Failure "Simulated error".
 ```
 
 ```ocaml
-run ~clear:["stat_subdir2"; "symlink"; "broken-symlink"; "parent-symlink"] @@ fun env ->
+# run ~clear:["test-file"] @@ fun env ->
   let cwd = Eio.Stdenv.cwd env in
   Switch.run @@ fun sw ->
-  Path.mkdir (cwd / "stat_subdir2");
-  Path.symlink ~link_to:"stat_subdir2" (cwd / "symlink");
-  Path.symlink ~link_to:"missing" (cwd / "broken-symlink");
-  try_stat (cwd / "stat_subdir2");
-  try_stat (cwd / "symlink");
-  try_stat (cwd / "broken-symlink");
-  try_chmod ~perm:0o777 (cwd / "stat_subdir2");
-  try_stat cwd;
-  try_stat (cwd / "..");
-  try_stat (cwd / "stat_subdir2/..");
-  Path.symlink ~link_to:".." (cwd / "parent-symlink");
-  try_stat (cwd / "parent-symlink");
-  try_stat (cwd / "missing1" / "missing2");
-  ();
+
+  let file_path = cwd / "test-file" in
+  Path.save ~create:(`Exclusive 0o644) file_path "test data";
+  traceln "+create <cwd:test-file> with permissions 0o644 -> ok";
+
+  let initial_perm = (Path.stat ~follow:true file_path).perm in
+  traceln "+<cwd:test-file> initial permissions = %o" initial_perm;
+  assert (initial_perm = 0o644);
+
+  try_chmod ~follow:true ~perm:0o400 file_path;
+
+  try_stat ~info_type:`Perm file_path;
+
+  try_chmod ~follow:true ~perm:0o600 file_path;
+  try_stat ~info_type:`Perm file_path;
+
+  Eio.Path.unlink file_path;
+  traceln "+unlink <cwd:test-file> -> ok";
+  ()
+++create <cwd:test-file> with permissions 0o644 -> ok
+++<cwd:test-file> initial permissions = 644
++chmod <cwd:test-file> to 400 -> ok
++<cwd:test-file> -> 400
++chmod <cwd:test-file> to 600 -> ok
++<cwd:test-file> -> 600
+++unlink <cwd:test-file> -> ok
+- : unit = ()
 ```