metadata-json-lint 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98bde19c3628ff9f087cddf19bda737480646331
-  data.tar.gz: 79bc0a7ba2e8f160bf57359059f000d47120d817
+  metadata.gz: 26b0284277b14da2149836312d2f7470eeb42fec
+  data.tar.gz: 1f700550be689ad9379a1bfb5a617f4de64a18db
 SHA512:
-  metadata.gz: c6897facd6d33655ff84f489373f589269ff5646e3f8977560ec9609b7235051198a9997499a1d6e9ebb7a62904471a5599bf3b16be5379ca58c836a00820bcb
-  data.tar.gz: 0ede3fccd32938c18df7e3da63cd52c25d9be3033c63148fb2c1146afa0d1699734ebb176bee11285a85d06d468187c6c3a9683ba980f355601ea78a5edd1725
+  metadata.gz: f0160d90cb4707dc94deb44d16f9a3d22dcd15f9f6b7749c054b8354ea593089407de42e679040a052c634637d6718d636f7abec41c3cd0e2811ee439d2a9211
+  data.tar.gz: 9cbad4cbd0437415b6c347a05491a4a17f5324ca2c4472fc02772701fc7c37ebbda5a2c95106cbf5305f8afe11b4bc224e9de13ce4b74967eb9fed593da3743f

data/lib/metadata_json_lint.rb

@@ -1,18 +1,21 @@
 require 'json'
 require 'spdx-licenses'
 require 'optparse'
-require 'semantic_puppet'
+
+require 'metadata-json-lint/version_requirement'
 
 module MetadataJsonLint
   def options
     @options ||= Struct.new(
       :fail_on_warnings,
       :strict_license,
-      :strict_dependencies
+      :strict_dependencies,
+      :format
     ).new(
       true, # fail_on_warnings
       true, # strict_license
-      false # strict_dependencies
+      false, # strict_dependencies
+      'text', # format
     )
   end
   module_function :options
@@ -32,6 +35,10 @@ module MetadataJsonLint
       opts.on('--[no-]fail-on-warnings', "Fail on any warnings. Defaults to '#{options[:fail_on_warnings]}'.") do |v|
         options[:fail_on_warnings] = v
       end
+
+      opts.on('-f', '--format FORMAT', %i[text json], 'The format in which results will be output (text, json)') do |format|
+        options[:format] = format
+      end
     end.parse!
 
     mj = if ARGV[0].nil?
@@ -49,6 +56,9 @@ module MetadataJsonLint
   module_function :run
 
   def parse(metadata)
+    @errors = []
+    @warnings = []
+
     # Small hack to use the module settings as defaults but allow overriding for different rake tasks
     options = options().clone
     # Configuration from rake tasks
@@ -65,111 +75,144 @@ module MetadataJsonLint
       abort("Error: Unable to parse metadata.json: #{e.exception}")
     end
 
-    error_state = false
-
     # Fields required to be in metadata.json
     # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
-    required_fields = %w(name version author license summary source dependencies)
+    required_fields = %w[name version author license summary source dependencies]
     required_fields.each do |field|
       if parsed[field].nil?
-        puts "Error: Required field '#{field}' not found in metadata.json."
-        error_state = true
+        error :required_fields, "Required field '#{field}' not found in metadata.json."
       end
     end
 
-    error_state ||= invalid_dependencies?(parsed['dependencies']) if parsed['dependencies']
+    validate_dependencies!(parsed['dependencies']) if parsed['dependencies']
 
     # Deprecated fields
     # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
-    deprecated_fields = %w(types checksum)
+    deprecated_fields = %w[types checksum]
     deprecated_fields.each do |field|
       unless parsed[field].nil?
-        puts "Error: Deprecated field '#{field}' found in metadata.json."
-        error_state = true
+        error :deprecated_fields, "Deprecated field '#{field}' found in metadata.json."
       end
     end
 
     # The nested 'requirements' name of 'pe' is deprecated as well.
     # https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/puppet-users/nkRPvG4q0Oo/GmXa109aJQAJ
-    error_state ||= invalid_requirements?(parsed['requirements']) if parsed['requirements']
+    validate_requirements!(parsed['requirements']) if parsed['requirements']
 
     # Summary can not be over 144 characters:
     # From: https://forge.puppetlabs.com/razorsedge/snmp/3.3.1/scores
     if !parsed['summary'].nil? && parsed['summary'].size > 144
-      puts 'Error: summary exceeds 144 characters in metadata.json.'
-      error_state = true
+      error :summary, 'Field \'summary\' exceeds 144 characters in metadata.json.'
     end
 
     # Shoulds/recommendations
     # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
     #
     if !parsed['license'].nil? && !SpdxLicenses.exist?(parsed['license']) && parsed['license'] != 'proprietary'
-      puts "Warning: License identifier #{parsed['license']} is not in the SPDX list: http://spdx.org/licenses/"
-      error_state = true if options[:strict_license]
+      msg = "License identifier #{parsed['license']} is not in the SPDX list: http://spdx.org/licenses/"
+
+      options[:strict_license] == true ? error(:license, msg) : warn(:license, msg)
     end
 
     if !parsed['tags'].nil? && !parsed['tags'].is_a?(Array)
