overcommit 0.30.0 → 0.32.0

data/lib/overcommit/hook_runner.rb

@@ -1,7 +1,7 @@
 module Overcommit
   # Responsible for loading the hooks the repository has configured and running
   # them, collecting and displaying the results.
-  class HookRunner
+  class HookRunner # rubocop:disable Metrics/ClassLength
     # @param config [Overcommit::Configuration]
     # @param logger [Overcommit::Logger]
     # @param context [Overcommit::HookContext]
@@ -12,6 +12,10 @@ module Overcommit
       @context = context
       @printer = printer
       @hooks = []
+
+      @lock = Mutex.new
+      @resource = ConditionVariable.new
+      @slots_available = @config.concurrency
     end
 
     # Loads and runs the hooks registered for this {HookRunner}.
@@ -51,78 +55,123 @@ module Overcommit
       if @hooks.any?(&:enabled?)
         @printer.start_run
 
-        interrupted = false
-        run_failed = false
-        run_warned = false
-
-        @hooks.each do |hook|
-          hook_status = run_hook(hook)
+        # Sort so hooks requiring fewer processors get queued first. This
+        # ensures we make better use of our available processors
+        @hooks_left = @hooks.sort_by { |hook| processors_for_hook(hook) }
+        @threads = Array.new(@config.concurrency) { Thread.new(&method(:consume)) }
 
-          run_failed = true if hook_status == :fail
-          run_warned = true if hook_status == :warn
-
-          if hook_status == :interrupt
-            # Stop running any more hooks and assume a bad result
-            interrupted = true
-            break
+        begin
+          InterruptHandler.disable_until_finished_or_interrupted do
+            @threads.each(&:join)
           end
+        rescue Interrupt
+          @printer.interrupt_triggered
+          # We received an interrupt on the main thread, so alert the
+          # remaining workers that an exception occurred
+          @interrupted = true
+          @threads.each { |thread| thread.raise Interrupt }
         end
 
-        print_results(run_failed, run_warned, interrupted)
+        print_results
 
-        !(run_failed || interrupted)
+        !(@failed || @interrupted)
       else
         @printer.nothing_to_run
         true # Run was successful
       end
     end
 
-    # @param failed [Boolean]
-    # @param warned [Boolean]
-    # @param interrupted [Boolean]
-    def print_results(failed, warned, interrupted)
-      if interrupted
+    def consume
+      loop do
+        hook = @lock.synchronize { @hooks_left.pop }
+        break unless hook
+        run_hook(hook)
+      end
+    end
+
+    def wait_for_slot(hook)
+      @lock.synchronize do
+        slots_needed = processors_for_hook(hook)
+
+        loop do
+          if @slots_available >= slots_needed
+            @slots_available -= slots_needed
+
+            # Give another thread a chance since there are still slots available
+            @resource.signal if @slots_available > 0
+            break
+          elsif @slots_available > 0
+            # It's possible that another hook that requires fewer slots can be
+            # served, so give another a chance
+            @resource.signal
+
+            # Wait for a signal from another thread to try again
+            @resource.wait(@lock)
+          end
+        end
+      end
+    end
+
+    def release_slot(hook)
+      @lock.synchronize do
+        slots_released = processors_for_hook(hook)
+        @slots_available += slots_released
+
+        if @hooks_left.any?
+          # Signal once. `wait_for_slot` will perform additional signals if
+          # there are still slots available. This prevents us from sending out
+          # useless signals
+          @resource.signal
+        end
+      end
+    end
+
+    def processors_for_hook(hook)
+      hook.parallelize? ? hook.processors : @config.concurrency
+    end
+
+    def print_results
+      if @interrupted
         @printer.run_interrupted
-      elsif failed
+      elsif @failed
         @printer.run_failed
-      elsif warned
+      elsif @warned
         @printer.run_warned
       else
         @printer.run_succeeded
       end
     end
 
-    def run_hook(hook)
-      return if should_skip?(hook)
-
-      @printer.start_hook(hook)
-
+    def run_hook(hook) # rubocop:disable Metrics/CyclomaticComplexity
       status, output = nil, nil
 
       begin
