metadata-json-lint 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e405de9a698335b307d33abbf151c898a9cde8ff
-  data.tar.gz: 6d63faf1798bbe981406d5792a06845d5ecee2f7
+  metadata.gz: 656d4c9a85eceaa230fe84711819956a3d746a71
+  data.tar.gz: 69c06229897d87ec0a65115b28b01eec85dfa5b2
 SHA512:
-  metadata.gz: 7871b687d36c40ee1519866af02a3fbf603e20b3fe163599ef9b153d235f1db4a58ffbfd06cee090048ec943d2c6afd1da12af72de24eda00aac90323db47b0a
-  data.tar.gz: 59c178ba9192e930789cb239304e81223eb781501f75a2cc2ae49dde805d933ce86e76cd94d7640bff5519c3d983dc95f8e2e090dfc6556d7c91ed2bb70edf76
+  metadata.gz: 36c139d8de7c19a488b0e73ed06f2461e6a177c65c62abc548b58ce36a715e3b574d08edb62c765c357fccb35a8754972eca0a411ccff303e5b58aef38599de7
+  data.tar.gz: 79a89a232bdae551740952c7827ebac93568006cce890f63eb913b5e3bf4fb111729a06bbfff4042659581ae0d11d390d30a399433c8b1d89d2e6a44fb6e8c3c

data/.rubocop.yml

@@ -17,6 +17,10 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
 Metrics/PerceivedComplexity:
   Enabled: false
 

