vanagon 0.16.0 → 0.19.0

data/lib/vanagon/engine/docker.rb

@@ -1,4 +1,5 @@
 require 'vanagon/engine/base'
+require 'vanagon/logger'
 
 class Vanagon
   class Engine
@@ -52,7 +53,7 @@ class Vanagon
         Vanagon::Utilities.ex("#{@docker_cmd} stop #{build_host_name}-builder")
         Vanagon::Utilities.ex("#{@docker_cmd} rm #{build_host_name}-builder")
       rescue Vanagon::Error => e
-        warn "There was a problem tearing down the docker container #{build_host_name}-builder (#{e.message})."
+        VanagonLogger.error "There was a problem tearing down the docker container #{build_host_name}-builder (#{e.message})."
       end
 
       def dispatch(command, return_output = false)

data/lib/vanagon/engine/ec2.rb

@@ -2,6 +2,7 @@ require 'aws-sdk'
 require 'erb'
 require 'base64'
 require 'vanagon/engine/base'
+require 'vanagon/logger'
 
 class Vanagon
   class Engine
@@ -57,17 +58,17 @@ class Vanagon
       end
 
       def select_target
-        warn "Instance created id: #{instance.id}"
-        warn "Created instance waiting for status ok"
+        VanagonLogger.info "Instance created id: #{instance.id}"
+        VanagonLogger.info "Created instance waiting for status ok"
         @ec2.wait_until(:instance_status_ok, instance_ids: [instance.id])
-        warn "Instance running"
+        VanagonLogger.info "Instance running"
         @target = instance.private_ip_address
       rescue ::Aws::Waiters::Errors::WaiterFailed => error
         fail "Failed to wait for ec2 instance to start got error #{error}"
       end
 
       def teardown
-        warn "Destroying instance on AWS id: #{instance.id}"
+        VanagonLogger.info "Destroying instance on AWS id: #{instance.id}"
         instances.batch_terminate!
       end
     end

data/lib/vanagon/engine/hardware.rb

@@ -1,4 +1,5 @@
 require 'vanagon/engine/base'
+require 'vanagon/logger'
 require 'json'
 require 'lock_manager'
 
@@ -23,7 +24,7 @@ class Vanagon
         Vanagon::Driver.logger.info "Polling for a lock on #{host}."
         @lockman.polling_lock(host, VANAGON_LOCK_USER, "Vanagon automated lock")
         Vanagon::Driver.logger.info "Lock acquired on #{host}."
-        warn "Lock acquired on #{host} for #{VANAGON_LOCK_USER}."
+        VanagonLogger.info "Lock acquired on #{host} for #{VANAGON_LOCK_USER}."
         host
       end
 
@@ -33,7 +34,7 @@ class Vanagon
           Vanagon::Driver.logger.info "Attempting  to lock #{h}."
           if @lockman.lock(h, VANAGON_LOCK_USER, "Vanagon automated lock")
             Vanagon::Driver.logger.info "Lock acquired on #{h}."
-            warn "Lock acquired on #{h} for #{VANAGON_LOCK_USER}."
+            VanagonLogger.info "Lock acquired on #{h} for #{VANAGON_LOCK_USER}."
             return h
           end
         end
@@ -45,7 +46,7 @@ class Vanagon
       # complete. In this case, we'll attempt to unlock the hardware
       def teardown
         Vanagon::Driver.logger.info "Removing lock on #{@target}."
-        warn "Removing lock on #{@target}."
+        VanagonLogger.info "Removing lock on #{@target}."
         @lockman.unlock(@target, VANAGON_LOCK_USER)
       end
 

data/lib/vanagon/engine/pooler.rb

@@ -1,6 +1,11 @@
 require 'vanagon/engine/base'
+require 'vanagon/logger'
 require 'yaml'
 
+### Note this class is deprecated in favor of using the ABS Engine. The pooler has changed it's API with regards to
+# getting VMs for ondemand provisioning and would need to be updated here.
+# See DIO-1066
+
 class Vanagon
   class Engine
     class Pooler < Base