-        # Disable the interrupt handler during individual hook run so that
-        # Ctrl-C actually stops the current hook from being run, but doesn't
-        # halt the entire process.
-        InterruptHandler.disable_until_finished_or_interrupted do
-          status, output = hook.run_and_transform
-        end
+        wait_for_slot(hook)
+        return if should_skip?(hook)
+
+        status, output = hook.run_and_transform
+      rescue Overcommit::Exceptions::MessageProcessingError => ex
+        status = :fail
+        output = ex.message
       rescue => ex
         status = :fail
         output = "Hook raised unexpected error\n#{ex.message}\n#{ex.backtrace.join("\n")}"
-      rescue Interrupt
-        # At this point, interrupt has been handled and protection is back in
-        # effect thanks to the InterruptHandler.
-        status = :interrupt
-        output = 'Hook was interrupted by Ctrl-C; restoring repo state...'
       end
 
-      @printer.end_hook(hook, status, output)
+      @failed = true if status == :fail
+      @warned = true if status == :warn
+
+      @printer.end_hook(hook, status, output) unless @interrupted
 
       status
+    rescue Interrupt
+      @interrupted = true
+    ensure
+      release_slot(hook)
     end
 
     def should_skip?(hook)
-      return true unless hook.enabled?
+      return true if @interrupted || !hook.enabled?
 
       if hook.skip?
         if hook.required?

data/lib/overcommit/hook_signer.rb

@@ -5,7 +5,7 @@ module Overcommit
 
     # We don't want to include the skip setting as it is set by Overcommit
     # itself
-    IGNORED_CONFIG_KEYS = %w[skip]
+    IGNORED_CONFIG_KEYS = %w[skip].freeze
 
     # @param hook_name [String] name of the hook
     # @param config [Overcommit::Configuration]

data/lib/overcommit/message_processor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Overcommit
   # Utility class that encapsulates the handling of hook messages and whether
   # they affect lines the user has modified or not.
@@ -6,10 +8,12 @@ module Overcommit
   # output tuple from an array of {Overcommit::Hook::Message}s, respecting the
   # configuration settings for the given hook.
   class MessageProcessor
-    ERRORS_MODIFIED_HEADER = 'Errors on modified lines:'
-    WARNINGS_MODIFIED_HEADER = 'Warnings on modified lines:'
-    ERRORS_UNMODIFIED_HEADER = "Errors on lines you didn't modify:"
-    WARNINGS_UNMODIFIED_HEADER = "Warnings on lines you didn't modify:"
+    ERRORS_MODIFIED_HEADER = 'Errors on modified lines:'.freeze
+    WARNINGS_MODIFIED_HEADER = 'Warnings on modified lines:'.freeze
+    ERRORS_UNMODIFIED_HEADER = "Errors on lines you didn't modify:".freeze
+    WARNINGS_UNMODIFIED_HEADER = "Warnings on lines you didn't modify:".freeze
+    ERRORS_GENERIC_HEADER = 'Errors:'.freeze
+    WARNINGS_GENERIC_HEADER = 'Warnings:'.freeze
 
     # @param hook [Overcommit::Hook::Base]
     # @param unmodified_lines_setting [String] how to treat messages on
@@ -40,10 +44,19 @@ module Overcommit
     def handle_modified_lines(messages, status)
       messages = remove_ignored_messages(messages)
 
-      messages_on_modified_lines, messages_on_unmodified_lines =
-        messages.partition { |message| message_on_modified_line?(message) }
+      messages_with_line, generic_messages = messages.partition(&:line)
 
+      # Always print generic messages first
       output = print_messages(
+        generic_messages,
+        ERRORS_GENERIC_HEADER,
+        WARNINGS_GENERIC_HEADER
+      )
+
+      messages_on_modified_lines, messages_on_unmodified_lines =
+        messages_with_line.partition { |message| message_on_modified_line?(message) }
+
+      output += print_messages(
         messages_on_modified_lines,
         ERRORS_MODIFIED_HEADER,
         WARNINGS_MODIFIED_HEADER
@@ -54,7 +67,7 @@ module Overcommit
         WARNINGS_UNMODIFIED_HEADER
       )
 
