simp-rake-helpers 5.24.0 → 6.0.0

data/lib/simp/rake/build/deps.rb

@@ -1,62 +1,60 @@
 #!/usr/bin/rake -T
+# frozen_string_literal: true
 
+require 'English'
 require 'yaml'
 
 class R10KHelper
-  attr_accessor :puppetfile
-  attr_accessor :modules
-  attr_accessor :basedir
+  attr_accessor :puppetfile, :modules, :basedir
 
   require 'r10k/puppetfile'
 
   # Horrible, but we need to be able to manipulate the cache
   class R10K::Git::ShellGit::ThinRepository
-    def cache_repo
-      @cache_repo
-    end
+    attr_reader :cache_repo
 
     # Return true if the repository has local modifications, false otherwise.
-    def dirty?(exclude_spec=false)
+    def dirty?(_exclude_spec = false)
       repo_status = false
 
       return repo_status unless File.directory?(path)
 
       Dir.chdir(path) do
-        %x(git update-index -q --ignore-submodules --refresh)
-        repo_status = "Could not update git index for '#{path}'" unless $?.success?
+        `git update-index -q --ignore-submodules --refresh`
+        repo_status = "Could not update git index for '#{path}'" unless $CHILD_STATUS.success?
 
         unless repo_status
-          %x(git diff-files --quiet --ignore-submodules --)
-          repo_status = "'#{path}' has unstaged changes" unless $?.success?
+          `git diff-files --quiet --ignore-submodules --`
+          repo_status = "'#{path}' has unstaged changes" unless $CHILD_STATUS.success?
         end
 
         unless repo_status
-          %x(git diff-index --cached --quiet HEAD --ignore-submodules --)
-          repo_status = "'#{path}' has uncommitted changes" unless $?.success?
+          `git diff-index --cached --quiet HEAD --ignore-submodules --`
+          repo_status = "'#{path}' has uncommitted changes" unless $CHILD_STATUS.success?
         end
 
         unless repo_status
           # Things that may be out of date but which should stop the updating
           # of the git repo