@@ -10,7 +15,7 @@ class Vanagon
       def initialize(platform, target = nil, **opts)
         super
 
-        @available_poolers = ["http://vmpooler.delivery.puppetlabs.net", "https://nspooler-service-prod-1.delivery.puppetlabs.net"]
+        @available_poolers = ["https://vmpooler.delivery.puppetlabs.net", "https://nspooler-service-prod-1.delivery.puppetlabs.net"]
         @token = load_token
         @required_attributes << "vmpooler_template"
       end
@@ -56,26 +61,26 @@ class Vanagon
         absolute_path = File.expand_path(path)
         return nil unless File.exist?(absolute_path)
 
-        warn "Reading vmpooler token from: #{path}"
+        VanagonLogger.info "Reading vmpooler token from: #{path}"
         File.read(absolute_path).chomp
       end
       private :read_vanagon_token
 
       # Read a vmpooler token from the yaml formatted vmfloaty config,
       # as outlined by the vmfloaty project:
-      # https://github.com/briancain/vmfloaty
+      # https://github.com/puppetlabs/vmfloaty
       #
       # @return [String, nil] the vmfloaty vmpooler token value
       def read_vmfloaty_token(path = "~/.vmfloaty.yml")
         absolute_path = File.expand_path(path)
         return nil unless File.exist?(absolute_path)
 
-        warn "Reading vmpooler token from: #{path}"
+        VanagonLogger.info "Reading vmpooler token from: #{path}"
         YAML.load_file(absolute_path)['token']
       end
       private :read_vmfloaty_token
 
-      # This method is used to obtain a vm to build upon using the Puppet Labs'
+      # This method is used to obtain a vm to build upon using Puppet's internal
       # vmpooler (https://github.com/puppetlabs/vmpooler) or other pooler technologies
       # leveraging the same API
       # @raise [Vanagon::Error] if a target cannot be obtained
@@ -141,14 +146,14 @@ class Vanagon
         )
         if response and response["ok"]
           Vanagon::Driver.logger.info "#{@target} has been destroyed"
-          warn "#{@target} has been destroyed"
+          VanagonLogger.info "#{@target} has been destroyed"
         else
           Vanagon::Driver.logger.info "#{@target} could not be destroyed"
-          warn "#{@target} could not be destroyed"
+          VanagonLogger.info "#{@target} could not be destroyed"
         end
       rescue Vanagon::Error => e
         Vanagon::Driver.logger.info "#{@target} could not be destroyed (#{e.message})"
-        warn "#{@target} could not be destroyed (#{e.message})"
+        VanagonLogger.error "#{@target} could not be destroyed (#{e.message})"
       end
     end
   end

data/lib/vanagon/environment.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require 'vanagon/extensions/string'
+require 'vanagon/logger'
 
 class Vanagon
   # Environment is a validating wrapper around a delegated Hash,
@@ -147,7 +148,7 @@ class Vanagon
         update your project's parameters.
       WARNING
 
-      warn warning.join("\n")
+      VanagonLogger.info warning.join("\n")
       str.gsub(pattern, '$(shell \1)')
     end
     private :sanitize_subshells
@@ -165,7 +166,7 @@ class Vanagon
         update your project's parameters.
       WARNING
 
-      warn warning.join("\n")
+      VanagonLogger.info warning.join("\n")
       str.gsub(pattern, '$(\1)')
     end
     private :sanitize_variables

data/lib/vanagon/logger.rb

@@ -0,0 +1,31 @@
+require 'logger'
+
+class VanagonLogger < ::Logger
+  def self.logger
+    @@logger ||= VanagonLogger.new
+  end
+
+  def self.debug_logger
+    @@debug_logger ||= VanagonLogger.new(STDERR)
+  end
+
+  def self.info(msg)
+    VanagonLogger.debug_logger.info msg
+  end
+
+  def self.warn(msg)
+    VanagonLogger.logger.warn msg
+  end
+
+  def self.error(msg)
+    VanagonLogger.logger.error msg
+  end
+
+  def initialize(output = STDOUT)
+    super(output)
+    self.level = ::Logger::INFO
+    self.formatter = proc do |severity, datetime, progname, msg|
+      "#{msg}\n"
+    end
+  end
+end

