metadata-json-lint 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26b0284277b14da2149836312d2f7470eeb42fec
-  data.tar.gz: 1f700550be689ad9379a1bfb5a617f4de64a18db
+  metadata.gz: 2f363e6245ce619ab7b466ed22c81b5777a63266
+  data.tar.gz: 78003ad2f645237859a2a3a79c1ad6bafbba25d9
 SHA512:
-  metadata.gz: f0160d90cb4707dc94deb44d16f9a3d22dcd15f9f6b7749c054b8354ea593089407de42e679040a052c634637d6718d636f7abec41c3cd0e2811ee439d2a9211
-  data.tar.gz: 9cbad4cbd0437415b6c347a05491a4a17f5324ca2c4472fc02772701fc7c37ebbda5a2c95106cbf5305f8afe11b4bc224e9de13ce4b74967eb9fed593da3743f
+  metadata.gz: 313273da7c521fbd0ddc64241576ea316341c0830ff5783f7507c547b20379d7db3e639f5e95983f6ccb635167f742808b91ea67e35a990291e61603191d336d
+  data.tar.gz: a2d3690009e395396de889258d89e5a5dcd207179051ebdecc8de0e9e410e212995ce00e2e202fcb3fd12be3f01f027cd6e0f721083d4f119182a405d4a9873f

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+*.gem
+Gemfile.lock
+/.bundle
+/vendor
+tests/*/last_output

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,24 @@
+inherit_from: .rubocop_todo.yml
+
+# we still support ruby 1.8
+Style/HashSyntax:
+  Enabled: false
+
+#Metric cops are rarely useful
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 175

data/.rubocop_todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-08 14:05:42 -0700 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/RescueException:
+  Exclude:
+    - 'lib/metadata_json_lint.rb'
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'lib/metadata_json_lint.rb'

data/.travis.yml

@@ -0,0 +1,24 @@
+---
+language: ruby
+
+script:
+  - bundle exec rake test
+
+sudo: false
+
+rvm:
+  - 2.0.0
+  - 2.1.9
+  - 2.3.1
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Rm6j/fS5n4TyqmqftwMj2Ebw0avsuDbuI9wVX4exUNiuQRru967QPrQinMuAwBGLCNYMs69ZHFBMkpk61khQGC3W7d5Yr/25HabnQBFpfO2llHhKKgM/Ckyqur+ku88EVJH9nRCDqOprJtC4RGHIA833ENL8xVP/VOvfiKG0Q14=
+  gem: metadata-json-lint
+  on:
+    tags: true
+    repo: voxpupuli/metadata-json-lint
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2014 HP Development Corporation L.P.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this software except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,63 @@
+# metadata-json-lint
+
+The metadata-json-lint tool validates and lints `metadata.json` files in Puppet modules against style guidelines from the [Puppet Forge module metadata](https://docs.puppet.com/puppet/latest/modules_publishing.html#write-a-metadatajson-file) recommendations.
+
+## Compatibility
+
+metadata-json-lint is compatible with Ruby versions 2.0.0, 2.1.9, and 2.3.1.
+
+## Installation
+
+Install the `metadata-json-lint` gem:
+
+```shell
+gem install metadata-json-lint
+```
+
+## Usage
+
+### Testing with metadata-json-lint
+
+On the command line, run `metadata-json-lint` with the path of your `metadata.json` file:
+
+```shell
+metadata-json-lint /path/to/metadata.json
+```
+
+### Testing with metadata-json-lint as a Rake task
+
+If you are already using `puppet_spec_helper`, the 'validate' task already includes `metadata-json-lint`.
+
+You can also integrate `metadata-json-lint` checks into your tests using the Rake task. Add `require 'metadata-json-lint/rake_task'` to your `Rakefile`, and then run:
+
+```ruby
+rake metadata_lint
+```
+
+To set options for the Rake task, include them when you define the task:
+
+```ruby
+require 'metadata-json-lint'
+task :metadata_lint do
+  MetadataJsonLint.parse('metadata.json') do |options|
+      options.strict_license = false
+  end
+end
+```
+
+Alternatively, set the option after requiring the Rake task:
+
+```ruby
+require 'metadata-json-lint/rake_task'
+MetadataJsonLint.options.strict_license = false
+```
+
+### Options
+
+* `--[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`.
+
+## Contributors
+
+A big thank you to the [contributors](https://github.com/voxpupuli/metadata-json-lint/graphs/contributors).

data/Rakefile

@@ -0,0 +1,15 @@
+desc 'Run all tests'
+task :test => %i[rubocop spec test:acceptance]
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+namespace :test do
+  desc 'Acceptance suite under test/ which runs metadata-json-lint against sample files with expected output'
+  task :acceptance do
+    sh 'tests/test.sh'
+  end
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

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

@@ -0,0 +1,35 @@
+require 'semantic_puppet'
+
+module MetadataJsonLint
+  # Parses a string module version requirement with semantic_puppet and
+  # provides methods to analyse it for lint warnings
+  class VersionRequirement
+    def initialize(requirement)
+      @requirement = requirement
+      @range = SemanticPuppet::VersionRange.parse(requirement)
+    end
+
+    # Whether the range uses a comparison operator (e.g. >=) with a wildcard
+    # syntax, such as ">= 1.x" or "< 2.0.x"
+    def mixed_syntax?
+      !/
+        [><=^~]{1,2} # comparison operators
+        \s*
+        \d\. # MAJOR
+        (?:
+          (?:x|\*) # MINOR is wildcard
+          |
+          \d\.(?:x|\*)  # MINOR is digit and PATCH is wildcard
+        )
+      /x.match(requirement).nil?
+    end
+
+    def open_ended?
+      @range.end == SemanticPuppet::Version::MAX
+    end
+
+    private
+
+    attr_reader :range, :requirement
+  end
+end

data/metadata-json-lint.gemspec

@@ -0,0 +1,25 @@
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = 'metadata-json-lint'
+  s.version     = '1.2.1'
+  s.date        = Date.today.to_s
+  s.summary     = 'metadata-json-lint /path/to/metadata.json'
+  s.description = 'Utility to verify Puppet metadata.json files'
+  s.authors     = ['Vox Pupuli']
+  s.email       = 'voxpupuli@groups.io'
+
+  s.files       = `git ls-files -z`.split("\x0")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files  = s.files.grep(%r{^(tests|spec)/})
+
+  s.homepage    = 'http://github.com/voxpupuli/metadata-json-lint'
+  s.license     = 'Apache-2.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_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'metadata_json_lint'
+
+# This file was generated by the `rspec --init` command
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

data/spec/version_requirement_spec.rb

@@ -0,0 +1,28 @@
+describe MetadataJsonLint::VersionRequirement do
+  describe '.new' do
+    it { expect(described_class.new('')).to be_a(MetadataJsonLint::VersionRequirement) }
+    it { expect(described_class.new('>= 1.0')).to be_a(MetadataJsonLint::VersionRequirement) }
+    it { expect { described_class.new('## 1.0') }.to raise_error(ArgumentError) }
+  end
+
+  describe '#mixed_syntax?' do
+    it { expect(described_class.new('>= 1.0.0').mixed_syntax?).to be false }
+    it { expect(described_class.new('1.0.x').mixed_syntax?).to be false }
+    it { expect(described_class.new('>= 1.0.0 < 2.0').mixed_syntax?).to be false }
+    it { expect(described_class.new('< 2.0').mixed_syntax?).to be false }
+
+    it { expect(described_class.new('>= 1.0.x').mixed_syntax?).to be true }
+    it { expect(described_class.new('>= 1.0.*').mixed_syntax?).to be true }
+    it { expect(described_class.new('>= 1.x').mixed_syntax?).to be true }
+    it { expect(described_class.new('>= 1.x.x').mixed_syntax?).to be true }
+    it { expect(described_class.new('>= 1.*').mixed_syntax?).to be true }
+    it { expect(described_class.new('>= 1.0.0 < 2.x').mixed_syntax?).to be true }
+    it { expect(described_class.new('<2.x').mixed_syntax?).to be true }
+  end
+
+  describe '#open_ended?' do
+    it { expect(described_class.new('>= 1.0 < 2.0').open_ended?).to be false }
+    it { expect(described_class.new('>= 1.0').open_ended?).to be true }
+    it { expect(described_class.new('').open_ended?).to be true }
+  end
+end

data/tests/bad_license/Rakefile

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

data/tests/bad_license/expected

@@ -0,0 +1 @@
+License identifier Unknown-1.0 is not in the SPDX list: http://spdx.org/licenses/

data/tests/bad_license/metadata.json

@@ -0,0 +1,83 @@
+{
+  "name": "puppetlabs-postgresql",
+  "version": "3.4.1",
+  "author": "Inkling/Puppet Labs",
+  "summary": "PostgreSQL defined resource types",
+  "license": "Unknown-1.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",
+  "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.x"
+    }
+  ],
+  "dependencies": [
+    {
+      "name": "puppetlabs/stdlib",
+      "version_requirement": "4.x"
+    },
+    {
+      "name": "puppetlabs/firewall",
+      "version_requirement": ">= 0.0.4"
+    },
+    {
+      "name": "puppetlabs/apt",
+      "version_requirement": ">=1.1.0 <2.0.0"
+    },
+    {
+      "name": "puppetlabs/concat",
+      "version_requirement": ">= 1.1.0 <2.0.0"
+    }
+  ]
+}

data/tests/broken/Rakefile

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

data/tests/broken/expected

@@ -0,0 +1 @@
+Error: Unable to parse metadata.json: [0-9]*: unexpected token at

data/tests/broken/metadata.json

@@ -0,0 +1,87 @@
+{
+  "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",
+  "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": "pe",
+      "version_requirement": ">= 3.2.0 < 3.4.0"
+    },
+    {
+      "name": "puppet",
+      "version_requirement": "3.x"
+    }
+  ],
+  "dependencies": [
+    {
+      "name": "puppetlabs/stdlib",
+      "version_requirement": "4.x"
+    },
+    {
+      "name": "puppetlabs/firewall",
+      "version_requirement": ">= 0.0.4"
+    },
+    {
+      "name": "puppetlabs/apt",
+      "version_requirement": ">=1.1.0 <2.0.0"
+    },
+    {
+      "name": "puppetlabs/concat",
+      "version_requirement": ">= 1.1.0 <2.0.0"
+    }
+  ]
+}