metadata_json_deps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a7a5bc8b50fa0665c13ff641af0c71eb6a7b8d968712b0f5e1ded9aa97e09d4
+  data.tar.gz: 240b09bfb0f276ad80aade880427ebd242adb17a3dc7f49d185c01b513af9f33
+SHA512:
+  metadata.gz: 62f244b8ad184507bfe491620ce0441fe94f3cd1df6dd152fa3f3deca5d9ad32c2eb069d6c0b002cd79dc2fd0379776a285a212c8bb482773350f938dcab313c
+  data.tar.gz: 0acedb635823a5e5b7c25e29a2c192e237af76739fa6afb7688b593baeba0d89f253b4dd6c5f06992ed609cc9cdd98c2ef396d7681437b9fcdfbe98c740f48ee

data/README.md

@@ -0,0 +1,47 @@
+# metadata-json-deps
+
+The metadata-json-deps tool validates dependencies in `metadata.json` files in Puppet modules against the latest published versions on the [Puppet Forge](https://forge.puppet.com/).
+
+## Compatibility
+
+metadata-json-deps is compatible with Ruby versions 2.0.0 and newer.
+
+## Installation
+
+via `gem` command:
+``` shell
+gem install metadata-json-deps
+```
+
+via Gemfile:
+``` ruby
+gem 'metadata-json-deps'
+```
+
+## Usage
+
+### Testing with metadata-json-deps
+
+On the command line, run `metadata-json-deps` with the path(s) of your `metadata.json` file(s):
+
+```shell
+metadata-json-deps /path/to/metadata.json
+```
+
+It can also be run verbosely to show valid dependencies:
+
+```shell
+metadata-json-deps -v modules/*/metadata.json
+```
+
+### Testing with metadata-json-deps as a Rake task
+
+You can also integrate `metadata-json-deps` checks into your tests using a Rake task:
+
+```ruby
+require 'metadata_json_deps'
+task :metadata_deps do
+  files = FileList['modules/*/metadata.json']
+  PuppetMetadataChecker::Runner.run(files)
+end
+```

data/bin/metadata-json-deps

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'metadata_json_deps'
+
+options = {}
+OptionParser.new do |opts|
+  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+end.parse!
+
+MetadataJsonDeps::Runner.run(ARGV, options[:verbose])

data/lib/metadata_json_deps/forge_versions.rb

@@ -0,0 +1,31 @@
+require 'puppet_forge'
+require 'semantic_puppet'
+
+module MetadataJsonDeps
+  class ForgeVersions
+    def initialize(cache = {})
+      @cache = cache
+    end
+
+    def get_current_version(name)
+      name = name.sub('/', '-')
+      version = @cache[name]
+
+      unless version
+        @cache[name] = version = get_version(get_mod(name))
+      end
+
+      version
+    end
+
+    private
+
+    def get_mod(name)
+      PuppetForge::Module.find(name)
+    end
+
+    def get_version(mod)
+      SemanticPuppet::Version.parse(mod.current_release.version)
+    end
+  end
+end

data/lib/metadata_json_deps/metadata_checker.rb

@@ -0,0 +1,26 @@
+require 'semantic_puppet'
+
+module MetadataJsonDeps
+  class MetadataChecker
+    def initialize(metadata, forge)
+      @metadata = metadata
+      @forge = forge
+    end
+
+    def module_dependencies
+      return [] unless @metadata['dependencies']
+
+      @metadata['dependencies'].map do |dep|
+        constraint = dep['version_requirement'] || '>= 0'
+        [dep['name'], SemanticPuppet::VersionRange.parse(constraint)]
+      end
+    end
+
+    def dependencies
+      module_dependencies.map do |dependency, constraint|
+        current = @forge.get_current_version(dependency)
+        [dependency, constraint, current, constraint.include?(current)]
+      end
+    end
+  end
+end

data/lib/metadata_json_deps/runner.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+module MetadataJsonDeps
+  class Runner
+    def initialize(filenames, verbose)
+      @filenames = filenames
+      @verbose = verbose
+      @forge = MetadataJsonDeps::ForgeVersions.new
+    end
+
+    def run
+      @filenames.each do |filename|
+        puts "Checking #{filename}"
+        checker = MetadataJsonDeps::MetadataChecker.new(JSON.parse(File.read(filename)), @forge)
+        checker.dependencies.each do |dependency, constraint, current, satisfied|
+          if satisfied
+            if @verbose
+              puts "  #{dependency} (#{constraint}) matches #{current}"
+            end
+          else
+            puts "  #{dependency} (#{constraint}) doesn't match #{current}"
+          end
+        end
+      end
+    rescue Interrupt
+    end
+
+    def self.run(filenames, verbose = false)
+      self.new(filenames, verbose).run
+    end
+  end
+end

data/lib/metadata_json_deps.rb

@@ -0,0 +1,5 @@
+module MetadataJsonDeps
+  autoload :ForgeVersions, 'metadata_json_deps/forge_versions'
+  autoload :MetadataChecker, 'metadata_json_deps/metadata_checker'
+  autoload :Runner, 'metadata_json_deps/runner'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: metadata_json_deps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ewoud Kohl van Wijngaarden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet_forge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: semantic_puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Verify all your dependencies allow the latest versions on Puppet Forge
+email: ewoud+rubygems@kohlvanwijngaarden.nl
+executables:
+- metadata-json-deps
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- bin/metadata-json-deps
+- lib/metadata_json_deps.rb
+- lib/metadata_json_deps/forge_versions.rb
+- lib/metadata_json_deps/metadata_checker.rb
+- lib/metadata_json_deps/runner.rb
+homepage: https://github.com/ekohl/metadata_json_deps
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ekohl/metadata_json_deps
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Check your Puppet metadata dependencies
+test_files: []