simp-rake-helpers 5.11.1 → 5.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 842c7c807e886d28ecc77134d1737609a2bdf1086684437a7f9963ec925cc39c
-  data.tar.gz: feeb1ee8af97de4ad45ed94d845d6767f91a905b98c5f3923528196a4c966d18
+  metadata.gz: cd1fc58d4764acdc2a2160e63a50a2a16015c1dd2a41f7b530baad394d6a397e
+  data.tar.gz: 6f322c3850b40ff56c8aa49a86146a176311e999495ada8cc8270ecf806f2d81
 SHA512:
-  metadata.gz: 2ab96c058e9375634c96e5ef949f30880657397efc9b5ed5a49acbd6e575452d568468aa8a6410597a495a2c31a8fc692c3ba049aec11099c398875f184e5399
-  data.tar.gz: 82f08cfae6782f618c682f24c1bc699ea28300d34620d7cce68ab017e795399f577d5d46984098a9553e972f620fab8b60a1027b06ac3e0a95ba0a6c1708daf1
+  metadata.gz: d58adb8bae7eba07b696cbfd3add6ce335672a7ddc6d9063f6057ca3da8f23e5492d6cecb805afe13104f377fac3c16cc38a8925791eef9c3f2543017c609bcf
+  data.tar.gz: baaf3228b15df258dcdd6030f7fa95d995ac4a08cf735218cbc941543eef389c881f9f31bed619d605b230da154fee39353eabcebb9165cbb70f3b44b88e595a

data/.travis.yml

@@ -3,35 +3,16 @@ language: ruby
 cache: bundler
 sudo: false
 
-bundler_args: --without development system_tests
-
 notifications:
   email: false
 
-addons:
-  apt:
-    packages:
-      - rpm
-      # provides unbuffer
-      - expect-dev
-
-before_install:
-  - rm -f Gemfile.lock
-
 jobs:
   include:
-    - stage: spec
-      rvm: 2.5.1
-      script:
-        - bundle exec rake spec
-
-    - stage: acceptance
-      sudo: required
-      rvm: 2.5.1
-      services:
-        - docker
-      script:
-        - travis_wait 90 unbuffer bundle exec rake acceptance
+  ###  Testing on Travis CI is indefinitely disabled
+  ###
+  ###  See:
+  ###    * https://blog.travis-ci.com/2020-11-02-travis-ci-new-billing
+  ###    * https://simp-project.atlassian.net/browse/SIMP-8703
 
     - stage: deploy
       rvm: 2.5.1

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 5.11.6 / 2021-02-03
+* Fix GPG handling for GPG 2.1+
+
+### 5.11.5 / 2020-12-02
+* Add support for Puppet 7
+* Work around issues with querying RPM spec file changelogs using RPM version 4.15.0+
+* Switch between 'with_unbundled_env' and 'with_clean_env' based on which one
+  Bundler supports.
+
+### 5.11.4 / 2020-08-03
+* Permit *.md files in `rake pkg:compare_latest_tag`
+
+### 5.11.3 / 2020-05-19
+* Fix automatically added dependencies for SIMP 6.4+
+
+### 5.11.2 / 2020-04-08
+* Version information should not be required on dependencies in metadata.json
+
 ### 5.11.1 / 2020-04-07
 * Puppet module RPM logic handles `-rc0` suffix in `metadata.json`
 

data/Gemfile

@@ -2,7 +2,7 @@
 #
 # SIMP_GEM_SERVERS | a space/comma delimited list of rubygem servers
 # PUPPET_VERSION   | specifies the version of the puppet gem to load
-puppetversion = ENV.key?('PUPPET_VERSION') ? "#{ENV['PUPPET_VERSION']}" : '~> 5'
+puppetversion = ENV.key?('PUPPET_VERSION') ? "#{ENV['PUPPET_VERSION']}" : '~> 6'
 gem_sources   = ENV.key?('SIMP_GEM_SERVERS') ? ENV['SIMP_GEM_SERVERS'].split(/[, ]+/) : ['https://rubygems.org']
 
 gem_sources.each { |gem_source| source gem_source }