data/lib/vanagon/platform.rb

@@ -1,6 +1,7 @@
 require 'vanagon/environment'
 require 'vanagon/platform/dsl'
 require 'vanagon/utilities'
+require 'vanagon/logger'
 
 class Vanagon
   class Platform
@@ -152,9 +153,9 @@ class Vanagon
       dsl.instance_eval(File.read(platfile), platfile, 1)
       dsl._platform
     rescue StandardError => e
-      warn "Error loading platform '#{name}' using '#{platfile}':"
-      warn e
-      warn e.backtrace.join("\n")
+      VanagonLogger.error "Error loading platform '#{name}' using '#{platfile}':"
+      VanagonLogger.error(e)
+      VanagonLogger.error e.backtrace.join("\n")
       raise e
     end
 
@@ -401,7 +402,7 @@ class Vanagon
     # @deprecated Please use is_macos? instead
     # @return [true, false] true if it is an osx variety, false otherwise
     def is_osx?
-      warn "is_osx? is a deprecated method, please use #is_macos? instead."
+      VanagonLogger.info "is_osx? is a deprecated method, please use #is_macos? instead."
       is_macos?
     end
 
@@ -539,7 +540,7 @@ class Vanagon
       match = version_string.match(VERSION_REGEX)
 
       if match.nil?
-        warn "Passing a version without an operator is deprecated!"
+        VanagonLogger.info "Passing a version without an operator is deprecated!"
         operator = default
         version = version_string
       end

data/lib/vanagon/platform/deb.rb

@@ -13,6 +13,8 @@ class Vanagon
           copy_extensions = '*.deb'
         end
         pkg_arch_opt = project.noarch ? "" : "-a#{@architecture}"
+        pkg_arch_opt = '-aarm64' if pkg_arch_opt == '-aaarch64'
+
         ["mkdir -p output/#{target_dir}",
         "mkdir -p $(tempdir)/#{project.name}-#{project.version}",
         "cp #{project.name}-#{project.version}.tar.gz $(tempdir)/#{project.name}_#{project.version}.orig.tar.gz",

data/lib/vanagon/platform/dsl.rb

@@ -8,6 +8,7 @@ require 'vanagon/platform/osx'
 require 'vanagon/platform/solaris_10'
 require 'vanagon/platform/solaris_11'
 require 'vanagon/platform/windows'
+require 'vanagon/logger'
 require 'securerandom'
 require 'uri'
 
@@ -259,7 +260,7 @@ class Vanagon
       # @param name [String] name that the pooler uses for this platform
       # @deprecated Please use vmpooler_template instead, this will be removed in a future vanagon release.
       def vcloud_name(cloud_name)
-        warn "vcloud_name is a deprecated platform DSL method, and will be removed in a future vanagon release. Please use vmpooler_template instead."
+        VanagonLogger.info "vcloud_name is a deprecated platform DSL method, and will be removed in a future vanagon release. Please use vmpooler_template instead."
         self.vmpooler_template(cloud_name)
       end
 
@@ -394,7 +395,7 @@ class Vanagon
       # @param gpg_key [String] optional gpg key to be fetched via curl and installed
       # @deprecated Please use the add_build_repository DSL method instead. apt_repo will be removed in a future vanagon release.
       def apt_repo(definition, gpg_key = nil)
-        warn "Please use the add_build_repository DSL method instead. apt_repo will be removed in a future vanagon release."
+        VanagonLogger.info "Please use the add_build_repository DSL method instead. apt_repo will be removed in a future vanagon release."
         self.add_build_repository(definition, gpg_key)
       end
 
@@ -403,7 +404,7 @@ class Vanagon
       # @param definition [String] the repo setup URI or RPM file
       # @deprecated Please use the add_build_repository DSL method instead. yum_repo will be removed in a future vanagon release.
       def yum_repo(definition)
-        warn "Please use the add_build_repository DSL method instead. yum_repo will be removed in a future vanagon release."
+        VanagonLogger.info "Please use the add_build_repository DSL method instead. yum_repo will be removed in a future vanagon release."
         self.add_build_repository(definition)
       end
 
@@ -412,7 +413,7 @@ class Vanagon
       # @param definition [String] the repo setup URI or RPM file
       # @deprecated Please use the add_build_repository DSL method instead. zypper_repo will be removed in a future vanagon release.
       def zypper_repo(definition)
-        warn "Please use the add_build_repository DSL method instead. zypper_repo will be removed in a future vanagon release."
+        VanagonLogger.info "Please use the add_build_repository DSL method instead. zypper_repo will be removed in a future vanagon release."
         self.add_build_repository(definition)
       end
 

data/lib/vanagon/platform/windows.rb

@@ -1,3 +1,5 @@
+require 'vanagon/logger'
+
 class Vanagon
   class Platform
     class Windows < Vanagon::Platform
@@ -231,7 +233,7 @@ class Vanagon
               ]
             end
           rescue RuntimeError
