vanagon 0.18.1 → 0.19.0

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/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
@@ -165,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
@@ -238,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?
@@ -261,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?
@@ -305,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

data/resources/deb/control.erb

@@ -18,7 +18,7 @@ Breaks: <%= get_replaces.map { |replace| "#{replace.replacement} #{replace.versi
 Conflicts: <%= get_conflicts.map { |conflict| "#{conflict.pkgname} #{conflict.version ? "(#{conflict.version})" : ""}" }.join(", ") %>
 <%- end -%>
 <%- unless get_requires.empty? -%>
-Depends: <%= get_requires.join(", ") %>
+Depends: <%= get_requires.map { |req| "#{req.requirement} #{req.version ? "(#{req.version})" : ""}" }.join(", ") %>
 <%- end -%>
 <%- unless get_provides.empty? -%>
 Provides: <%= get_provides.map { |prov| prov.provide }.join(", ") %>

data/resources/osx/postinstall.erb

@@ -5,8 +5,12 @@
 <%- get_configfiles.each do |config|
 dest_file = config.path.gsub(/\.pristine$/, '') -%>
 
-if [ -f "<%= dest_file %>" ] && ! diff "<%= config.path %>" "<%= dest_file %>" > /dev/null; then
-  echo "Detected file at '<%= dest_file %>'; updated file at '<%= config.path %>'."
+if [ -f "<%= dest_file %>" ]; then
+  if diff "<%= config.path %>" "<%= dest_file %>" > /dev/null; then
+    rm -f "<%= config.path %>"
+  else
+    echo "Detected file at '<%= dest_file %>'; updated file at '<%= config.path %>'."
+  fi
 else
   mv '<%= config.path %>' '<%= dest_file %>'
 fi

data/resources/rpm/project.spec.erb

@@ -77,7 +77,7 @@ Source1:        file-list-for-rpm
 Autoprov: 0
 Autoreq: 0
 <%- get_requires.each do |requires| -%>
-Requires:  <%= requires %>
+Requires:  <%= requires.requirement %><%= requires.version ? " #{requires.version}" : "" %>
 <%- end -%>
 
 # All rpm packages built by vanagon have the pre-/post-install script

data/resources/solaris/10/depend.erb

@@ -1,3 +1,3 @@
-<%- get_requires.each do |requirement| -%>
-P <%= requirement %>
+<%- get_requires.each do |requires| -%>
+P <%= requires.requirement %>
 <%- end -%>

data/resources/solaris/10/postinstall.erb

@@ -9,8 +9,12 @@
 <%- get_configfiles.each do |config|
 dest_file = config.path.gsub(/\.pristine$/, '') -%>
 
-if [ -f "<%= dest_file %>" ] && ! diff "<%= config.path %>" "<%= dest_file %>" > /dev/null; then
-  echo "Detected file at '<%= dest_file %>'; updated file at '<%= config.path %>'."
+if [ -f "<%= dest_file %>" ]; then
+  if diff "<%= config.path %>" "<%= dest_file %>" > /dev/null; then
+    rm -f "<%= config.path %>"
+  else
+    echo "Detected file at '<%= dest_file %>'; updated file at '<%= config.path %>'."
+  fi
 else
   cp -pr '<%= config.path %>' '<%= dest_file %>'
 fi
@@ -19,7 +23,11 @@ fi
 
 # Set up any specific permissions needed...
 <%- (get_directories + get_configfiles + get_files).select { |pathname| pathname.has_overrides? }.uniq.each do |file_or_directory| -%>
-  <%= "chmod '#{file_or_directory.mode}' '#{file_or_directory.path}'" if file_or_directory.mode %>
+  <%- if file_or_directory.mode -%>
+  if [ -f "<%= file_or_directory.path %>" ] || [ -d "<%= file_or_directory.path %>" ]; then
+    chmod '<%= file_or_directory.mode %>' '<%= file_or_directory.path %>'
+  fi
+  <%- end -%>
   <%- if file_or_directory.owner -%>
     if getent passwd '<%= file_or_directory.owner %>' &> /dev/null; then
       chown '<%= file_or_directory.owner %>' '<%= file_or_directory.path %>'

data/resources/solaris/11/p5m.erb

@@ -17,8 +17,8 @@ set name=variant.opensolaris.zone value=global value=nonglobal
 %>
 
 # Add any needed dependencies
-<%- get_requires.each do |requirement| -%>
-depend fmri=pkg:/<%= requirement %> type=require
+<%- get_requires.each do |requires| -%>
+depend fmri=pkg:/<%= requires.requirement %> type=require
 <%- end -%>
 
 # Always drop /etc, /usr, and /var, it will cause conflicts with other system packages

data/spec/lib/vanagon/cli_spec.rb

@@ -164,7 +164,7 @@ foo bar baz
 - Platforms
 1 2 3
 "
-  }
+}
       it "outputs projects and platforms space separated" do 
         expect do
           cli.run(options_space_only)
@@ -221,6 +221,3 @@ baz
     end
   end
 end
-
-      
-

data/spec/lib/vanagon/component/dsl_spec.rb

@@ -313,11 +313,18 @@ end" }
       comp = Vanagon::Component::DSL.new('requires-test', {}, {})
       comp.requires('library1')
       comp.requires('library2')
-      expect(comp._component.requires).to include('library1')
-      expect(comp._component.requires).to include('library2')
+      expect(comp._component.requires.first.requirement).to include('library1')
+      expect(comp._component.requires.last.requirement).to include('library2')
     end
   end
 
+    it 'supports versioned requires' do
+      comp = Vanagon::Component::DSL.new('requires-test', {}, {})
+      comp.requires('library1', '1.2.3')
+      expect(comp._component.requires.first.requirement).to eq('library1')
+      expect(comp._component.requires.first.version).to eq('1.2.3')
+    end
+
   describe '#provides' do
     it 'adds the package provide to the list of provides' do
       comp = Vanagon::Component::DSL.new('provides-test', {}, {})

data/spec/lib/vanagon/component_spec.rb

@@ -5,8 +5,9 @@ describe "Vanagon::Component" do
   describe "#get_environment" do
     subject { Vanagon::Component.new('env-test', {}, {}) }
 
-    it "prints a deprecation warning to STDERR" do
-      expect { subject.get_environment }.to output(/deprecated/).to_stderr
+    it "logs a deprecation warning with VanagonLogger.info" do
+      expect(VanagonLogger).to receive(:info).with(/deprecated/)
+      subject.get_environment
     end
 
     it "returns a makefile compatible environment" do