-      puts "Warning: Tags must be in an array. Currently it's a #{parsed['tags'].class}."
-      error_state = true
+      error :tags, "Tags must be in an array. Currently it's a #{parsed['tags'].class}."
     end
 
-    return unless error_state
-    if options[:fail_on_warnings] == true
-      abort("Errors found in #{metadata}")
-    else
-      puts "Errors found in #{metadata}"
+    if !@errors.empty? || !@warnings.empty?
+      result = @errors.empty? ? "Warnings found in #{metadata}" : "Errors found in #{metadata}"
+
+      case options[:format]
+      when :json
+        puts JSON.fast_generate(:result => result, :warnings => @warnings, :errors => @errors)
+      else
+        @warnings.each { |warn| puts "(WARN) #{warn}" }
+        @errors.each { |err| puts "(ERROR) #{err}" }
+        puts result
+      end
+
+      if !@errors.empty? || (!@warnings.empty? && (options[:fail_on_warnings] == true))
+        exit(1)
+      end
     end
+
+    exit(0)
   end
   module_function :parse
 
-  def invalid_requirements?(requirements)
-    error_state = false
+  def validate_requirements!(requirements)
     requirements.each do |requirement|
       if requirement['name'] == 'pe'
-        puts "The 'pe' requirement is no longer supported by the Forge."
-        error_state = true
+        warn :requirements, "The 'pe' requirement is no longer supported by the Forge."
       end
     end
-    error_state
   end
-  module_function :invalid_requirements?
+  module_function :validate_requirements!
 
-  def invalid_dependencies?(deps)
-    error_state = false
+  def validate_dependencies!(deps)
     dep_names = []
     deps.each do |dep|
       if dep_names.include?(dep['name'])
-        puts "Error: duplicate dependencies on #{dep['name']}"
-        error_state = true
+        warn :dependencies, "Duplicate dependencies on #{dep['name']}"
       end
       dep_names << dep['name']
 
-      # Open ended dependency
-      # From: https://docs.puppet.com/puppet/latest/reference/modules_metadata.html#best-practice-set-an-upper-bound-for-dependencies
       begin
-        next unless dep['version_requirement'].nil? || open_ended?(dep['version_requirement'])
-        puts "Warning: Dependency #{dep['name']} has an open " \
-          "ended dependency version requirement #{dep['version_requirement']}"
-        error_state = true if options[:strict_dependencies]
+        requirement = VersionRequirement.new(dep.fetch('version_requirement', ''))
       rescue ArgumentError => e
         # Raised when the version_requirement provided could not be parsed
-        puts "Invalid 'version_requirement' field in metadata.json: #{e}"
-        error_state = true
+        error :dependencies, "Invalid 'version_requirement' field in metadata.json: #{e}"
       end
+      validate_version_requirement!(dep, requirement)
 
       # 'version_range' is no longer used by the forge
       # See https://tickets.puppetlabs.com/browse/PUP-2781
-      next unless dep['version_range']
-      puts "Warning: Dependency #{dep['name']} has a 'version_range' attribute " \
-        'which is no longer used by the forge.'
-      error_state = true
+      if dep.key?('version_range')
+        warn :dependencies, "Dependency #{dep['name']} has a 'version_range' attribute " \
+          'which is no longer used by the forge.'
+      end
+    end
+  end
+  module_function :validate_dependencies!
+
+  def validate_version_requirement!(dep, requirement)
+    # Open ended dependency
+    # From: https://docs.puppet.com/puppet/latest/reference/modules_metadata.html#best-practice-set-an-upper-bound-for-dependencies
+    if requirement.open_ended?
+      msg = "Dependency #{dep['name']} has an open " \
+        "ended dependency version requirement #{dep['version_requirement']}"
+      options[:strict_dependencies] == true ? error(:dependencies, msg) : warn(:dependencies, msg)
+    end
+
+    # Mixing operator and wildcard version syntax
+    # From: https://docs.puppet.com/puppet/latest/modules_metadata.html#version-specifiers
+    # Supported in Puppet 5 and higher, but the syntax is unclear and incompatible with older versions
+    return unless requirement.mixed_syntax?
+    warn(:dependencies, 'Mixing "x" or "*" version syntax with operators is not recommended in ' \
+      "metadata.json, use one style in the #{dep['name']} dependency: #{dep['version_requirement']}")
+  end
+  module_function :validate_version_requirement!
+
+  def format_error(check, msg)
+    case options[:format]
+    when :json
+      { :check => check, :msg => msg }
+    else
+      "#{check}: #{msg}"
     end
-    error_state
   end
-  module_function :invalid_dependencies?
+  module_function :format_error
+
+  def warn(check, msg)
+    @warnings ||= []
+
+    @warnings << format_error(check, msg)
+  end
+  module_function :warn
+
+  def error(check, msg)
+    @errors ||= []
 
-  def open_ended?(module_end)
-    SemanticPuppet::VersionRange.parse(module_end).end == SemanticPuppet::Version::MAX
+    @errors << format_error(check, msg)
   end
-  module_function :open_ended?
+  module_function :error
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spdx-licenses
@@ -72,6 +72,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement