metadata-json-lint 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a60434bef6d7594672b4de904d56f329d598b149
-  data.tar.gz: bf55bd986686f7c8f9b12c1190dbe21e245d2b92
+  metadata.gz: 98bde19c3628ff9f087cddf19bda737480646331
+  data.tar.gz: 79bc0a7ba2e8f160bf57359059f000d47120d817
 SHA512:
-  metadata.gz: 998f77de243d71dd44e5b66df7a17b8e7386de67adbc25e5c579881940d7bc2d0497e78a599a30e1c4aae0e130e9ac949236ef0654da3b96787f2fc15c7b2898
-  data.tar.gz: bc73115194b69d677238304dd773b15c118054eb1a3ae51dfb3a284efa0e2f7cbf1992fb61a7a52f87f128ccf4514f6c6d28f148f0d27e48cbaaf44996e0a059
+  metadata.gz: c6897facd6d33655ff84f489373f589269ff5646e3f8977560ec9609b7235051198a9997499a1d6e9ebb7a62904471a5599bf3b16be5379ca58c836a00820bcb
+  data.tar.gz: 0ede3fccd32938c18df7e3da63cd52c25d9be3033c63148fb2c1146afa0d1699734ebb176bee11285a85d06d468187c6c3a9683ba980f355601ea78a5edd1725

data/lib/metadata_json_lint.rb

@@ -5,11 +5,15 @@ require 'semantic_puppet'
 
 module MetadataJsonLint
   def options
-    @options ||= {
-      :fail_on_warnings    => true,
-      :strict_license      => true,
-      :strict_dependencies => false
-    }
+    @options ||= Struct.new(
+      :fail_on_warnings,
+      :strict_license,
+      :strict_dependencies
+    ).new(
+      true, # fail_on_warnings
+      true, # strict_license
+      false # strict_dependencies
+    )
   end
   module_function :options
 
@@ -17,15 +21,15 @@ module MetadataJsonLint
     OptionParser.new do |opts|
       opts.banner = 'Usage: metadata-json-lint [options] [metadata.json]'
 
-      opts.on('--[no-]strict-dependencies', 'Fail on open-ended module version dependencies') do |v|
+      opts.on('--[no-]strict-dependencies', "Fail on open-ended module version dependencies. Defaults to '#{options[:strict_dependencies]}'.") do |v|
         options[:strict_dependencies] = v
       end
 
-      opts.on('--[no-]strict-license', "Don't fail on strict license check") do |v|
+      opts.on('--[no-]strict-license', "Don't fail on strict license check. Defaults to '#{options[:strict_license]}'.") do |v|
         options[:strict_license] = v
       end
 
-      opts.on('--[no-]fail-on-warnings', 'Fail on any warnings') do |v|
+      opts.on('--[no-]fail-on-warnings', "Fail on any warnings. Defaults to '#{options[:fail_on_warnings]}'.") do |v|
         options[:fail_on_warnings] = v
       end
     end.parse!
@@ -45,7 +49,15 @@ module MetadataJsonLint
   module_function :run
 
   def parse(metadata)
-    f = File.read(metadata)
+    # Small hack to use the module settings as defaults but allow overriding for different rake tasks
+    options = options().clone
+    # Configuration from rake tasks
+    yield options if block_given?
+    begin
+      f = File.read(metadata)
+    rescue Exception => e
+      abort("Error: Unable to read metadata file: #{e.exception}")
+    end
 
     begin
       parsed = JSON.parse(f)
@@ -53,12 +65,11 @@ module MetadataJsonLint
       abort("Error: Unable to parse metadata.json: #{e.exception}")
     end
 
-    # Fields required to be in metadata.json
-    # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
     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.each do |field|
       if parsed[field].nil?
         puts "Error: Required field '#{field}' not found in metadata.json."
@@ -70,9 +81,7 @@ module MetadataJsonLint
 
     # Deprecated fields
     # From: https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
-
     deprecated_fields = %w(types checksum)
-
     deprecated_fields.each do |field|
       unless parsed[field].nil?
         puts "Error: Deprecated field '#{field}' found in metadata.json."
@@ -80,6 +89,10 @@ module MetadataJsonLint
       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']
+
     # 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
@@ -89,12 +102,17 @@ module MetadataJsonLint
 
     # 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]
     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
+    end
+
     return unless error_state
     if options[:fail_on_warnings] == true
       abort("Errors found in #{metadata}")
@@ -104,6 +122,18 @@ module MetadataJsonLint
   end
   module_function :parse
 
+  def invalid_requirements?(requirements)
+    error_state = false
+    requirements.each do |requirement|
+      if requirement['name'] == 'pe'
+        puts "The 'pe' requirement is no longer supported by the Forge."
+        error_state = true
+      end
+    end
+    error_state
+  end
+  module_function :invalid_requirements?
+
   def invalid_dependencies?(deps)
     error_state = false
     dep_names = []
@@ -126,6 +156,13 @@ module MetadataJsonLint
         puts "Invalid 'version_requirement' field in metadata.json: #{e}"
         error_state = true
       end
+
+      # '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
     end
     error_state
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spdx-licenses