git-fastclone 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7330529bf940f74fcdf782fa298d7de00d0f75b5ccbd303bb6a99d57668b6a0
-  data.tar.gz: 4dc5b12076314094bf03638433dcbc6df5f486b6b2b5da6ff2350c77942b23ca
+  metadata.gz: 8b86bd9aa9bc5a377dd7d5b7b456eb0de1aee7ffd1e746642775d08042e9714f
+  data.tar.gz: '08dff02e06757c022c7ee0fec4890261c3d3efbee76130f2c7f4e0c2cdd91361'
 SHA512:
-  metadata.gz: c3ce186a25e7acbc07735118a7a9d55bbca2deee8ff7ba79ea8eebdb1dd8ecff2a01beb640528af0ed8d35a9a62bf03161b8afa545ca6ceb5b7b3ea62ce510ba
-  data.tar.gz: f6d0ec9167c8dc69ebdd7caad9c24d595bfd83c3400618d8eefaeb1e0ace4f6dc7a1eb4a752bb499f3c2dc16edf522096e4680dd69f414dcbef6dd9bc9addcd3
+  metadata.gz: ce36dfc95ed1d5621fc32df5721d1b796e1cdbb58c11952351dd124bf14a784bef8624e23bde74be3a3c848fff320201639b0e7737be44c8860860a0fb99a019
+  data.tar.gz: 77a296e5b3c6ea817fef4c0ca6df39c4f33e8f35626fd896d4f41ff9c201bf8de15c57a0543e7a8aac4cf63f7de352a00b01844c964657fb20192abbce3790a4

data/README.md

@@ -43,17 +43,29 @@ Usage
     gem install git-fastclone
     git fastclone [options] <git-repo-url>
 
-    -b, --branch <branch>   Clone a specific branch
-    -v, --verbose           Verbose mode
-    -c, --color             Display colored output
-        --config CONFIG     Git config applied to the cloned repo
-        --lock-timeout N    Timeout in seconds to acquire a lock on any reference repo.
+    -b, --branch BRANCH              Checkout this branch rather than the default
+    -v, --verbose                    Verbose mode
+        --print_git_errors           Print git output if a command fails
+    -c, --color                      Display colored output
+        --config CONFIG              Git config applied to the cloned repo
+        --lock-timeout N             Timeout in seconds to acquire a lock on any reference repo.
+                Default is 0 which waits indefinitely.
+        --pre-clone-hook command     An optional command that should be invoked before cloning mirror repo
 
 Change the default `REFERENCE_REPO_DIR` environment variable if necessary.
 
 Cygwin users need to add `~/bin` to PATH.
 
 
+Hooks
+-----
+
+- `pre-clone-hook` is invoked right before cloning a new mirror repo, which gives a change to prepopulate git's mirror from a different source.
+The hook is invoked with given arguments:
+1. cloning repo url
+1. path to the repo mirror location
+1. attempt number, 0-indexed
+
 How to test?
 ------------
 Manual testing:

data/lib/git-fastclone/version.rb

@@ -2,5 +2,5 @@
 
 # Version string for git-fastclone
 module GitFastCloneVersion
-  VERSION = '1.4.4'
+  VERSION = '1.5.0'
 end

data/lib/git-fastclone.rb

@@ -47,13 +47,23 @@ module GitFastClone
     end
     module_function :reference_repo_dir
 
+    def reference_filename(filename)
+      separator = if RbConfig::CONFIG['host_os'] =~ /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                    '__'
+                  else
+                    ':'
+                  end
+      "#{separator}#{filename}"
+    end
+    module_function :reference_filename
+
     def reference_repo_submodule_file(url, reference_dir, using_local_repo)
-      "#{reference_repo_dir(url, reference_dir, using_local_repo)}:submodules.txt"
+      "#{reference_repo_dir(url, reference_dir, using_local_repo)}#{reference_filename('submodules.txt')}"
     end
     module_function :reference_repo_submodule_file
 
     def reference_repo_lock_file(url, reference_dir, using_local_repo)
-      lock_file_name = "#{reference_repo_dir(url, reference_dir, using_local_repo)}:lock"
+      lock_file_name = "#{reference_repo_dir(url, reference_dir, using_local_repo)}#{reference_filename('lock')}"
       File.open(lock_file_name, File::RDWR | File::CREAT, 0o644)
     end
     module_function :reference_repo_lock_file
