metadata-json-lint 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb2c947e575640401cda92a61f4b092a3670a0eac2c2bb94de66ce03b6d13d9f
-  data.tar.gz: 39c477f21af81c03b70e6e019fe38871d010dd8367561842b67c450d737f9679
+  metadata.gz: 18ae05b2da0e3412d155e0ef98619401e66103b491592d0bf39662ef779ff510
+  data.tar.gz: 1e072d693b6a7f3f1f819b81584a0766da507a18526195d7111617fcd1404cfd
 SHA512:
-  metadata.gz: 6248827093dbcbde3a6e49beed51c61f40ed8b28b443155f04b062ee24f52790004dcb30567f6eb1f750250e0c9df34c0965de264f0589e851ff9706e72b6f39
-  data.tar.gz: f66771e15322868d43eb8e140f734e710c84a9035f4f47870c095a1af5d06aca12e4b49be94828bce7ea21773989028d7aea8db912782a9cca6212b489de1824
+  metadata.gz: a6e20d329944205d3e8c24cc86176feca9a94609dfba8aabce7bf92c1529518ca51b6d24ef874df397b49f8e8769df3694f41983696a316b0cb1f06b8721c371
+  data.tar.gz: cbf678ed70b94343ea6f123104bbc8471888b32c65fa4b40e7189adce53d679d879c4a1393afe11f8a5968622c83b331ab862a08583c862b188ac03dfc689ed3

data/.rubocop.yml

@@ -20,6 +20,7 @@ Metrics/MethodLength:
 Metrics/BlockLength:
   Exclude:
     - spec/**/*_spec.rb
