vanagon 0.18.1 → 0.21.0

data/lib/vanagon/component/dsl.rb

@@ -1,4 +1,5 @@
 require 'vanagon/component'
+require 'vanagon/logger'
 require 'vanagon/patch'
 require 'ostruct'
 require 'json'
@@ -131,8 +132,8 @@ class Vanagon
       # component
       #
       # @param requirement [String] a package that is required at runtime for this component
-      def requires(requirement)
-        @component.requires << requirement
+      def requires(requirement, version = nil)
+        @component.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.
@@ -167,37 +168,42 @@ class Vanagon
       # @param service_file [String] path to the service file relative to the source
       # @param default_file [String] path to the default file relative to the source
       # @param service_name [String] name of the service
-      # @param service_type [String] type of the service (network, application, system, etc)
-      # @param link_target [String] executable service file should be linked to
-      def install_service(service_file, default_file = nil, service_name = @component.name, service_type: nil, link_target: nil) # rubocop:disable Metrics/AbcSize
-        case @component.platform.servicetype
+      # @param options optional extra parameters
+      #        service_type [String] type of the service (network, application, system, etc)
+      #        init_system [String] the init system on which to install service (sysv, systemd)
+      #        link_target [String] executable service file should be linked to
+      def install_service(service_file, default_file = nil, service_name = @component.name, **options) # rubocop:disable Metrics/AbcSize
+        init_system = options[:init_system] || @component.platform.servicetype
+        servicedir = @component.platform.get_service_dir(init_system)
+
+        case init_system
         when "sysv"
-          target_service_file = File.join(@component.platform.servicedir, service_name)
+          target_service_file = File.join(servicedir, service_name)
           target_default_file = File.join(@component.platform.defaultdir, service_name)
           target_mode = '0755'
           default_mode = '0644'
         when "systemd"
-          target_service_file = File.join(@component.platform.servicedir, "#{service_name}.service")
+          target_service_file = File.join(servicedir, "#{service_name}.service")
           target_default_file = File.join(@component.platform.defaultdir, service_name)
           target_mode = '0644'
           default_mode = '0644'
         when "launchd"
