packaging 0.108.2 → 0.109.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3fd1a48b6b204c719549f2d857edefc600eb504da996e5ec68c0298a11734c0
-  data.tar.gz: 2ccdf98e53f9cea5aaa92346517679e5c468bcc32f6ed6f81c22144906f8b1fe
+  metadata.gz: 11bd7673d3f37ddab90b44202787f13882b390ffb4acbb858b3161166f0d2d0e
+  data.tar.gz: 4623cd4dd183c885ac2984fcb31d403629b2a8e1b294fade1ee918862a978f04
 SHA512:
-  metadata.gz: ef6517a8347b83b2adbe306302a4a6274a8854731b582f3ec0a1d1a7f6066e7655ad7bf953c40db9cdf359346068a4ebe4e0ebd9cb1cfac733533a1a7c27fe5f
-  data.tar.gz: e359e1e2c06be60e2cb668c2dd478cad89321e8bde6718968d697829dd6987d7800dde683c17325eb1c3be21470d8de497711da9f0610995ac7ea1aecde12697
+  metadata.gz: b495a1512b62e06c39405daaa6a89c09dcea8350006ef6321af2084f01e04b6c97dd41f80bb8ec8592d7b4fe875b1491ae5deee1b45b4bdb99b6888a586dfbee
+  data.tar.gz: f448461101f22184101346cddba0650932796d4dff63fc7ce716f13592c29ff1c417f5908226c3184095067c6aecb32dff6cf069d9274d701c5e559aa0e73079

data/README.md

@@ -1,7 +1,5 @@
 # Packaging
 
