git-fastclone 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5f3f84cbab65351479f22b659b912521699f542c898010527f25b7c3786c84
-  data.tar.gz: 5f02716656bf0962d9a808ae368078f0e151e6bdfd3abba5b25503504f64194b
+  metadata.gz: da2eb17be407c42dbabdb002d8cee1fb56820f6543df47758b0376e84ed2344e
+  data.tar.gz: 0c1ca35bca06f608f8087670eba49cb5cc7d6c1af7c308e38159477455bd33c3
 SHA512:
-  metadata.gz: a9219567c52c31d5219027adb6227c88970dd839fa8dd2f50258fc205adc3e4f9372d44d6f734242849865d7885f6b8f5a3fadfef05f77c88e24d8d85016a849
-  data.tar.gz: c136b5240dfc87480457c924772944282f518f8c77d49473f41724449ae0566d8cc5476e6f698aa86de2b18f1f77a8995d0f5f3e8778546630e390d6ed2d2530
+  metadata.gz: 4a3d27522c916ac8883ad8abceb5d19529bb406409b3f7904652a54640b2edc91184420baad3118d8379b7c26ce2331018367c994375843c9130ae9511f1108f
+  data.tar.gz: 413c42026762c4bf1a80d693d2920c0a519969a7d5c4f215fb810b88f6dabb5e449a15d331214c0751e0daa92c4cbc706915e7ca4d9691ec2aaefb292b8cbef6

data/lib/git-fastclone/version.rb

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

data/lib/git-fastclone.rb

@@ -74,7 +74,7 @@ module GitFastClone
     DEFAULT_GIT_ALLOW_PROTOCOL = 'file:git:http:https:ssh'
 
     attr_accessor :reference_dir, :prefetch_submodules, :reference_updated, :reference_mutex,
-                  :options, :abs_clone_path, :using_local_repo, :verbose, :color,
+                  :options, :abs_clone_path, :using_local_repo, :verbose, :print_git_errors, :color,
                   :flock_timeout_secs
 
     def initialize
@@ -100,6 +100,8 @@ module GitFastClone
 
       self.verbose = false
 
+      self.print_git_errors = false
+
       self.color = false
 
       self.flock_timeout_secs = 0
@@ -133,9 +135,15 @@ module GitFastClone
         end
 
         opts.on('-v', '--verbose', 'Verbose mode') do
+          puts '--print_git_errors is redundant when using --verbose' if print_git_errors
           self.verbose = true
         end
 
+        opts.on('--print_git_errors', 'Print git output if a command fails') do
+          puts '--print_git_errors is redundant when using --verbose' if verbose
+          self.print_git_errors = true
+        end
+
         opts.on('-c', '--color', 'Display colored output') do
           self.color = true
         end
@@ -212,13 +220,14 @@ module GitFastClone
         clone_commands = ['git', 'clone', verbose ? '--verbose' : '--quiet']
         clone_commands << '--reference' << mirror.to_s << url.to_s << clone_dest
         clone_commands << '--config' << config.to_s unless config.nil?
-        fail_pipe_on_error(clone_commands, quiet: !verbose)
+        fail_on_error(*clone_commands, quiet: !verbose, print_on_failure: print_git_errors)
       end
 
       # Only checkout if we're changing branches to a non-default branch
       if rev
         Dir.chdir(File.join(abs_clone_path, src_dir)) do
-          fail_pipe_on_error(['git', 'checkout', '--quiet', rev.to_s], quiet: !verbose)
+          fail_on_error('git', 'checkout', '--quiet', rev.to_s, quiet: !verbose,
+                                                                print_on_failure: print_git_errors)
         end
       end
 
@@ -243,7 +252,8 @@ module GitFastClone
       submodule_url_list = []
       output = ''
       Dir.chdir(File.join(abs_clone_path, pwd).to_s) do
-        output = fail_on_error('git', 'submodule', 'init', quiet: !verbose)
+        output = fail_on_error('git', 'submodule', 'init', quiet: !verbose,
+                                                           print_on_failure: print_git_errors)
       end
 
       output.split("\n").each do |line|