-          target_service_file = File.join(@component.platform.servicedir, "#{service_name}.plist")
+          target_service_file = File.join(servicedir, "#{service_name}.plist")
           target_mode = '0644'
           default_mode = '0644'
         when "smf"
           # modify version in smf manifest so service gets restarted after package upgrade
           @component.install << %{#{@component.platform.sed} -ri 's/(<service.*version=)(".*")/\\1"#{Time.now.to_i}"/' #{service_file}}
-          target_service_file = File.join(@component.platform.servicedir, service_type.to_s, "#{service_name}.xml")
+          target_service_file = File.join(servicedir, options[:service_type].to_s, "#{service_name}.xml")
           target_default_file = File.join(@component.platform.defaultdir, service_name)
           target_mode = '0644'
           default_mode = '0755'
         when "aix"
-          @component.service = OpenStruct.new(:name => service_name, :service_command => File.read(service_file).chomp)
+          @component.service << OpenStruct.new(:name => service_name, :service_command => File.read(service_file).chomp)
           # Return here because there is no file to install, just a string read in
           return
         when "windows"
-          @component.service = OpenStruct.new(\
+          @component.service << OpenStruct.new(\
             :bindir_id => "#{service_name.gsub(/[^A-Za-z0-9]/, '').upcase}BINDIR", \
             :service_file => service_file, \
             :component_group_id => "#{service_name.gsub(/[^A-Za-z0-9]/, '')}Component"\
@@ -205,13 +211,13 @@ class Vanagon
           # return here as we are just collecting the name of the service file to put into the harvest filter list.
           return
         else
-          fail "Don't know how to install the #{@component.platform.servicetype}. Please teach #install_service how to do this."
+          fail "Don't know how to install the #{init_system}. Please teach #install_service how to do this."
         end
 
         # Install the service and default files
-        if link_target
-          install_file(service_file, link_target, mode: target_mode)
-          link link_target, target_service_file
+        if options[:link_target]
+          install_file(service_file, options[:link_target], mode: target_mode)
+          link options[:link_target], target_service_file
         else
           install_file(service_file, target_service_file, mode: target_mode)
         end
@@ -222,7 +228,8 @@ class Vanagon
         end
 
         # Register the service for use in packaging
-        @component.service = OpenStruct.new(:name => service_name, :service_file => target_service_file, :type => service_type)
+        @component.service << OpenStruct.new(:name => service_name, :service_file => target_service_file,
+                                             :type => options[:service_type], :init_system => init_system)
       end
 
       # Copies a file from source to target during the install phase of the component
@@ -237,7 +244,7 @@ class Vanagon
 
         if @component.platform.is_windows?
           unless mode.nil? && owner.nil? && group.nil?
-            warn "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
+            VanagonLogger.info "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
           end
         else
           mode ||= '0644'
@@ -407,7 +414,7 @@ class Vanagon
         install_flags = ['-d']
         if @component.platform.is_windows?
           unless mode.nil? && owner.nil? && group.nil?
-            warn "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
+            VanagonLogger.info "You're trying to set the mode, owner, or group for windows. I don't know how to do that, ignoring!"
           end
         else
           install_flags << "-m '#{mode}'" unless mode.nil?
@@ -422,7 +429,7 @@ class Vanagon
       # @param env [Hash] mapping of keys to values to add to the environment for the component
       def environment(*env)
         if env.size == 1 && env.first.is_a?(Hash)
-          warn <<-WARNING.undent
+          VanagonLogger.info <<-WARNING.undent
             the component DSL method signature #environment({Key => Value}) is deprecated
             and will be removed by Vanagon 1.0.0.
 

data/lib/vanagon/component/source.rb

@@ -1,4 +1,5 @@
 require 'fustigit'
+require 'vanagon/logger'
 require 'vanagon/component/source/http'
 require 'vanagon/component/source/git'
 require 'vanagon/component/source/local'
@@ -66,7 +67,7 @@ class Vanagon
           timeout = 5
           if Vanagon::Component::Source::Git.valid_remote?(uri, timeout)
             if uri =~ /^http/
-              warn "Passing git URLs as http(s) addresses is deprecated! Please prefix your source URL with `git:`"
+              VanagonLogger.info "Passing git URLs as http(s) addresses is deprecated! Please prefix your source URL with `git:`"
             end
             return :git
           end

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

@@ -1,5 +1,6 @@
 require 'vanagon/utilities'
 require 'vanagon/errors'
+require 'vanagon/logger'
 # This stupid library requires a capital 'E' in its name
 # but it provides a wealth of useful constants
 require 'English'
@@ -25,14 +26,38 @@ class Vanagon
           #        git command has failed. Useful in instances where a URL
           #        prompts for credentials despite not being a git remote
           # @return [Boolean] whether #url is a valid Git repo or not
+
+          # [RE-13837] This ought to be the way to do this. Unfortunately,
+          # there's a bug in Git.ls_remote that when ssh prints something like
+          #  Warning: Permanently added 'github.com,192.30.255.113' (RSA)
+          # Git.ls_remote attempts to parse it as actual git output and fails
+          # with: NoMethodError: undefined method `split' for nil:NilClass
+          #
+          # We'll work around that case by calling 'git ls-remote' directly ourselves.
+          #
+          # I'm leaving in the broken version here for a time when the ruby-git library
+          # is fixed.
+
+          #def valid_remote?(url, timeout = 0)
+          #  Timeout.timeout(timeout) do
+          #    !!::Git.ls_remote(url)
+          #  end
+          #rescue ::Git::GitExecuteError
+          #  false
+          #rescue Timeout::Error
+          #  false
+          #end
+
           def valid_remote?(url, timeout = 0)
             Timeout.timeout(timeout) do
-              !!::Git.ls_remote(url)
+              Vanagon::Utilities.local_command("git ls-remote #{url} > /dev/null 2>&1")
+              return false unless $?.exitstatus.zero?
+              return true
             end
-          rescue ::Git::GitExecuteError
-            false
           rescue Timeout::Error
-            false
+            return false
+          rescue RuntimeError
+            return false
           end
         end
 
@@ -81,7 +106,7 @@ class Vanagon
         # There is no md5 to manually verify here, so this is a noop.
         def verify
           # nothing to do here, so just tell users that and return
-          warn "Nothing to verify for '#{dirname}' (using Git reference '#{ref}')"
+          VanagonLogger.info "Nothing to verify for '#{dirname}' (using Git reference '#{ref}')"
         end
 
         # The dirname to reference when building from the repo
@@ -131,8 +156,8 @@ class Vanagon
         # Clone a remote repo, make noise about it, and fail entirely
         # if we're unable to retrieve the remote repo
         def clone!
-          warn "Cloning Git repo '#{url}'"
-          warn "Successfully cloned '#{dirname}'" if clone
+          VanagonLogger.info "Cloning Git repo '#{url}'"
+          VanagonLogger.info "Successfully cloned '#{dirname}'" if clone
         rescue ::Git::GitExecuteError
           raise Vanagon::InvalidRepo, "Unable to clone from '#{url}'"
         end
@@ -141,7 +166,7 @@ class Vanagon
         # Checkout desired ref/sha, make noise about it, and fail
         # entirely if we're unable to checkout that given ref/sha
         def checkout!
-          warn "Checking out '#{ref}' from Git repo '#{dirname}'"
+          VanagonLogger.info "Checking out '#{ref}' from Git repo '#{dirname}'"
           clone.checkout(ref)
         rescue ::Git::GitExecuteError
           raise Vanagon::CheckoutFailed, "unable to checkout #{ref} from '#{url}'"
@@ -151,7 +176,7 @@ class Vanagon
         # Attempt to update submodules, and do not panic
         # if there are no submodules to initialize
         def update_submodules
-          warn "Attempting to update submodules for repo '#{dirname}'"
+          VanagonLogger.info "Attempting to update submodules for repo '#{dirname}'"
           clone.update_submodules(init: true)
         end
         private :update_submodules
@@ -163,7 +188,7 @@ class Vanagon
         def describe
           clone.describe(ref, tags: true)
         rescue ::Git::GitExecuteError
-          warn "Directory '#{dirname}' cannot be versioned by Git. Maybe it hasn't been tagged yet?"
+          VanagonLogger.info "Directory '#{dirname}' cannot be versioned by Git. Maybe it hasn't been tagged yet?"
         end
         private :describe
       end

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'
 
@@ -50,32 +51,28 @@ 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 pick_engine(options) # rubocop:disable Metrics/PerceivedComplexity
-      default_engine = 'always_be_scheduling'
-
-      # Use the explicitly configured engine if no target was provided.
-      return options[:engine] if options[:engine] && !options[:target]
-
-      # If the configured engine matches the default engine, use it
-      return options[:engine] if options[:engine] == default_engine
-
-      # Make some guesses about which engine to use
-      return 'hardware' if @platform.build_hosts
-      return 'ec2' if @platform.aws_ami
-      return 'docker' if @platform.docker_image
-      return 'base' if @options[:target]
-
-      return default_engine
+      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
     end
 
     def load_engine_object(engine_type, platform, target)
-      engine_type = 'base' if target
-
       require "vanagon/engine/#{engine_type}"
       @engine = Object::const_get("Vanagon::Engine::#{camelize(engine_type)}")
         .new(platform, target, remote_workdir: remote_workdir)
@@ -138,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
@@ -163,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)
@@ -178,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