-            warn "Unable to connect to #{project.signing_username}@#{project.signing_hostname}, skipping signing extra files: #{project.extra_files_to_sign.join(',')}"
+            VanagonLogger.error "Unable to connect to #{project.signing_username}@#{project.signing_hostname}, skipping signing extra files: #{project.extra_files_to_sign.join(',')}"
           end
         end
         make_commands << [

data/lib/vanagon/project.rb

@@ -1,5 +1,6 @@
 require 'vanagon/component'
 require 'vanagon/environment'
+require 'vanagon/logger'
 require 'vanagon/platform'
 require 'vanagon/project/dsl'
 require 'vanagon/utilities'
@@ -130,9 +131,9 @@ class Vanagon
       dsl.instance_eval(File.read(projfile), projfile, 1)
       dsl._project
     rescue StandardError => e
-      warn "Error loading project '#{name}' using '#{projfile}':"
-      warn e
-      warn e.backtrace.join("\n")
+      VanagonLogger.error "Error loading project '#{name}' using '#{projfile}':"
+      VanagonLogger.error(e)
+      VanagonLogger.error e.backtrace.join("\n")
       raise e
     end
 
@@ -296,10 +297,14 @@ class Vanagon
     #
     # @return [Array] array of runtime requirements for the project
     def get_requires
-      req = []
-      req << components.flat_map(&:requires)
-      req << @requires
-      req.flatten.uniq
+      requires = []
+      requires << @requires.flatten
+      requires << components.flat_map(&:requires)
+      requires.flatten!
+      requires.each do |requirement|
+        requirement.version = @platform.version_munger(requirement.version, default: '<') if requirement.version
+      end
+      requires.uniq
     end
 
     # Collects all of the replacements for the project and its components
@@ -307,8 +312,8 @@ class Vanagon
     # @return [Array] array of package level replacements for the project
     def get_replaces
       replaces = []
-      replaces.push @replaces.flatten
-      replaces.push components.flat_map(&:replaces)
+      replaces << @replaces.flatten
+      replaces << components.flat_map(&:replaces)
       replaces.flatten!
       replaces.each do |replace|
         # TODO: Make this a more reasonable default before 1.0.0
@@ -324,8 +329,9 @@ class Vanagon
 
     # Collects all of the conflicts for the project and its components
     def get_conflicts
-      conflicts = components.flat_map(&:conflicts) + @conflicts
-      # Mash the whole thing down into a flat Array
+      conflicts = []
+      conflicts << @conflicts.flatten
+      conflicts << components.flat_map(&:conflicts)
       conflicts.flatten!
       conflicts.each do |conflict|
         # TODO: Make this a more reasonable default before 1.0.0
@@ -360,8 +366,8 @@ class Vanagon
     # @return [Array] array of package level provides for the project
     def get_provides
       provides = []
-      provides.push @provides.flatten
-      provides.push components.flat_map(&:provides)
+      provides << @provides.flatten
+      provides << components.flat_map(&:provides)
       provides.flatten!
       provides.each do |provide|
         # TODO: Make this a more reasonable default before 1.0.0
@@ -841,7 +847,7 @@ class Vanagon
     end
 
     def load_upstream_metadata(metadata_uri)
-      warn "Loading metadata from #{metadata_uri}"
+      VanagonLogger.info "Loading metadata from #{metadata_uri}"
       case metadata_uri
       when /^http/
         @upstream_metadata = JSON.parse(Net::HTTP.get(URI(metadata_uri)))

data/lib/vanagon/project/dsl.rb

@@ -1,4 +1,5 @@
 require 'vanagon/errors'
+require 'vanagon/logger'
 require 'vanagon/project'
 require 'vanagon/utilities'
 require 'vanagon/component/source'
@@ -109,8 +110,8 @@ class Vanagon
       # Sets the run time requirements for the project. Mainly for use in packaging.
       #
       # @param req [String] of requirements of the project
-      def requires(req)
-        @project.requires << req
+      def requires(requirement, version = nil)
+        @project.requires << OpenStruct.new(:requirement => requirement, :version => version)
       end
 
       # Indicates that this component replaces a system level package. Replaces can be collected and used by the project and package.
@@ -185,7 +186,7 @@ class Vanagon
         last_tag = repo_object.describe('HEAD', { :abbrev => 0 })
         release(repo_object.rev_list("#{last_tag}..HEAD", { :count => true }))
       rescue Git::GitExecuteError
-        warn "Directory '#{File.expand_path('..', @configdir)}' cannot be versioned by git. Maybe it hasn't been tagged yet?"
+        VanagonLogger.error "Directory '#{File.expand_path('..', @configdir)}' cannot be versioned by git. Maybe it hasn't been tagged yet?"
       end
 
       # Sets the version for the project based on a git describe of the
@@ -196,7 +197,7 @@ class Vanagon
         git_version = Git.open(File.expand_path("..", @configdir)).describe('HEAD', tags: true)
         version(git_version.split('-').reject(&:empty?).join('.'))
       rescue Git::GitExecuteError
-        warn "Directory '#{File.expand_path('..', @configdir)}' cannot be versioned by git. Maybe it hasn't been tagged yet?"
+        VanagonLogger.error "Directory '#{File.expand_path('..', @configdir)}' cannot be versioned by git. Maybe it hasn't been tagged yet?"
       end
 
       # Get the version string from a git branch name. This will look for a '.'
@@ -268,7 +269,7 @@ class Vanagon
       #
       # @param name [String] name of component to add. must be present in configdir/components and named $name.rb currently
       def component(name)
-        warn "Loading #{name}" if @project.settings[:verbose]
+        VanagonLogger.info "Loading #{name}" if @project.settings[:verbose]
         if @include_components.empty? or @include_components.include?(name)
           component = Vanagon::Component.load_component(name, File.join(@configdir, "components"), @project.settings, @project.platform)
           @project.components << component

data/lib/vanagon/utilities.rb

@@ -9,6 +9,7 @@ require 'timeout'
 # but it provides a wealth of useful constants
 require 'English'
 require 'vanagon/extensions/string'
+require 'vanagon/logger'
 
 class Vanagon
   module Utilities
@@ -39,17 +40,16 @@ class Vanagon
     end
 
     # Simple wrapper around Net::HTTP. Will make a request of the given type to
-    # the given url and return the body as parsed by JSON.
+    # the given url and return the response object
     #
     # @param url [String] The url to make the request against (needs to be parsable by URI
     # @param type [String] One of the supported request types (currently 'get', 'post', 'delete')
     # @param payload [String] The request body data payload used for POST and PUT
     # @param header [Hash] Send additional information in the HTTP request header
-    # @return [Hash] The response body is parsed by JSON and returned
+    # @return [Net::HTTPAccepted] The response object
     # @raise [RuntimeError, Vanagon::Error] an exception is raised if the
-    # action is not supported, or if there is a problem with the http request,
-    # or if the response is not JSON
-    def http_request(url, type, payload = {}.to_json, header = nil) # rubocop:disable Metrics/AbcSize
+    # action is not supported, or if there is a problem with the http request
+    def http_request_generic(url, type, payload = {}.to_json, header = nil) # rubocop:disable Metrics/AbcSize
       uri = URI.parse(url)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme == 'https'
@@ -77,14 +77,37 @@ class Vanagon
       end
 
       response = http.request(request)
-
-      JSON.parse(response.body)
+      response
     rescue Errno::ETIMEDOUT, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET,
       EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
       Net::ProtocolError => e
       raise Vanagon::Error.wrap(e, "Problem reaching #{url}. Is #{uri.host} down?")
+    end
+
+    # uses http_request_generic and returns the body as parsed by JSON.
+    # @param url [String] The url to make the request against (needs to be parsable by URI
+    # @param type [String] One of the supported request types (currently 'get', 'post', 'delete')
+    # @param payload [String] The request body data payload used for POST and PUT
+    # @param header [Hash] Send additional information in the HTTP request header
+    # @return [Hash] The response in JSON format
+    # @raise [RuntimeError, Vanagon::Error] an exception is raised if the response
+    # body cannot be parsed as JSON
+    def http_request(url, type, payload = {}.to_json, header = nil)
+      response = http_request_generic(url, type, payload, header)
+      JSON.parse(response.body)
     rescue JSON::ParserError => e
-      raise Vanagon::Error.wrap(e, "#{uri.host} handed us a response that doesn't look like JSON.")
+      raise Vanagon::Error.wrap(e, "#{url} handed us a response that doesn't look like JSON.")
+    end
+
+    # uses http_request_generic and returns the response code.
+    # @param url [String] The url to make the request against (needs to be parsable by URI
+    # @param type [String] One of the supported request types (currently 'get', 'post', 'delete')
+    # @param payload [String] The request body data payload used for POST and PUT
+    # @param header [Hash] Send additional information in the HTTP request header
+    # @return [String] The response code eg 202, 200 etc
+    def http_request_code(url, type, payload = {}.to_json, header = nil)
+      response = http_request_generic(url, type, payload, header)
+      response.code
     end
 
     # Similar to rake's sh, the passed command will be executed and an
@@ -143,7 +166,7 @@ class Vanagon
             yield
             return true
           rescue StandardError => e
-            warn 'An error was encountered evaluating block. Retrying..'
+            VanagonLogger.error 'An error was encountered evaluating block. Retrying..'
             error = e
           end
         end
@@ -216,7 +239,7 @@ class Vanagon
     #                        output of the command if return_command_output is true
     # @raise [RuntimeError] If there is no target given or the command fails an exception is raised
     def remote_ssh_command(target, command, port = 22, return_command_output: false)
-      warn "Executing '#{command}' on '#{target}'"
+      VanagonLogger.info "Executing '#{command}' on '#{target}'"
       if return_command_output
         ret = %x(#{ssh_command(port)} -T #{target} '#{command.gsub("'", "'\\\\''")}').chomp
         if $CHILD_STATUS.success?
@@ -239,7 +262,7 @@ class Vanagon
     # @raise [RuntimeError] If the command fails an exception is raised
     def local_command(command, return_command_output: false)
       clean_environment do
-        warn "Executing '#{command}' locally"
+        VanagonLogger.info "Executing '#{command}' locally"
         if return_command_output
           ret = %x(#{command}).chomp
           if $CHILD_STATUS.success?
@@ -283,7 +306,7 @@ class Vanagon
       outfile ||= File.join(Dir.mktmpdir, File.basename(erbfile).sub(File.extname(erbfile), ""))
       output = erb_string(erbfile, opts[:binding])
       File.open(outfile, 'w') { |f| f.write output }
-      warn "Generated: #{outfile}"
+      VanagonLogger.info "Generated: #{outfile}"
       FileUtils.rm_rf erbfile if remove_orig
       outfile
     end