Add gitconfig and gitignore parameters (Git)

.fixtures.yml

@@ -2,5 +2,6 @@ fixtures:
   repositories:
     stdlib: "https://github.com/puppetlabs/puppetlabs-stdlib.git"
     apt: "https://github.com/puppetlabs/puppetlabs-apt.git"
+    vcsrepo: "https://github.com/puppetlabs/puppetlabs-vcsrepo.git"
   symlinks:
     software: "#{source_dir}"

README.md

@@ -108,6 +108,7 @@ classes:
 - software::editors::atom
 - software::entertainment::vlc
 - software::social::skype
+- software::vcsscm::git
 
 software::browsers::chrome::channel: stable
 
@@ -119,6 +120,13 @@ software::editors::atom::packages:
 software::editors::atom::themes:
   twilight-syntax: {}
 software::editors::atom::user: username
+
+software::vcsscm::git:
+  gui: true
+  bash_completion: true
+  bash_prompt: true
+  gitconfig: true
+  gitignore: puppet:///modules/custom/user/gitignore
 ```
 
 ## Reference

files/vcsscm/git/system-gitconfig

@@ -0,0 +1,4 @@
+# System-global Git configuration. https://git-scm.com/docs/git-config#FILES
+
+[alias]
+	undo-commit = reset --soft HEAD^

files/vcsscm/git/user-gitconfig

@@ -0,0 +1 @@
+# User-global Git configuration. See /etc/gitconfig for system-global settings.

files/vcsscm/git/user-gitignore

@@ -0,0 +1,58 @@
+# Global Git Ignore. https://git-scm.com/docs/gitignore
+
+# Special files and folder of various OSes
+.AppleDesktop
+.AppleDB
+.AppleDouble
+.apdisk
+.com.apple.timemachine.donotpresent
+Desktop.ini
+.directory
+*.DS_Store
+.fseventsd
+.fuse_hidden*
+.LSOverride
+Network Trash Folder
+.nfs*
+$RECYCLE.BIN/
+.Spotlight-V100
+.TemporaryItems
+Temporary Items
+.Trash-*
+.Trashes
+.VolumeIcon.icns
+
+# Various cache files and folders
+.cache
+.eggs/
+*.egg-info/
+.eslintcache
+Thumbs.db
+webassets-cache
+
+# Build files and folders
+**/material-design-icons/*/ios/*.imageset/Contents.json
+**/material-design-icons/sprites/
+**/material-design-icons/iconfont/
+**/material-design-icons/*/drawable-anydpi-v21/*.xml
+**/material-design-icons/**/*.png
+**/material-design-icons/*/svg/design/*.svg
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Editor and IDE files and folders
+.idea
+*.stTheme.cache
+*.sublime-project
+*.sublime-workspace
+*.tmlanguage.cache
+*.tmPreferences.cache
+GitHub.sublime-settings
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/

manifests/vcsscm/git.pp

@@ -1,12 +1,14 @@
 # git.pp
-# Install git cli
+# Install git cli, optional tab completion, config and ignore files
 #
 
 class software::vcsscm::git (
   $ensure          = $software::params::software_ensure,
   $gui             = false,
   $bash_completion = false,
   $bash_prompt     = false,
+  $gitconfig       = false,
+  $gitignore       = false,
 ) inherits software::params {
 
   validate_string($ensure)
@@ -30,6 +32,7 @@
       }
 
       if $bash_prompt {
+
         vcsrepo { '/opt/bash-git-prompt/':
           ensure   => present,
           provider => git,
@@ -45,6 +48,87 @@
           source => 'puppet:///modules/software/vcsscm/git/bash-git-prompt',
         }
       }
+
+      if $gitconfig or $gitignore {
+
+        if !defined(File['/etc/skel/.config']) {
+          file { '/etc/skel/.config':
+            ensure => directory,
+            owner  => 'root',
+            group  => 'root',
+            mode   => '0755',
+          }
+        }
+
+        if !defined(File['/etc/skel/.config/git']) {
+          file { '/etc/skel/.config/git':
+            ensure => directory,
+            owner  => 'root',
+            group  => 'root',
+            mode   => '0755',
+          }
+        }
+      }
+
+      if $gitconfig {
+
+        $gitconfig_system = $gitconfig ? {
+          Boolean => 'puppet:///modules/software/vcsscm/git/system-gitconfig',
+          String  => false,  # a string will only set user config
+          Hash    => $gitconfig['system'],
+          default => fail('$gitconfig must be one of (Boolean, String, Hash)'),
+        }
+
+        if $gitconfig_system {
+
+          file { '/etc/gitconfig':
+            ensure => file,
+            owner  => 'root',
+            group  => 'root',
+            mode   => '0644',
+            source => $gitconfig_system,
+          }
+        }
+
+        $gitconfig_user = $gitconfig ? {
+          Boolean => 'puppet:///modules/software/vcsscm/git/user-gitconfig',
+          String  => $gitconfig,
+          Hash    => $gitconfig['user'],
+          default => fail('$gitconfig must be one of (Boolean, String, Hash)'),
+        }
+
+        if $gitconfig_user {
+
+          file { '/etc/skel/.config/git/config':
+            ensure => file,
+            owner  => 'root',
+            group  => 'root',
+            mode   => '0644',
+            source => $gitconfig_user,
+          }
+        }
+      }
+
+      if $gitignore {
+
+        $gitignore_user = $gitignore ? {
+          Boolean => 'puppet:///modules/software/vcsscm/git/user-gitignore',
+          String  => $gitignore,
+          Hash    => $gitignore['user'],
+          default => fail('$gitignore must be one of (Boolean, String, Hash)'),
+        }
+
+        if $gitignore_user {
+
+          file { '/etc/skel/.config/git/ignore':
+            ensure => file,
+            owner  => 'root',
+            group  => 'root',
+            mode   => '0644',
+            source => $gitignore_user,
+          }
+        }
+      }
     }
     'windows': {
       package { 'git':

metadata.json

@@ -18,7 +18,7 @@
     {"name": "puppetlabs/stdlib", "version_requirement": ">= 4.2.0 < 5.0.0"},
     {"name": "puppetlabs/apt", "version_requirement": ">= 2.1.1 < 3.0.0"},
     {"name": "puppetlabs/chocolatey", "version_requirement": ">= 0.8.0 < 2.0.0"},
-    {"name": "puppetlabs/vcsrepo", "version_requirement": ">= 2.0.0 < 3.0.0"},
+    {"name": "puppetlabs/vcsrepo", "version_requirement": ">= 1.3.1 < 3.0.0"},
     {"name": "thekevjames/homebrew", "version_requirement": ">= 1.5.0 < 2.0.0"},
     {"name": "unibet/vagrant", "version_requirement": ">= 0.2.1 < 1.0.0"}
   ],

spec/classes/software_vcsscm_git_spec.rb

@@ -13,6 +13,134 @@
         else
           it { is_expected.to compile.with_all_deps }
           it { is_expected.to contain_package('git') }
+          it { is_expected.not_to contain_package('gitk') }
+          it { is_expected.not_to contain_package('git-gui') }
+          it { is_expected.not_to contain_package('bash-completion') }
+          it { is_expected.not_to contain_vcsrepo('/opt/bash-git-prompt/') }
+          it { is_expected.not_to contain_file('/etc/bash_completion.d/bash-git-prompt') }
+          it { is_expected.not_to contain_file('/etc/gitconfig') }
+          it { is_expected.not_to contain_file('/etc/skel/.config/git/config') }
+          it { is_expected.not_to contain_file('/etc/skel/.config/git/ignore') }
+        end
+      end
+
+      context 'with gui' do
+        let :params do
+          {
+            :gui => true
+          }
+        end
+        if facts[:operatingsystem] == 'Darwin'
+          it { is_expected.to compile.and_raise_error(/is not supported on Darwin./) }
+        else
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_package('git') }
+          it { is_expected.to contain_package('gitk') }
+          it { is_expected.to contain_package('git-gui') }
+        end
+      end
+
+      context 'with bash completion and prompt' do
+        let :params do
+          {
+            :bash_completion => true,
+            :bash_prompt     => true
+          }
+        end
+        if facts[:operatingsystem] == 'Darwin'
+          it { is_expected.to compile.and_raise_error(/is not supported on Darwin./) }
+        else
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_package('git') }
+          it { is_expected.to contain_package('bash-completion') }
+          it { is_expected.to contain_vcsrepo('/opt/bash-git-prompt/') }
+          it {
+            is_expected.to contain_file('/etc/bash_completion.d/bash-git-prompt')
+              .with_source('puppet:///modules/software/vcsscm/git/bash-git-prompt')
+          }
+        end
+      end
+
+      context 'with booleans for gitconfig and gitignore' do
+        let :params do
+          {
+            :gitconfig => true,
+            :gitignore => true
+          }
+        end
+        if facts[:operatingsystem] == 'Darwin'
+          it { is_expected.to compile.and_raise_error(/is not supported on Darwin./) }
+        else
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_package('git') }
+          it {
+            is_expected.to contain_file('/etc/gitconfig')
+              .with_source('puppet:///modules/software/vcsscm/git/system-gitconfig')
+          }
+          it {
+            is_expected.to contain_file('/etc/skel/.config/git/config')
+              .with_source('puppet:///modules/software/vcsscm/git/user-gitconfig')
+          }
+          it {
+            is_expected.to contain_file('/etc/skel/.config/git/ignore')
+              .with_source('puppet:///modules/software/vcsscm/git/user-gitignore')
+          }
+        end
+      end
+
+      context 'with strings for gitconfig and gitignore' do
+        let :params do
+          {
+            :gitconfig => 'puppet:///modules/user-supplied/custom/user-gitconfig',
+            :gitignore => 'puppet:///modules/user-supplied/custom/user-gitignore'
+          }
+        end
+        if facts[:operatingsystem] == 'Darwin'
+          it { is_expected.to compile.and_raise_error(/is not supported on Darwin./) }
+        else
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_package('git') }
+          it { is_expected.not_to contain_file('/etc/gitconfig') }
+          it {
+            is_expected.to contain_file('/etc/skel/.config/git/config')
+              .with_source('puppet:///modules/user-supplied/custom/user-gitconfig')
+          }
+          it {
+            is_expected.to contain_file('/etc/skel/.config/git/ignore')
+              .with_source('puppet:///modules/user-supplied/custom/user-gitignore')
+          }
+        end
+      end
+
+      context 'with hashes for gitconfig and gitignore' do
+        let :params do
+          {
+            :gitconfig => {
+              :system => 'puppet:///modules/user-supplied/custom/system-gitconfig',
+              :user   => 'puppet:///modules/user-supplied/custom/user-gitconfig'
+            },
+            :gitignore => {
+              :user => 'puppet:///modules/user-supplied/custom/user-gitignore'
+            }
+          }
+        end
+        if facts[:operatingsystem] == 'Darwin'
+          it { is_expected.to compile.and_raise_error(/is not supported on Darwin./) }
+        else
+          it { is_expected.to compile.with_all_deps }
+          it { is_expected.to contain_package('git') }
+          it {
+            is_expected.to contain_file('/etc/gitconfig')
+              .with_source('puppet:///modules/user-supplied/custom/system-gitconfig')
+          }
+          it {
+            is_expected.to contain_file('/etc/skel/.config/git/config')
+              .with_source('puppet:///modules/user-supplied/custom/user-gitconfig')
+          }
+          it {
+            is_expected.to contain_file('/etc/skel/.config/git/ignore')
+              .with_source('puppet:///modules/user-supplied/custom/user-gitignore')
+          }
         end
       end
     end