Merge pull request chriskuehl#11 from pillarsdotnet/master

chriskuehl · web-flow · commit aeb19c564d1d · 2019-05-29T16:49:07.000-07:00
Add hooks for r10k/g10k and ruby -wc.
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -1,30 +1,53 @@
--   id: puppet-validate
-    name: Validate Puppet manifests
-    description: Validate syntax of Puppet manifests
-    entry: puppet-validate
-    language: ruby
-    files: \.pp$
-    additional_dependencies: ['puppet']
+- id: epp-validate
+  additional_dependencies: ['puppet']
+  description: Validate syntax of Puppet EPP templates
+  entry: epp-validate
+  files: \.epp$
+  language: ruby
+  name: Validate EPP templates
 
--   id: erb-validate
-    name: Validate ERB templates
-    description: Validate syntax of Ruby ERB templates
-    entry: erb-validate
-    language: ruby
-    files: \.erb$
+- id: erb-validate
+  description: Validate syntax of Ruby ERB templates
+  entry: erb-validate
+  files: \.erb$
+  language: ruby
+  name: Validate ERB templates
 
--   id: epp-validate
-    name: Validate EPP templates
-    description: Validate syntax of Puppet EPP templates
-    entry: epp-validate
-    language: ruby
-    files: \.epp$
-    additional_dependencies: ['puppet']
+- id: g10k-validate
+  description: Validate syntax of Puppetfile using g10k
+  entry: g10k-validate
+  files: ^Puppetfile$
+  language: ruby
+  name: Validate g10k Puppetfile
 
--   id: puppet-lint
-    name: puppet-lint
-    description: Check Puppet manifests for stylistic problems
-    entry: puppet-lint
-    language: ruby
-    files: \.pp$
-    additional_dependencies: ['puppet-lint']
+- id: puppet-lint
+  additional_dependencies: ['puppet-lint']
+  description: Check Puppet manifests for stylistic problems
+  entry: puppet-lint
+  files: \.pp$
+  language: ruby
+  name: puppet-lint
+
+- id: puppet-validate
+  additional_dependencies: ['puppet']
+  description: Validate syntax of Puppet manifests
+  entry: puppet-validate
+  files: \.pp$
+  language: ruby
+  name: Validate Puppet manifests
+
+- id: r10k-validate
+  additional_dependencies: ['r10k']
+  description: Validate syntax of Puppetfile using r10k
+  entry: r10k-validate
+  files: ^Puppetfile$
+  language: ruby
+  name: Validate r10k Puppetfile
+
+- id: ruby-validate
+  additional_dependencies: ['ruby']
+  description: Validate syntax of ruby code
+  entry: ruby-validate
+  files: \.rb$
+  language: ruby
+  name: Validate ruby syntax
diff --git a/README.md b/README.md
@@ -5,18 +5,32 @@ Puppet pre-commit hooks
 
 Provides the following hooks:
 