-[![Build Status](https://travis-ci.org/puppetlabs/packaging.png?branch=master)](https://travis-ci.org/puppetlabs/packaging)
-
 This is a repository for packaging automation for Puppet software.
 The goal is to abstract and automate packaging processes beyond individual
 software projects to a level where this repo can be cloned inside any project

data/lib/packaging/artifactory.rb

@@ -192,18 +192,23 @@ module Pkg
       properties_hash
     end
 
-    # Basic method to check if a package exists on artifactory
+    # Return a list of artifact paths for package. Returns empty array if none.
+    def artifact_paths(package)
+      check_authorization
+      Artifactory::Resource::Artifact.search(
+        name: File.basename(package),
+        artifactory_uri: @artifactory_uri
+      )
+    end
+
+    # Check if a package exists on artifactory
     # @param package [String] The full relative path to the package to be
     #   checked, relative from the current working directory
-    # Return true if package already exists on artifactory
+    # Return true if package already exists on artifactory.
+    # #artifact_paths, above, is more useful since it will inform where they are.
+    # This is kept for backward compatibility.
     def package_exists_on_artifactory?(package)
-      check_authorization
-      artifact = Artifactory::Resource::Artifact.search(name: File.basename(package), :artifactory_uri => @artifactory_uri)
-      if artifact.empty?
-        return false
-      else
-        return true
-      end
+      artifact_paths(package).any?
     end
 
     # @param package [String] The full relative path to the package to be
@@ -231,7 +236,7 @@ module Pkg
     # @return [String] The contents of the YAML file
     def retrieve_yaml_data(pkg, ref)
       yaml_url = "#{@artifactory_uri}/#{DEFAULT_REPO_TYPE}/#{DEFAULT_REPO_BASE}/#{pkg}/#{ref}/#{ref}.yaml"
-      URI.open(yaml_url, &:read)
+      URI.parse(yaml_url).read
     rescue StandardError
       raise "Failed to load YAML data for #{pkg} at #{ref} from #{yaml_url}!"
     end

data/lib/packaging/config/validations.rb

@@ -4,7 +4,7 @@ module Pkg
       # As a validation, this one is kindof lame but is intended as a seed pattern for possibly
       # more robust ones.
       def not_empty?(value)
-        value.to_s.empty? ? false : true
+        !value.to_s.empty?
       end
     end
   end

data/lib/packaging/config.rb

@@ -5,8 +5,8 @@ module Pkg
   #   have it set via accessors, and serialize it back to yaml for easy transport.
   #
   class Config
-    require 'packaging/config/params.rb'
-    require 'packaging/config/validations.rb'
+    require 'packaging/config/params'
+    require 'packaging/config/validations'
     require 'yaml'
 
     class << self
@@ -79,7 +79,7 @@ module Pkg
                           Pkg::Util::Net.check_host_ssh([self.builds_server]).empty?
 
         dir = "/opt/jenkins-builds/#{self.project}/#{self.ref}"
-        cmd = "if [ -s \"#{dir}/artifacts\" ]; then cd #{dir};"\
+        cmd = "if [ -s \"#{dir}/artifacts\" ]; then cd #{dir};" \
               "find ./artifacts -mindepth 2 -type f; fi"
         artifacts, = Pkg::Util::Net.remote_execute(
           self.builds_server,
@@ -132,12 +132,12 @@ module Pkg
 
           case package_format
           when 'deb'
-            repo_config = "../repo_configs/deb/pl-#{self.project}-#{self.ref}-"\
+            repo_config = "../repo_configs/deb/pl-#{self.project}-#{self.ref}-" \
                           "#{Pkg::Platforms.get_attribute(tag, :codename)}.list"
           when 'rpm'
             # Using original_tag here to not break legacy fedora repo targets
             unless tag.include? 'aix'
-              repo_config = "../repo_configs/rpm/pl-#{self.project}-"\
+              repo_config = "../repo_configs/rpm/pl-#{self.project}-" \
                             "#{self.ref}-#{original_tag}.repo"
             end
           when 'swix', 'svr4', 'ips', 'dmg', 'msi'

data/lib/packaging/deb/repo.rb

@@ -93,7 +93,7 @@ module Pkg::Deb::Repo
 
       artifact_paths.each do |path|
         platform_tag = Pkg::Paths.tag_from_artifact_path(path)
-        platform, version, = Pkg::Platforms. parse_platform_tag(platform_tag)
+        platform, version, = Pkg::Platforms.parse_platform_tag(platform_tag)
         codename = Pkg::Platforms.codename_for_platform_version(platform, version)
         arches = Pkg::Platforms.arches_for_codename(codename)
 
@@ -224,10 +224,10 @@ SignWith: #{Pkg::Config.gpg_key}"
 
       options << '--dry-run' if dryrun
       options << path
-      if !destination.nil?
-        options << "#{destination}:#{dest_path.parent}"
-      else
+      if destination.nil?
         options << dest_path.parent.to_s
+      else
+        options << "#{destination}:#{dest_path.parent}"
       end
       options.join("\s")
     end

data/lib/packaging/nuget.rb

@@ -23,7 +23,7 @@ module Pkg::Nuget
       form_data = ["-H 'Authorization: Basic #{authentication}'", "-f"]
       packages.each do |pkg|
         puts "Working on package #{pkg}"
-        projname, version = File.basename(pkg).match(/^(.*)-([\d+\.]+)\.nupkg$/).captures
+        projname, version = File.basename(pkg).match(/^(.*)-([\d+.]+)\.nupkg$/).captures
         package_form_data = ["--upload-file #{pkg}"]
         package_path = "#{projname}/#{version}/#{File.basename(pkg)}"
         stdout = ''

data/lib/packaging/paths.rb

@@ -23,7 +23,7 @@ module Pkg::Paths
   # Given a path to an artifact, divine the appropriate platform tag associated
   # with the artifact and path
   def tag_from_artifact_path(path)
-    platform = Pkg::Platforms.supported_platforms.find { |p| path =~ /(\/|\.)#{p}[^\.]/ }
+    platform = Pkg::Platforms.supported_platforms.find { |p| path =~ /(\/|\.)#{p}[^.]/ }
     platform = 'windowsfips' if path =~ /windowsfips/
 
     codename = Pkg::Platforms.codenames.find { |c| path =~ /\/#{c}/ }
@@ -318,7 +318,8 @@ module Pkg::Paths
 
     # For repos prior to puppet7, the puppet version was part of the repository
     # For example: /opt/repository/apt/pool/bionic/puppet6/p/puppet-agent
-    if %w[puppet7 puppet7-nightly
+    if %w[puppet8 puppet8-nightly
+          puppet7 puppet7-nightly
           puppet6 puppet6-nightly
           puppet5 puppet5-nightly
           puppet puppet-nightly
@@ -349,7 +350,7 @@ module Pkg::Paths
   def debian_component_from_path(path)
     # substitute '.' and '/' since those aren't valid characters for debian components
     matches = path.match(/(\d+\.\d+|master|main)\/(\w+)/)
-    regex_for_substitution = /[\.\/]/
+    regex_for_substitution = /[.\/]/
     fail "Error: Could not determine Debian Component from path #{path}" if matches.nil?
     base_component = matches[1]
     component_qualifier = matches[2]

data/lib/packaging/sign/msi.rb

@@ -66,14 +66,12 @@ module Pkg::Sign::Msi
 
     # Download the signed msis
     msis.each do |msi|
-      begin
-        signed_msi = signed_bucket.file(signed_msis[msi])
-        signed_msi.download(msi)
-      rescue StandardError => e
-        delete_tosign_msis(tosign_bucket, msis)
-        delete_signed_msis(signed_bucket, signed_msis)
-        fail "There was an error retrieving the signed msi:#{msi}.\n#{e}"
-      end
+      signed_msi = signed_bucket.file(signed_msis[msi])
+      signed_msi.download(msi)
+    rescue StandardError => e
+      delete_tosign_msis(tosign_bucket, msis)
+      delete_signed_msis(signed_bucket, signed_msis)
+      fail "There was an error retrieving the signed msi:#{msi}.\n#{e}"
     end
 
     # Cleanup buckets

data/lib/packaging/util/execution.rb

@@ -71,7 +71,7 @@ module Pkg::Util::Execution
             break
           rescue StandardError => err
             puts "An error was encountered evaluating block. Retrying.."
-            exception = err.to_s + "\n" + err.backtrace.join("\n")
+            exception = "#{err.to_s}\n#{err.backtrace.join("\n")}"
           end
         end
       else

data/lib/packaging/util/ezbake.rb

@@ -15,7 +15,7 @@ module Pkg::Util::EZbake
         )
       end
 
-      if File.exists?(ezbake_yaml)
+      if File.exist?(ezbake_yaml)
         FileUtils.cp(
           ezbake_yaml,
           File.join(target_directory, "#{Pkg::Config.ref}.ezbake.manifest.yaml")

data/lib/packaging/util/file.rb

@@ -58,7 +58,7 @@ module Pkg::Util::File
 
     def erb_string(erbfile, b = binding)
       template = File.read(erbfile)
-      message  = ERB.new(template, nil, "-")
+      message  = ERB.new(template, trim_mode: "-")
       message.result(b)
     end
 
@@ -98,7 +98,7 @@ module Pkg::Util::File
       Dir.chdir(Pkg::Config.project_root) do
         file_patterns.each do |pattern|
           if File.directory?(pattern) and !Pkg::Util::File.empty_dir?(pattern)
-            install << Dir[pattern + "/**/*"]
+            install << Dir["#{pattern}/**/*"]
           else
             install << Dir[pattern]
           end
@@ -146,8 +146,8 @@ module Pkg::Util::File
       team_data_branch = Pkg::Config.team
 
       if Pkg::Config.build_pe
-        project_data_branch = 'pe-' + project_data_branch unless project_data_branch =~ /^pe-/
-        team_data_branch = 'pe-' + team_data_branch unless team_data_branch =~ /^pe-/
+        project_data_branch = "pe-#{project_data_branch}" unless project_data_branch =~ /^pe-/
+        team_data_branch = "pe-#{team_data_branch}" unless team_data_branch =~ /^pe-/
       end
 
       # Remove .packaging directory from old-style extras loading
@@ -189,7 +189,6 @@ module Pkg::Util::File
     # PL Release team
     def load_extras(temp_directory)
       unless ENV['PARAMS_FILE'] && ENV['PARAMS_FILE'] != ''
-        temp_directory = temp_directory
         raise "load_extras requires a directory containing extras data" if temp_directory.nil?
         Pkg::Config.config_from_yaml("#{temp_directory}/#{Pkg::Config.builder_data_file}")
 
@@ -200,4 +199,3 @@ module Pkg::Util::File
     end
   end
 end
-

data/lib/packaging/util/net.rb

@@ -7,7 +7,7 @@ module Pkg::Util::Net
     def fetch_uri(uri, target)
       require 'open-uri'
       if Pkg::Util::File.file_writable?(File.dirname(target))
-        File.open(target, 'w') { |f| f.puts(URI.open(uri).read) }
+        File.open(target, 'w') { |f| f.puts(URI.parse(uri).read) }
       end
     end
 
@@ -33,11 +33,9 @@ module Pkg::Util::Net
     def check_host_ssh(hosts)
       errs = []
       Array(hosts).flatten.each do |host|
-        begin
-          remote_execute(host, 'exit', { extra_options: '-oBatchMode=yes' })
-        rescue StandardError
-          errs << host
-        end
+        remote_execute(host, 'exit', { extra_options: '-oBatchMode=yes' })
+      rescue StandardError
+        errs << host
       end
       return errs
     end
@@ -51,12 +49,10 @@ module Pkg::Util::Net
     def check_host_gpg(hosts, gpg)
       errs = []
       Array(hosts).flatten.each do |host|
-        begin
-          remote_execute(host, "gpg --list-secret-keys #{gpg} > /dev/null 2&>1",
-                         { extra_options: '-oBatchMode=yes' })
-        rescue StandardError
-          errs << host
-        end
+        remote_execute(host, "gpg --list-secret-keys #{gpg} > /dev/null 2&>1",
+                       { extra_options: '-oBatchMode=yes' })
+      rescue StandardError
+        errs << host
       end
       return errs
     end

data/lib/packaging/util/ship.rb

@@ -377,7 +377,7 @@ module Pkg::Util::Ship
       FileUtils.cp(ezbake_manifest, File.join(local_directory, "#{Pkg::Config.ref}.ezbake.manifest"))
     end
     ezbake_yaml = File.join("ext", "ezbake.manifest.yaml")
-    if File.exists?(ezbake_yaml)
+    if File.exist?(ezbake_yaml)
       FileUtils.cp(ezbake_yaml, File.join(local_directory, "#{Pkg::Config.ref}.ezbake.manifest.yaml"))
     end
 
@@ -478,7 +478,8 @@ module Pkg::Util::Ship
   def ship_to_artifactory(local_directory = 'pkg')
     Pkg::Util::File.fetch
     unless Pkg::Config.project
-      fail "You must set the 'project' in build_defaults.yaml or with the 'PROJECT_OVERRIDE' environment variable."
+      fail 'Project missing. Set it with the "project" key in build_defaults.yaml or ' \
+           'with the "PROJECT_OVERRIDE" environment variable.'
     end
     artifactory = Pkg::ManageArtifactory.new(Pkg::Config.project, Pkg::Config.ref)
 
@@ -492,14 +493,23 @@ module Pkg::Util::Ship
         a <=> b
       end
     end
+
     artifacts.each do |artifact|
-      if File.extname(artifact) == ".yaml" || File.extname(artifact) == ".json"
-        artifactory.deploy_package(artifact)
-      elsif artifactory.package_exists_on_artifactory?(artifact)
-        warn "Attempt to upload '#{artifact}' failed. Package already exists!"
-      else
+      # Always ship .yaml and .jsons even if they already exist
+      if %w[.yaml .json].include? File.extname(artifact)
         artifactory.deploy_package(artifact)
+        next
       end
+
+      # Warn against anything that already exists
+      existing = artifactory.artifact_paths(artifact)
+      if existing.any?
+        warn "Uploading '#{artifact}' to Artifactory refused. " \
+             "Package already exists here: #{existing.join(', ')}"
+        next
+      end
+
+      artifactory.deploy_package(artifact)
     end
   end
 end

data/lib/packaging/util/tool.rb

@@ -18,7 +18,7 @@ module Pkg::Util::Tool
           exts.each do |ext|
             locationext = File.expand_path(location + ext)
 
-            return '"' + locationext + '"' if FileTest.executable?(locationext)
+            return "\"#{locationext}\"" if FileTest.executable?(locationext)
           end
         end
 

data/lib/packaging/util/version.rb

@@ -93,7 +93,7 @@ module Pkg::Util::Version
       end
 
       if new_version.include?('dirty')
-        new_version = new_version.sub(/\.?dirty/, '') + 'dirty'
+        new_version = "#{new_version.sub(/\.?dirty/, '')}dirty"
       end
 
       new_version.split('-')
@@ -143,9 +143,11 @@ module Pkg::Util::Version
     #
     def versionbump(workdir = nil)
       version = ENV['VERSION'] || Pkg::Config.version.to_s.strip
-      new_version = '"' + version + '"'
+      new_version = "\"#{version}\""
 
+      # rubocop:disable Style/StringConcatenation
       version_file = "#{workdir ? workdir + '/' : ''}#{Pkg::Config.version_file}"
+      # rubocop:enable Style/StringConcatenation
 
       # Read the previous version file in...
       contents = IO.read(version_file)
@@ -160,7 +162,7 @@ module Pkg::Util::Version
       puts "Updating #{old_version} to #{new_version} in #{version_file}"
       if contents =~ /@DEVELOPMENT_VERSION@/
         contents.gsub!('@DEVELOPMENT_VERSION@', version)
-      elsif contents =~ /version\s*=\s*[\'"]DEVELOPMENT[\'"]/
+      elsif contents =~ /version\s*=\s*['"]DEVELOPMENT['"]/
         contents.gsub!(/version\s*=\s*['"]DEVELOPMENT['"]/, "version = '#{version}'")
       elsif contents =~ /VERSION = #{old_version}/
         contents.gsub!("VERSION = #{old_version}", "VERSION = #{new_version}")
@@ -179,8 +181,8 @@ module Pkg::Util::Version
     #
     # @param json_data [hash] json data hash containing the ref to check
     def report_json_tags(json_data)
-      puts 'component: ' + File.basename(json_data['url'])
-      puts 'ref: ' + json_data['ref'].to_s
+      puts "component: #{File.basename(json_data['url'])}"
+      puts "ref: #{json_data['ref'].to_s}"
       if Pkg::Util::Git.remote_tagged?(json_data['url'], json_data['ref'].to_s)
         tagged = 'Tagged? [ Yes ]'
       else