Add support for Puppet metadata-json-lint pre-commit hook

Author: hajee

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## master (unreleased)
 
+* Add [`metadata-json-lint`](https://voxpupuli.org/blog/2014/11/06/linting-metadata-json/) pre-commit hook
 * Fix `LineEndings` pre-commit hook handling of file paths with spaces
 
 ## 0.41.0

README.md

@@ -519,6 +519,7 @@ issue](https://github.com/brigade/overcommit/issues/238) for more details.
 * [LocalPathsInGemfile](lib/overcommit/hook/pre_commit/local_paths_in_gemfile.rb)
 * [Mdl](lib/overcommit/hook/pre_commit/mdl.rb)
 * [`*`MergeConflicts](lib/overcommit/hook/pre_commit/merge_conflicts.rb)
+* [MetadataJsonLint](lib/overcommit/hook/pre_commit/metadata_json_lint.rb)
 * [NginxTest](lib/overcommit/hook/pre_commit/nginx_test.rb)
 * [PhpCs](lib/overcommit/hook/pre_commit/php_cs.rb)
 * [PhpLint](lib/overcommit/hook/pre_commit/php_lint.rb)

config/default.yml

@@ -427,6 +427,15 @@ PreCommit:
     required_executable: 'grep'
     flags: ['-IHn', "^<<<<<<<[ \t]"]
 
+  MetadataJsonLint:
+    enabled: false
+    strict_license: true
+    strict_dependencies: false
+    fail_on_warning: true
+    description: 'Checking Puppet module metadata'
+    required_executable: 'metadata-json-lint'
+    install_command: 'gem install metadata-json-lint semantic_puppet'
+
   NginxTest:
     enabled: false
     description: 'Test nginx configs'

lib/overcommit/hook/pre_commit/metadata_json_lint.rb

@@ -0,0 +1,50 @@
+module Overcommit::Hook::PreCommit
+  #
+  # Run's the Puppet metadata linter. It has support for adding options
+  # in the .overcommit.yaml
+  #
+  # PreCommit:
+  #   MetadataJsonLint:
+  #     enabled: true
+  #     strict_license: false
+  #     strict_dependencies: false
+  #     fail_on_warning: true
+  #     description: 'Checking module metadata'
+  #
+  # @see https://voxpupuli.org/blog/2014/11/06/linting-metadata-json/
+  #
+  class MetadataJsonLint < Base
+    MESSAGE_REGEX = /\((?<type>.*)\).*/
+
+    MESSAGE_TYPE_CATEGORIZER = lambda do |type|
+      type == 'WARN' ? :warning : :error
+    end
+
+    def options
+      [:strict_license, :strict_dependencies, :fail_on_warning].collect do |option|
+        name = option.to_s.tr('_', '-')
+        value = config.fetch(option.to_s) { true }
+        if value
+          "--#{name}"
+        else
+          "--no-#{name}"
+        end
+      end
+    end
+
+    def run
+      # When metadata.json, not modified return pass
+      return :pass unless applicable_files.include?('metadata.json')
+
+      arguments = options << 'metadata.json'
+      result = execute(command, args: arguments)
+      output = result.stdout.chomp.gsub(/^"|"$/, '')
+      return :pass if result.success? && output.empty?
+      extract_messages(
+        output.split("\n"),
+        MESSAGE_REGEX,
+        MESSAGE_TYPE_CATEGORIZER
+      )
+    end
+  end
+end

spec/overcommit/hook/pre_commit/metadata_json_lint_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Overcommit::Hook::PreCommit::MetadataJsonLint do
+  let(:config)  { Overcommit::ConfigurationLoader.default_configuration }
+  let(:context) { double('context') }
+  subject { described_class.new(config, context) }
+
+  context 'metadata.json not modified' do
+    before do
+      subject.stub(:applicable_files).and_return(%w[file1.pp file2.pp])
+    end
+
+    it { should pass }
+  end
+
+  context 'metadata.json is modified' do
+    before do
+      subject.stub(:applicable_files).and_return(%w[file1.pp file2.pp metadata.json])
+    end
+
+    context 'when metadata-json-lint exits successfully' do
+      let(:result) { double('result') }
+
+      before do
+        result.stub(:success?).and_return(true)
+        subject.stub(:execute).and_return(result)
+      end
+
+      context 'with no output' do
+        before do
+          result.stub(:stdout).and_return('')
+        end
+
+        it { should pass }
+      end
+
+      context 'and it reports a warning' do
+        before do
+          result.stub(:stdout).and_return(normalize_indent(<<-OUT))
+            (WARN) requirements: The 'pe' requirement is no longer supported by the Forge.
+          OUT
+        end
+
+        it { should warn }
+      end
+    end
+
+    context 'when metadata-json-lint exits unsuccessfully' do
+      let(:result) { double('result') }
+
+      before do
+        result.stub(:success?).and_return(false)
+        subject.stub(:execute).and_return(result)
+      end
+
+      context 'and it reports a warning' do
+        before do
+          result.stub(:stdout).and_return(normalize_indent(<<-OUT))
+            (WARN) requirements: The 'pe' requirement is no longer supported by the Forge.
+          OUT
+        end
+
+        it { should warn }
+      end
+
+      context 'and it reports an error' do
+        before do
+          result.stub(:stdout).and_return(normalize_indent(<<-OUT))
+            (ERR) requirements: The 'pe' requirement is no longer supported by the Forge.
+          OUT
+        end
+
+        it { should fail_hook }
+      end
+    end
+  end
+end