simp-rake-helpers 5.24.0 → 6.0.0

data/lib/simp/rpm.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 module Simp
@@ -23,7 +25,7 @@ module Simp
     end
 
     def self.rpm_cmd
-      @rpm_cmd ||= (ENV.fetch('SIMP_RPM_LUA_debug','no') =='yes') ? "rpm -D 'lua_debug 1'" : 'rpm'
+      @rpm_cmd ||= (ENV.fetch('SIMP_RPM_LUA_debug', 'no') == 'yes') ? "rpm -D 'lua_debug 1'" : 'rpm'
     end
 
     # Constructs a new Simp::RPM object. Requires the path to the spec file, or
@@ -44,7 +46,7 @@ module Simp
     #   apply when +rpm_source+ is an RPM spec file.
     # [rpm_name] The full name of the rpm
     def initialize(rpm_source)
-      @verbose = ENV.fetch('SIMP_RPM_verbose','no') =='yes'
+      @verbose = ENV.fetch('SIMP_RPM_verbose', 'no') == 'yes'
 
       update_rpmmacros
 
@@ -62,11 +64,11 @@ module Simp
 
       @packages = @info.keys
 
-      if @verbose
-        require 'pp'
-        puts "== Simp::RPM @packages"
-        puts @packages.pretty_inspect
-      end
+      return unless @verbose
+
+      require 'pp'
+      puts '== Simp::RPM @packages'
+      puts @packages.pretty_inspect
     end
 
     # @returns The RPM '.dist' of the system. 'nil' will be will be
@@ -77,72 +79,71 @@ module Simp
     def self.system_dist
       # We can only have one of these
       unless defined?(@@system_dist)
