puppet-moddeps 0.3.2 → 2.0.0

data/lib/puppet/moddeps/module.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# This class represents a module specification.
+# class to have a consistent API for accessing a module's attributes.
+#
+module Puppet
+  module Moddeps
+    class Module
+      attr_reader :owner, :name, :version
+
+      def initialize(owner, name, version = nil)
+        @owner   = owner
+        @name    = name
+        @version = version unless version == :latest
+      end
+
+      # Creates a new module from a hash.
+      #
+      def self.from_hash(mod)
+        unless mod['name'].is_a?(String)
+          raise "Module name must be a String, not #{mod['name'].inspect}"
+        end
+
+        owner, name = mod['name'].tr('/', '-').split('-', 2)
+
+        unless owner && name
+          raise "Module name #{mod['name']} must include both the owner and module name."
+        end
+
+        new(owner, name, mod['version_requirement'])
+      end
+
+      # Returns the module's title.
+      #
+      def title
+        "#{@owner}-#{@name}"
+      end
+      alias to_s title
+
+      # Checks two modules for equality.
+      #
+      def eql?(other)
+        self.class == other.class &&
+          @owner == other.owner &&
+          @name == other.name &&
+          versions_intersect?(other)
+      end
+      alias == eql?
+
+      # Returns true if the versions of two modules intersect. Used to determine
+      # if an installed module satisfies the version requirement of another.
+      #
+      def versions_intersect?(other)
+        range       = ::SemanticPuppet::VersionRange.parse(@version || '')
+        other_range = ::SemanticPuppet::VersionRange.parse(other.version || '')
+
+        range.intersection(other_range) != ::SemanticPuppet::VersionRange::EMPTY_RANGE
+      end
+
+      # Hashes the module.
+      #
+      def hash
+        [@owner, @name].hash
+      end
+
+      # Returns a hash representation similar to the module
+      # declaration.
+      #
+      def to_hash
+        {
+          'name'                => title,
+          'version_requirement' => version
+        }.compact
+      end
+
+      # Returns the Puppetfile specification for the module.
+      #
+      def to_spec
+        if @version
+          "mod #{title.inspect}, #{@version.inspect}"
+        else
+          "mod #{title.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/puppet/moddeps/version.rb

@@ -1,5 +1,5 @@
-module Puppet
-  module Moddeps
-    VERSION = "0.3.2"
-  end
-end
+module Puppet
+  module Moddeps
+    VERSION = "2.0.0"
+  end
+end

data/puppet-moddeps.gemspec

@@ -1,41 +1,50 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'puppet/moddeps/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "puppet-moddeps"
-  spec.version       = Puppet::Moddeps::VERSION
-  spec.authors       = ["GeneBean"]
-  spec.email         = ["me@technicalissues.us"]
-  spec.summary       = %q{Installs dependencies for a given Puppet module}
-  spec.description   = <<-EOF
-    This gem will allow you to pull in all missing dependencies for a given
-    Puppet module. This is targeted specifically at private modules that have a
-    populated metadata.json file.
-  EOF
-  spec.homepage      = "https://github.com/genebean/puppet-moddeps"
-  #spec.homepage      = "http://rubygems.org/gems/puppet-moddeps"
-  spec.license       = "New BSD"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.required_ruby_version = '>= 1.8.7'
-
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
-  spec.add_development_dependency 'coveralls', '~> 0.7'
-  spec.add_development_dependency 'guard', '~> 2.10'
-  spec.add_development_dependency 'guard-rspec', '~> 4.5'
-  spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'pry-nav', '~> 0.2'
-  spec.add_development_dependency 'pry-remote', '~> 0.1'
-  spec.add_development_dependency 'rake', '~> 10.4'
-  spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'rspec-nc', '~> 0.2'
-
-  spec.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.1'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppet/moddeps/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "puppet-moddeps"
+  spec.version       = Puppet::Moddeps::VERSION
+  spec.authors       = ["GeneBean"]
+  spec.email         = ["gene@technicalissues.us"]
+  spec.summary       = %q{Installs dependencies for a given Puppet module}
+  spec.description   = <<-EOF
+    This gem will allow you to pull in all missing dependencies for a given
+    Puppet module. This is targeted specifically at private modules that have a
+    populated metadata.json file.
+  EOF
+  spec.homepage      = "https://github.com/genebean/puppet-moddeps"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.5.7'
+
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.4'
+  spec.add_development_dependency 'codecov', '~> 0.2.12'
+  spec.add_development_dependency 'guard', '~> 2.16', '>= 2.16.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7', '>= 4.7.3'
+  spec.add_development_dependency 'guard-yard', '~> 2.2', '>= 2.2.1'
+  spec.add_development_dependency 'pry', '~> 0.13.1'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'pry-remote', '~> 0.1.8'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rspec-nc', '~> 0.3.0'
+  spec.add_development_dependency 'wdm', '~> 0.1.1' if Gem.win_platform?
+  spec.add_development_dependency 'yard', '~> 0.9.25'
+
+  if ENV.key?('PUPPET_VERSION')
+    puppetversion = "= #{ENV['PUPPET_VERSION']}"
+  else
+    puppetversion = ['>= 6.0', '< 7.0']
+  end
+  spec.add_development_dependency 'puppet', puppetversion
+
+  spec.add_runtime_dependency 'json', '~> 2.3', '>= 2.3.1'
+  spec.add_runtime_dependency 'puppetfile-resolver', '~> 0.4.0'
+end

data/spec/puppet/moddeps/installer_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe Puppet::Moddeps::Installer do
+
+  before(:all) do
+    if (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RbConfig::CONFIG['host_os']) != nil
+      @expected_path = %x(puppet config print modulepath).split(';')[0].strip
+    else
+      @expected_path = %x(puppet config print modulepath).split(':')[0].strip
+    end
+  end
+
+  describe '.initialize(module_path, puppet_version)' do
+    it 'should set the default module path and puppet version' do
+      base_obj = Puppet::Moddeps::Installer.new
+
+      expect(base_obj.module_path).to eq(@expected_path)
+      expect(base_obj.puppet_version).to be_nil
+    end
+
+    it 'should use the provided values' do
+      base_obj = Puppet::Moddeps::Installer.new('/tmp', '6.18.0')
+      expect(base_obj.module_path).to eq('/tmp')
+      expect(base_obj.puppet_version).to eq('6.18.0')
+    end
+
+    it 'should fail when an array is passed to path' do
+      expect {
+        Puppet::Moddeps::Installer.new(['path1', 'path2'])
+      }.to raise_error(SystemExit, 'The provided module path was not a string.' )
+    end
+
+    it 'should fail when an array is passed to puppet_version' do
+      expect {
+        Puppet::Moddeps::Installer.new('/tmp', ['arg1', 'arg2'])
+      }.to raise_error(SystemExit, 'The provided puppet version was not a string.' )
+    end
+  end
+
+  describe '.install(puppet_module) feedback verification' do
+    before(:each) do
+      @base_object = Puppet::Moddeps::Installer.new
+    end
+
+    context 'with no parameters' do
+      it 'should print usage info' do
+        expect { @base_object.install }.to raise_error(SystemExit, /Usage.*/)
+      end
+    end
+
+    it 'should print usage if an element of the array is not a string' do
+      allow(@base_object).to receive(:installed?).and_return(true)
+      expect { @base_object.install(['arg1', ['arg2']]) }.to raise_error(SystemExit, /Usage.*/)
+      expect { @base_object.install([['arg1'], 'arg2']) }.to raise_error(SystemExit, /Usage.*/)
+      expect { @base_object.install([{'arg1' => 'arg2'}]) }.to raise_error(SystemExit, /Usage.*/)
+    end
+
+    it 'should print usage if an empty array is passed in' do
+      params = []
+      expect { @base_object.install(params) }.to raise_error(SystemExit, /Usage.*/)
+    end
+
+    it 'should fail if the parameter is not an installed module' do
+      expect { @base_object.install(['fake_missing_module']) }.to raise_error(SystemExit, /Can\'t find fake_missing_module in.*/)
+    end
+  end
+
+  describe '.path_separator' do
+
+    subject { Puppet::Moddeps::Installer.new }
+
+    context 'on Windows' do
+      it 'should return ; as the path separator' do
+        expect(subject.path_separator('mingw32')).to eq(';')
+      end
+    end
+
+    context 'on Linux' do
+      it 'should return : as the path separator' do
+        expect(subject.path_separator('linux-gnu')).to eq(':')
+      end
+    end
+  end
+
+  describe '.install Puppet modules' do
+     it "should install dependencies for a single module" do
+       base_object = Puppet::Moddeps::Installer.new
+       module_to_install = Puppet::Moddeps::Module.new("genebean", "foo", "1.2.3")
+       allow(base_object).to receive(:installed?).and_return(true)
+       allow(base_object).to receive(:module_versions_match?).and_return(false)
+
+       # return a single module to install
+       allow(base_object).to receive(:resolve_local_module_deps).and_return([module_to_install])
+       allow(base_object).to receive(:call_puppet)
+
+       base_object.install(['apache'])
+
+       # validate that only the returned modules is installed
+       expect(base_object).to have_received(:call_puppet).once
+       expect(base_object).to have_received(:call_puppet).once.with(module_to_install)
+     end
+
+     it "should install dependencies for multiple modules" do
+       base_object = Puppet::Moddeps::Installer.new
+       first_module_to_install = Puppet::Moddeps::Module.new("genebean", "foo", "1.2.3")
+       second_module_to_install = Puppet::Moddeps::Module.new("genebean", "bar", "4.5.6")
+       allow(base_object).to receive(:installed?).and_return(true)
+       allow(base_object).to receive(:module_versions_match?).and_return(false)
+
+       # return two modules to install
+       allow(base_object).to receive(:resolve_local_module_deps).and_return([first_module_to_install, second_module_to_install])
+       allow(base_object).to receive(:call_puppet)
+
+       base_object.install(['apache', 'nginx'])
+
+       # validate that only the two returned modules get installed
+       expect(base_object).to have_received(:call_puppet).twice
+       expect(base_object).to have_received(:call_puppet).once.with(first_module_to_install)
+       expect(base_object).to have_received(:call_puppet).once.with(second_module_to_install)
+     end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,13 @@
-require "codeclimate-test-reporter"
-CodeClimate::TestReporter.start
-
-require 'coveralls'
-Coveralls.wear!
-
-require 'pry'
-require 'puppet/moddeps'
+require 'simplecov'
+require 'codecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::Codecov
+])
+SimpleCov.start
+
+require 'pry'
+require 'puppet/moddeps'
+require 'rbconfig'
+require 'semantic_puppet'

metadata

@@ -1,204 +1,287 @@
 --- !ruby/object:Gem::Specification
 name: puppet-moddeps
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 2.0.0
 platform: ruby
 authors:
 - GeneBean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.2.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.2.12
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 2.16.2
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 4.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 4.7.3
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: guard-yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: 2.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
-  name: pry-nav
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ! '>='
+        version: '2.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+- !ruby/object:Gem::Dependency
+  name: puppetfile-resolver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ! '>='
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
-description: ! "    This gem will allow you to pull in all missing dependencies for
-  a given\n    Puppet module. This is targeted specifically at private modules that
-  have a\n    populated metadata.json file.\n"
+        version: 0.4.0
+description: |2
+      This gem will allow you to pull in all missing dependencies for a given
+      Puppet module. This is targeted specifically at private modules that have a
+      populated metadata.json file.
 email:
-- me@technicalissues.us
+- gene@technicalissues.us
 executables:
 - puppet-moddeps
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".github/dependabot.yml"
+- ".github/workflows/gempush.yml"
+- ".github/workflows/ruby.yaml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -206,15 +289,15 @@ files:
 - Vagrantfile
 - bin/puppet-moddeps
 - lib/puppet/moddeps.rb
+- lib/puppet/moddeps/installer.rb
+- lib/puppet/moddeps/module.rb
 - lib/puppet/moddeps/version.rb
 - puppet-moddeps.gemspec
-- scripts/pretest.sh
-- scripts/vagrant-user.sh
-- spec/moddeps_spec.rb
+- spec/puppet/moddeps/installer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/genebean/puppet-moddeps
 licenses:
-- New BSD
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -222,20 +305,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.5.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Installs dependencies for a given Puppet module
 test_files:
-- spec/moddeps_spec.rb
+- spec/puppet/moddeps/installer_spec.rb
 - spec/spec_helper.rb