data/CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 2.0.0
+
+### Changes
+* The `semantic_puppet` gem is no longer included as a runtime dependency due to conflicts with Puppet 5.x libraries that break the `puppet module` command. As such, `semantic_puppet` must be added to a user's Gemfile in Puppet <= 4.x. See [Installation](https://github.com/voxpupuli/metadata-json-lint#installation) docs for more info
+* `metadata-json-lint` now officially only supports Ruby >= 2.0.0
+
+### Fixed
+* Fix puppet 5.x `semantic_puppet` conflicts ([#79](https://github.com/voxpupuli/metadata-json-lint/issues/79))
+* Clarify Ruby >= 2.x only support ([#74](https://github.com/voxpupuli/metadata-json-lint/issues/74))
+
 ## 1.2.2
 
 ### Fixed

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
+group :test do
+  gem 'semantic_puppet'
+end
+
 gemspec

data/README.md

@@ -4,14 +4,35 @@ The metadata-json-lint tool validates and lints `metadata.json` files in Puppet
 
 ## Compatibility
 
-metadata-json-lint is compatible with Ruby versions 2.0.0, 2.1.9, and 2.3.1.
+metadata-json-lint is compatible with Ruby versions 2.0.0, 2.1.9, 2.3.1, and 2.4.1.
 
 ## Installation
+**NOTE: `metadata-json-lint` has a dependency on the `semantic_puppet` gem if you're on 
+Puppet 4 or earlier. This dependency was removed from the gemspec file due to a conflict 
+in Puppet 5 where the `semantic_puppet` ruby gem conflicts with a version of 
+`semantic_puppet` bundled with the core Puppet 5 code.**
+
+### Puppet 5
+via `gem` command:
+``` shell
+gem install metadata-json-lint
+```
 
-Install the `metadata-json-lint` gem:
+via Gemfile:
+``` ruby
+gem 'metadata-json-lint'
+```
 
-```shell
-gem install metadata-json-lint
+### Puppet 4 and earlier
+via `gem` command:
+``` shell
+gem install metadata-json-lint semantic_puppet
+```
+
+via Gemfile:
+``` ruby
+gem 'metadata-json-lint'
+gem 'semantic_puppet'
 ```
 
 ## Usage

data/lib/metadata-json-lint/schema.rb

@@ -0,0 +1,150 @@
+require 'json-schema'
+
+module MetadataJsonLint
+  # Provides validation of metadata.json against a JSON schema document
+  # maintained in this class. Provides a good first pass over the metadata with
+  # type checking and basic format/length validations.
+  #
+  # rubocop:disable Metrics/ClassLength # schema data structure is quite large
+  class Schema
+    # Based on https://docs.puppet.com/puppet/latest/modules_metadata.html
+    #
+    # rubocop:disable Style/TrailingCommaInLiteral # easier to modify individual lines
+    def schema
+      {
+        '$schema' => 'http://json-schema.org/draft-04/schema#',
+        'properties' => {
+          'author' => {
+            'type' => 'string',
+          },
+          'data_provider' => {
+            'type' => %w[null string],
+          },
+          'dependencies' => {
+            'type' => 'array',
+            'items' => {
+              'properties' => {
+                'name' => {
+                  'type' => 'string',
+                  'pattern' => '^\w+[/-][a-z][a-z0-9_]*$',
+                },
+                'version_requirement' => {
+                  'type' => 'string',
+                },
+              },
+              'required' => %w[
+                name
+              ],
+            },
+          },
+          'description' => {
+            'type' => 'string',
+          },
+          'issues_url' => {
+            'type' => 'string',
+            'format' => 'uri',
+          },
+          'license' => {
+            'type' => 'string',
+          },
+          'operatingsystem_support' => {
+            'type' => 'array',
+            'items' => {
+              'properties' => {
+                'operatingsystem' => {
+                  'type' => 'string',
+                },
+                'operatingsystemrelease' => {
+                  'type' => 'array',
+                  'items' => {
+                    'type' => 'string',
+                  },
+                },
+              },
+              'required' => %w[
+                operatingsystem
+              ],
+            },
+          },
+          'name' => {
+            'type' => 'string',
+            'pattern' => '^\w+-[a-z][a-z0-9_]*$',
+          },
+          'project_page' => {
+            'type' => 'string',
+            'format' => 'uri',
+          },
+          # Undocumented but in use: https://tickets.puppetlabs.com/browse/DOCUMENT-387
+          'requirements' => {
+            'type' => 'array',
+            'items' => {
+              'properties' => {
+                'name' => {
+                  'type' => 'string',
+                },
+                'version_requirement' => {
+                  'type' => 'string',
+                },
+              },
+              'required' => %w[
+                name
+              ],
+            },
+          },
+          'source' => {
+            'type' => 'string',
+          },
+          'summary' => {
+            'type' => 'string',
+            'maxLength' => 144,
+          },
+          'tags' => {
+            'type' => 'array',
+            'items' => {
+              'type' => 'string'
+            },
+          },
+          'version' => {
+            'type' => 'string',
+            'format' => 'semver',
+          },
+        },
+        # from https://docs.puppetlabs.com/puppet/latest/reference/modules_publishing.html#write-a-metadatajson-file
+        'required' => %w[
+          author
+          dependencies
+          license
+          name
+          source
+          summary
+          version
+        ],
+      }
+    end
+    # rubocop:enable Style/TrailingCommaInLiteral
+
+    def validate(data, options = {})
+      JSON::Validator.register_format_validator('semver', method(:semver_validator))
+
+      JSON::Validator.fully_validate(schema, data, options.merge(errors_as_objects: true)).map do |error|
+        field = error[:fragment].split('/')[1]
+        field = 'root' if field.nil? || field.empty?
+
+        message = error[:message]
+                  .sub(/ in schema [\w-]+/, '') # remove schema UUID, not needed in output
+                  .sub(%r{'#/}, "'") # remove root #/ prefix from document paths
+                  .sub("property ''", 'file') # call the root #/ node the file
+
+        { field: field, message: message }
+      end
+    end
+
+    private
+
+    def semver_validator(value)
+      SemanticPuppet::Version.parse(value)
+    rescue SemanticPuppet::Version::ValidationFailure => e
+      raise JSON::Schema::CustomFormatError, "must be a valid semantic version: #{e.message}"
+    end
+  end
+end

data/lib/metadata_json_lint.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'spdx-licenses'
 require 'optparse'
 
+require 'metadata-json-lint/schema'
 require 'metadata-json-lint/version_requirement'
 
 module MetadataJsonLint
@@ -75,13 +76,10 @@ 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
-    required_fields = %w[name version author license summary source dependencies]
-    required_fields.each do |field|
-      if parsed[field].nil?
-        error :required_fields, "Required field '#{field}' not found in metadata.json."
-      end
+    # Validate basic structure against JSON schema
+    schema_errors = Schema.new.validate(parsed)
+    schema_errors.each do |err|
+      error (err[:field] == 'root' ? :required_fields : err[:field]), err[:message]
     end
 
     validate_dependencies!(parsed['dependencies']) if parsed['dependencies']
@@ -99,12 +97,6 @@ module MetadataJsonLint
     # https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/puppet-users/nkRPvG4q0Oo/GmXa109aJQAJ
     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
-      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
     #
@@ -113,10 +105,6 @@ module MetadataJsonLint
       warn(:license, msg)
     end
 
-    if !parsed['tags'].nil? && !parsed['tags'].is_a?(Array)
-      error :tags, "Tags must be in an array. Currently it's a #{parsed['tags'].class}."
-    end
-
     if !@errors.empty? || !@warnings.empty?
       result = @errors.empty? ? "Warnings found in #{metadata}" : "Errors found in #{metadata}"
 

data/metadata-json-lint.gemspec

@@ -2,7 +2,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'metadata-json-lint'
-  s.version     = '1.2.2'
+  s.version     = '2.0.0'
   s.date        = Date.today.to_s
   s.summary     = 'metadata-json-lint /path/to/metadata.json'
   s.description = 'Utility to verify Puppet metadata.json files'
@@ -16,10 +16,19 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://github.com/voxpupuli/metadata-json-lint'
   s.license     = 'Apache-2.0'
 
+  s.required_ruby_version = '>= 2.0.0'
   s.add_runtime_dependency 'spdx-licenses', '~> 1.0'
-  s.add_runtime_dependency 'json'
-  s.add_runtime_dependency 'semantic_puppet', '>= 0.1.2', '< 2.0.0'
+  s.add_runtime_dependency 'json-schema', '~> 2.8'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop'
+  s.requirements << 'semantic_puppet >= 0.1.2 < 2.0.0'
+  s.post_install_message = <<-EOS
+  -------------------------------------------------------------------
+      If your puppet is <= 4.x, then the semantic_puppet gem MUST
+      be in your Gemfile!!
+
+      On puppet >= 5.x, semantic_puppet will break functionality!
+  -------------------------------------------------------------------
+  EOS
 end

data/spec/schema_spec.rb

@@ -0,0 +1,38 @@
+describe MetadataJsonLint::Schema do
+  describe '#schema' do
+    it { expect(subject.schema).to be_a(Hash) }
+  end
+
+  describe '#validate' do
+    let(:minimal) { { author: '', dependencies: [], license: 'A', name: 'a-a', source: '', summary: '', version: '1.0.0' } }
+
+    context 'with empty hash' do
+      subject { described_class.new.validate({}) }
+      it { is_expected.to be_a(Array) }
+      it { expect(subject.size).to eq(7) }
+      it { is_expected.to include(field: 'root', message: "The file did not contain a required property of 'author'") }
+    end
+
+    context 'with minimal entries' do
+      subject { described_class.new.validate(minimal) }
+      it { is_expected.to eq([]) }
+    end
+
+    context 'with validation error on entry' do
+      subject { described_class.new.validate(minimal.merge(summary: 'A' * 145)) }
+      it { is_expected.to eq([{ field: 'summary', message: "The property 'summary' was not of a maximum string length of 144" }]) }
+    end
+
+    context 'with validation error on nested entry' do
+      subject { described_class.new.validate(minimal.merge(dependencies: [{ name: 'in###id' }])) }
+      it { expect(subject.size).to eq(1) }
+      it { is_expected.to include(field: 'dependencies', message: a_string_matching(%r{The property 'dependencies/0/name' value "in###id" did not match the regex})) }
+    end
+
+    context 'with semver validation failure' do
+      subject { described_class.new.validate(minimal.merge(version: 'a')) }
+      it { expect(subject.size).to eq(1) }
+      it { is_expected.to include(field: 'version', message: a_string_matching(/The property 'version' must be a valid semantic version/)) }
+    end
+  end
+end

data/tests/long_summary/expected

@@ -1 +1 @@
-Field 'summary' exceeds 144 characters in metadata.json
+(ERROR) summary: The property 'summary' was not of a maximum string length of 144

data/tests/noname/expected

@@ -1 +1 @@
-Required field 'name' not found in metadata.json.
+(ERROR) required_fields: The file did not contain a required property of 'name'

data/tests/tags_no_array/expected

@@ -1 +1 @@
-Tags must be in an array. Currently it's a String.
+(ERROR) tags: The property 'tags' of type string did not match the following type: array

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spdx-licenses
@@ -25,39 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: semantic_puppet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -119,9 +99,11 @@ files:
 - Rakefile
 - bin/metadata-json-lint
 - lib/metadata-json-lint/rake_task.rb
+- lib/metadata-json-lint/schema.rb
 - lib/metadata-json-lint/version_requirement.rb
 - lib/metadata_json_lint.rb
 - metadata-json-lint.gemspec
+- spec/schema_spec.rb
 - spec/spec_helper.rb
 - spec/version_requirement_spec.rb
 - tests/bad_license/Rakefile
@@ -187,7 +169,13 @@ homepage: http://github.com/voxpupuli/metadata-json-lint
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message: |2
+    -------------------------------------------------------------------
+        If your puppet is <= 4.x, then the semantic_puppet gem MUST
+        be in your Gemfile!!
+
+        On puppet >= 5.x, semantic_puppet will break functionality!
+    -------------------------------------------------------------------
 rdoc_options: []
 require_paths:
 - lib
@@ -195,19 +183,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- semantic_puppet >= 0.1.2 < 2.0.0
 rubyforge_project: 
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: metadata-json-lint /path/to/metadata.json
 test_files:
+- spec/schema_spec.rb
 - spec/spec_helper.rb
 - spec/version_requirement_spec.rb
 - tests/bad_license/Rakefile