vanagon 0.17.0 → 0.20.0

data/lib/vanagon/component/source/http.rb

@@ -1,4 +1,5 @@
 require 'vanagon/utilities'
+require 'vanagon/logger'
 require 'vanagon/component/source/local'
 require 'net/http'
 require 'uri'
@@ -93,7 +94,7 @@ class Vanagon
         #
         # @raise [RuntimeError] an exception is raised if the sum does not match the sum of the file
         def verify # rubocop:disable Metrics/AbcSize
-          warn "Verifying file: #{file} against sum: '#{sum}'"
+          VanagonLogger.info "Verifying file: #{file} against sum: '#{sum}'"
           actual = get_sum(File.join(workdir, file), sum_type)
           return true if sum == actual
 
@@ -107,7 +108,7 @@ class Vanagon
           uri = URI.parse(target_url.to_s)
           target_file ||= File.basename(uri.path)
 
-          warn "Downloading file '#{target_file}' from url '#{target_url}'"
+          VanagonLogger.info "Downloading file '#{target_file}' from url '#{target_url}'"
 
           Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
             http.request(Net::HTTP::Get.new(uri, headers)) do |response|

data/lib/vanagon/component/source/local.rb

@@ -1,4 +1,5 @@
 require 'vanagon/utilities'
+require 'vanagon/logger'
 
 class Vanagon
   class Component
@@ -57,7 +58,7 @@ class Vanagon
         #
         # @raise [RuntimeError, Vanagon::Error] an exception is raised if the URI scheme cannot be handled
         def copy
-          warn "Copying file '#{url.basename}' to workdir"
+          VanagonLogger.info "Copying file '#{url.basename}' to workdir"
 
           FileUtils.cp_r(url, file)
         end

data/lib/vanagon/component/source/rewrite.rb

@@ -1,4 +1,5 @@
 require 'vanagon/component/source'
+require 'vanagon/logger'
 
 class Vanagon
   class Component
@@ -16,7 +17,7 @@ class Vanagon
           # @deprecated Please use the component DSL method #mirror(<URI>)
           #   instead. This method will be removed before Vanagon 1.0.0.
           def register_rewrite_rule(protocol, rule)
-            warn <<-HERE.undent
+            VanagonLogger.info <<-HERE.undent
               rewrite rule support is deprecated and will be removed before Vanagon 1.0.0.
               Rewritten URLs will be automatically converted into mirror URLs for now but
               please use the component DSL method '#mirror url' to define new mirror URL
@@ -76,7 +77,7 @@ class Vanagon
           def parse_and_rewrite(uri)
             return uri if rewrite_rules.empty?
             if !!uri.match(/^git:http/)
-              warn <<-HERE.undent
+              VanagonLogger.info <<-HERE.undent
                 `fustigit` parsing doesn't get along with how we specify the source
                 type by prefixing `git`. As `rewrite_rules` are deprecated, we'll
                 replace `git:http` with `http` in your uri. At some point this will

data/lib/vanagon/driver.rb

@@ -4,6 +4,7 @@ require 'vanagon/component'
 require 'vanagon/utilities'
 require 'vanagon/common'
 require 'vanagon/errors'
+require 'vanagon/logger'
 require 'tmpdir'
 require 'logger'
 
@@ -20,33 +21,29 @@ class Vanagon
       @retry_count ||= @project.retry_count || ENV["VANAGON_RETRY_COUNT"] || 1
     end
 
