Adds validate task

  * Adds basic tests for ra10ke
  * Adds a text based Puppetfile parser module
  * Adds a monkey patch file for string colors
  * Adds a new validate task that checks all the refs
    of all the git urls.
  * Adds table_print gem for pretty output with validate task

.gitignore

@@ -1 +1,3 @@
 Gemfile.lock
+pkg
+.bundle

.ruby-version

@@ -0,0 +1,2 @@
+2.5.3
+

README.md

@@ -79,6 +79,41 @@ runs faster.
 
 Reads the Puppetfile in the current directory and installs them under the `path` provided as an argument.
 
+### r10k:validate[path]
+The validate rake task will determine if the url is a valid url by connecting 
+to the repository and verififying it actually exists and can be accessed.
+Additional if a branch, tag, or ref is specified in the Puppetfile the validate
+task will also verify that that branch/tag/ref exists in the remote repository.
+
+If you have ever deployed r10k to production only to find out a tag or branch is
+missing this validate task will catch that issue.  
+
+A exit status of 0 is returned if there are no faults, while a 1 is returned if
+any module has a bad status. 
+
+Status emojis can be customized by setting the following environment variables.
+
+Example
+
+ * `GOOD_EMOJI='👍'`
+ * `BAD_EMOJI='😨'`
+
+
+```
+NAME     | URL                                           | REF                            | STATUS
+---------|-----------------------------------------------|--------------------------------|-------
+splunk   | https://github.com/cudgel/splunk.git          | prod                           | 👍
+r10k     | https://github.com/acidprime/r10k             | v3.1.1                         | 👍
+gms      | https://github.com/npwalker/abrader-gms       | gitlab_disable_ssl_verify_s... | 👍
+rbac     | https://github.com/puppetlabs/pltraining-rbac | 2f60e1789a721ce83f8df061e13... | 👍
+acl      | https://github.com/dobbymoodge/puppet-acl.git | master                         | 👍
+deploy   | https://github.com/cudgel/deploy.git          | master                         | 👍
+dotfiles | https://github.com/cudgel/puppet-dotfiles.git | master                         | 👍
+gitlab   | https://github.com/vshn/puppet-gitlab         | 00397b86dfb3487d9df768cbd36... | 👍
+
+👍👍 Puppetfile looks good.👍👍
+```
+
 #### Limitations
 
   * It works only with modules from the [Forge](https://forge.puppetlabs.com), and Git.

Rakefile

@@ -3,8 +3,15 @@ require 'rake/clean'
 require 'rubygems'
 require 'bundler/gem_tasks'
 require 'fileutils'
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
 CLEAN.include("pkg/", "tmp/")
 CLOBBER.include("Gemfile.lock")
 
-task :default => [:clean, :build]
+task :default => [:spec]
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+end
+

lib/ra10ke.rb

@@ -5,15 +5,17 @@
 require 'ra10ke/syntax'
 require 'ra10ke/dependencies'
 require 'ra10ke/install'
+require 'ra10ke/validate'
 require 'git'
 require 'semverse'
-
+require 'r10k/puppetfile'
 module Ra10ke
   class RakeTask < ::Rake::TaskLib
     include Ra10ke::Solve
     include Ra10ke::Syntax
     include Ra10ke::Dependencies
     include Ra10ke::Install
+    include Ra10ke::Validate
 
     attr_accessor :basedir, :moduledir, :puppetfile_path, :puppetfile_name, :force, :purge
 
@@ -32,6 +34,7 @@ def initialize(*args)
         define_task_syntax(*args)
         define_task_dependencies(*args)
         define_task_install(*args)
+        define_task_validate(*args)
       end
     end
 
@@ -40,3 +43,4 @@ def get_puppetfile
     end
   end
 end
+

lib/ra10ke/monkey_patches.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class String
+  # colorization
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  # removes specified markes from string. 
+  # @return [String] - the string with markers removed
+  def strip_comment(markers = ['#', "\n"])
+    re = Regexp.union(markers)
+    index = (self =~ re)
+    index.nil? ? rstrip : self[0, index].rstrip
+  end
+end
+

lib/ra10ke/puppetfile_parser.rb

@@ -0,0 +1,84 @@
+# it might be desirable to parse the Puppetfile as a string instead of evaling it. 
+# this module allows you to do just that.
+require 'ra10ke/monkey_patches'
+
+module Ra10ke
+    module PuppetfileParser
+
+      # @return [Array] - returns a array of hashes that contain modules with a git source
+      def git_modules(file = puppetfile)
+        modules(file).find_all do |mod|
+          mod[:args].key?(:git)
+        end
+      end
+
+      # @param puppetfile [String] - the absolute path to the puppetfile
+      # @return [Array] - returns an array of module hashes that represent the puppetfile
+      # @example
+      # [{:namespace=>"puppetlabs", :name=>"stdlib", :args=>[]},
+      # {:namespace=>"petems", :name=>"swap_file", :args=>["'4.0.0'"]}]
+      def modules(puppetfile)
+        @modules ||= begin
+          return [] unless File.exist?(puppetfile)
+
+          all_lines = File.read(puppetfile).lines.map(&:strip_comment)
+          # remove comments from all the lines
+          lines_without_comments = all_lines.reject { |line| line.match(/#.*\n/) }.join("\n").delete("\n")
+          lines_without_comments.split('mod').map do |line|
+            next nil if line =~ /^forge/
+            next nil if line.empty?
+
+            parse_module_args(line)
+          end.compact.uniq
+        end
+      end
+
+      # @param data [String] - the string to parse the puppetfile args out of
+      # @return [Array] -  an array of arguments in hash form
+      # @example
+      # {:namespace=>"puppetlabs", :name=>"stdlib", :args=>[]}
+      # {:namespace=>"petems", :name=>"swap_file", :args=>["'4.0.0'"]}
+      def parse_module_args(data)
+        return {} if data.empty?
+        args = data.split(',').map(&:strip)
+        # we can't guarantee that there will be a namespace when git is used
+        # remove quotes and dash and slash
+        namespace, name = args.shift.gsub(/'|"/, '').split(%r{-|/})
+        name ||= namespace
+        namespace = nil if namespace == name
+        {
+          namespace: namespace,
+          name: name,
+          args: process_args(args)
+        }
+      end
+
+      # @return [Array] - returns an array of hashes with the args in key value pairs
+      # @param [Array] - the arguments processed from each entry in the puppetfile
+      # @example
+      # [{:args=>[], :name=>"razor", :namespace=>"puppetlabs"},
+      #  {:args=>[{:version=>"0.0.3"}], :name=>"ntp", :namespace=>"puppetlabs"},
+      #  {:args=>[], :name=>"inifile", :namespace=>"puppetlabs"},
+      #  {:args=>
+      #    [{:git=>"https://github.com/nwops/reportslack.git"}, {:ref=>"1.0.20"}],
+      #   :name=>"reportslack",
+      #   :namespace=>"nwops"},
+      #  {:args=>{:git=>"git://github.com/puppetlabs/puppetlabs-apt.git"},
+      #   :name=>"apt",
+      #   :namespace=>nil}
+      # ]
+      def process_args(args)
+        results = {}
+        args.each do |arg|
+          a = arg.gsub(/'|"/, '').split(/\A\:|\:\s|\=\>/).map(&:strip).reject(&:empty?)
+          if a.count < 2
+            results[:version] = a.first
+          else
+            results[a.first.to_sym] = a.last
+          end
+        end
+        results
+      end
+    end
+end
+

lib/ra10ke/validate.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'ra10ke/monkey_patches'
+require 'tempfile'
+require 'table_print'
+require 'ra10ke/puppetfile_parser'
+require 'English'
+
+module Ra10ke
+  module Validate
+
+    GOOD_EMOJI = ENV['GOOD_EMOJI'] || '👍'
+    BAD_EMOJI = ENV['BAD_EMOJI'] || '😨'
+
+    # Validate the git urls and refs
+    def define_task_validate(*args)
+      desc 'Validate the git urls and branches, refs, or tags'
+      task :validate do
+        gitvalididation = Ra10ke::Validate::Validation.new(puppetfile_path)
+        exit_code = 0
+        if gitvalididation.bad_mods?
+          exit_code = 1
+          message = BAD_EMOJI + '  Not all modules in the Puppetfile are valid. '.red + BAD_EMOJI
+        else
+          message = GOOD_EMOJI + '  Puppetfile looks good. '.green + GOOD_EMOJI
+        end
+        tp gitvalididation.sorted_mods, :name, { url: { width: 50 } }, :ref, :status
+        abort(message) if exit_code.positive?
+        puts message
+      end
+    end
+
+    class Validation
+      include Ra10ke::PuppetfileParser
+
+      attr_reader :puppetfile
+
+      def initialize(file)
+        file ||= './Puppetfile'
+        @puppetfile = File.expand_path(file)
+        abort("Puppetfile does not exist at #{puppetfile}") unless File.readable?(puppetfile)
+      end
+
+      # @return [Boolean] - return true if the ref is valid
+      # @param url [String] - the git string either https or ssh url
+      # @param ref [String] - the ref object, branch name, tag name, or commit sha, defaults to HEAD
+      def valid_ref?(url, ref = 'HEAD')
+        raise ArgumentError unless ref
+
+        `git ls-remote --symref #{url} | grep #{ref}`
+        $CHILD_STATUS.success?
+      end
+
+      # @return [Boolean] - return true if the commit sha is valid
+      # @param url [String] - the git string either https or ssh url
+      # @param ref [String] - the sha id
+      def valid_commit?(url, sha)
+        return false if sha.nil? || sha.empty?
+        puts "Warning: consider pinning #{url} to tag if possible.".yellow
+        Dir.mktmpdir do |dir|
+          `git clone --no-tags #{url} #{dir} 2>&1 > /dev/null`
+          Dir.chdir(dir) do
+            `git show #{sha} 2>&1 > /dev/null`
+            $CHILD_STATUS.success?
+          end
+        end
+      end
+
+      # @return [Array[Hash]] array of module information and git status
+      def all_modules
+        @all_modules ||= begin
+          git_modules(puppetfile).map do |mod|
+            ref = mod[:args][:ref] || mod[:args][:tag] || mod[:args][:branch]
+            valid_ref = valid_ref?(mod[:args][:git], ref) || valid_commit?(mod[:args][:git], mod[:args][:ref])
+            {
+              name: mod[:name],
+              url: mod[:args][:git],
+              ref: ref,
+              valid_ref?: valid_ref,
+              status: valid_ref ? Ra10ke::Validate::GOOD_EMOJI : Ra10ke::Validate::BAD_EMOJI
+            }
+          end
+        end
+      end
+
+      # @return [Boolean] - true if there are any bad mods
+      def bad_mods?
+        all_modules.find_all { |mod| !mod[:valid_ref?] }.count > 0
+      end
+
+      # @return [Hash] - sorts the mods based on good/bad
+      def sorted_mods
+        @sorted_mods ||= all_modules.sort_by { |a| a[:valid_ref?] ? 1 : 0 }
+      end
+    end
+  end
+end

ra10ke.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "git"
   spec.add_dependency "solve"
   spec.add_dependency 'semverse', '~> 2.0'
+  spec.add_dependency 'table_print', '~> 1.5.6'
+  spec.add_development_dependency 'rspec', '~> 3.6'
 end
+

spec/fixtures/Puppetfile

@@ -0,0 +1,41 @@
+forge "http://forge.puppetlabs.com"
+
+mod "puppetlabs/inifile",     '2.2.0'
+mod "puppetlabs/stdlib",      '4.24.0'
+mod "puppetlabs/concat",      '4.0.0'
+mod "puppetlabs/ntp",         '6.4.1'
+
+# introduced for tomcat module collaboration with uws
+mod 'puppet-archive', '3.1.1'
+
+mod 'gitlab',
+  :git => 'https://github.com/vshn/puppet-gitlab',
+  :ref => '00397b86dfb3487d9df768cbd3698d362132b5bf'  # master
+
+mod 'r10k',
+  :git => 'https://github.com/acidprime/r10k',
+  :tag => 'v3.1.1'
+
+mod 'gms',
+  :git    => 'https://github.com/npwalker/abrader-gms',
+  :branch => 'gitlab_disable_ssl_verify_support'
+
+mod 'pltraining-rbac',
+  :git    => 'https://github.com/puppetlabs/pltraining-rbac',
+  :ref    => '2f60e1789a721ce83f8df061e13f8bf81cd4e4ce'
+
+mod 'puppet-acl',
+  :git => 'https://github.com/dobbymoodge/puppet-acl.git',
+  :branch => 'master'
+
+mod 'deploy',
+  :git => 'https://github.com/cudgel/deploy.git',
+  :branch => 'master'
+
+mod 'dotfiles',
+  :git => 'https://github.com/cudgel/puppet-dotfiles.git',
+  :branch => 'master'
+
+mod 'splunk',
+  :git => 'https://github.com/cudgel/splunk.git',
+  :branch => 'prod'

spec/fixtures/Puppetfile_with_bad_refs

@@ -0,0 +1,9 @@
+forge "http://forge.puppetlabs.com"
+
+mod 'gitlab',
+  :git => 'https://github.com/vshn/puppet-gitlab',
+  :ref => '00397b86dfb3487d9df768cbd3698d362132b5bf'  # master
+
+mod 'r10k',
+  :git => 'https://github.com/acidprime/r10k',
+  :tag => 'bad'