Merge pull request #557 from socialpoint/feat/add-skip-hooks

Add skip_hooks property to vcsrepo

Author: petergmurphy

lib/puppet/provider/vcsrepo/git.rb

@@ -6,7 +6,7 @@
   desc 'Supports Git repositories'
 
   has_features :bare_repositories, :reference_tracking, :ssh_identity, :multiple_remotes,
-               :user, :depth, :branch, :submodules, :safe_directory
+               :user, :depth, :branch, :submodules, :safe_directory, :hooks_allowed
 
   def create
     check_force
@@ -19,10 +19,16 @@ def create
       end
 
       init_repository
+      unless @resource.value(:skip_hooks).nil?
+        self.skip_hooks = @resource.value(:skip_hooks)
+      end
     else
       clone_repository(default_url, @resource.value(:path))
       update_remotes(@resource.value(:source))
       set_mirror if @resource.value(:ensure) == :mirror && @resource.value(:source).is_a?(Hash)
+      unless @resource.value(:skip_hooks).nil?
+        self.skip_hooks = @resource.value(:skip_hooks)
+      end
 
       if @resource.value(:revision)
         checkout
@@ -319,6 +325,42 @@ def set_no_mirror
     end
   end
 
+  def skip_hooks
+    git_ver = git_version
+    config_args = ['config']
+    if Gem::Version.new(git_ver) >= Gem::Version.new('1.7.4')
+      config_args.push('--local')
+    end
+    at_path do
+      begin
+        d = git_with_identity(*config_args, '--get', 'core.hooksPath')
+      rescue Puppet::ExecutionFailure
+        return :false
+      end
+      return :true if d.chomp == '/dev/null'
+      :false
+    end
+  end
+
+  def skip_hooks=(desired)
+    git_ver = git_version
+    config_args = ['config']
+    if Gem::Version.new(git_ver) >= Gem::Version.new('1.7.4')
+      config_args.push('--local')
+    end
+    at_path do
+      if desired == :true
+        exec_git(*config_args, 'core.hooksPath', '/dev/null')
+      elsif desired == :false
+        begin
+          exec_git(*config_args, '--unset', 'core.hooksPath')
+        rescue Puppet::ExecutionFailure
+          next
+        end
+      end
+    end
+  end
+
   private
 
   # @!visibility private

lib/puppet/type/vcsrepo.rb

@@ -64,6 +64,9 @@
   feature :safe_directory,
           'The provider supports setting a safe directory. This will only be used for newer versions of git.'
 
+  feature :hooks_allowed,
+          'The provider supports managing hooks for the repository operations.'
+
   ensurable do
     desc 'Ensure the version control repository.'
     attr_accessor :latest
@@ -312,6 +315,11 @@ def insync?(is)
     defaultto :false
   end
 
+  newproperty :skip_hooks, required_features: [:hooks_allowed] do
+    desc 'Explicitly skip any global hooks for this repository.'
+    newvalues(:true, :false)
+  end
+
   autorequire(:package) do
     ['git', 'git-core', 'mercurial', 'subversion']
   end

spec/acceptance/clone_repo_spec.rb

@@ -561,4 +561,41 @@
       it { is_expected.to contain 'ref: refs/heads/main' }
     end
   end
+
+  context 'with skip hooks' do
+    pp_template = <<-MANIFEST
+      vcsrepo { "#{tmpdir}/testrepo_skip_hooks":
+        ensure => present,
+        provider => git,
+        source => "file://#{tmpdir}/testrepo.git",
+        skip_hooks => %s,
+      }
+    MANIFEST
+
+    context 'when true' do
+      pp = pp_template % :true
+
+      it 'clones a repo' do
+        # Run it twice and test for idempotency
+        idempotent_apply(pp)
+      end
+
+      describe file("#{tmpdir}/testrepo_skip_hooks/.git/config") do
+        it { is_expected.to contain 'hooksPath = /dev/null' }
+      end
+    end
+
+    context 'when false' do
+      pp = pp_template % :false
+
+      it 'clones a repo' do
+        # Run it twice and test for idempotency
+        idempotent_apply(pp)
+      end
+
+      describe file("#{tmpdir}/testrepo_skip_hooks/.git/config") do
+        it { is_expected.not_to contain 'hooksPath' }
+      end
+    end
+  end
 end

spec/unit/puppet/provider/vcsrepo/git_spec.rb

@@ -583,4 +583,43 @@ def branch_a_list(include_branch = nil?)
       provider.update_references
     end
   end
+
+  describe 'skip_hooks' do
+    before :each do
+      expect_chdir('/tmp/test')
+      expect(provider).to receive(:exec_git).with('--version').and_return('1.7.4')
+    end
+
+    context 'when true' do
+      before :each do
+        resource[:skip_hooks] = true
+      end
+
+      context 'when core.hooksPath not defined' do
+        it 'defines core.hooksPath null' do
+          expect(provider).to receive(:exec_git).with('config', '--local', 'core.hooksPath', '/dev/null')
+          provider.skip_hooks = resource.value(:skip_hooks)
+        end
+      end
+      context 'when core.hooksPath defined not null' do
+        it 'defines core.hooksPath null' do
+          expect(provider).to receive(:exec_git).with('config', '--local', 'core.hooksPath', '/dev/null')
+          provider.skip_hooks = resource.value(:skip_hooks)
+        end
+      end
+    end
+
+    context 'when false' do
+      before :each do
+        resource[:skip_hooks] = false
+      end
+
+      context 'when core.hooksPath defined null' do
+        it 'unsets core.hooksPath' do
+          expect(provider).to receive(:exec_git).with('config', '--local', '--unset', 'core.hooksPath')
+          provider.skip_hooks = resource.value(:skip_hooks)
+        end
+      end
+    end
+  end
 end