@@ -261,10 +271,9 @@ module GitFastClone
       threads << Thread.new do
         with_git_mirror(submodule_url) do |mirror, _|
           Dir.chdir(File.join(abs_clone_path, pwd).to_s) do
-            fail_pipe_on_error(
-              ['git', 'submodule', verbose ? nil : '--quiet', 'update', '--reference', mirror.to_s,
-               submodule_path.to_s].compact, quiet: !verbose
-            )
+            cmd = ['git', 'submodule', verbose ? nil : '--quiet', 'update', '--reference', mirror.to_s,
+                   submodule_path.to_s].compact
+            fail_on_error(*cmd, quiet: !verbose, print_on_failure: print_git_errors)
           end
         end
 
@@ -337,21 +346,13 @@ module GitFastClone
     # that this repo has been updated on this run of fastclone
     def store_updated_repo(url, mirror, repo_name, fail_hard)
       unless Dir.exist?(mirror)
-        fail_pipe_on_error(
-          ['git', 'clone', verbose ? '--verbose' : '--quiet', '--mirror', url.to_s,
-           mirror.to_s], quiet: !verbose
-        )
+        fail_on_error('git', 'clone', verbose ? '--verbose' : '--quiet', '--mirror', url.to_s, mirror.to_s,
+                      quiet: !verbose, print_on_failure: print_git_errors)
       end
 
       Dir.chdir(mirror) do
         cmd = ['git', 'remote', verbose ? '--verbose' : nil, 'update', '--prune'].compact
-        if verbose
-          fail_pipe_on_error(cmd, quiet: !verbose)
-        else
-          # Because above operation might spit out a lot to stderr, we use this to swallow them
-          # and only display if the operation return non 0 exit code
-          fail_on_error(*cmd, quiet: !verbose)
-        end
+        fail_on_error(*cmd, quiet: !verbose, print_on_failure: print_git_errors)
       end
       reference_updated[repo_name] = true
     rescue RunnerExecutionRuntimeError => e

data/lib/runner_execution.rb

@@ -20,37 +20,9 @@ module RunnerExecution
     end
   end
 
-  # Wrapper around open3.pipeline_r which fails on error.
-  # and stops users from invoking the shell by accident.
-  def fail_pipe_on_error(*cmd_list, quiet: false, **opts)
-    print_command('Running Pipeline:', cmd_list) unless quiet
-
-    env = opts.delete(:env) { {} }
-    raise ArgumentError, "The :env option must be a hash, not #{env.inspect}" unless env.is_a?(Hash)
-
-    cmd_list.map! { |cmd| shell_safe(cmd).unshift(env) }
-
-    output, *status_list = Open3.pipeline_r(*cmd_list, opts) do |out, wait_threads|
-      out_reader = Thread.new do
-        if quiet
-          output = out.read
-        else
-          # Output from pipeline should go to stdout and also get returned for
-          # processing if necessary.
-          output = tee(out, STDOUT)
-        end
-        out.close
-        output
-      end
-      [out_reader.value] + wait_threads.map(&:value)
-    end
-    exit_on_status(output, cmd_list, status_list, quiet: quiet)
-  end
-  module_function :fail_pipe_on_error
-
   # Runs a command that fails on error.
   # Uses popen2e wrapper. Handles bad statuses with potential for retries.
-  def fail_on_error(*cmd, stdin_data: nil, binmode: false, quiet: false, **opts)
+  def fail_on_error(*cmd, stdin_data: nil, binmode: false, quiet: false, print_on_failure: false, **opts)
     print_command('Running Shell Safe Command:', [cmd]) unless quiet
     shell_safe_cmd = shell_safe(cmd)
     retry_times = opts[:retry] || 0
@@ -67,7 +39,9 @@ module RunnerExecution
     end
 
     # Get out with the status, good or bad.
-    exit_on_status(output, [shell_safe_cmd], [status], quiet: quiet)
+    # When quiet, we don't need to print the output, as it is already streamed from popen2e_wrapper
+    needs_print_on_failure = quiet && print_on_failure
+    exit_on_status(output, [shell_safe_cmd], [status], quiet: quiet, print_on_failure: needs_print_on_failure)
   end
   module_function :fail_on_error
 
