metadata-json-lint 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f363e6245ce619ab7b466ed22c81b5777a63266
-  data.tar.gz: 78003ad2f645237859a2a3a79c1ad6bafbba25d9
+  metadata.gz: e405de9a698335b307d33abbf151c898a9cde8ff
+  data.tar.gz: 6d63faf1798bbe981406d5792a06845d5ecee2f7
 SHA512:
-  metadata.gz: 313273da7c521fbd0ddc64241576ea316341c0830ff5783f7507c547b20379d7db3e639f5e95983f6ccb635167f742808b91ea67e35a990291e61603191d336d
-  data.tar.gz: a2d3690009e395396de889258d89e5a5dcd207179051ebdecc8de0e9e410e212995ce00e2e202fcb3fd12be3f01f027cd6e0f721083d4f119182a405d4a9873f
+  metadata.gz: 7871b687d36c40ee1519866af02a3fbf603e20b3fe163599ef9b153d235f1db4a58ffbfd06cee090048ec943d2c6afd1da12af72de24eda00aac90323db47b0a
+  data.tar.gz: 59c178ba9192e930789cb239304e81223eb781501f75a2cc2ae49dde805d933ce86e76cd94d7640bff5519c3d983dc95f8e2e090dfc6556d7c91ed2bb70edf76

data/.gitignore

@@ -3,4 +3,4 @@
 Gemfile.lock
 /.bundle
 /vendor