-      [transform_status(status, messages_on_modified_lines), output]
+      [transform_status(status, generic_messages + messages_on_modified_lines), output]
     end
 
     def transform_status(status, messages_on_modified_lines)

data/lib/overcommit/os.rb

@@ -27,10 +27,10 @@ module Overcommit
       private
 
       def host_os
-        @os ||= ::RbConfig::CONFIG['host_os']
+        @os ||= ::RbConfig::CONFIG['host_os'].freeze
       end
     end
 
-    SEPARATOR = self.windows? ? '\\' : File::SEPARATOR
+    SEPARATOR = (windows? ? '\\' : File::SEPARATOR).freeze
   end
 end

data/lib/overcommit/printer.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'monitor'
+
 module Overcommit
   # Provide a set of callbacks which can be executed as events occur during the
   # course of {HookRunner#run}.
@@ -9,6 +11,8 @@ module Overcommit
     def initialize(logger, context)
       @log = logger
       @context = context
+      @lock = Monitor.new # Need to use monitor so we can have re-entrant locks
+      synchronize_all_methods
     end
 
     # Executed at the very beginning of running the collection of hooks.
@@ -20,13 +24,6 @@ module Overcommit
       log.debug "✓ No applicable #{hook_script_name} hooks to run"
     end
 
-    # Executed at the start of an individual hook run.
-    def start_hook(hook)
-      unless hook.quiet?
-        print_header(hook)
-      end
-    end
-
     def hook_skipped(hook)
       log.warning "Skipping #{hook.name}"
     end
@@ -39,11 +36,16 @@ module Overcommit
     def end_hook(hook, status, output)
       # Want to print the header for quiet hooks only if the result wasn't good
       # so that the user knows what failed
-      print_header(hook) if hook.quiet? && status != :pass
+      print_header(hook) if !hook.quiet? || status != :pass
 
       print_result(hook, status, output)
     end
 
+    def interrupt_triggered
+      log.newline
+      log.error 'Interrupt signal received. Stopping hooks...'
+    end
+
     # Executed when a hook run was interrupted/cancelled by user.
     def run_interrupted
       log.newline
@@ -108,5 +110,27 @@ module Overcommit
     def hook_script_name
       @context.hook_script_name
     end
+
+    # Get all public methods that were defined on this class and wrap them with
+    # synchronization locks so we ensure the output isn't interleaved amongst
+    # the various threads.
+    def synchronize_all_methods
+      methods = self.class.instance_methods - self.class.superclass.instance_methods
+
+      methods.each do |method_name|
+        old_method = :"old_#{method_name}"
+        new_method = :"synchronized_#{method_name}"
+
+        self.class.__send__(:alias_method, old_method, method_name)
+
+        self.class.send(:define_method, new_method) do |*args|
+          @lock.synchronize do
+            __send__(old_method, *args)
+          end
+        end
+
+        self.class.__send__(:alias_method, method_name, new_method)
+      end
+    end
   end
 end

data/lib/overcommit/utils.rb

@@ -211,6 +211,42 @@ module Overcommit
         Subprocess.spawn_detached(args)
       end
 
