No longer call tar tool for creating archive, use tar library

Author: kit-ty-kate

master_changes.md

@@ -65,6 +65,7 @@ users)
 ## Lint
 
 ## Repository
+  * No longer call tar tool to create archives, use tar library instead [#6945 @kit-ty-kate]
 
 ## Lock
 
@@ -215,6 +216,7 @@ users)
   * `OpamRepositoryPath` was moved to `opam-format` [#6917 @rjbou]
   * `OpamRepositoryRoot` was added [#6680 @kit-ty-kate @rjbou]
   * `OpamTar`: add module to manipulate tar gz archive. It handles only files, not directories [#6945 @kit-ty-kate @rjbou]
+  * `OpamRepositoryCommand.update_with_auto_upgrade`, `OpamUpdate.repository`: no longer call an external process to create an archive [#6945 @kit-ty-kate]
 
 ## opam-state
   * `OpamStateConfig.t`: replace `no_depexts` fields that contains disabling informations by `depexts` field that returns if the depexts mechanism is enabled. This field is automatically update by global config value in `OpamStateConfig.load_defaults` [#6489 @rjbou]
@@ -280,3 +282,5 @@ users)
   * `OpamSystem.{command,commands,read_command_output}`: add a `?dir: dirname` optional arg to launch the command in a specific directory [#6910 @NathanReb]
   * `OpamFilename.Unix`: add `starts_with` [#6945 @rjbou]
   * `OpamCompat.Seq`: add `to_dispenser` [#6945 @kit-ty-kate]
+  * `OpamSystem.directories_with_links`, `OpamSystem.rec_files`, `OpamFilename.rec_files`: add optional `?except_vcs` that default to false to exclude VCS directories [#6945 @kit-ty-kate @rjbou]
+  * `OpamFilename.make_tar_gz{_job}`: rename `make_tar_gz_job` into `make_tar_gz` as it no longer need an external process call [#6945 @kit-ty-kate]

src/client/opamRepositoryCommand.ml

@@ -259,23 +259,15 @@ let update_with_auto_upgrade rt repo_names =
                 OpamRepositoryState.Cache.remove ());
              OpamConsole.msg "Upgrading repository \"%s\"...\n"
                (OpamRepositoryName.to_string r.repo_name);
-             let open OpamProcess.Job.Op in
              let repo_root =
                match OpamRepositoryState.get_repo_root rt r with
                | OpamRepositoryRoot.Dir x -> x
              in
              OpamAdminRepoUpgrade.do_upgrade repo_root;
              if OpamRepositoryConfig.(!r.repo_tarring) then
-               OpamProcess.Job.run
-                 (OpamRepositoryRoot.make_tar_gz_job
-                    (OpamRepositoryPath.tar rt.repos_global.root r.repo_name)
-                    repo_root
-                  @@| function
-                  | Some e ->
-                    Printf.ksprintf failwith
-                      "Failed to regenerate local repository archive: %s"
-                      (Printexc.to_string e)
-                  | None -> ());
+               OpamRepositoryRoot.make_tar_gz
+                 (OpamRepositoryPath.tar rt.repos_global.root r.repo_name)
+                 repo_root;
              let def =
                OpamRepositoryRoot.Dir.Path.repo repo_root
                |> OpamFile.Repo.safe_read

src/core/opamFilename.ml

@@ -392,9 +392,6 @@ let extract_in filename dirname =
 let extract_in_job filename dirname =
   OpamSystem.extract_in_job (to_string filename) ~dir:(Dir.to_string dirname)
 
-let make_tar_gz_job filename dirname =
-  OpamSystem.make_tar_gz_job (to_string filename) ~dir:(Dir.to_string dirname)
-
 type generic_file =
   | D of Dir.t
   | F of t

src/core/opamFilename.mli

@@ -251,8 +251,6 @@ val extract_in: t -> Dir.t -> unit
 
 val extract_in_job: t -> Dir.t -> exn option OpamProcess.job
 
-val make_tar_gz_job: t -> Dir.t -> exn option OpamProcess.job
-
 (** Extract a generic file *)
 val extract_generic_file: generic_file -> Dir.t -> unit
 

src/core/opamSystem.ml

@@ -937,17 +937,6 @@ module Tar = struct
           make_command tar_cmd [ Printf.sprintf "xf%c" c ; f file; "-C" ; f dir ]
         in
         command (extract_option typ))
-
-  let compress_command =
-    fun file dir ->
-      let f = Lazy.force cygpath_tar in
-      let tar_cmd = Lazy.force tar_cmd in
-      make_command tar_cmd [
-        "cfz"; f file;
-        "-C" ; f (Filename.dirname dir);
-        f (Filename.basename dir)
-      ]
-
 end
 
 module Zip = struct
@@ -988,16 +977,6 @@ let extract_command file =
   if Zip.is_archive file then Zip.extract_command file
   else Tar.extract_command file
 
-let make_tar_gz_job ~dir file =
-  let tmpfile = file ^ ".tmp" in
-  remove_file tmpfile;
-  Tar.compress_command tmpfile dir @@> fun r ->
-  OpamProcess.cleanup r;
-  if OpamProcess.is_success r then
-    (mv tmpfile file; Done None)
-  else
-    (remove_file tmpfile; Done (Some (Process_error r)))
-
 let extract_job ~dir file =
   if not (Sys.file_exists file) then
     Done (Some (File_not_found file))

src/core/opamSystem.mli

@@ -287,8 +287,6 @@ val extract_in: dir:string -> string -> unit
 (** [extract_in_job] is similar to [extract_in], but as a job *)
 val extract_in_job: dir:string -> string -> exn option OpamProcess.job
 
-val make_tar_gz_job: dir:string -> string -> exn option OpamProcess.job
-
 (** Create a directory. Do not fail if the directory already
     exist. *)
 val mkdir: string -> unit

src/repository/opamRepositoryRoot.ml

@@ -55,7 +55,7 @@ module Dir = struct
     end)
 end
 
-let make_tar_gz_job = OpamFilename.make_tar_gz_job
+let make_tar_gz = OpamTar.create
 let extract_in_job = OpamFilename.extract_in_job
 
 type t =

src/repository/opamRepositoryRoot.mli

@@ -54,7 +54,7 @@ module Dir : sig
      and type 'a typed_file = 'a OpamFile.t
 end
 
-val make_tar_gz_job : filename -> Dir.t -> exn option OpamProcess.job
+val make_tar_gz : filename -> Dir.t -> unit
 val extract_in_job : filename -> Dir.t -> exn option OpamProcess.job
 
 type t =

src/state/opamUpdate.ml

@@ -125,8 +125,8 @@ let repository rt repo =
     let tarred_repo = OpamRepositoryPath.tar gt.root repo.repo_name in
     (if OpamRepositoryConfig.(!r.repo_tarring) then
        match repo_root with
-       | Dir dir -> OpamRepositoryRoot.make_tar_gz_job tarred_repo dir
-     else Done None)
+       | Dir dir -> OpamRepositoryRoot.make_tar_gz tarred_repo dir);
+    Done None
     @@+ function
     | Some e ->
       OpamStd.Exn.fatal e;

tests/reftests/action-disk.test

@@ -1,5 +1,5 @@
 N0REP0
-### OPAMDEBUGSECTIONS="SYSTEM FILE(config) FILE(repos-config) FILE(repo) FILE(switch-config) FILE(switch-state) FILE(opam) FILE(environment) FILE(package-version-list) FILE(.install) FILE(changes) FILE(.config) CACHE(installed) CACHE(repository)"
+### OPAMDEBUGSECTIONS="TAR SYSTEM FILE(config) FILE(repos-config) FILE(repo) FILE(switch-config) FILE(switch-state) FILE(opam) FILE(environment) FILE(package-version-list) FILE(.install) FILE(changes) FILE(.config) CACHE(installed) CACHE(repository)"
 ### OPAMDEBUG=-5
 ### OPAMVERBOSE=2
 ### OPAMYES=1