-        cmd  = %Q(#{rpm_cmd} -E '%{dist}' 2> /dev/null)
+        cmd  = %(#{rpm_cmd} -E '%{dist}' 2> /dev/null)
         if @verbose
-          puts "== Simp::RPM.system_dist"
+          puts '== Simp::RPM.system_dist'
           puts "   #{cmd} "
         end
-        dist = %x{#{cmd}}.strip.split('.')
+        dist = `#{cmd}`.strip.split('.')
         puts "  result = '#{dist}'" if @verbose
 
-        if dist.size > 1
-          @@system_dist = (dist[1] =~ /^\./) ? dist[1] : ('.' + dist[1])
-        else
-          @@system_dist = nil
-        end
-        puts "  @@system_dist = #{@@system_dist ||'nil'}" if @verbose
+        @@system_dist = if dist.size > 1
+                          (dist[1] =~ %r{^\.}) ? dist[1] : ('.' + dist[1])
+                        else
+                          nil
+                        end
+        puts "  @@system_dist = #{@@system_dist || 'nil'}" if @verbose
       end
 
-      return @@system_dist
+      @@system_dist
     end
 
     def system_dist
-      return Simp::RPM.system_dist
+      Simp::RPM.system_dist
     end
 
     # Work around the silliness with 'centos' being tacked onto things via the
     # 'dist' flag
     def update_rpmmacros
-      unless defined?(@@macros_updated)
+      return if defined?(@@macros_updated)
 
-        # Workaround for CentOS system builds
-        dist           = ENV['SIMP_RPM_dist'] || system_dist
-        dist_macro     = %(%dist #{dist})
-        rpmmacros      = [dist_macro]
-        rpmmacros_file = File.join(ENV['HOME'], '.rpmmacros')
+      # Workaround for CentOS system builds
+      dist           = ENV['SIMP_RPM_dist'] || system_dist
+      dist_macro     = %(%dist #{dist})
+      rpmmacros      = [dist_macro]
+      rpmmacros_file = File.join(Dir.home, '.rpmmacros')
 
-        if File.exist?(rpmmacros_file)
-          rpmmacros = File.read(rpmmacros_file).split("\n")
+      if File.exist?(rpmmacros_file)
+        rpmmacros = File.read(rpmmacros_file).split("\n")
 
-          dist_index = rpmmacros.each_index.select{|i| rpmmacros[i] =~ /^%dist\s+/}.first
+        dist_index = rpmmacros.each_index.find { |i| rpmmacros[i] =~ %r{^%dist\s+} }
 
-          if dist_index
-            rpmmacros[dist_index] = dist_macro
-          else
-            rpmmacros << dist_macro
-          end
+        if dist_index
+          rpmmacros[dist_index] = dist_macro
+        else
+          rpmmacros << dist_macro
         end
+      end
 
-        File.open(rpmmacros_file, 'w') do |fh|
-          fh.puts rpmmacros.join("\n")
-          fh.flush
-        end
+      File.open(rpmmacros_file, 'w') do |fh|
+        fh.puts rpmmacros.join("\n")
+        fh.flush
+      end
 
-        if @verbose
-          puts "== SIMP::RPM#update_rpmmacros:"
-          puts "   wrote to '#{rpmmacros_file}': "
-          puts "   #{'-'*20}"
-          puts rpmmacros.map{|x| "   #{x}\n"}.join
-          puts
-        end
-        @@macros_updated = true
+      if @verbose
+        puts '== SIMP::RPM#update_rpmmacros:'
+        puts "   wrote to '#{rpmmacros_file}': "
+        puts "   #{'-' * 20}"
+        puts rpmmacros.map { |x| "   #{x}\n" }.join
+        puts
       end
+      @@macros_updated = true
     end
 
     # @returns The name of the package (as it would be queried in yum)
     #
     # @fails if package is invalid
-    def basename(package=@packages.first)
+    def basename(package = @packages.first)
       valid_package?(package)
       @info[package][:basename]
     end
@@ -150,7 +151,7 @@ module Simp
     # @returns The version of the package
     #
     # @fails if package is invalid
-    def version(package=@packages.first)
+    def version(package = @packages.first)
       valid_package?(package)
       @info[package][:version]
     end
@@ -158,7 +159,7 @@ module Simp
     # @returns The release version of the package
     #
     # @fails if package is invalid
-    def release(package=@packages.first)
+    def release(package = @packages.first)
       valid_package?(package)
       @info[package][:release]
     end
@@ -166,14 +167,14 @@ module Simp
     # @returns The full version of the package: [version]-[release]
     #
     # @fails if package is invalid
-    def full_version(package=@packages.first)
+    def full_version(package = @packages.first)
       valid_package?(package)
       @info[package][:full_version]
     end
 
     # @returns The full name of the package: [basename]-[full_version]
     # @fails if package is invalid
-    def name(package=@packages.first)
+    def name(package = @packages.first)
       valid_package?(package)
       @info[package][:name]
     end
@@ -181,7 +182,7 @@ module Simp
     # @returns The machine architecture of the package
     #
     # @fails if package is invalid
-    def arch(package=@packages.first)
+    def arch(package = @packages.first)
       valid_package?(package)
       @info[package][:arch]
     end
@@ -191,7 +192,7 @@ module Simp
     #   object was derived from an RPM spec file.
     #
     # @fails if package is invalid
-    def signature(package=@packages.first)
+    def signature(package = @packages.first)
       valid_package?(package)
       @info[package][:signature]
     end
@@ -199,7 +200,7 @@ module Simp
     # @returns The full name of the RPM
     #
     # @fails if package is invalid
-    def rpm_name(package=@packages.first)
+    def rpm_name(package = @packages.first)
       valid_package?(package)
       @info[package][:rpm_name]
     end
@@ -207,7 +208,7 @@ module Simp
     # @returns Whether or not the package has a `dist` tag
     #
     # @fails if package is invalid
-    def has_dist_tag?(package=@packages.first)
+    def has_dist_tag?(package = @packages.first)
       valid_package?(package)
       @info[package][:has_dist_tag]
     end
@@ -217,7 +218,7 @@ module Simp
     # `dist`
     #
     # @fails if package is invalid
-    def dist(package=@packages.first)
+    def dist(package = @packages.first)
       valid_package?(package)
       @info[package][:dist]
     end
@@ -237,8 +238,8 @@ module Simp
       valid_package?(package)
       return true if other_rpm.nil? || other_rpm.empty?
 
-      unless other_rpm.match(%r(\.rpm$))
-        raise ArgumentError.new("You must pass valid RPM name! Got: '#{other_rpm}'")
+      unless %r{\.rpm$}.match?(other_rpm)
+        raise ArgumentError, "You must pass valid RPM name! Got: '#{other_rpm}'"
       end
 
       if File.readable?(other_rpm)
@@ -246,38 +247,36 @@ module Simp
       else
         # determine RPM info in a hacky way, ASSUMING, the other RPM has the
         # same basename and arch
-        other_full_version = other_rpm.gsub(/#{package}\-/,'').gsub(/.rpm$/,'')
+        other_full_version = other_rpm.gsub(%r{#{package}-}, '').gsub(%r{.rpm$}, '')
         package_arch = arch(package)
-        unless package_arch.nil? or package_arch.empty?
-          other_full_version.gsub!(/.#{package_arch}/,'')
+        unless package_arch.nil? || package_arch.empty?
+          other_full_version.gsub!(%r{.#{package_arch}}, '')
         end
       end
 
       begin
-
-        return Gem::Version.new(full_version(package)) > Gem::Version.new(other_full_version)
-
+        Gem::Version.new(full_version(package)) > Gem::Version.new(other_full_version)
       rescue ArgumentError, NoMethodError
-        fail("Could not compare RPMs '#{rpm_name(package)}' and '#{other_rpm}'")
+        raise("Could not compare RPMs '#{rpm_name(package)}' and '#{other_rpm}'")
       end
     end
 
     def valid_package?(package)
-      unless @packages.include?(package)
-        raise ArgumentError.new("'#{package}' is not a valid sub-package")
-      end
+      return false if @packages.include?(package)
+
+      raise ArgumentError, "'#{package}' is not a valid sub-package"
     end
 
     # Copies specific content from one directory to another.
     # start_dir:: the root directory where the original files are located within
     # src:: a pattern given to find(1) to match against the desired files to copy
     # dest:: the destination directory to receive the copies
-    def self.copy_wo_vcs(start_dir, src, dest, dereference=true)
-      if dereference.nil? || dereference
-        dereference = "--dereference"
-      else
-        dereference = ""
-      end
+    def self.copy_wo_vcs(start_dir, src, dest, dereference = true)
+      dereference = if dereference.nil? || dereference
+                      '--dereference'
+                    else
+                      ''
+                    end
 
       Dir.chdir(start_dir) do
         sh %{find #{src} \\( -path "*/.svn" -a -type d -o -path "*/.git*" \\) -prune -o -print | cpio -u --warning none --quiet --make-directories #{dereference} -p "#{dest}" 2>&1 > /dev/null}
@@ -288,33 +287,33 @@ module Simp
     # stdout output and stderr output.
     # cmd:: command to be executed
     def self.execute(cmd)
-      if @verbose ||= ENV.fetch('SIMP_RPM_verbose','no') =='yes'
+      if @verbose ||= ENV.fetch('SIMP_RPM_verbose', 'no') == 'yes'
         puts "== Simp::RPM.execute(#{cmd})"
         puts "  #{cmd}"
       end
 
-      outfile = File.join('/tmp', "#{ENV['USER']}_#{SecureRandom.hex}")
-      errfile = File.join('/tmp', "#{ENV['USER']}_#{SecureRandom.hex}")
-      pid = spawn(cmd, :out=>outfile, :err=>errfile)
+      outfile = File.join('/tmp', "#{ENV.fetch('USER', nil)}_#{SecureRandom.hex}")
+      errfile = File.join('/tmp', "#{ENV.fetch('USER', nil)}_#{SecureRandom.hex}")
+      pid = spawn(cmd, :out => outfile, :err => errfile)
 
       begin
-        pid,status = Process.wait2(pid)
+        _, status = Process.wait2(pid)
       rescue Errno::ECHILD
         # process exited before status could be determined
       end
 
-      exit_status = status.nil? ? nil : status.exitstatus
-      stdout = IO.read(outfile)
-      stderr = IO.read(errfile)
+      exit_status = status&.exitstatus
+      stdout = File.read(outfile)
+      stderr = File.read(errfile)
 
       { :exit_status => exit_status, :stdout => stdout, :stderr => stderr }
     ensure
       if @verbose
         puts "    -------- exit_status: #{exit_status}"
-        puts "    -------- stdout ",''
-        puts File.readlines(outfile).map{|x| "    #{x}"}.join
-        puts '',"    -------- stderr ",''
-        puts File.readlines(errfile).map{|x| "    #{x}"}.join
+        puts '    -------- stdout ', ''
+        puts File.readlines(outfile).map { |x| "    #{x}" }.join
+        puts '', '    -------- stderr ', ''
+        puts File.readlines(errfile).map { |x| "    #{x}" }.join
       end
       FileUtils.rm_f([outfile, errfile])
     end
@@ -347,49 +346,48 @@ module Simp
     def self.get_info(rpm_source)
       raise "Error: unable to read '#{rpm_source}'" unless File.readable?(rpm_source)
 
-      if ENV['SIMP_RPM_dist']
-        target_dist = (ENV['SIMP_RPM_dist'] =~ /^\./) ? ENV['SIMP_RPM_dist'] : ('.' + ENV['SIMP_RPM_dist'])
-      else
-        target_dist = system_dist
-      end
+      target_dist = if ENV['SIMP_RPM_dist']
+                      (ENV.fetch('SIMP_RPM_dist', nil) =~ %r{^\.}) ? ENV.fetch('SIMP_RPM_dist', nil) : ('.' + ENV.fetch('SIMP_RPM_dist', nil))
+                    else
+                      system_dist
+                    end
 
       info_array = []
       common_info = {}
 
-      rpm_version_query = %Q(#{rpm_cmd} -q --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\\n')
+      rpm_version_query = %(#{rpm_cmd} -q --queryformat '%{NAME} %{VERSION} %{RELEASE} %{ARCH}\\n')
 
-      rpm_signature_query = %Q(#{rpm_cmd} -q --queryformat '%|DSAHEADER?{%{DSAHEADER:pgpsig}}:{%|RSAHEADER?{%{RSAHEADER:pgpsig}}:{%|SIGGPG?{%{SIGGPG:pgpsig}}:{%|SIGPGP?{%{SIGPGP:pgpsig}}:{(none)}|}|}|}|\\n')
+      rpm_signature_query = %(#{rpm_cmd} -q --queryformat '%|DSAHEADER?{%{DSAHEADER:pgpsig}}:{%|RSAHEADER?{%{RSAHEADER:pgpsig}}:{%|SIGGPG?{%{SIGGPG:pgpsig}}:{%|SIGPGP?{%{SIGPGP:pgpsig}}:{(none)}|}|}|}|\\n') # rubocop:disable Layout/LineLength
 
       source_is_rpm = rpm_source.split('.').last == 'rpm'
       if source_is_rpm
         dist_info = rpm_source.split('-').last.split('.')[1..-3]
 
-        unless dist_info.empty?
-          common_info[:has_dist_tag] = true
-          common_info[:dist] = '.' + dist_info.first
-        else
+        if dist_info.empty?
           common_info[:has_dist_tag] = false
           common_info[:dist] = target_dist
+        else
+          common_info[:has_dist_tag] = true
+          common_info[:dist] = '.' + dist_info.first
         end
       elsif File.read(rpm_source).include?('%{?dist}')
-        common_info[:dist] =target_dist
+        common_info[:dist] = target_dist
         common_info[:has_dist_tag] = true
       else
         common_info[:has_dist_tag] = false
-        common_info[:dist]     = target_dist
+        common_info[:dist] = target_dist
       end
 
       unless source_is_rpm
         macros = {
           'dist' => target_dist
         }
-        macros.each do |k,v|
-          rpm_version_query += %Q[ -D '#{k} #{v}']
+        macros.each do |k, v|
+          rpm_version_query += %( -D '#{k} #{v}')
         end
 
       end
 
-
       if source_is_rpm
         query_source = "-p #{rpm_source}"
         version_results = execute("#{rpm_version_query} #{query_source}")
@@ -404,28 +402,26 @@ module Simp
         raise <<~EOE
           #{indent('Error getting RPM info for #{query_source}:', 2)}
           #{indent(version_results[:stderr].strip, 5)}
-          #{indent("Run '#{rpm_version_query.gsub("\n",'\\n')} #{query_source}' to recreate the issue.", 2)}
+          #{indent("Run '#{rpm_version_query.gsub("\n", '\\n')} #{query_source}' to recreate the issue.", 2)}
         EOE
       end
 
       unless signature_results.nil?
-        if signature_results[:exit_status] != 0
-          raise <<~EOE
+        raise <<~EOE if signature_results[:exit_status] != 0
             #{indent('Error getting RPM signature for #{query_source}:', 2)}
             #{indent(signature_results[:stderr].strip, 5)}
-            #{indent("Run '#{rpm_signature_query.gsub("\n",'\\n')} #{query_source}' to recreate the issue.", 2)}
-          EOE
-       else
-         signature = signature_results[:stdout].strip
-       end
+            #{indent("Run '#{rpm_signature_query.gsub("\n", '\\n')} #{query_source}' to recreate the issue.", 2)}
+        EOE
+
+        signature = signature_results[:stdout].strip
       end
 
       version_results[:stdout].strip.lines.each do |line|
         info = common_info.dup
-        parts = line.split(' ')
+        parts = line.split
 
         info[:basename], info[:version], info[:release], info[:arch] = parts
-        info[:signature]    = signature unless signature.nil? or signature.include?('none')
+        info[:signature]    = signature unless signature.nil? || signature.include?('none')
         info[:full_version] = "#{info[:version]}-#{info[:release]}"
         info[:name]         = "#{info[:basename]}-#{info[:full_version]}"
         info[:rpm_name]     = "#{info[:name]}.#{info[:arch]}.rpm"
@@ -434,35 +430,35 @@ module Simp
       end
 
       if @verbose
-        puts "== SIMP::RPM.get_info"
+        puts '== SIMP::RPM.get_info'
         require 'pp'
         pp info_array
       end
 
       if info_array.size == 1
-        return info_array[0]
+        info_array[0]
       else
         # will only happen when source is spec file and that spec file
         # specifies sub-packages
-        return info_array
+        info_array
       end
     end
 
     def self.indent(message, indent_length)
-       message.split("\n").map {|line| ' '*indent_length + line }.join("\n")
+      message.split("\n").map { |line| (' ' * indent_length) + line }.join("\n")
     end
 
-    def self.create_rpm_build_metadata(project_dir, srpms=nil, rpms=nil)
+    def self.create_rpm_build_metadata(project_dir, srpms = nil, rpms = nil)
       require 'yaml'
 
       last_build = {
-        'git_hash' => %x(git rev-list --max-count=1 HEAD).chomp,
-        'srpms'    => {},
-        'rpms'     => {}
+        'git_hash' => `git rev-list --max-count=1 HEAD`.chomp,
+        'srpms' => {},
+        'rpms' => {}
       }
 
       Dir.chdir(File.join(project_dir, 'dist')) do
-        if srpms.nil? or rpms.nil?
+        if srpms.nil? || rpms.nil?
           all_rpms = Dir.glob('*.rpm')
           srpms = Dir.glob('src.rpm')
           rpms = all_rpms - srpms
@@ -472,10 +468,10 @@ module Simp
           file_stat = File.stat(srpm)
 
           last_build['srpms'][File.basename(srpm)] = {
-            'metadata'  => Simp::RPM.get_info(srpm),
-            'size'      => file_stat.size,
+            'metadata' => Simp::RPM.get_info(srpm),
+            'size' => file_stat.size,
             'timestamp' => file_stat.ctime,
-            'path'      => File.absolute_path(srpm)
+            'path' => File.absolute_path(srpm)
           }
         end
 
@@ -484,14 +480,14 @@ module Simp
 
           last_build['rpms'][File.basename(rpm)] = {
             'metadata' => Simp::RPM.get_info(rpm),
-            'size'      => file_stat.size,
+            'size' => file_stat.size,
             'timestamp' => file_stat.ctime,
-            'path'     => File.absolute_path(rpm)
-           }
+            'path' => File.absolute_path(rpm)
+          }
         end
 
         FileUtils.mkdir_p(File.join(project_dir, 'dist', 'logs'))
-        File.open('logs/last_rpm_build_metadata.yaml','w') do |fh|
+        File.open('logs/last_rpm_build_metadata.yaml', 'w') do |fh|
           fh.puts(last_build.to_yaml)
         end
       end
@@ -499,7 +495,7 @@ module Simp
 
     # Returns the version of RPM installed on the system
     def self.version
-      %x{rpm --version}.strip.split.last
+      `rpm --version`.strip.split.last
     end
   end
 end