@@ -13,6 +13,10 @@ gem 'simp-build-helpers'
 gem 'simp-beaker-helpers'
 gem 'beaker-puppet_install_helper'
 gem 'rake', '>= 12.3.3'
+# You'll need the following if using podman until they are released upstream
+#gem 'beaker-docker', :git => 'https://github.com/trevor-vaughan/beaker-docker', :branch => 'support_rootless_podman'
+#gem 'docker-api', :git => 'https://github.com/trevor-vaughan/docker-api', :branch => 'podman-compat'
+gem 'beaker-docker'
 
 if puppetversion
   gem 'puppet', puppetversion

data/lib/simp/componentinfo.rb

@@ -139,6 +139,23 @@ class Simp::ComponentInfo
     if $?.exitstatus != 0
       fail("Could not extract changelog from #{rpm_spec_files[0]}." +
         " To debug, execute:\n   #{changelog_query}")
+    elsif raw_changelog.strip.empty?
+      changelog_lines = []
+
+      in_changelog = false
+      File.read(rpm_spec_files[0]).lines.each do |line|
+        changelog_lines << line if in_changelog
+
+        if line.start_with?('%')
+          if line.start_with?('%changelog')
+            in_changelog = true
+          else
+            in_changelog = false
+          end
+        end
+      end
+
+      raw_changelog = changelog_lines.join
     end
     @changelog = parse_changelog(raw_changelog, latest_version_only, verbose)
   end

data/lib/simp/local_gpg_signing_key.rb

@@ -78,6 +78,22 @@ module Simp
       @gpg_agent_script   = 'run_gpg_agent'
     end
 
+    # Return the version of GPG instealled on the system
+    #
+    # @return [Gem::Version]
+    def gpg_version
+      return @gpg_version if @gpg_version
+
+      which('gpg', true)
+      @gpg_version = %x{gpg --version}.lines.first.split(/\s+/).last
+
+      unless @gpg_version.nil? || @gpg_version.empty?
+        @gpg_version = Gem::Version.new(@gpg_version)
+      end
+
+      @gpg_version
+    end
+
     # Returns a gpg-agent's env string, if it can be detected from the
     #   gpg-agent-info file
     #
@@ -99,6 +115,8 @@ module Simp
     def dev_key_days_left
       ensure_gpg_directory
       days_left   = 0