-tests/*/last_output
+tests/*/last_*output

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Change Log
+
+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/).
+
+## 1.2.2
+
+### Fixed
+* Fix `metadata_lint` rake task exiting on success, not continuing ([#70](https://github.com/voxpupuli/metadata-json-lint/issues/70))
+* Fix failure on incorrect license warning when `--no-strict-license` used ([#69](https://github.com/voxpupuli/metadata-json-lint/issues/69))
+
+## 1.2.1
+
+### Fixed
+* Fix missing lib/ files in published gem
+
+## 1.2.0
+
+### Added
+* Add `--format`/`-f` option to support a JSON output format
+* Add warning for mixed version range syntax, supported only in Puppet 5
+
+### Changed
+* The default text format mode now outputs more structured messages
+* README has been edited and clarity improved
+
+### Fixed
+* Fix non-zero exit code caused by some checks
+
+## 1.1.0
+
+### Added
+* Ensure module `tags` are correctly specified as an array ([#44](https://github.com/voxpupuli/metadata-json-lint/issues/44))
+* Ensure `requirements` doesn't list the deprecated `pe` key ([#46](https://github.com/voxpupuli/metadata-json-lint/issues/46))
+* Ensure `dependencies` aren't listed with `version_range` keys ([#47](https://github.com/voxpupuli/metadata-json-lint/issues/47))
+* Support strictness configuration via Ruby API, for use in rake tasks definitions
+* Show default strictness option values in `--help` output
+
+### Fixed
+* Fix unclear error message when metadata.json does not exist
+* Fix gem publishing date
+* Various test improvements, ensuring failures are caught accurately and precisely

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

@@ -5,5 +5,7 @@ require 'json'
 
 desc 'Run metadata-json-lint'
 task :metadata_lint do
-  MetadataJsonLint.parse('metadata.json') if File.exist?('metadata.json')
+  if File.exist?('metadata.json')
+    abort unless MetadataJsonLint.parse('metadata.json')
+  end
 end

data/lib/metadata_json_lint.rb

@@ -51,7 +51,7 @@ module MetadataJsonLint
            ARGV[0]
          end
 
-    MetadataJsonLint.parse(mj)
+    exit(MetadataJsonLint.parse(mj) ? 0 : 1)
   end
   module_function :run
 
@@ -108,10 +108,9 @@ 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'
+    if options[:strict_license] && !parsed['license'].nil? && !SpdxLicenses.exist?(parsed['license']) && parsed['license'] != 'proprietary'
       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)
+      warn(:license, msg)
     end
 
     if !parsed['tags'].nil? && !parsed['tags'].is_a?(Array)
@@ -131,11 +130,11 @@ module MetadataJsonLint
       end
 
       if !@errors.empty? || (!@warnings.empty? && (options[:fail_on_warnings] == true))
-        exit(1)
+        return false
       end
     end
 
-    exit(0)
+    true
   end
   module_function :parse
 

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.1'
+  s.version     = '1.2.2'
   s.date        = Date.today.to_s
   s.summary     = 'metadata-json-lint /path/to/metadata.json'
   s.description = 'Utility to verify Puppet metadata.json files'

data/tests/bad_license/metadata.json

@@ -69,7 +69,7 @@
     },
     {
       "name": "puppetlabs/firewall",
-      "version_requirement": ">= 0.0.4"
+      "version_requirement": ">= 0.0.4 <1.0.0"
     },
     {
       "name": "puppetlabs/apt",

data/tests/json_format/expected

@@ -1 +1 @@
-"errors":\[{"check":"license","msg":"License identifier Unknown-1.0 is not in the SPDX list: http://spdx.org/licenses/"}\]
+"warnings":\[{"check":"license","msg":"License identifier Unknown-1.0 is not in the SPDX list: http://spdx.org/licenses/"}\]

data/tests/json_format/metadata.json

@@ -69,7 +69,7 @@
     },
     {
       "name": "puppetlabs/firewall",
-      "version_requirement": ">= 0.0.4"
+      "version_requirement": ">= 0.0.4 <1.0.0"
     },
     {
       "name": "puppetlabs/apt",

data/tests/rake_chaining/Rakefile

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+require 'metadata-json-lint/rake_task'
+
+task :test => %i[metadata_lint success]
+task :success do
+  puts 'Successfully linted'
+end

data/tests/rake_chaining/metadata.json

@@ -0,0 +1,91 @@
+{
+  "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": "puppet",
+      "version_requirement": "3.x"
+    }
+  ],
+  "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

@@ -66,7 +66,7 @@ test_rake() {
   local RESULT=-1;
 
   cd $name;
-  bundle exec rake $rake_task >/dev/null 2>&1
+  bundle exec rake $rake_task >last_rake_output 2>&1
   RESULT=$?
   if [ $RESULT -ne $expect ]; then
     fail "Failing Test '${name}' (rake: ${rake_task})"
@@ -98,8 +98,10 @@ test "duplicate-dep" $SUCCESS --no-fail-on-warnings
 
 # Run a broken one, expect FAILURE
 test "bad_license" $FAILURE
-# Run with --no-strict-license, expect SUCCESS
-test "bad_license" $SUCCESS --no-strict-license --no-fail-on-warnings
+# Run with --no-strict-license only, expect SUCCESS
+test "bad_license" $SUCCESS --no-strict-license
+# Run with --no-fail-on-warnings, expect SUCCESS
+test "bad_license" $SUCCESS --no-fail-on-warnings
 
 # Run a broken one, expect FAILURE
 test "long_summary" $FAILURE
@@ -154,4 +156,10 @@ test_rake "rake_global_options" $SUCCESS
 # Test multiple lints with different options
 test_rake "rake_multiple_json_options" $SUCCESS metadata_lint_multi
 
+# Test successful lint followed by further tasks
+test_rake "rake_chaining" $SUCCESS test
+if ! grep -qx "Successfully linted" rake_chaining/last_rake_output; then
+  fail "Failing Test 'rake_chaining' failed to run second rake task"
+fi
+
 exit $STATUS

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metadata-json-lint
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spdx-licenses
@@ -112,6 +112,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -165,6 +166,8 @@ files:
 - tests/perfect/metadata.json
 - tests/proprietary/Rakefile
 - tests/proprietary/metadata.json
+- tests/rake_chaining/Rakefile
+- tests/rake_chaining/metadata.json
 - tests/rake_global_options/Rakefile
 - tests/rake_global_options/expected
 - tests/rake_global_options/metadata.json
@@ -249,6 +252,8 @@ test_files:
 - tests/perfect/metadata.json
 - tests/proprietary/Rakefile
 - tests/proprietary/metadata.json
+- tests/rake_chaining/Rakefile
+- tests/rake_chaining/metadata.json
 - tests/rake_global_options/Rakefile
 - tests/rake_global_options/expected
 - tests/rake_global_options/metadata.json