@@ -156,6 +166,11 @@ module GitFastClone
                 Default is 0 which waits indefinitely.') do |timeout_secs|
           self.flock_timeout_secs = timeout_secs.to_i
         end
+
+        opts.on('--pre-clone-hook command',
+                'An optional command that should be invoked before cloning mirror repo') do |command|
+          options[:pre_clone_hook] = command
+        end
       end.parse!
     end
 
@@ -314,7 +329,7 @@ module GitFastClone
     # overall checkout or not. When we pre-fetch based off of cached information,
     # fail_hard is false. When we fetch based off info in a repository directly,
     # fail_hard is true.
-    def update_reference_repo(url, fail_hard)
+    def update_reference_repo(url, fail_hard, attempt_number)
       repo_name = reference_repo_name(url)
       mirror = reference_repo_dir(url, reference_dir, using_local_repo)
 
@@ -323,24 +338,26 @@ module GitFastClone
         submodule_file = reference_repo_submodule_file(url, reference_dir, using_local_repo)
 
         # if prefetch is on, then grab children immediately to frontload network requests
-        prefetch(submodule_file) if File.exist?(submodule_file) && prefetch_submodules
+        prefetch(submodule_file, attempt_number) if File.exist?(submodule_file) && prefetch_submodules
 
         # Store the fact that our repo has been updated if necessary
-        store_updated_repo(url, mirror, repo_name, fail_hard) unless reference_updated[repo_name]
+        store_updated_repo(url, mirror, repo_name, fail_hard, attempt_number) unless reference_updated[repo_name]
       end
     end
 
     # Grab the children in the event of a prefetch
-    def prefetch(submodule_file)
+    def prefetch(submodule_file, attempt_number)
       File.readlines(submodule_file).each do |line|
         # We don't join these threads explicitly
-        Thread.new { update_reference_repo(line.strip, false) }
+        Thread.new { update_reference_repo(line.strip, false, attempt_number) }
       end
     end
 
     # Creates or updates the mirror repo then stores an indication
     # that this repo has been updated on this run of fastclone
-    def store_updated_repo(url, mirror, repo_name, fail_hard)
+    def store_updated_repo(url, mirror, repo_name, fail_hard, attempt_number)
+      trigger_pre_clone_hook_if_needed(url, mirror, attempt_number)
+      # If pre_clone_hook correctly creates a mirror directory, we don't want to clone, but just update it
       unless Dir.exist?(mirror)
         fail_on_error('git', 'clone', verbose ? '--verbose' : '--quiet', '--mirror', url.to_s, mirror.to_s,
                       quiet: !verbose, print_on_failure: print_git_errors)
@@ -404,7 +421,7 @@ module GitFastClone
       retries_allowed ||= 1
       attempt_number ||= 0
 
-      update_reference_repo(url, true)
+      update_reference_repo(url, true, attempt_number)
       dir = reference_repo_dir(url, reference_dir, using_local_repo)
 
       # Sometimes remote updates involve re-packing objects on a different thread
@@ -431,5 +448,11 @@ module GitFastClone
     def usage
       'Usage: git fastclone [options] <git-url> [path]'
     end
+
+    private def trigger_pre_clone_hook_if_needed(url, mirror, attempt_number)
+      return if Dir.exist?(mirror) || !options.include?(:pre_clone_hook)
+
+      popen2e_wrapper(options[:pre_clone_hook], url.to_s, mirror.to_s, attempt_number.to_s, quiet: !verbose)
+    end
   end
 end

data/spec/git_fastclone_runner_spec.rb

@@ -145,6 +145,54 @@ describe GitFastClone::Runner do
         subject.clone(placeholder_arg, nil, '.', 'config')
       end
     end
