vanagon 0.18.0 → 0.20.1

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

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
@@ -32,6 +33,9 @@ class Vanagon
     # Where does a given platform expect to find init scripts/service files?
     # e.g. /etc/init.d, /usr/lib/systemd/system
     attr_accessor :servicedir
+    # Array of OpenStructs containing the servicetype and the corresponding
+    # servicedir
+    attr_accessor :servicetypes
     # Where does a given platform's init system expect to find
     # something resembling 'defaults' files. Most likely to apply
     # to Linux systems that use SysV-ish, upstart, or systemd init systems.
@@ -152,9 +156,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
 
@@ -244,6 +248,7 @@ class Vanagon
       # Our first attempt at defining metadata about a platform
       @cross_compiled ||= false
       @valid_operators ||= ['<', '>', '<=', '>=', '=']
+      @servicetypes = []
     end
 
     def shell # rubocop:disable Lint/DuplicateMethods
@@ -401,7 +406,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 +544,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
@@ -552,5 +557,33 @@ class Vanagon
     def validate_operator(operator_string)
       valid_operators.include?(operator_string)
     end
+
+    # Get all configured service types (added through plat.servicetype)
+    # @return array of service types, empty array if none have been configured
+    def get_service_types
+      if @servicetypes.any?
+        @servicetypes.flat_map(&:servicetype).compact
+      elsif @servicetype
+        [@servicetype]
+      else
+        []
+      end
+    end
+
+    # Get configured service dir (added through plat.servicedir, or plat.servicetype 'foo', servicedir: 'bar')
+    # @param servicetype the service type you want the service dir for (optional)
+    # @raises VanagonError if more than one service dir is found
+    def get_service_dir(servicetype = '')
+      if @servicetypes.empty?
+        return @servicedir
+      end
+      servicedir = @servicetypes.select { |s| s.servicetype.include?(servicetype) }.flat_map(&:servicedir).compact
+
+      if servicedir.size > 1
+        raise Vanagon::Error, "You can only have one service dir for each service type. Found '#{servicedir.join(',')}' for service type #{servicetype}"
+      end
+
+      servicedir.first
+    end
   end
 end

data/lib/vanagon/platform/dsl.rb

@@ -8,7 +8,9 @@ require 'vanagon/platform/osx'
 require 'vanagon/platform/solaris_10'
 require 'vanagon/platform/solaris_11'
 require 'vanagon/platform/windows'
+require 'vanagon/logger'
 require 'securerandom'
+require 'ostruct'
 require 'uri'
 
 class Vanagon
@@ -218,6 +220,11 @@ class Vanagon
       # @param dir [String] Directory where service files live on the platform
       def servicedir(dir)
         @platform.servicedir = dir
+
+        # Add to the servicetypes array if we haven't already
+        if @platform.servicetype && @platform.servicedir && @platform.servicetypes.select { |s| s.servicetype == @platform.servicetype }.empty?
+          @platform.servicetypes << OpenStruct.new(:servicetype => @platform.servicetype, :servicedir => @platform.servicedir)
+        end
       end
 
       # Set the directory where default or sysconfig files live for the platform
@@ -230,8 +237,18 @@ class Vanagon
       # Set the servicetype for the platform so that services can be installed correctly.
       #
       # @param type [String] service type for the platform ('sysv' for example)
-      def servicetype(type)
-        @platform.servicetype = type
+      # @param servicedir [String] service dir for this platform and service type ('/etc/init.d' for example). Optional.
+      def servicetype(type, servicedir: nil) # rubocop:disable Metrics/AbcSize
+        if servicedir
+          @platform.servicetypes << OpenStruct.new(:servicetype => type, :servicedir => servicedir)
+        else
+          @platform.servicetype = type
+        end
+
+        # Add to the servicetypes array if we haven't already
+        if @platform.servicetype && @platform.servicedir && @platform.servicetypes.select { |s| s.servicetype == @platform.servicetype }.empty?
+          @platform.servicetypes << OpenStruct.new(:servicetype => @platform.servicetype, :servicedir => @platform.servicedir)
+        end
       end
 
       # Set the list of possible host to perform a build on (when not using
@@ -259,7 +276,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 +411,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 +420,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 +429,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
@@ -345,10 +351,14 @@ class Vanagon
     # will return nil
     #
     # @param [string] name of service to grab
-    # @return [@component.service obj] specific service
+    # @return [@component.service obj] specific service, or array of services
+    #         if there's more than one
     def get_service(name)
       components.each do |component|
         if component.name == name
+          if component.service.size == 1
+            return component.service.first
+          end
           return component.service
         end
       end
@@ -360,8 +370,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 +851,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)))