@@ -183,20 +157,21 @@ module RunnerExecution
   # return code of the first one.
   #
   # Otherwise returns first argument (output)
-  def exit_on_status(output, cmd_list, status_list, quiet: false)
+  def exit_on_status(output, cmd_list, status_list, quiet: false, print_on_failure: false)
     status_list.each_index do |index|
       status = status_list[index]
       cmd = cmd_list[index]
-      check_status(cmd, status, output: output, quiet: quiet)
+      check_status(cmd, status, output: output, quiet: quiet, print_on_failure: print_on_failure)
     end
 
     output
   end
   module_function :exit_on_status
 
-  def check_status(cmd, status, output: nil, quiet: false)
+  def check_status(cmd, status, output: nil, quiet: false, print_on_failure: false)
     return if status.exited? && status.exitstatus == 0
 
+    logger.info(output) if print_on_failure
     # If we exited nonzero or abnormally, print debugging info and explode.
     if status.exited?
       logger.debug("Process Exited normally. Exit status:#{status.exitstatus}") unless quiet

data/spec/git_fastclone_runner_spec.rb

@@ -89,7 +89,7 @@ describe GitFastClone::Runner do
   describe '.clone' do
     let(:runner_execution_double) { double('runner_execution') }
     before(:each) do
-      allow(runner_execution_double).to receive(:fail_pipe_on_error) {}
+      allow(runner_execution_double).to receive(:fail_on_error) {}
       allow(Dir).to receive(:pwd) { '/pwd' }
       allow(Dir).to receive(:chdir).and_yield
       allow(subject).to receive(:with_git_mirror).and_yield('/cache', 0)
@@ -97,13 +97,13 @@ describe GitFastClone::Runner do
     end
 
     it 'should clone correctly' do