+
+    context 'with pre-clone-hook errors' do
+      let(:pre_clone_hook) { '/some/command' }
+      before(:each) do
+        subject.options[:pre_clone_hook] = pre_clone_hook
+        subject.reference_dir = placeholder_arg
+        allow(subject).to receive(:with_git_mirror).and_call_original
+        allow(subject).to receive(:with_reference_repo_lock) do |_url, &block|
+          block.call
+        end
+      end
+
+      it 'invokes hook command' do
+        allow(subject).to receive(:fail_on_error)
+        expect(subject).to receive(:popen2e_wrapper).with(
+          pre_clone_hook, 'PH', 'PH/PH', '0',
+          { quiet: true }
+        ) { runner_execution_double }
+
+        subject.clone(placeholder_arg, nil, '.', 'config')
+      end
+
+      it 'does not call clone if hook creates mirror' do
+        allow(subject).to receive(:popen2e_wrapper).with(
+          pre_clone_hook, 'PH', 'PH/PH', '0',
+          { quiet: true }
+        ) do
+          # Emulate creating mirror dir
+          allow(Dir).to receive(:exist?).with('PH/PH').and_return(true)
+        end
+        allow(subject).to receive(:fail_on_error)
+
+        subject.clone(placeholder_arg, nil, '.', 'config')
+      end
+
+      it 'does not call pre-clone hook if mirror is already created' do
+        # Emulate already created mirror dir
+        allow(Dir).to receive(:exist?).and_call_original
+        allow(Dir).to receive(:exist?).with('PH/PH').and_return(true)
+        expect(subject).not_to receive(:popen2e_wrapper).with(
+          pre_clone_hook, 'PH', 'PH/PH', '0',
+          { quiet: true }
+        )
+        allow(subject).to receive(:fail_on_error)
+
+        subject.clone(placeholder_arg, nil, '.', 'config')
+      end
+    end
   end
 
   describe '.clear_clone_dest_if_needed' do
@@ -249,7 +297,7 @@ describe GitFastClone::Runner do
         allow(File).to receive(:exist?) { true }
         subject.prefetch_submodules = true
         subject.reference_dir = placeholder_arg
-        subject.update_reference_repo(test_url_valid, false)
+        subject.update_reference_repo(test_url_valid, false, 0)
       end
     end
 
@@ -262,7 +310,7 @@ describe GitFastClone::Runner do
         allow(File).to receive(:exist?) { true }
         subject.prefetch_submodules = false
         subject.reference_dir = placeholder_arg
-        subject.update_reference_repo(placeholder_arg, false)
+        subject.update_reference_repo(placeholder_arg, false, 0)
       end
     end
 
@@ -277,7 +325,7 @@ describe GitFastClone::Runner do
         allow(subject).to receive(:reference_repo_dir) { placeholder_arg }
         subject.reference_updated = placeholder_hash
         subject.prefetch_submodules = false
-        subject.update_reference_repo(placeholder_arg, false)
+        subject.update_reference_repo(placeholder_arg, false, 0)
       end
     end
 
@@ -291,7 +339,7 @@ describe GitFastClone::Runner do
         subject.reference_updated = placeholder_hash
         subject.reference_dir = placeholder_arg
         subject.prefetch_submodules = false
-        subject.update_reference_repo(placeholder_arg, false)
+        subject.update_reference_repo(placeholder_arg, false, 0)
       end
     end
   end
@@ -302,7 +350,7 @@ describe GitFastClone::Runner do
 
       allow(File).to receive(:readlines) { %w[1 2 3] }
       subject.prefetch_submodules = true
-      subject.prefetch(placeholder_arg)
+      subject.prefetch(placeholder_arg, 0)
     end
   end
 
@@ -315,7 +363,7 @@ describe GitFastClone::Runner do
         allow(subject).to receive(:fail_on_error) { raise ex }
         expect(FileUtils).to receive(:remove_entry_secure).with(placeholder_arg, force: true)
         expect do
-          subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, true)
+          subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, true, 0)
         end.to raise_error(ex)
       end
 
@@ -327,7 +375,7 @@ describe GitFastClone::Runner do
         allow(subject).to receive(:fail_on_error) { raise ex }
         expect(FileUtils).to_not receive(:remove_entry_secure).with(placeholder_arg, force: true)
         expect do
-          subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, true)
+          subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, true, 0)
         end.to raise_error(ex)
       end
     end
@@ -340,7 +388,7 @@ describe GitFastClone::Runner do
         allow(subject).to receive(:fail_on_error) { raise ex }
         expect(FileUtils).to receive(:remove_entry_secure).with(placeholder_arg, force: true)
         expect do
-          subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, false)
+          subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, false, 0)
         end.to_not raise_error
       end
     end
@@ -351,7 +399,7 @@ describe GitFastClone::Runner do
       allow(subject).to receive(:fail_on_error)
 
       subject.reference_updated = placeholder_hash
-      subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, false)
+      subject.store_updated_repo(placeholder_arg, placeholder_arg, placeholder_arg, false, 0)
       expect(subject.reference_updated).to eq(placeholder_arg => true)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-fastclone
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Michael Tauraso
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-15 00:00:00.000000000 Z
+date: 2024-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize