puppet-moddeps 1.2.0 → 2.0.0

data/README.md

@@ -1,100 +1,75 @@
-# Puppet::Moddeps
-
-[![Gem Version][gem-v-img]][gem-version]
-
-#### Master branch:
-[![Build Status][travis-img-master]][travis-ci]
-[![Code Climate][cc-img]][code-climate]
-[![Coverage Status][coveralls-img-master]][coveralls-master]
-[![Dependency Status][gemnasium-img]][gemnasium]
-
-#### Devlop branch:
-[![Build Status][travis-img-develop]][travis-ci]
-[![Coverage Status][coveralls-img-develop]][coveralls-develop]
-
-## Description
-
-This gem will allow you to pull in all missing dependencies for a given Puppet
-module. This is targeted specifically at private modules or modules cloned from
-GitHub that have a populated `metadata.json` file.
-
-puppet-moddeps has been extensively tested on CentOS 6 using the system ruby
-(v1.8.7). Due to dependency requirements all development is done on ruby 1.9.3
-or higher. Automated testing of v1.8.7 cannot be done on Travis-CI due to the
-development dependencies.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'puppet-moddeps'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install puppet-moddeps
-
-## Usage
-
-To put this gem to use just install it and run `puppet-moddeps some_module`,
-replacing `some_module` with the name of any module installed in
-`/etc/puppet/modules`. It will parse the module's `metadata.json` file pull down
-it's listed dependencies.
-
-## Contributing
-
-The development environment requires at least Ruby 1.9.2 due to the use of Guard
-and Coveralls.  The gem is designed to run on Ruby 1.8.7 and higher as that is
-the version available in Red Hat / CentOS 6.
-
-1. Fork it ( https://github.com/genebean/puppet-moddeps/fork )
-2. Create your feature branch based off of the develop branch
-   (`git checkout develop; git checkout -b my-new-feature`)
-3. Install development gems (`bundle install`)
-4. Open a second terminal and use guard to make sure your code doesn't break anything
-   (`bundle exec guard`)
-5. Commit your changes and associated tests (`git commit -am 'Add some feature'`)
-6. Push to the branch (`git push origin my-new-feature`)
-7. Create a new Pull Request
-
-### Vagrant
-
-Development and testing can also be done utilizing the included `Vagrantfile`.
-To do so, install [Vagrant][vagrant] and [VirtualBox][vbox], fork and clone the
-project, cd into the project, and run `vagrant up` followed by `vagrant ssh`.
-The setup process will take care of running `bundle install` for you. You
-can find the code symlinked into the vagrant user's home directory. Also, RVM
-is installed system-wide in the referenced Vagrant box.
-
-### Tests
-
-Please try and write tests using Rspec's expect syntax for any code you add or change.
-Code must have tests before it will be merged.
-
-## License
-
-This code is released under the New BSD license (aka 3-clause BSD). A copy is
-in the LICENSE file in this repo.
-
-
-[code-climate]: https://codeclimate.com/github/genebean/puppet-moddeps
-[cc-img]: https://img.shields.io/codeclimate/github/genebean/puppet-moddeps.svg
-[coveralls-master]: https://coveralls.io/r/genebean/puppet-moddeps?branch=master
-[coveralls-develop]: https://coveralls.io/r/genebean/puppet-moddeps?branch=develop
-[coveralls-img-master]: https://img.shields.io/coveralls/genebean/puppet-moddeps/master.svg
-[coveralls-img-develop]: https://img.shields.io/coveralls/genebean/puppet-moddeps/develop.svg
-[gem-v-img]: https://badge.fury.io/rb/puppet-moddeps.svg
-[gem-version]: http://badge.fury.io/rb/puppet-moddeps
-[gemnasium-img]: https://img.shields.io/gemnasium/genebean/puppet-moddeps.svg
-[gemnasium]: https://gemnasium.com/genebean/puppet-moddeps
-[rvm]: http://rvm.io
-[travis-ci]: https://travis-ci.org/genebean/puppet-moddeps
-[travis-img-master]: https://img.shields.io/travis/genebean/puppet-moddeps/master.svg
-[travis-img-develop]: https://img.shields.io/travis/genebean/puppet-moddeps/develop.svg
-[vbox]: https://www.virtualbox.org
-[vagrant]: https://www.vagrantup.com
+# Puppet::Moddeps
+
+[![Gem](https://img.shields.io/gem/v/puppet-moddeps)](https://rubygems.org/gems/puppet-moddeps)
+[![Actions Status](https://github.com/genebean/puppet-moddeps/workflows/Rspec%20Tests/badge.svg)](https://github.com/genebean/puppet-moddeps/actions)
+[![codecov](https://codecov.io/gh/genebean/puppet-moddeps/branch/master/graph/badge.svg?token=9sn4KbY0yu)](https://app.codecov.io/gh/genebean/puppet-moddeps)
+![GitHub](https://img.shields.io/github/license/genebean/puppet-moddeps)
+
+## Description
+
+This gem will allow you to pull in all missing dependencies for a given Puppet module by running `puppet-moddeps some_module`. This is targeted specifically at private modules or modules cloned from GitHub that have a populated `metadata.json` file. It really shines as a tool to install all the dependencies of a module that you have just created or when you have just updated the list of dependencies in a module's `metadata.json` file.
+
+## Installation
+
+puppet-moddeps has been extensively tested using the ruby bundled with the Puppet agent. The recommended way to use this gem is to first install puppet and then open an elevated command prompt and run this:
+
+```bash
+puppet resource package puppet-moddeps provider=puppet_gem ensure=latest
+```
+
+Alternatively, you can also install it using another instance of Ruby so long as it is at least version 2.5.7.
+
+## Usage
+
+After installation, you can run `puppet-moddeps some_module`, replacing `some_module` with the name of any module installed in `/etc/puppetlabs/code/environments/production/modules/`. It will resolve the module's dependencies based on its `metadata.json` file and install each of them.
+
+### Using in a module's Vagrantfile
+
+If your module includes a [`Vagrantfile`](https://www.vagrantup.com/docs/vagrantfile) you can utilize this gem as part of your provisioning step by adding this to it:
+
+```ruby
+MODULE_NAME='some_module'
+Vagrant.configure('2') do |config|
+  config.vm.box = 'genebean/centos-7-puppet-latest' # Any box that includes Puppet will work here
+  config.vm.provision 'shell', inline: <<-SCRIPT
+    puppet resource file /etc/puppetlabs/code/environments/production/modules/#{MODULE_NAME} ensure=link target=/vagrant force=true
+    /opt/puppetlabs/puppet/bin/gem install puppet-moddeps
+    /opt/puppetlabs/puppet/bin/puppet-moddeps #{MODULE_NAME}
+  SCRIPT
+end
+```
+
+## Contributing
+
+Pull requests are welcome!
+
+1. Fork it ( https://github.com/genebean/puppet-moddeps/fork )
+2. Create a feature branch
+3. Install bundler (`gem install bundler`)
+4. Install development gems (`bundle install`)
+5. Open a second terminal and use guard to make sure your code doesn't break anything (`bundle exec guard -p`)
+6. Commit your changes and associated tests (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create a new pull request
+
+### Vagrant
+
+Development and testing can also be done utilizing the included `Vagrantfile`.
+To do so, install [Vagrant][vagrant] and [VirtualBox][vbox], fork and clone the
+project, cd into the project, and run `vagrant up` followed by `vagrant ssh`.
+The setup process will take care of running `bundle install` for you. You
+can find the code symlinked into the vagrant user's home directory. Also, RVM
+is installed system-wide in the referenced Vagrant box.
+
+### Tests
+
+Please try and write tests using Rspec's expect syntax for any code you add or change.
+Code must have tests before it will be merged.
+
+## License
+
+This code is released under the Apache 2.0 license. A copy is in the LICENSE file in this repo.
+
+[rvm]: http://rvm.io
+[vbox]: https://www.virtualbox.org
+[vagrant]: https://www.vagrantup.com

data/Rakefile

@@ -1,11 +1,14 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-# Default directory to look in is `/specs`
-# Run with `rake spec`
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.rspec_opts = ['--color', '--format', 'documentation']
-end
-
-task :default => :spec
-
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+YARD::Rake::YardocTask.new
+
+task :default => :spec
+

data/Vagrantfile

@@ -1,16 +1,16 @@
-# -*- mode: ruby -*-
-# vi: set ft=ruby :
-
-# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
-VAGRANTFILE_API_VERSION = "2"
-
-Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
-  config.vm.box = "genebean/centos6-rvm193-64bit"
-
-  config.vm.synced_folder "./", "/home/vagrant/puppet-moddeps"
-
-  config.vm.provision "shell", inline: "yum -y install dos2unix git nano ruby-devel tree vim-enhanced"
-  config.vm.provision "shell", inline: "dos2unix /vagrant/scripts/*.sh"
-  config.vm.provision "shell", inline: "su - vagrant -c 'export PUPPET_VERSION=3.7.3; /vagrant/scripts/vagrant-user.sh'"
-
-end
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "genebean/centos-7-rvm-multi"
+
+  config.vm.network "forwarded_port", guest: 8808, host: 8808 # used for Yard docs
+
+  config.vm.synced_folder "./", "/home/vagrant/puppet-moddeps"
+
+  config.vm.provision "shell", inline: "yum -y install dos2unix git nano ruby-devel tree vim-enhanced"
+  config.vm.provision "shell", inline: "echo 'install bundler after selecting a ruby with RVM'"
+end

data/bin/puppet-moddeps

@@ -1,6 +1,6 @@
-#!/usr/bin/env ruby
-
-require 'puppet/moddeps'
-
-depinstaller = Puppet::Moddeps::InstallDeps.new
+#!/usr/bin/env ruby
+
+require 'puppet/moddeps'
+
+depinstaller = Puppet::Moddeps::Installer.new
 depinstaller.install(ARGV)

data/lib/puppet/moddeps.rb

@@ -1,8 +1,8 @@
-require 'puppet/moddeps/install_deps'
-require 'puppet/moddeps/version'
-
-module Puppet
-  module Moddeps
-
-  end
-end
+require 'puppet/moddeps/installer'
+require 'puppet/moddeps/version'
+
+module Puppet
+  module Moddeps
+
+  end
+end

data/lib/puppet/moddeps/installer.rb

@@ -0,0 +1,244 @@
+require 'json'
+require 'puppetfile-resolver'
+require 'puppet/moddeps/module'
+
+module Puppet
+  module Moddeps
+    class Installer
+
+      # The path to which modules will be installed
+      #
+      # @return [String]
+      #   The path to which modules will be installed
+      attr_reader :module_path
+
+      # The version of Puppet that will be used when resolving dependencies.
+      # If none is provided then a Puppet version constraint is not applied
+      # during resolution.
+      #
+      # @return [String]
+      #   The version of Puppet that will be used when resolving dependencies
+      #   if one was specified.
+      attr_reader :puppet_version
+
+      # Creates an instance of Puppet::Moddeps::Installer
+      #
+      # @param module_path [String]
+      #   The path to which modules will be installed
+      # @param puppet_version [String]
+      #   The verion of Puppet to use when resolving dependencies
+      #
+      # @example No parameters
+      #   depinstaller = Puppet::Moddeps::Installer.new
+      #
+      # @example Specify a module path
+      #   depinstaller = Puppet::Moddeps::Installer.new('/tmp')
+      #
+      # @example Specify a module path and a Puppet version
+      #   depinstaller = Puppet::Moddeps::Installer.new('/tmp', '6.18.0')
+      #
+      def initialize(module_path=nil, puppet_version=nil)
+        if module_path
+          abort('The provided module path was not a string.') unless module_path.is_a?(String)
+          @module_path = module_path
+        else
+          separator = self.path_separator(RbConfig::CONFIG['host_os'])
+          @module_path = %x(puppet config print modulepath).split(separator)[0].strip
+        end
+
+        if puppet_version
+          abort('The provided puppet version was not a string.') unless puppet_version.is_a?(String)
+        end
+
+        @puppet_version = puppet_version
+
+        @usage = <<~ENDUSAGE
+          Usage: puppet-moddeps module_one [module_two] [...]
+                 Call puppet-moddeps with the name of one or more installed modules'
+        ENDUSAGE
+      end
+
+      # Installs the dependencies for one or more local modules. This is the
+      # primary entry point for this class.
+      #
+      # @param puppet_module [Array[String]]
+      #   An array of strings representig the names of one or more locally
+      #   installed puppet modules.
+      #
+      # @example Install dependencies for one module
+      #   depinstaller.install(['apache'])
+      #
+      # @example Install dependencies for multiple module
+      #   depinstaller.install(['apache', 'nginx'])
+      def install(*puppet_module)
+        # puppet_module will always be an array.
+        # The elements of the array are the values passed in.
+        if puppet_module.nil? || puppet_module.size == 0 || puppet_module[0].nil? || puppet_module[0].size == 0
+          puts 'input problem'
+          abort(@usage)
+        end
+
+        module_array = puppet_module[0]
+
+        # The intent is to only accept strings as arguments.
+        # It is also expected that all arguments are installed modules
+        module_array.each do |mod|
+          abort(@usage) unless mod.is_a?(String)
+          abort("Can't find #{mod} in #{@module_path}") unless self.installed?(mod)
+        end
+
+        module_objects = resolve_local_module_deps(module_array)
+        
+        # Remove the local modules from the list of modules to install
+        # so that the installation process does not overwrite whatever
+        # initiated running puppet-moddeps.
+        module_objects.each do |obj|
+          if module_array.include?(obj.name)
+            module_objects.delete(obj)
+          end
+        end
+
+        # install the needed modules
+        self.install_modules(module_objects)
+      end
+
+      # Test to see if a module's folder is present within the module path.
+      #
+      # @param module_name [String]
+      #   The name of a module
+      #
+      # @return [Boolean]
+      #   Returns true if found, false otherwise
+      def installed?(module_name)
+        File.directory?("#{@module_path}/#{module_name}")
+      end
+
+      # Determine the character used to separate entries in an operating
+      # system's path environment variable.
+      #
+      # @param os_string [String]
+      #   A string representing a host's operating system as returned
+      #   by RbConfig::CONFIG['host_os']
+      #
+      # @return [String]
+      #   Returns ";" on Windows and ":" on everything else
+      def path_separator(os_string)
+        if (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ os_string) != nil
+          separator = ';'
+        else
+          separator = ':'
+        end
+      end
+
+      # Resolves the dependencies of one or more locally installed modules
+      #
+      # @param modules [Array[String]]
+      #   An array of module names
+      #
+      # @return [Array[Puppet::Moddeps::Module]]
+      #   An array of module objects representing the modules that need
+      #   to be installed to satisfiy the dependencies of the local module(s)
+      def resolve_local_module_deps(modules)
+        # Build the document model from the modules.
+        model = PuppetfileResolver::Puppetfile::Document.new('')
+
+        modules.each do |mod|
+          model.add_module(
+            PuppetfileResolver::Puppetfile::LocalModule.new(mod)
+          )
+        end
+
+        # Make sure the Puppetfile model is valid.
+        unless model.valid?
+          raise "Unable to resolve dependencies for modules: #{modules.map(&:title).join(', ')}"
+        end
+
+        resolver = PuppetfileResolver::Resolver.new(model, @puppet_version)
+
+        # Configure and resolve the dependency graph, catching any errors
+        # raised by puppetfile-resolver and re-raising them as Bolt errors.
+        begin
+          result = resolver.resolve(
+            cache:                 nil,
+            ui:                    nil,
+            module_paths:          [@module_path],
+            allow_missing_modules: false
+          )
+        rescue StandardError => e
+          raise e.message
+        end
+
+        # Turn specifications into module objects. This will skip over anything that is not
+        # a module specification (i.e. a Puppet version specification).
+        module_objects = result.specifications.each_with_object(Set.new) do |(_name, spec), acc|
+          next unless spec.instance_of? PuppetfileResolver::Models::ModuleSpecification
+          acc << Puppet::Moddeps::Module.new(spec.owner, spec.name, spec.version.to_s)
+        end
+      end
+
+      # Installs requested modules if they are not already installed.
+      #
+      # @param module_objects [Array[Puppet::Moddeps::Module]]
+      #   An array of module objects representing the modules that need
+      #   to be installed
+      def install_modules(module_objects)
+        if Array(module_objects).size > 0
+          puts "Modules will be installed into #{@module_path}"
+
+          Array(module_objects).each do |mod|
+            if self.installed?(mod.name) && self.module_versions_match?(mod.owner, mod.name, mod.version)
+              puts "#{mod.owner}-#{mod.name} #{mod.version} is already installed, skipping"
+            else
+              self.call_puppet(mod)
+            end
+          end
+        else
+          puts 'No dependencies were marked for installation.'
+        end
+      end
+
+      # Parses the metadata.json file of a module and returns it as Hash
+      #
+      # @param module_name [String]
+      #   The name of a module
+      #
+      # @return [Hash]
+      #   A hash representing the JSON metadata
+      def parse_metadata(module_name)
+        metadata = File.read("#{@module_path}/#{module_name}/metadata.json")
+        data     = JSON.parse(metadata)
+      end
+
+      # Compare the owner, name, and version of an installed module to a
+      # provided set of information.
+      #
+      # @param module_owner [String]
+      #   The owner / author of a module. Ex. puppetlabs
+      # @param module_name [String]
+      #   The name of a module. Ex. apache
+      # @param module_version [String]
+      #   The semantic version of a module. Ex. 5.6.0
+      #
+      # @return [Boolean]
+      #   Retruns true if the information matches, false otherwise
+      def module_versions_match?(module_owner, module_name, module_version)
+        metadata = self.parse_metadata(module_name)
+        if metadata['author'].eql?(module_owner) && metadata['version'].eql?(module_version)
+          return true
+        else
+          return false
+        end
+      end
+
+      # Shell out to the puppet binary to install a module without dependencies.
+      #
+      # @param module_object [Puppet::Moddeps::Module]
+      #   A Module object that represents the module to install
+      def call_puppet(module_object)
+        cmd = "puppet module install --force --ignore-dependencies #{module_object.owner}-#{module_object.name} --version #{module_object.version}"
+        puts "Running \"#{cmd}\""
+        %x(#{cmd})
+      end
+    end
+  end
+end