-          our_exclusions=[
+          our_exclusions = [
             'build/rpm_metadata',
-            'dist/'
+            'dist/',
           ]
 
-          untracked_files = %x(git ls-files -o -d --exclude-standard --exclude=#{our_exclusions.join(' --exclude=')})
+          untracked_files = `git ls-files -o -d --exclude-standard --exclude=#{our_exclusions.join(' --exclude=')}`
 
-          if $?.success?
-            unless untracked_files.empty?
-              untracked_files.strip!
+          raise Error, "Failure running 'git ls-files -o -d --exclude-standard' at '#{path}'" unless $CHILD_STATUS.success?
 
-              if untracked_files.lines.count > 0
-                repo_status = "'#{path}' has untracked files"
-              end
+          unless untracked_files.empty?
+            untracked_files.strip!
+
+            if untracked_files.lines.any?
+              repo_status = "'#{path}' has untracked files"
             end
-          else
-            # We should never get here
-            raise Error, "Failure running 'git ls-files -o -d --exclude-standard' at '#{path}'"
           end
+
+          # We should never get here
+
         end
       end
 
@@ -69,8 +67,7 @@ class R10KHelper
     @basedir = File.dirname(File.expand_path(puppetfile))
 
     Dir.chdir(@basedir) do
-
-      R10K::Git::Cache.settings[:cache_root] = File.join(@basedir,'.r10k_cache')
+      R10K::Git::Cache.settings[:cache_root] = File.join(@basedir, '.r10k_cache')
 
       unless File.directory?(R10K::Git::Cache.settings[:cache_root])
         FileUtils.mkdir_p(R10K::Git::Cache.settings[:cache_root])
@@ -79,26 +76,26 @@ class R10KHelper
       r10k = R10K::Puppetfile.new(Dir.pwd, nil, puppetfile)
       r10k.load!
 
-      @modules = r10k.modules.collect do |mod|
+      @modules = r10k.modules.map do |mod|
         mod_status = mod.repo.repo.dirty?
 
-        mod = {
-          :name        => mod.name,
-          :path        => mod.path.to_s,
-          :remote      => mod.repo.instance_variable_get('@remote'),
+        {
+          :name => mod.name,
+          :path => mod.path.to_s,
+          :remote => mod.repo.instance_variable_get(:@remote),
           :desired_ref => mod.desired_ref,
-          :git_source  => mod.repo.repo.origin,
-          :git_ref     => mod.repo.head,
-          :module_dir  => mod.basedir,
-          :status      => mod_status ? mod_status : :known,
+          :git_source => mod.repo.repo.origin,
+          :git_ref => mod.repo.head,
+          :module_dir => mod.basedir,
+          :status => mod_status || :known,
           :r10k_module => mod,
-          :r10k_cache  => mod.repo.repo.cache_repo
+          :r10k_cache => mod.repo.repo.cache_repo
         }
       end
     end
 
-    module_dirs = @modules.collect do |mod|
-      mod = mod[:module_dir]
+    module_dirs = @modules.map do |mod|
+      mod[:module_dir]
     end
 
     module_dirs.uniq!
@@ -109,30 +106,30 @@ class R10KHelper
       end
 
       known_modules.map! do |mod|
-        mod = mod[:name]
+        mod[:name]
       end
 
-      current_modules = Dir.glob(File.join(module_dir,'*')).map do |mod|
-        mod = File.basename(mod)
+      current_modules = Dir.glob(File.join(module_dir, '*')).map do |mod|
+        File.basename(mod)
       end
 
       (current_modules - known_modules).each do |mod|
         # Did we find random git repos in our module spaces?
-        if File.exist?(File.join(module_dir, mod, '.git'))
-          @modules << {
-            :name        => mod,
-            :path        => File.join(module_dir, mod),
-            :module_dir  => module_dir,
-            :status      => :unknown,
-          }
-        end
+        next unless File.exist?(File.join(module_dir, mod, '.git'))
+
+        @modules << {
+          :name => mod,
+          :path => File.join(module_dir, mod),
+          :module_dir => module_dir,
+          :status => :unknown
+        }
       end
     end
   end
 
   def puppetfile
     last_module_dir = nil
-    pupfile = Array.new
+    pupfile = []
 
     @modules.each do |mod|
       module_dir = mod[:path].split(@basedir.to_s).last.split('/')[1..-2].join('/')
@@ -156,40 +153,35 @@ class R10KHelper
 
   def each_module(&block)
     Dir.chdir(@basedir) do
-      @modules.each do |mod|
-        # This works for Puppet Modules
-
-        block.call(mod)
-      end
+      @modules.each(&block)
     end
   end
 
   def unknown_modules
-    @modules.select do |mod|
+    @modules.select { |mod|
       mod[:status] == :unknown
-    end.map do |mod|
-      mod = mod[:name]
+    }.map do |mod|
+      mod[:name]
     end
   end
 end
 
 module Simp; end
 module Simp::Rake; end
-module Simp::Rake::Build
 
-  class Deps < ::Rake::TaskLib
-    require 'pager'
-    include Pager
+class Simp::Rake::Build::Deps < Rake::TaskLib
+  require 'pager'
+  include Pager
 
-    def initialize( base_dir )
-      @base_dir = base_dir
-      @verbose = ENV.fetch('SIMP_PKG_verbose','no') == 'yes'
-      define_tasks
-    end
+  def initialize(base_dir)
+    @base_dir = base_dir
+    @verbose = ENV.fetch('SIMP_PKG_verbose', 'no') == 'yes'
+    define_tasks
+  end
 
-    def define_tasks
-      namespace :deps do
-        desc <<-EOM
+  def define_tasks
+    namespace :deps do
+      desc <<-EOM
         Checks out all dependency repos.
 
         This task used R10k to update all dependencies.
@@ -198,196 +190,193 @@ module Simp::Rake::Build
           * :method  => The update method to use (Default => 'tracking')
                tracking => checks out each dep (by branch) according to Puppetfile.tracking
                stable   => checks out each dep (by ref) according to in Puppetfile.stable
-        EOM
-        task :checkout, [:method] do |t,args|
-          args.with_defaults(:method => 'tracking')
-
-          r10k_helper = R10KHelper.new("Puppetfile.#{args[:method]}")
-
-          r10k_issues = Parallel.map(
-            Array(r10k_helper.modules),
-            :in_processes => get_cpu_limit,
-            :progress => 'Submodule Checkout'
-          ) do |mod|
-            issues = []
-
-            Dir.chdir(@base_dir) do
-              unless File.directory?(mod[:path])
-                FileUtils.mkdir_p(mod[:path])
-              end
+      EOM
+      task :checkout, [:method] do |_t, args|
+        args.with_defaults(:method => 'tracking')
+
+        r10k_helper = R10KHelper.new("Puppetfile.#{args[:method]}")
 
-              # Only for known modules...
-              unless mod[:status] == :unknown
-                # Since r10k is destructive, we're enumerating all valid states
-                if [
-                    :absent,
-                    :mismatched,
-                    :outdated,
-                    :insync,
-                    :dirty
-                ].include?(mod[:r10k_module].status)
-                  unless mod[:r10k_cache].synced?
-                    mod[:r10k_cache].sync
-                  end
-
-                  if mod[:status] == :known
-                    mod[:r10k_module].sync
-                  else
-                    # If we get here, the module was dirty and should be skipped
-                    issues << "#{mod[:name]}: Skipped - #{mod[:status]}"
-                    next
-                  end
+        r10k_issues = Parallel.map(
+          Array(r10k_helper.modules),
+          :in_processes => get_cpu_limit,
+          :progress => 'Submodule Checkout',
+        ) do |mod|
+          issues = []
+
+          Dir.chdir(@base_dir) do
+            unless File.directory?(mod[:path])
+              FileUtils.mkdir_p(mod[:path])
+            end
+
+            # Only for known modules...
+            unless mod[:status] == :unknown
+              # Since r10k is destructive, we're enumerating all valid states
+              if [
+                :absent,
+                :mismatched,
+                :outdated,
+                :insync,
+                :dirty,
+              ].include?(mod[:r10k_module].status)
+                unless mod[:r10k_cache].synced?
+                  mod[:r10k_cache].sync
+                end
+
+                if mod[:status] == :known
+                  mod[:r10k_module].sync
                 else
-                  issues << "#{mod[:name]}: Skipped - Unknown status type #{mod[:r10k_module].status}"
+                  # If we get here, the module was dirty and should be skipped
+                  issues << "#{mod[:name]}: Skipped - #{mod[:status]}"
+                  next
                 end
+              else
+                issues << "#{mod[:name]}: Skipped - Unknown status type #{mod[:r10k_module].status}"
               end
             end
-
-            issues
           end
 
-          r10k_issues.flatten!
+          issues
+        end
+
+        r10k_issues.flatten!
 
-          unless r10k_issues.empty?
-            $stderr.puts('='*80)
+        unless r10k_issues.empty?
+          warn('=' * 80)
 
-            unless @verbose
-              $stderr.puts('Warning: Some repositories were skipped!')
-              $stderr.puts('  * If this is a fresh build, this could be an issue')
-              $stderr.puts('  * This is expected if re-running a build')
-              $stderr.puts('  * Run with SIMP_PKG_verbose=yes for full details')
-            else
-              $stderr.puts("R10k Checkout Issues:")
-              r10k_issues.each do |issue|
-                $stderr.puts("  * #{issue}")
-              end
+          if @verbose
+            warn('R10k Checkout Issues:')
+            r10k_issues.each do |issue|
+              warn("  * #{issue}")
             end
-
-            $stderr.puts('='*80)
+          else
+            warn('Warning: Some repositories were skipped!')
+            warn('  * If this is a fresh build, this could be an issue')
+            warn('  * This is expected if re-running a build')
+            warn('  * Run with SIMP_PKG_verbose=yes for full details')
           end
+
+          warn('=' * 80)
         end
+      end
 
-        desc <<-EOM
+      desc <<-EOM
         Get the status of the project Git repositories
 
         Arguments:
           * :method  => The update method to use (Default => 'tracking')
                tracking => checks out each dep (by branch) according to Puppetfile.tracking
                stable   => checks out each dep (by ref) according to in Puppetfile.stable
-        EOM
-        task :status, [:method] do |t,args|
-          args.with_defaults(:method => 'tracking')
-          @dirty_repos = nil
+      EOM
+      task :status, [:method] do |_t, args|
+        args.with_defaults(:method => 'tracking')
+        @dirty_repos = nil
 
-          r10k_helper = R10KHelper.new("Puppetfile.#{args[:method]}")
+        r10k_helper = R10KHelper.new("Puppetfile.#{args[:method]}")
 
-          mods_with_changes = {}
+        mods_with_changes = {}
 
-          r10k_helper.each_module do |mod|
-            unless File.directory?(mod[:path])
-              $stderr.puts("Warning: '#{mod[:path]}' is not a module...skipping") if File.exist?(mod[:path])
-              next
-            end
+        r10k_helper.each_module do |mod|
+          unless File.directory?(mod[:path])
+            warn("Warning: '#{mod[:path]}' is not a module...skipping") if File.exist?(mod[:path])
+            next
+          end
 
-            if mod[:status] != :known
-              # Clean up the path a bit for printing
-              dirty_path = mod[:path].split(r10k_helper.basedir.to_s).last
-              if dirty_path[0].chr == File::SEPARATOR
-                dirty_path[0] = ''
-              end
+          next unless mod[:status] != :known
 
-              mods_with_changes[mod[:name]] = dirty_path
-            end
+          # Clean up the path a bit for printing
+          dirty_path = mod[:path].split(r10k_helper.basedir.to_s).last
+          if dirty_path[0].chr == File::SEPARATOR
+            dirty_path[0] = ''
           end
 
-          if mods_with_changes.empty?
-            puts "No repositories have changes."
-            @dirty_repos = false
-          else
-            puts "The following repositories have changes:"
-            puts mods_with_changes.map{|k,v| "  + #{k} => #{v}"}.join("\n")
+          mods_with_changes[mod[:name]] = dirty_path
+        end
 
-            @dirty_repos = true
-          end
+        if mods_with_changes.empty?
+          puts 'No repositories have changes.'
+          @dirty_repos = false
+        else
+          puts 'The following repositories have changes:'
+          puts mods_with_changes.map { |k, v| "  + #{k} => #{v}" }.join("\n")
 
-          unknown_mods = r10k_helper.unknown_modules
-          unless unknown_mods.empty?
-            puts "The following modules were unknown:"
-            puts unknown_mods.map{|k,v| "  ? #{k}"}.join("\n")
-          end
+          @dirty_repos = true
         end
 
-        desc <<-EOM
+        unknown_mods = r10k_helper.unknown_modules
+        unless unknown_mods.empty?
+          puts 'The following modules were unknown:'
+          puts unknown_mods.map { |k, _v| "  ? #{k}" }.join("\n")
+        end
+      end
+
+      desc <<-EOM
         Records the current dependencies into Puppetfile.stable.
 
         Arguments:
           * :method    => Save to Puppetfile.[method] (Default => 'stable')
           * :reference => Use Puppetfile.[reference] to reference which repos
                           should be recorded (Default => 'tracking')
-        EOM
-        task :record, [:method,:reference] do |t,args|
-          args.with_defaults(:method => 'stable')
-          args.with_defaults(:reference => 'tracking')
+      EOM
+      task :record, [:method, :reference] do |_t, args|
+        args.with_defaults(:method => 'stable')
+        args.with_defaults(:reference => 'tracking')
 
-          r10k_helper = R10KHelper.new("Puppetfile.#{args[:reference]}")
-          File.open("Puppetfile.#{args[:method]}",'w'){|f| f.puts r10k_helper.puppetfile }
-        end
+        r10k_helper = R10KHelper.new("Puppetfile.#{args[:reference]}")
+        File.open("Puppetfile.#{args[:method]}", 'w') { |f| f.puts r10k_helper.puppetfile }
+      end
 
-        desc <<-EOM
+      desc <<-EOM
         Provide a log of changes to all modules from the given top level Git reference.
 
         Arguments:
           * :ref => The top level git ref to use as the oldest point for all logs.
           * :source => The source Puppetfile to use (Default => 'tracking')
-        EOM
-        task :changelog, [:ref] do |t,args|
-          args.with_defaults(:source => 'tracking')
-
-          r10k_helper = R10KHelper.new("Puppetfile.#{args[:source]}")
-
-          git_logs = Hash.new
-
-          Dir.chdir(r10k_helper.basedir) do
-            ref = args[:ref]
-            refdate = nil
-            begin
-              refdate = %x(git log -1 --format=%ai '#{ref}')
-              refdate = nil unless $?.success?
-            rescue Exception
-              #noop
-            end
+      EOM
+      task :changelog, [:ref] do |_t, args|
+        args.with_defaults(:source => 'tracking')
+
+        r10k_helper = R10KHelper.new("Puppetfile.#{args[:source]}")
+
+        git_logs = {}
+
+        Dir.chdir(r10k_helper.basedir) do
+          ref = args[:ref]
+          refdate = nil
+          begin
+            refdate = `git log -1 --format=%ai '#{ref}'`
+            refdate = nil unless $CHILD_STATUS.success?
+          rescue Exception
+            # noop
+          end
 
-            fail("You must specify a valid reference") unless ref
-            fail("Could not find a Git log for #{ref}") unless refdate
+          raise('You must specify a valid reference') unless ref
+          raise("Could not find a Git log for #{ref}") unless refdate
 
-            mods_with_changes = {}
+          log_output = `git log --since='#{refdate}' --stat --reverse`.chomp
+          git_logs['__SIMP CORE__'] = log_output unless log_output.strip.empty?
 
-            log_output = %x(git log --since='#{refdate}' --stat --reverse).chomp
-            git_logs['__SIMP CORE__'] = log_output unless log_output.strip.empty?
+          r10k_helper.each_module do |mod|
+            next unless File.directory?(mod[:path])
 
-            r10k_helper.each_module do |mod|
-              if File.directory?(mod[:path])
-                Dir.chdir(mod[:path]) do
-                  log_output = %x(git log --since='#{refdate}' --stat --reverse).chomp
-                  git_logs[mod[:name]] = log_output unless log_output.strip.empty?
-                end
-              end
+            Dir.chdir(mod[:path]) do
+              log_output = `git log --since='#{refdate}' --stat --reverse`.chomp
+              git_logs[mod[:name]] = log_output unless log_output.strip.empty?
             end
+          end
 
-            if git_logs.empty?
-              puts( "No changes found for any components since #{refdate}")
-            else
-              page
+          if git_logs.empty?
+            puts("No changes found for any components since #{refdate}")
+          else
+            page
 
-              git_logs.keys.sort.each do |mod_name|
-                puts <<-EOM
+            git_logs.keys.sort.each do |mod_name|
+              puts <<-EOM
   ========
   #{mod_name}:
 
-  #{git_logs[mod_name].gsub(/^/,'  ')}
+  #{git_logs[mod_name].gsub(%r{^}, '  ')}
 
-                EOM
-              end
+              EOM
             end
           end
         end

data/lib/simp/rake/build/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/tasklib'
 require 'ruby-progressbar'
 require 'rake/clean'
@@ -5,22 +7,24 @@ require 'rake/clean'
 module Simp; end
 module Simp::Rake; end
 module Simp::Rake::Build; end
+
 class Simp::Rake::Build::Helpers
-  def initialize( dir = Dir.pwd )
-    Dir[ File.join(File.dirname(__FILE__),'*.rb') ].each do |rake_file|
+  def initialize(dir = Dir.pwd)
+    Dir[File.join(File.dirname(__FILE__), '*.rb')].sort.each do |rake_file|
       next if rake_file == __FILE__
+
       require rake_file
     end
-    Simp::Rake::Build::Auto.new( dir )
-    Simp::Rake::Build::Build.new( dir )
-    Simp::Rake::Build::Code.new( dir )
-    Simp::Rake::Build::Deps.new( dir )
-    Simp::Rake::Build::Iso.new( dir )
-    Simp::Rake::Build::Pkg.new( dir )
-    Simp::Rake::Build::Spec.new( dir )
-    Simp::Rake::Build::Tar.new( dir )
-    Simp::Rake::Build::Upload.new( dir )
-    Simp::Rake::Build::Unpack.new( dir )
-    Simp::Rake::Build::Clean.new( dir )
+    Simp::Rake::Build::Auto.new(dir)
+    Simp::Rake::Build::Build.new(dir)
+    Simp::Rake::Build::Code.new(dir)
+    Simp::Rake::Build::Deps.new(dir)
+    Simp::Rake::Build::Iso.new(dir)
+    Simp::Rake::Build::Pkg.new(dir)
+    Simp::Rake::Build::Spec.new(dir)
+    Simp::Rake::Build::Tar.new(dir)
+    Simp::Rake::Build::Upload.new(dir)
+    Simp::Rake::Build::Unpack.new(dir)
+    Simp::Rake::Build::Clean.new(dir)
   end
 end