-      expect(subject).to receive(:fail_pipe_on_error).with(
-        ['git', 'checkout', '--quiet', 'PH'],
-        { quiet: true }
+      expect(subject).to receive(:fail_on_error).with(
+        'git', 'checkout', '--quiet', 'PH',
+        { quiet: true, print_on_failure: false }
       ) { runner_execution_double }
-      expect(subject).to receive(:fail_pipe_on_error).with(
-        ['git', 'clone', '--quiet', '--reference', '/cache', 'PH', '/pwd/.'],
-        { quiet: true }
+      expect(subject).to receive(:fail_on_error).with(
+        'git', 'clone', '--quiet', '--reference', '/cache', 'PH', '/pwd/.',
+        { quiet: true, print_on_failure: false }
       ) { runner_execution_double }
 
       subject.clone(placeholder_arg, placeholder_arg, '.', nil)
@@ -111,26 +111,41 @@ describe GitFastClone::Runner do
 
     it 'should clone correctly with verbose mode on' do
       subject.verbose = true
-      expect(subject).to receive(:fail_pipe_on_error).with(
-        ['git', 'checkout', '--quiet', 'PH'],
-        { quiet: false }
+      expect(subject).to receive(:fail_on_error).with(
+        'git', 'checkout', '--quiet', 'PH',
+        { quiet: false, print_on_failure: false }
       ) { runner_execution_double }
-      expect(subject).to receive(:fail_pipe_on_error).with(
-        ['git', 'clone', '--verbose', '--reference', '/cache', 'PH', '/pwd/.'],
-        { quiet: false }
+      expect(subject).to receive(:fail_on_error).with(
+        'git', 'clone', '--verbose', '--reference', '/cache', 'PH', '/pwd/.',
+        { quiet: false, print_on_failure: false }
       ) { runner_execution_double }
 
       subject.clone(placeholder_arg, placeholder_arg, '.', nil)
     end
 
     it 'should clone correctly with custom configs' do
-      expect(subject).to receive(:fail_pipe_on_error).with(
-        ['git', 'clone', '--quiet', '--reference', '/cache', 'PH', '/pwd/.', '--config', 'config'],
-        { quiet: true }
+      expect(subject).to receive(:fail_on_error).with(
+        'git', 'clone', '--quiet', '--reference', '/cache', 'PH', '/pwd/.', '--config', 'config',
+        { quiet: true, print_on_failure: false }
       ) { runner_execution_double }
 
       subject.clone(placeholder_arg, nil, '.', 'config')
     end
+
+    context 'with printing errors' do
+      before(:each) do
+        subject.print_git_errors = true
+      end
+
+      it 'prints failures' do
+        expect(subject).to receive(:fail_on_error).with(
+          'git', 'clone', '--quiet', '--reference', '/cache', 'PH', '/pwd/.', '--config', 'config',
+          { quiet: true, print_on_failure: true }
+        ) { runner_execution_double }
+
+        subject.clone(placeholder_arg, nil, '.', 'config')
+      end
+    end
   end
 
   describe '.clear_clone_dest_if_needed' do
@@ -298,7 +313,7 @@ describe GitFastClone::Runner do
         status = double('status')
         allow(status).to receive(:exitstatus).and_return(1)
         ex = RunnerExecution::RunnerExecutionRuntimeError.new(status, 'cmd')
-        allow(subject).to receive(:fail_pipe_on_error) { raise ex }
+        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)
@@ -311,7 +326,7 @@ describe GitFastClone::Runner do
         status = double('status')
         allow(status).to receive(:exitstatus).and_return(1)
         ex = RunnerExecution::RunnerExecutionRuntimeError.new(status, 'cmd')
-        allow(subject).to receive(:fail_pipe_on_error) { raise ex }
+        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)
@@ -322,7 +337,7 @@ describe GitFastClone::Runner do
     let(:placeholder_hash) { {} }
 
     it 'should correctly update the hash' do
-      allow(subject).to receive(:fail_pipe_on_error)
+      allow(subject).to receive(:fail_on_error)
       allow(Dir).to receive(:chdir) {}
 
       subject.reference_updated = placeholder_hash
@@ -367,12 +382,6 @@ describe GitFastClone::Runner do
     let(:expected_commands) { [] }
 
     before(:each) do
-      allow(subject).to receive(:fail_pipe_on_error) { |*params|
-        command = params[0]
-        expect(expected_commands.length).to be > 0
-        expected_command = expected_commands.shift
-        expect(command).to eq(expected_command)
-      }
       allow(subject).to receive(:fail_on_error) { |*params|
         # last one is an argument `quiet:`
         command = params.first(params.size - 1)

data/spec/runner_execution_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Square Inc.
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'spec_helper'
+require 'git-fastclone'
+
+# Integration tests use real demo_tool.sh to inspect the E2E behavior
+describe RunnerExecution do
+  subject { described_class }
+  let(:external_tool) { "#{__dir__}/../script/spec_demo_tool.sh" }
+  let(:logger) { double('logger') }
+
+  before do
+    allow($stdout).to receive(:puts)
+    allow(logger).to receive(:info)
+    allow(logger).to receive(:debug)
+    allow(logger).to receive(:warn)
+    allow(RunnerExecution).to receive(:logger).and_return(logger)
+  end
+
+  describe '.fail_on_error' do
+    it 'should log failure info on command error' do
+      expect(logger).to receive(:info).with("My error output\n")
+
+      expect do
+        described_class.fail_on_error(external_tool, '1', 'My error output', quiet: true,
+                                                                             print_on_failure: true)
+      end.to raise_error(RunnerExecution::RunnerExecutionRuntimeError)
+    end
+
+    it 'should not log failure output on command success' do
+      expect($stdout).not_to receive(:info)
+
+      described_class.fail_on_error(external_tool, '0', 'My success output', quiet: true,
+                                                                             print_on_failure: true)
+    end
+
+    it 'should not log failure output when not in the quiet mode' do
+      expect($stdout).not_to receive(:info)
+
+      described_class.fail_on_error(external_tool, '0', 'My success output', quiet: false,
+                                                                             print_on_failure: true)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-fastclone
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Michael Tauraso
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -44,6 +44,7 @@ files:
 - lib/runner_execution.rb
 - spec/git_fastclone_runner_spec.rb
 - spec/git_fastclone_url_helper_spec.rb
+- spec/runner_execution_spec.rb
 - spec/spec_helper.rb
 homepage: http://square.github.io/git-fastclone/
 licenses:
@@ -65,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: git-clone --recursive on steroids!