-* **puppet-validate:** uses `puppet parser validate` to check the syntax of
-  Puppet manifests.
+* **epp-validate:** validates and syntax-checks [Puppet's epp templates][epp].
+
+* **erb-validate:** compiles and syntax-checks [Ruby erb templates][erb].
+
+* **g10k-validate:** uses [g10k][g10k] to validate [Puppetfile][puppetfile] syntax.
 
 * **puppet-lint:** uses [`puppet-lint`](http://puppet-lint.com/) to check for
-  stylistic issues with your Puppet manifests.
+  stylistic issues with Puppet manifests.
 
-* **erb-validate:** compiles and syntax-checks Ruby erb templates.
+* **puppet-validate:** uses [`puppet parser validate`][puppet-parser] to check the syntax of
+  Puppet manifests.
 
-* **epp-validate:** validates and syntax-checks [Puppet's epp templates][epp].
+* **r10k-validate:** uses [r10k][r10k] to validate [Puppetfile][puppetfile] syntax.
+
+* **ruby-validate:** uses [`ruby -c`][ruby-c] to validate the syntax of ruby code.
 
 
 [epp]: https://docs.puppet.com/puppet/latest/lang_template_epp.html
+[erb]: https://puppet.com/docs/puppet/latest/lang_template_erb.html
+[g10k]: https://github.com/xorpaul/g10k
+[puppetfile]: https://puppet.com/docs/pe/latest/puppetfile.html
+[puppet-parser]: https://puppet.com/docs/puppet/latest/man/parser.html#EXAMPLES
+[r10k]: https://github.com/puppetlabs/r10k
+[rubocop]: https://github.com/rubocop-hq/rubocop
+[ruby-c]: https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/options.html
+[yamllint]: https://github.com/adrienverge/yamllint
 
 ## Usage
 
@@ -26,24 +40,46 @@ Provides the following hooks:
    root of your git repository:
 
     ```yaml
-    -   repo: https://github.com/chriskuehl/puppet-pre-commit-hooks.git
-        sha: v2.0.2
-        hooks:
-        -   id: puppet-validate
-        -   id: erb-validate
-        -   id: epp-validate
-        -   id: puppet-lint
-            args:
+    - repo: https://github.com/chriskuehl/puppet-pre-commit-hooks.git
+      sha: v2.0.2
+      hooks:
+        - id: epp-validate
+        - id: erb-validate
+        - id: puppet-lint
+          args:
             -   --fail-on-warnings
+        - id: puppet-validate
+        - id: r10k-validate
+        - id: ruby-validate
     ```
 
     You'll almost certainly want to adjust the puppet-lint args for your
     project. I find the following most helpful:
 
     ```yaml
-            -   --no-80chars-check
-            -   --no-documentation-check
-            -   --no-puppet_url_without_modules-check
+         - --no-80chars-check
+         - --no-documentation-check
+         - --no-puppet_url_without_modules-check
+    ```
+
+    To check ruby *style* as well as *syntax*, you may find it useful
+    to add a hook for [`rubocop`][rubocop]:
+
+    ```yaml
+    - repo: https://github.com/jumanjihouse/pre-commit-hooks
+      rev: 1.11.0
+      hooks:
+        - id: reek
+        - id: rubocop
+    ```
+
+    To check yaml syntax, you may want to add a hook for [`yamllint`][yamllint]:
+
+    ```yaml
+    - repo: 'https://github.com/adrienverge/yamllint'
+      rev: v1.15.0
+      hooks:
+        - id: 'yamllint'
     ```
 
 3. Run `pre-commit install` to add pre-commit git hooks.
diff --git a/pre_commit_fake_gem.gemspec b/pre_commit_fake_gem.gemspec
@@ -6,5 +6,5 @@ Gem::Specification.new do |s|
     s.description = 'pre-commit hooks for Puppet projects'
 
     s.bindir = 'ruby-stubs'
-    s.executables = ['puppet-validate', 'erb-validate', 'epp-validate']
+    s.executables = ['erb-validate', 'epp-validate', 'g10k-validate', 'puppet-validate', 'r10k-validate', 'ruby-validate']
 end
diff --git a/ruby-stubs/g10k-validate b/ruby-stubs/g10k-validate
@@ -0,0 +1,14 @@
+require 'English'
+
+status = 0
+ARGV.each do |file|
+  output = `g10k -dryrun -puppetfile -puppetfilelocation "#{file}" check 2>&1`
+  next unless output =~ /^Error:/
+  puts "#{file}: failed g10k validation"
+  puts output
+  status = 1
+end
+
+exit status
+
+# vim: ft=ruby
diff --git a/ruby-stubs/r10k-validate b/ruby-stubs/r10k-validate
@@ -0,0 +1,14 @@
+require 'English'
+
+status = 0
+ARGV.each do |file|
+  output = `(cd $(dirname "#{file}") && r10k puppetfile check 2>&1)`
+  next if $CHILD_STATUS.exitstatus == 0
+  puts "#{file}: failed r10k validation"
+  puts output
+  status = 1
+end
+
+exit status
+
+# vim: ft=ruby
diff --git a/ruby-stubs/ruby-validate b/ruby-stubs/ruby-validate
@@ -0,0 +1,14 @@
+require 'English'
+
+status = 0
+ARGV.each do |file|
+  output = `ruby -wc "#{file}" 2>&1`
+  next if $CHILD_STATUS.exitstatus == 0
+  puts "#{file}: failed ruby syntax check"
+  puts output
+  status = 1
+end
+
+exit status
+
+# vim: ft=ruby