-    def initialize(platform, project, options = { workdir: nil, configdir: nil, target: nil, engine: nil, components: nil, skipcheck: false, verbose: false, preserve: false, only_build: nil, remote_workdir: nil }) # rubocop:disable Metrics/AbcSize
-      @verbose = options[:verbose]
-      @preserve = options[:preserve]
+    def initialize(platform, project, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity
+      @options = options
+      @verbose = options[:verbose] || false
+      @preserve = options[:preserve] || false
       @workdir = options[:workdir] || Dir.mktmpdir
 
       @@configdir = options[:configdir] || File.join(Dir.pwd, "configs")
       components = options[:components] || []
       only_build = options[:only_build]
-      target = options[:target]
 
       @platform = Vanagon::Platform.load_platform(platform, File.join(@@configdir, "platforms"))
-      @project = Vanagon::Project.load_project(project, File.join(@@configdir, "projects"), @platform, components)
+      @project = Vanagon::Project.load_project(
+        project, File.join(@@configdir, "projects"), @platform, components
+      )
       @project.settings[:verbose] = options[:verbose]
-      @project.settings[:skipcheck] = options[:skipcheck]
+      @project.settings[:skipcheck] = options[:skipcheck] || false
       filter_out_components(only_build) if only_build
       loginit('vanagon_hosts.log')
 
       @remote_workdir = options[:"remote-workdir"]
 
-      if options[:engine]
-        # Use the explicitly configured engine.
-        load_engine_object(options[:engine], @platform, target)
-      else
-        # Use 'pooler' as a default, but also apply selection logic that may
-        # choose something different based on platform configuration.
-        load_engine('pooler', @platform, target)
-      end
+      engine = pick_engine(options)
+      load_engine_object(engine, @platform, options[:target])
     end
 
     def filter_out_components(only_build)
@@ -54,29 +51,31 @@ class Vanagon
       # flatten all the results in to one array and set project.components to that.
       @project.components = only_build.flat_map { |comp| @project.filter_component(comp) }.uniq
       if @verbose
-        warn "Only building:"
-        @project.components.each { |comp| warn comp.name }
+        VanagonLogger.info "Only building:"
+        @project.components.each { |comp| VanagonLogger.info comp.name }
       end
     end
 
-    def load_engine(engine_type, platform, target)
-      if engine_type != 'always_be_scheduling'
-        if platform.build_hosts
-          engine_type = 'hardware'
-        elsif platform.aws_ami
-          engine_type = 'ec2'
-        elsif platform.docker_image
-          engine_type = 'docker'
-        elsif target
-          engine_type = 'base'
-        end
+    def pick_engine(options) # rubocop:disable Metrics/PerceivedComplexity
+      if options[:engine] && !options[:target]
+        options[:engine]
+      elsif @platform.build_hosts
+        'hardware'
+      elsif @platform.aws_ami
+        'ec2'
+      elsif @platform.docker_image
+        'docker'
+      elsif options[:target]
+        'base'
+      else
+        'always_be_scheduling'
       end
-      load_engine_object(engine_type, platform, target)
     end
 
     def load_engine_object(engine_type, platform, target)
       require "vanagon/engine/#{engine_type}"
-      @engine = Object::const_get("Vanagon::Engine::#{camelize(engine_type)}").new(platform, target, remote_workdir: remote_workdir)
+      @engine = Object::const_get("Vanagon::Engine::#{camelize(engine_type)}")
+        .new(platform, target, remote_workdir: remote_workdir)
     rescue StandardError, ScriptError => e
       raise Vanagon::Error.wrap(e, "Could not load the desired engine '#{engine_type}'")
     end
@@ -103,7 +102,9 @@ class Vanagon
       { "name" => @engine.build_host_name, "engine" => @engine.name }
     end
 
-    # Returns the set difference between the build_requires and the components to get a list of external dependencies that need to be installed.
+    # Returns the set difference between the build_requires and the
+    # components to get a list of external dependencies that need to
+    # be installed.
     def list_build_dependencies
       @project.components.map(&:build_requires).flatten.uniq - @project.components.map(&:name)
     end
@@ -134,7 +135,7 @@ class Vanagon
       end
 
       @engine.startup(workdir)
-      warn "Target is #{@engine.target}"
+      VanagonLogger.info "Target is #{@engine.target}"
       Vanagon::Utilities.retry_with_timeout(retry_count, timeout) do
         install_build_dependencies
       end
@@ -159,8 +160,8 @@ class Vanagon
         @engine.teardown
         cleanup_workdir
       end
-      warn e
-      warn e.backtrace.join("\n")
+      VanagonLogger.error(e)
+      VanagonLogger.error e.backtrace.join("\n")
       raise e
     ensure
       if ["hardware", "ec2"].include?(@engine.name)
@@ -174,7 +175,7 @@ class Vanagon
         raise Vanagon::Error, "Project requires a version set, all is lost."
       end
 
-      warn "rendering Makefile"
+      VanagonLogger.info "rendering Makefile"
       @project.fetch_sources(workdir, retry_count, timeout)
       @project.make_bill_of_materials(workdir)
       @project.generate_packaging_artifacts(workdir)

data/lib/vanagon/engine/always_be_scheduling.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'vanagon/engine/base'
+require 'vanagon/logger'
 require 'yaml'
 
 class Vanagon
@@ -141,14 +142,14 @@ class Vanagon
         absolute_path = File.expand_path(path)
         return nil unless File.exist?(absolute_path)
 
-        warn "Reading ABS token from: #{path}"
+        VanagonLogger.info "Reading ABS token from: #{path}"
         contents = File.read(absolute_path).chomp
         lines = contents.each_line.map(&:chomp)
 
         abs = lines.shift
         @token_vmpooler = lines.shift
 
-        warn "Please add a second line with the vmpooler token to be able to modify or see the VM in floaty/bit-bar" if @token_vmpooler.nil?
+        VanagonLogger.info "Please add a second line with the vmpooler token to be able to modify or see the VM in floaty/bit-bar" if @token_vmpooler.nil?
         return abs
       end
       private :read_vanagon_token
@@ -217,7 +218,7 @@ class Vanagon
             message.concat(" with a vmpooler_fallback token")
           end
         end
-        warn message
+        VanagonLogger.info message
         return abs_token
       end
       private :read_vmfloaty_token
@@ -235,7 +236,7 @@ class Vanagon
       def select_target_from(pooler) # rubocop:disable Metrics/AbcSize
         request_object = build_request_object
 
-        warn "Requesting VMs with job_id: #{@saved_job_id}.  Will poll for up to an hour."
+        VanagonLogger.info "Requesting VMs with job_id: #{@saved_job_id}.  Will poll for up to an hour."
         #the initial request is always replied with "come back again"
         response = Vanagon::Utilities.http_request_generic(
           "#{pooler}/request",
@@ -245,10 +246,10 @@ class Vanagon
         )
 
         unless response.code == "202"
-          warn "failed to request ABS with code #{response.code}"
+          VanagonLogger.info "failed to request ABS with code #{response.code}"
           if valid_json?(response.body)
             response_json = JSON.parse(response.body)
-            warn "reason: #{response_json['reason']}"
+            VanagonLogger.info "reason: #{response_json['reason']}"
           end
           return ''
         end
@@ -278,12 +279,12 @@ class Vanagon
 
             sleep_seconds = 10 if i >= 10
             sleep_seconds = i if i < 10
-            warn "Waiting #{sleep_seconds} seconds to check if ABS request has been filled. (x#{i})"
+            VanagonLogger.info "Waiting #{sleep_seconds} seconds to check if ABS request has been filled. (x#{i})"
 
             sleep(sleep_seconds)
           end
         rescue SystemExit, Interrupt
-          warn "\nVanagon interrupted during mains ABS polling. Make sure you delete the requested job_id #{@saved_job_id}"
+          VanagonLogger.error "\nVanagon interrupted during mains ABS polling. Make sure you delete the requested job_id #{@saved_job_id}"
           raise
         end
         response_body = translated(response_body, @saved_job_id)
@@ -321,14 +322,14 @@ class Vanagon
         )
         if response && response.body == 'OK'
           Vanagon::Driver.logger.info "#{@saved_job_id} has been scheduled for removal"
-          warn "#{@saved_job_id} has been scheduled for removal"
+          VanagonLogger.info "#{@saved_job_id} has been scheduled for removal"
         else
           Vanagon::Driver.logger.info "#{@saved_job_id} could not be scheduled for removal: #{response.body}"
-          warn "#{@saved_job_id} could not be scheduled for removal"
+          VanagonLogger.info "#{@saved_job_id} could not be scheduled for removal"
         end
       rescue Vanagon::Error => e
         Vanagon::Driver.logger.info "#{@saved_job_id} could not be scheduled for removal (#{e.message})"
-        warn "#{@saved_job_id} could not be scheduled for removal (#{e.message})"
+        VanagonLogger.info "#{@saved_job_id} could not be scheduled for removal (#{e.message})"
       end
 
       private

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,4 +1,5 @@
 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
@@ -60,7 +61,7 @@ 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
@@ -74,7 +75,7 @@ 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}"
         YAML.load_file(absolute_path)['token']
       end
       private :read_vmfloaty_token
@@ -145,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