+
+      which('gpg', true)
       current_key = %x(GPG_AGENT_INFO='' gpg --homedir=#{@dir} --list-keys #{@key_email} 2>/dev/null)
       unless current_key.empty?
         lasts_until = current_key.lines.first.strip.split("\s").last.delete(']')
@@ -138,33 +156,54 @@ module Simp
         write_gpg_agent_startup_script
 
         begin
-          # Start the GPG agent.
-          gpg_agent_output = %x(./#{@gpg_agent_script}).strip
-
-          # Provide a local socket (needed by the `gpg` command when
-          local_socket     = File.join(Dir.pwd, 'S.gpg-agent')
-
-          # This condition was handled differently in previous logic.
-          #
-          #   a.) As the surrounding logic works now, it will _always_ be a new
-          #       agent by this point, because the directory is cleaned out
-          #   b.) The agent's information will be read from the env-file it
-          #        writes at startup
-          #   c.) The old command `gpg-agent --homedir=#{Dir.pwd} /get serverpid`
-          #       did not work on EL6 or EL7.
-          #
-          warn(empty_gpg_agent_message) if gpg_agent_output.empty?
-
-          agent_info = gpg_agent_info
-
-          # The socket is useful to get back info on the command line.
-          unless File.exist?(File.join(Dir.pwd, File.basename(agent_info[:socket])))
-            ln_s(agent_info[:socket], local_socket, :verbose => @verbose)
+          if gpg_version < Gem::Version.new('2.1')
+            # Start the GPG agent.
+            gpg_agent_output = %x(./#{@gpg_agent_script}).strip
+
+            # Provide a local socket (needed by the `gpg` command when
+            local_socket = File.join(Dir.pwd, 'S.gpg-agent')
+
+            # This condition was handled differently in previous logic.
+            #
+            #   a.) As the surrounding logic works now, it will _always_ be a new
+            #       agent by this point, because the directory is cleaned out
+            #   b.) The agent's information will be read from the env-file it
+            #        writes at startup
+            #   c.) The old command `gpg-agent --homedir=#{Dir.pwd} /get serverpid`
+            #       did not work on EL6 or EL7.
+            #
+            warn(empty_gpg_agent_message) if gpg_agent_output.empty?
+
+            agent_info = gpg_agent_info
+
+            # The socket is useful to get back info on the command line.
+            unless File.exist?(File.join(Dir.pwd, File.basename(agent_info[:socket])))
+              ln_s(agent_info[:socket], local_socket, :verbose => @verbose)
+            end
+
+            generate_key(agent_info[:info])
+          else
+            which('gpg', true)
+            which('gpg-agent', true)
+            which('gpg-connect-agent', true)
+
+            # Start the GPG agent
+            %x{gpg-agent --homedir=#{Dir.pwd} >&/dev/null || gpg-agent --homedir=#{Dir.pwd} --daemon >&/dev/null}
+
+            agent_info = {}
+
+            # Provide a local socket (needed by the `gpg` command when
+            agent_info[:socket] = %x{echo 'GETINFO socket_name' | gpg-connect-agent --homedir=#{Dir.pwd}}.lines.first[1..-1].strip
+
+            # Get the pid
+            agent_info[:pid] = %x{echo 'GETINFO pid' | gpg-connect-agent --homedir=#{Dir.pwd}}.lines.first[1..-1].strip.to_i
+
+            generate_key(%{#{agent_info[:socket]}:#{agent_info[:pid]}:1})
           end
-          generate_key(agent_info[:info])
         ensure
           kill_agent(agent_info[:pid])
         end
+
         agent_info
       end
     end
@@ -209,11 +248,18 @@ module Simp
     # @param gpg_agent_info_str [String] value to set the GPG_AGENT_INFO
     #   environment variable to use in order to use the correct `gpg-agent`.
     def generate_key(gpg_agent_info_str)
+      which('gpg', true)
+
       puts "Generating new GPG key#{@verbose ? " under '#{@dir}'" : ''}..."
       gpg_cmd = %(GPG_AGENT_INFO=#{gpg_agent_info_str} gpg --homedir="#{@dir}")
+
       pipe    = @verbose ? '| tee' : '>'
       sh %(#{gpg_cmd} --batch --gen-key #{GPG_GENKEY_PARAMS_FILENAME})
       sh %(#{gpg_cmd} --armor --export #{@key_email} #{pipe} "#{@key_file}")
+
+      if File.stat(@key_file).size == 0
+        fail "Error: Something went wrong generating #{@key_file}"
+      end
     end
 
     # Return a data structure from a gpg-agent env-file formatted string.
@@ -232,38 +278,46 @@ module Simp
     def write_genkey_parameter_file
       now               = Time.now.to_i.to_s
       expire_date       = Date.today + 14
-      passphrase        = SecureRandom.base64(500)
-      genkey_parameters = <<-GENKEY_PARAMETERS.gsub(%r{^ {8}}, '')
-        %echo Generating Development GPG Key
-        %echo
-        %echo This key will expire on #{expire_date}
-        %echo
-        Key-Type: RSA
-        Key-Length: 4096
-        Key-Usage: sign
-        Name-Real: SIMP Development
-        Name-Comment: Development key #{now}
-        Name-Email: #{@key_email}
-        Expire-Date: 2w
-        Passphrase: #{passphrase}
-        %pubring pubring.gpg
-        %secring secring.gpg
-        # The following creates the key, so we can print "Done!" afterwards
-        %commit
-        %echo New GPG Development Key Created
-      GENKEY_PARAMETERS
-      File.open(GPG_GENKEY_PARAMS_FILENAME, 'w') { |fh| fh.puts(genkey_parameters) }
+      passphrase        = SecureRandom.base64(100)
+      genkey_parameters = [
+        '%echo Generating Development GPG Key',
+        '%echo',
+        "%echo This key will expire on #{expire_date}",
+        '%echo',
+        'Key-Type: RSA',
+        'Key-Length: 4096',
+        'Key-Usage: sign',
+        'Name-Real: SIMP Development',
+        "Name-Comment: Development key #{now}",
+        "Name-Email: #{@key_email}",
+        'Expire-Date: 2w',
+        "Passphrase: #{passphrase}",
+      ]
+
+      if gpg_version < Gem::Version.new('2.1')
+        genkey_parameters << '%pubring pubring.gpg'
+        genkey_parameters << '%secring secring.gpg'
+      end
+
+      genkey_parameters << '# The following creates the key, so we can print "Done!" afterwards'
+      genkey_parameters << '%commit'
+      genkey_parameters << '%echo New GPG Development Key Created'
+
+      File.open(GPG_GENKEY_PARAMS_FILENAME, 'w') { |fh| fh.puts(genkey_parameters.join("\n")) }
     end
 
     # Write a local gpg-agent daemon script file
     def write_gpg_agent_startup_script
+      which('gpg-agent', true)
+      pinentry_cmd = which('pinentry-curses', true)
+
       gpg_agent_script = <<-AGENT_SCRIPT.gsub(%r{^ {20}}, '')
         #!/bin/sh
 
         gpg-agent --homedir=#{Dir.pwd} --daemon \
           --no-use-standard-socket --sh --batch \
           --write-env-file "#{@gpg_agent_env_file}" \
-          --pinentry-program /usr/bin/pinentry-curses < /dev/null &
+          --pinentry-program #{pinentry_cmd} < /dev/null &
       AGENT_SCRIPT
 
       File.open(@gpg_agent_script, 'w') { |fh| fh.puts(gpg_agent_script) }

data/lib/simp/rake.rb

@@ -96,14 +96,21 @@ module Simp::Rake
     exec pager rescue exec "/bin/sh", "-c", pager
   end
 
-  # Originally snarfed from
-  # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
-  def which(cmd)
-    command = Facter::Core::Execution.which(cmd)
+  def which(cmd, fail=false)
+    @which_cache ||= {}
 
-    warn "Warning: Command #{cmd} not found on the system." unless command
+    if @which_cache.has_key?(cmd)
+      command = @which_cache[cmd]
+    else
+      command = Facter::Core::Execution.which(cmd)
+      @which_cache[cmd] = command
+    end
+
+    msg = "Warning: Command #{cmd} not found on the system."
+
+    fail ? raise(msg) : warn(msg) unless command
 
-    return command
+    command
   end
 
   def help

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

@@ -76,7 +76,8 @@ module Simp::Rake::Build
               #
               # Clean env will give bundler the environment present before
               # Bundler is activated.
-              ::Bundler.with_clean_env do
+              clean_env_method = Bundler.respond_to?(:with_unbundled_env) ? :with_unbundled_env : :with_clean_env
+              ::Bundler.send(clean_env_method) do
                 out = %x(bundle #{args[:action]} 2>&1)
                 status = $?.success?
                 puts out if verbose
@@ -94,6 +95,7 @@ module Simp::Rake::Build
         namespace :yum do
           task :prep do
             if $simp6
+              # `$simp6_build_dir` is set by the build:auto task
               @build_dir = $simp6_build_dir
 
               unless @build_dir
@@ -469,10 +471,10 @@ module Simp::Rake::Build
           ##############################################################################
 
           desc <<-EOM
-          Create a workspace for a new distribution.
+          Create a new yum directory tree for a new distribution.
 
-          Creates a YUM scaffold under
-          #{@build_dir}/yum_data/SIMP{:simp_version}_{:os}{:os_version}_{:arch}.
+          Creates a YUM directory tree under
+          {dist_build_dir}/yum_data/SIMP{:simp_version}_{:os}{:os_version}_{:arch}.
 
           * :os           - The Operating System that you wish to use.
                             Supported OSs: #{@target_dists}.join(', ')
@@ -482,31 +484,45 @@ module Simp::Rake::Build
                             Default: Auto
 
           * :arch         - The architecture that you support. Default: x86_64
+
+          Set ENV['SIMP_BUILD_yum_dir'] to override the path of {dist_build_dir}
+
+          Will not overwrite existing directories or package.yaml files
           EOM
-          task :scaffold,[:os,:os_version,:simp_version,:arch] => [:prep] do |t,args|
+          task :scaffold,[:os,:os_version,:simp_version,:arch] do |t,args|
             # @simp_version is set in the main Rakefile
             args.with_defaults(:simp_version => @simp_version.split('-').first)
             args.with_defaults(:arch => @build_arch)
 
-            target_dir = get_target_dir(args)
-
-            unless File.exist?(target_dir)
-              mkdir_p(target_dir)
-              puts("Created #{target_dir}")
-            end
-
-            # Put together the rest of the scaffold directories
-            Dir.chdir(@build_base_dir) do
-              if $simp6
-                mkdir('../my_repos') unless File.exist?('../my_repos')
-              else
-                mkdir('my_repos') unless File.exist?('my_repos')
-              end
-            end
-
-            Dir.chdir(target_dir) do
-              mkdir('repos') unless File.exist?('repos')
-              mkdir('packages') unless File.exist?('packages')
+            major_os_ver = args[:os_version].split('.').first
+            build_dir = distro_build_dir(
+              File.join(@base_dir,'build'), args[:os], major_os_ver, args[:arch]
+            )
+            build_dir = ENV['SIMP_BUILD_yum_dir'] if File.directory?(ENV['SIMP_BUILD_yum_dir'].to_s)
+            ENV['SIMP_BUILD_yum_dir'] ||= build_dir  # <-- for hacky :prep task
+
+            target_dir = File.join(build_dir,'yum_data')
+
+            # Create directories
+            my_repos = $simp6 ? '../my_repos' : 'my_repos'
+            [
+              target_dir,
+              File.join(target_dir,'repos'),
+              File.join(target_dir,'packages'),
+              File.expand_path(my_repos,target_dir)
+            ].each { |dir| mkdir_p(dir, verbose: false) }
+
+            # Create example packages.yaml
+            packages_yaml_path = File.join(target_dir, 'packages.yaml')
+            unless File.exists? packages_yaml_path
+              pkg = 'example-package-name'
+              pkg_file = "#{pkg}-1.0.0-1.el#{major_os_ver}.#{args[:arch]}.rpm"
+              yum_url = "https://yum.server/#{args[:os]}/#{major_os_ver}/#{args[:arch]}"
+              pkg_url = "#{yum_url}/#{pkg_file}"
+              yaml = { pkg => { rpm_name: pkg_file, source: pkg_url } }.to_yaml
+              File.open(packages_yaml_path,'w'){|f| f.puts yaml.gsub(/^/,'# ') }
+              puts "Created #{target_dir}"
+              puts "Created example file at #{packages_yaml_path}"
             end
           end
 
@@ -525,7 +541,7 @@ module Simp::Rake::Build
 
           * :arch         - The architecture that you support. Default: x86_64
           EOM
-          task :sync,[:os,:os_version,:simp_version,:arch] => [:prep, :scaffold] do |t,args|
+          task :sync,[:os,:os_version,:simp_version,:arch] => [:scaffold, :prep] do |t,args|
             # @simp_version is set in the main Rakefile
             args.with_defaults(:simp_version => @simp_version.split('-').first)
             args.with_defaults(:arch => @build_arch)
@@ -550,7 +566,7 @@ module Simp::Rake::Build
 
           * :arch         - The architecture that you support. Default: x86_64
           EOM
-          task :diff,[:os,:os_version,:simp_version,:arch] => [:prep, :scaffold] do |t,args|
+          task :diff,[:os,:os_version,:simp_version,:arch] => [:scaffold, :prep] do |t,args|
             args.with_defaults(:simp_version => @simp_version.split('-').first)
             args.with_defaults(:arch => @build_arch)
 
@@ -616,7 +632,7 @@ module Simp::Rake::Build
 
           * :arch         - The architecture that you support. Default: x86_64
           EOM
-          task :fetch,[:pkg,:os,:os_version,:simp_version,:arch] => [:prep, :scaffold] do |t,args|
+          task :fetch,[:pkg,:os,:os_version,:simp_version,:arch] => [:scaffold, :prep] do |t,args|
             args.with_defaults(:simp_version => @simp_version.split('-').first)
             args.with_defaults(:arch => @build_arch)