+      # Return the number of processors used by the OS for process scheduling.
+      #
+      # @see https://github.com/grosser/parallel/blob/v1.6.1/lib/parallel/processor_count.rb#L17-L51
+      def processor_count # rubocop:disable all
+        @processor_count ||=
+          begin
+            if Overcommit::OS.windows?
+              require 'win32ole'
+              result = WIN32OLE.connect('winmgmts://').ExecQuery(
+                'select NumberOfLogicalProcessors from Win32_Processor')
+              result.to_enum.collect(&:NumberOfLogicalProcessors).reduce(:+)
+            elsif File.readable?('/proc/cpuinfo')
+              IO.read('/proc/cpuinfo').scan(/^processor/).size
+            elsif File.executable?('/usr/bin/hwprefs')
+              IO.popen('/usr/bin/hwprefs thread_count').read.to_i
+            elsif File.executable?('/usr/sbin/psrinfo')
+              IO.popen('/usr/sbin/psrinfo').read.scan(/^.*on-*line/).size
+            elsif File.executable?('/usr/sbin/ioscan')
+              IO.popen('/usr/sbin/ioscan -kC processor') do |out|
+                out.read.scan(/^.*processor/).size
+              end
+            elsif File.executable?('/usr/sbin/pmcycles')
+              IO.popen('/usr/sbin/pmcycles -m').read.count("\n")
+            elsif File.executable?('/usr/sbin/lsdev')
+              IO.popen('/usr/sbin/lsdev -Cc processor -S 1').read.count("\n")
+            elsif File.executable?('/usr/sbin/sysctl')
+              IO.popen('/usr/sbin/sysctl -n hw.ncpu').read.to_i
+            elsif File.executable?('/sbin/sysctl')
+              IO.popen('/sbin/sysctl -n hw.ncpu').read.to_i
+            else
+              # Unknown platform; assume 1 processor
+              1
+            end
+          end
+      end
+
       # Calls a block of code with a modified set of environment variables,
       # restoring them once the code has executed.
       def with_environment(env)

data/lib/overcommit/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Defines the gem version.
 module Overcommit
-  VERSION = '0.30.0'
+  VERSION = '0.32.0'.freeze
 end

data/template-dir/hooks/commit-msg

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/overcommit-hook

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/post-checkout

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/post-commit

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/post-merge

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/post-rewrite

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/pre-commit

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/pre-push

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

data/template-dir/hooks/pre-rebase

@@ -30,7 +30,15 @@ require 'yaml'
 # rubocop:disable Style/RescueModifier
 if gemfile = YAML.load_file('.overcommit.yml')['gemfile'] rescue nil
   ENV['BUNDLE_GEMFILE'] = gemfile
-  require 'bundler/setup'
+  require 'bundler'
+
+  begin
+    Bundler.setup
+  rescue Bundler::BundlerError => ex
+    puts "Problem loading '#{gemfile}': #{ex.message}"
+    puts "Try running:\nbundle install --gemfile=#{gemfile}" if ex.is_a?(Bundler::GemNotFound)
+    exit 78 # EX_CONFIG
+  end
 end
 # rubocop:enable Style/RescueModifier
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overcommit
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Brigade Engineering
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-24 00:00:00.000000000 Z
+date: 2016-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: childprocess
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6
+        version: 0.5.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6
+        version: 0.5.8
 - !ruby/object:Gem::Dependency
   name: iniparse
   requirement: !ruby/object:Gem::Requirement
@@ -39,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -96,6 +110,7 @@ files:
 - lib/overcommit/hook/commit_msg/empty_message.rb
 - lib/overcommit/hook/commit_msg/gerrit_change_id.rb
 - lib/overcommit/hook/commit_msg/hard_tabs.rb
+- lib/overcommit/hook/commit_msg/message_format.rb
 - lib/overcommit/hook/commit_msg/russian_novel.rb
 - lib/overcommit/hook/commit_msg/single_line_subject.rb
 - lib/overcommit/hook/commit_msg/spell_check.rb
@@ -140,6 +155,7 @@ files:
 - lib/overcommit/hook/pre_commit/dogma.rb
 - lib/overcommit/hook/pre_commit/es_lint.rb
 - lib/overcommit/hook/pre_commit/execute_permissions.rb
+- lib/overcommit/hook/pre_commit/forbidden_branches.rb
 - lib/overcommit/hook/pre_commit/go_lint.rb
 - lib/overcommit/hook/pre_commit/go_vet.rb
 - lib/overcommit/hook/pre_commit/haml_lint.rb
@@ -155,6 +171,7 @@ files:
 - lib/overcommit/hook/pre_commit/jsl.rb
 - lib/overcommit/hook/pre_commit/json_syntax.rb
 - lib/overcommit/hook/pre_commit/local_paths_in_gemfile.rb
+- lib/overcommit/hook/pre_commit/mdl.rb
 - lib/overcommit/hook/pre_commit/merge_conflicts.rb
 - lib/overcommit/hook/pre_commit/nginx_test.rb
 - lib/overcommit/hook/pre_commit/pep257.rb