+    - ./*.gemspec
 
 Metrics/PerceivedComplexity:
   Enabled: false

data/.travis.yml

@@ -7,10 +7,10 @@ script:
 sudo: false
 
 rvm:
-  - 2.0.0
   - 2.1.9
-  - 2.3.1
-  - 2.4.1
+  - 2.4.3
+  - 2.4.4
+  - 2.5.1
 
 deploy:
   provider: rubygems

data/CHANGELOG.md

@@ -5,6 +5,10 @@ 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.2.0
+* Validate Puppet version_requirement [#99](https://github.com/voxpupuli/metadata-json-lint/issues/99)
+* Add optional check `--strict-puppet-version` to validate the Puppet Agent Version is not EOL or open ended [#100](https://github.com/voxpupuli/metadata-json-lint/pull/100)
+
 ## 2.1.0
 
 ### Changes

data/README.md

@@ -8,8 +8,6 @@ metadata-json-lint is compatible with Ruby versions 2.0.0, 2.1.9, 2.3.1, and 2.4
 
 ## Installation
 
-Puppet 4.9.0 and newer:
-
 via `gem` command:
 ``` shell
 gem install metadata-json-lint
@@ -20,19 +18,6 @@ via Gemfile:
 gem 'metadata-json-lint'
 ```
 
-**Puppet 4.8.x and older:**
-
-via `gem` command:
-``` shell
-gem install metadata-json-lint semantic_puppet
-```
-
-via Gemfile:
-``` ruby
-gem 'metadata-json-lint'
-gem 'semantic_puppet'
-```
-
 ## Usage
 
 ### Testing with metadata-json-lint
@@ -76,6 +61,7 @@ MetadataJsonLint.options.strict_license = false
 * `--[no-]strict-dependencies`: Whether to fail if module version dependencies are open-ended. Defaults to `false`.
 * `--[no-]strict-license`: Whether to fail on strict license check. Defaults to `true`.
 * `--[no-]fail-on-warnings`: Whether to fail on warnings. Defaults to `true`.
+* `--[no-]strict-puppet-version`: Whether to fail if Puppet version requirements are open-ended or no longer supported. Defaults to `false`.
 
 ## Contributors
 

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

@@ -47,6 +47,22 @@ module MetadataJsonLint
       end
     end
 
+    def puppet_eol?
+      true if range.begin < SemanticPuppet::Version.parse(MIN_PUPPET_VER)
+    end
+
+    def ver_range
+      range
+    end
+
+    def min
+      range.begin
+    end
+
+    def max
+      range.end
+    end
+
     private
 
     attr_reader :range, :requirement

data/lib/metadata_json_lint.rb

@@ -9,16 +9,20 @@ require 'metadata-json-lint/schema'
 require 'metadata-json-lint/version_requirement'
 
 module MetadataJsonLint
+  MIN_PUPPET_VER = '4.10.0'.freeze
+
   def options
     @options ||= Struct.new(
       :fail_on_warnings,
       :strict_license,
       :strict_dependencies,
+      :strict_puppet_version,
       :format
     ).new(
       true, # fail_on_warnings
       true, # strict_license
       false, # strict_dependencies
+      false, # strict_puppet_version
       'text', # format
     )
   end
@@ -40,6 +44,10 @@ module MetadataJsonLint
         options[:fail_on_warnings] = v
       end
 
+      opts.on('--[no-]strict-puppet-version', "Fail on strict Puppet Version check based on current supported Puppet versions. Defaults to '#{options[:strict_puppet_version]}'.") do |v|
+        options[:strict_puppet_version] = 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
@@ -136,10 +144,34 @@ module MetadataJsonLint
       if requirement['name'] == 'pe'
         warn :requirements, "The 'pe' requirement is no longer supported by the Forge."
       end
+
+      begin
+        puppet_req = VersionRequirement.new(requirement.fetch('version_requirement', ''))
+      rescue ArgumentError => e
+        # Raised when the version_requirement provided could not be parsed
+        error :requirements, "Invalid 'version_requirement' field in metadata.json: #{e}"
+      end
+
+      validate_puppet_ver!(puppet_req) unless puppet_req.instance_variable_get('@requirement').nil?
     end
   end
   module_function :validate_requirements!
 
+  def validate_puppet_ver!(requirement)
+    if options[:strict_puppet_version] && requirement.open_ended?
+      warn(:requirement, "Puppet has an open ended version requirement #{requirement.ver_range}")
+    end
+
+    if options[:strict_puppet_version] && requirement.puppet_eol?
+      warn(:requirement, "#{requirement.min} is no longer supported. Minimum supported version is #{MIN_PUPPET_VER}")
+    end
+
+    return unless requirement.mixed_syntax?
+    warn(:requirement, 'Mixing "x" or "*" version syntax with operators is not recommended in ' \
+      "metadata.json, use one style in the puppet version: #{requirement.instance_variable_get('@requirement')}")
+  end
+  module_function :validate_puppet_ver!
+
   def validate_dependencies!(deps)
     dep_names = []
     deps.each do |dep|

data/metadata-json-lint.gemspec

@@ -2,7 +2,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'metadata-json-lint'
-  s.version     = '2.1.0'
+  s.version     = '2.2.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'
@@ -19,7 +19,9 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
   s.add_runtime_dependency 'spdx-licenses', '~> 1.0'
   s.add_runtime_dependency 'json-schema', '~> 2.8'
+  s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'semantic_puppet'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop', '~> 0.50.0'
   s.post_install_message = '

data/spec/metadata_json_lint_spec.rb

@@ -0,0 +1,37 @@
+describe MetadataJsonLint do
+  describe '.validate_requirements!' do
+    context 'empty requirements' do
+      let :requirements do
+        []
+      end
+
+      it { expect { described_class.validate_requirements!(requirements) }.not_to raise_error }
+    end
+
+    context 'with pe' do
+      let :requirements do
+        [
+          { 'name' => 'pe' }
+        ]
+      end
+
+      it do
+        expect(described_class).to receive('warn').with(:requirements, "The 'pe' requirement is no longer supported by the Forge.")
+        expect { described_class.validate_requirements!(requirements) }.not_to raise_error
+      end
+    end
+
+    context 'with invalid requirement' do
+      let :requirements do
+        [
+          { 'name' => 'puppet', 'version_requirement' => 'a' }
+        ]
+      end
+
+      it do
+        expect(described_class).to receive('error').with(:requirements, "Invalid 'version_requirement' field in metadata.json: Unparsable version range: \"a\"")
+        expect { described_class.validate_requirements!(requirements) }.not_to raise_error
+      end
+    end
+  end
+end

data/tests/duplicate-dep/metadata.json

@@ -57,13 +57,9 @@
     }
   ],
   "requirements": [
-    {
-      "name": "pe",
-      "version_requirement": ">= 3.2.0 < 3.4.0"
-    },
     {
       "name": "puppet",
-      "version_requirement": "3.x"
+      "version_requirement": "5.5.1"
     }
   ],
   "dependencies": [

data/tests/requirements_eol_version/Rakefile

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+require 'metadata-json-lint/rake_task'

data/tests/requirements_eol_version/expected

@@ -0,0 +1,2 @@
+(WARN) requirements: 3.2.0 is no longer supported. Minimum supported version is 4.10.0(WARN) requirement: 3.2.0 is no longer supported. Minimum supported version is 4.10.0
+Warnings found in metadata.json

data/tests/requirements_eol_version/metadata.json

@@ -0,0 +1,92 @@
+{
+  "name": "puppetlabs-postgresql",
+  "version": "3.4.1",
+  "author": "Inkling/Puppet Labs",
+  "summary": "PostgreSQL defined resource types",
+  "license": "Apache-2.0",
+  "source": "git://github.com/puppetlabs/puppet-postgresql.git",
+  "project_page": "https://github.com/puppetlabs/puppet-postgresql",
+  "issues_url": "https://github.com/puppetlabs/puppet-postgresql/issues",
+  "tags": [ "postgres" ],
+  "operatingsystem_support": [
+    {
+      "operatingsystem": "RedHat",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "CentOS",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "OracleLinux",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Scientific",
+      "operatingsystemrelease": [
+        "5",
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Debian",
+      "operatingsystemrelease": [
+        "6",
+        "7"
+      ]
+    },
+    {
+      "operatingsystem": "Ubuntu",
+      "operatingsystemrelease": [
+        "10.04",
+        "12.04",
+        "14.04"
+      ]
+    }
+  ],
+  "requirements": [
+    {
+      "name": "puppet",
+      "version_requirement": "3.2.0"
+    }
+  ],
+  "dependencies": [
+    {
+      "name": "puppetlabs/stdlib",
+      "version_requirement": "1.2.3"
+    },
+    {
+      "name": "puppetlabs/apt",
+      "version_requirement": "< 1.2.3"
+    },
+    {
+      "name": "puppetlabs/puppetdb",
+      "version_requirement": "<= 1.2.3"
+    },
+    {
+      "name": "puppetlabs/vcsrepo",
+      "version_requirement": ">= 1.0.0 < 2.0.0"
+    },
+    {
+      "name": "puppetlabs/rabbitmq",
+      "version_requirement": "1.x"
+    },
+    {
+      "name": "puppetlabs/motd",
+      "version_requirement": "1.2.x"
+    }
+  ]
+}

data/tests/test.sh

@@ -144,6 +144,9 @@ test "json_format" $FAILURE --format json
 # Run against a metadata.json with a string for the requirements
 test "non_array_requirements" $FAILURE
 
+# Run against a metadata.json with an unsupported minimum Puppet version for the requirements
+test "requirements_eol_version" $FAILURE --strict-puppet-version
+
 # Test running without specifying file to parse
 cd perfect
 bundle exec metadata-json-lint

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spdx-licenses
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +132,7 @@ files:
 - lib/metadata-json-lint/version_requirement.rb
 - lib/metadata_json_lint.rb
 - metadata-json-lint.gemspec
+- spec/metadata_json_lint_spec.rb
 - spec/schema_spec.rb
 - spec/spec_helper.rb
 - spec/version_requirement_spec.rb
@@ -160,6 +189,9 @@ files:
 - tests/rake_multiple_json_options/Rakefile
 - tests/rake_multiple_json_options/metadata_license.json
 - tests/rake_multiple_json_options/metadata_ok.json
+- tests/requirements_eol_version/Rakefile
+- tests/requirements_eol_version/expected
+- tests/requirements_eol_version/metadata.json
 - tests/tags_no_array/Rakefile
 - tests/tags_no_array/expected
 - tests/tags_no_array/metadata.json
@@ -195,11 +227,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: metadata-json-lint /path/to/metadata.json
 test_files:
+- spec/metadata_json_lint_spec.rb
 - spec/schema_spec.rb
 - spec/spec_helper.rb
 - spec/version_requirement_spec.rb
@@ -256,6 +289,9 @@ test_files:
 - tests/rake_multiple_json_options/Rakefile
 - tests/rake_multiple_json_options/metadata_license.json
 - tests/rake_multiple_json_options/metadata_ok.json
+- tests/requirements_eol_version/Rakefile
+- tests/requirements_eol_version/expected
+- tests/requirements_eol_version/metadata.json
 - tests/tags_no_array/Rakefile
 - tests/tags_no_array/expected
 - tests/tags_no_array/metadata.json