vanagon 0.14.3 → 0.15.0

data/lib/vanagon/platform.rb

@@ -1,8 +1,18 @@
 require 'vanagon/environment'
 require 'vanagon/platform/dsl'
+require 'vanagon/utilities'
 
 class Vanagon
   class Platform
+    # Rubocop complains about Style/MixinUsage:
+    #   "include is used at the top level. Use inside class or module."
+    # Moving this include to this level passes spec tests -- any deeper than this,
+    # and spec tests collapse. I think an unfortunate number of platforms rely
+    # on these utilities without an explicit `require` and that's something we
+    # should refactor at some point.
+    #   - Ryan McKern 2017-12-27
+    include Vanagon::Utilities
+
     # Basic generic information related to a given instance of Platform.
     # e.g. The name we call it, the platform triplet (name-version-arch), etc.
     attr_accessor :name
@@ -33,8 +43,10 @@ class Vanagon
     attr_accessor :find
     attr_accessor :install
     attr_accessor :make
+    attr_accessor :mktemp
     attr_accessor :patch
     attr_accessor :rpmbuild # This is RedHat/EL/Fedora/SLES specific
+    attr_accessor :sed
     attr_accessor :sort
     attr_accessor :tar
     attr_accessor :shasum
@@ -117,11 +129,15 @@ class Vanagon
     # Freeform Hash of leftover settings
     attr_accessor :settings
 
+    attr_accessor :valid_operators
+
     # Platform names currently contain some information about the platform. Fields
     # within the name are delimited by the '-' character, and this regex can be used to
     # extract those fields.
     PLATFORM_REGEX = /^(.*)-(.*)-(.*)$/
 
+    VERSION_REGEX = /^([=<>]+)\s*([^<>=]*)$/
+
     # Loads a given platform from the configdir
     #
     # @param name [String] the name of the platform
@@ -133,10 +149,10 @@ class Vanagon
       dsl = Vanagon::Platform::DSL.new(name)
       dsl.instance_eval(File.read(platfile), platfile, 1)
       dsl._platform
-    rescue => e
-      $stderr.puts "Error loading platform '#{name}' using '#{platfile}':"
-      $stderr.puts e
-      $stderr.puts e.backtrace.join("\n")
+    rescue StandardError => e
+      warn "Error loading platform '#{name}' using '#{platfile}':"
+      warn e
+      warn e.backtrace.join("\n")
       raise e
     end
 
@@ -212,17 +228,20 @@ class Vanagon
       @environment = Vanagon::Environment.new
       @provisioning = []
       @install ||= "install"
+      @mktemp ||= "mktemp -d -p /var/tmp"
       @target_user ||= "root"
       @find ||= "find"
+      @sed ||= "sed"
       @sort ||= "sort"
       @copy ||= "cp"
       @shasum ||= "sha1sum"
 
       # Our first attempt at defining metadata about a platform
       @cross_compiled ||= false
+      @valid_operators ||= ['<', '>', '<=', '>=', '=']
     end
 
-    def shell
+    def shell # rubocop:disable Lint/DuplicateMethods
       @shell ||= "/bin/bash"
     end
 
@@ -239,7 +258,7 @@ class Vanagon
     # @param target_repo [String] optional repo target for built packages defined
     #   at the project level
     # @return [String] relative path to where packages should be output to
-    def output_dir(target_repo = "")
+    def output_dir(target_repo = "") # rubocop:disable Lint/DuplicateMethods
       @output_dir ||= File.join(@os_name, @os_version, target_repo, @architecture)
     end
 
@@ -250,7 +269,7 @@ class Vanagon
     # @param target_repo [String] optional repo target for built source packages
     # defined at the project level
     # @return [String] relative path to where source packages should be output to
-    def source_output_dir(target_repo = "")
+    def source_output_dir(target_repo = "") # rubocop:disable Lint/DuplicateMethods
       @source_output_dir ||= output_dir(target_repo)
     end
 
@@ -267,7 +286,7 @@ class Vanagon
     # Also has the side effect of setting the @os_name instance attribute
     #
     # @return [String] the operating system name as specified in the platform
-    def os_name
+    def os_name # rubocop:disable Lint/DuplicateMethods
       @os_name ||= @name.match(PLATFORM_REGEX)[1]
     end
 
@@ -275,7 +294,7 @@ class Vanagon
     # Also has the side effect of setting the @os_version instance attribute
     #
     # @return [String] the operating system version as specified in the platform
-    def os_version
+    def os_version # rubocop:disable Lint/DuplicateMethods
       @os_version ||= @name.match(PLATFORM_REGEX)[2]
     end
 
@@ -283,7 +302,7 @@ class Vanagon
     # Also has the side effect of setting the @architecture instance attribute
     #
     # @return [String] the architecture of the platform
-    def architecture
+    def architecture # rubocop:disable Lint/DuplicateMethods
       @architecture ||= @name.match(PLATFORM_REGEX)[3]
     end
 
@@ -472,5 +491,30 @@ class Vanagon
       provisioning << command
       provisioning.flatten!
     end
+
+    # version strings for dependencies, conflicts, replaces, etc need some munging
+    # based on platform.
+    #
+    # @param version_string operator(<,>,=,<=,>=) and version to be munged, like
+    #        '<1.2.3'
+    # @param default [deprecated] default operator to use if version string doesn't
+    #        contain an operator
+    def version_munger(version_string, default: '=')
+      match = version_string.match(VERSION_REGEX)
+
+      if match.nil?
+        warn "Passing a version without an operator is deprecated!"
+        operator = default
+        version = version_string
+      end
+      operator ||= match[1]
+      version ||= match[2]
+      fail "Operator '#{operator}' is invalid" unless validate_operator(operator)
+      "#{operator} #{version}"
+    end
+
+    def validate_operator(operator_string)
+      valid_operators.include?(operator_string)
+    end
   end
 end

data/lib/vanagon/project/dsl.rb

@@ -251,7 +251,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)
-        $stderr.puts "Loading #{name}" if @project.settings[:verbose]
+        warn "Loading #{name}" if @project.settings[:verbose]
         if @include_components.empty? or @include_components.include?(name)
           component = Vanagon::Component.load_component(name, File.join(Vanagon::Driver.configdir, "components"), @project.settings, @project.platform)
           @project.components << component

data/lib/vanagon/project.rb

@@ -103,10 +103,10 @@ class Vanagon
       dsl = Vanagon::Project::DSL.new(name, platform, include_components)
       dsl.instance_eval(File.read(projfile), projfile, 1)
       dsl._project
-    rescue => e
-      $stderr.puts "Error loading project '#{name}' using '#{projfile}':"
-      $stderr.puts e
-      $stderr.puts e.backtrace.join("\n")
+    rescue StandardError => e
+      warn "Error loading project '#{name}' using '#{projfile}':"
+      warn e
+      warn e.backtrace.join("\n")
       raise e
     end
 
@@ -231,7 +231,13 @@ class Vanagon
       replaces = []
       replaces.push @replaces.flatten
       replaces.push components.flat_map(&:replaces)
-      replaces.flatten.uniq
+      replaces.flatten!
+      replaces.each do |replace|
+        # TODO: Make this a more reasonable default before 1.0.0
+        # but in the interim, maintain the current behavior
+        replace.version = @platform.version_munger(replace.version, default: '<') if replace.version
+      end
+      replaces.uniq
     end
 
     def has_replaces?
@@ -242,7 +248,13 @@ class Vanagon
     def get_conflicts
       conflicts = components.flat_map(&:conflicts) + @conflicts
       # Mash the whole thing down into a flat Array
-      conflicts.flatten.uniq
+      conflicts.flatten!
+      conflicts.each do |conflict|
+        # TODO: Make this a more reasonable default before 1.0.0
+        # but in the interim, maintain the current behavior
+        conflict.version = @platform.version_munger(conflict.version, default: '<') if conflict.version
+      end
+      conflicts.uniq
     end
 
     def has_conflicts?
@@ -272,7 +284,13 @@ class Vanagon
       provides = []
       provides.push @provides.flatten
       provides.push components.flat_map(&:provides)
-      provides.flatten.uniq
+      provides.flatten!
+      provides.each do |provide|
+        # TODO: Make this a more reasonable default before 1.0.0
+        # but in the interim, maintain the current behavior
+        provide.version = @platform.version_munger(provide.version, default: '>=') if provide.version
+      end
+      provides.uniq
     end
 
     def has_provides?

data/lib/vanagon/utilities.rb

@@ -139,7 +139,7 @@ class Vanagon
           begin
             yield
             return true
-          rescue => e
+          rescue StandardError => e
             warn 'An error was encountered evaluating block. Retrying..'
             error = e
           end
@@ -213,7 +213,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)
-      $stderr.puts "Executing '#{command}' on '#{target}'"
+      warn "Executing '#{command}' on '#{target}'"
       if return_command_output
         ret = %x(#{ssh_command(port)} -T #{target} '#{command.gsub("'", "'\\\\''")}').chomp
         if $CHILD_STATUS.success?
@@ -236,7 +236,7 @@ class Vanagon
     # @raise [RuntimeError] If the command fails an exception is raised
     def local_command(command, return_command_output: false)
       clean_environment do
-        $stderr.puts "Executing '#{command}' locally"
+        warn "Executing '#{command}' locally"
         if return_command_output
           ret = %x(#{command}).chomp
           if $CHILD_STATUS.success?
@@ -280,7 +280,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 }
-      $stderr.puts "Generated: #{outfile}"
+      warn "Generated: #{outfile}"
       FileUtils.rm_rf erbfile if remove_orig
       outfile
     end

data/lib/vanagon.rb

@@ -1,7 +1,7 @@
 require 'time'
 
-LIBDIR = File.expand_path(File.dirname(__FILE__))
-VANAGON_ROOT = File.join(File.expand_path(File.dirname(__FILE__)), "..")
+LIBDIR = __dir__
+VANAGON_ROOT = File.join(__dir__, "..")
 BUILD_TIME = Time.now.iso8601
 VANAGON_VERSION = Gem.loaded_specs["vanagon"].version.to_s
 

data/resources/Makefile.erb

@@ -4,7 +4,7 @@ SHELL = <%=  @platform.shell %>
 export <%= var %>
 <%- end -%>
 
-tempdir := $(shell mktemp -d -p /var/tmp 2>/dev/null || mktemp -d -t 'tmp')
+tempdir := $(shell <%= @platform.mktemp %> 2>/dev/null)
 workdir := $(PWD)
 
 all: file-list-before-build <%= package_name %>
@@ -31,7 +31,7 @@ file-list-after-build: <%= @components.map {|comp| comp.name }.join(" ") %>
 
 file-list: file-list-before-build <%= @name %>-project
 	comm -23 file-list-after-build file-list-before-build > file-list
-	comm -23 file-list-after-build file-list-before-build | sed -e 's/\(^.*[[:space:]].*$$\)/"\1"/g' > file-list-for-rpm
+	comm -23 file-list-after-build file-list-before-build | <%= @platform.sed %> -e 's/\(^.*[[:space:]].*$$\)/"\1"/g' > file-list-for-rpm
 
 <%- if @version_file -%>
 <%= @version_file.path %>:

data/resources/deb/control.erb

@@ -11,11 +11,11 @@ Architecture: <%= @noarch ? 'all' : 'any' %>
 Section: admin
 Priority: optional
 <%- unless get_replaces.empty? -%>
-Replaces: <%= get_replaces.map { |replace| "#{replace.replacement} #{replace.version ? "(<< #{replace.version})" : ""}" }.join(", ") %>
-Breaks: <%= get_replaces.map { |replace| "#{replace.replacement} #{replace.version ? "(<< #{replace.version})" : ""}" }.join(", ") %>
+Replaces: <%= get_replaces.map { |replace| "#{replace.replacement} #{replace.version ? "(#{replace.version})" : ""}" }.join(", ") %>
+Breaks: <%= get_replaces.map { |replace| "#{replace.replacement} #{replace.version ? "(#{replace.version})" : ""}" }.join(", ") %>
 <%- end -%>
 <%- unless get_conflicts.empty? -%>
-Conflicts: <%= get_conflicts.map { |conflict| "#{conflict.pkgname} #{conflict.version ? "(<< #{conflict.version})" : ""}" }.join(", ") %>
+Conflicts: <%= get_conflicts.map { |conflict| "#{conflict.pkgname} #{conflict.version ? "(#{conflict.version})" : ""}" }.join(", ") %>
 <%- end -%>
 <%- unless get_requires.empty? -%>
 Depends: <%= get_requires.join(", ") %>

data/resources/rpm/project.spec.erb

@@ -14,15 +14,25 @@
     /usr/lib64/rpm/brp-strip-static-archive %{__strip} \
     /usr/lib64/rpm/brp-strip-comment-note %{__strip} %{__objdump} \
 %{nil}
+<%- elsif !@platform.is_aix? -%>
+# enable more stripping. This was failing on cisco wrlinux and AIX. We may want
+# to get this worked out eventually, but for now let's just skip these for
+# those platforms
+%global __debug_package %{nil}
+# to resolve: "ERROR: No build ID note found"
+%undefine _missing_build_ids_terminate_build
+# To avoid files installed but not packaged errors
+%global __os_install_post %{__os_install_post} \
+    rm -rf %{buildroot}/usr/lib/debug
 <%- end -%>
 
 # Turn off the brp-python-bytecompile script
-%global __os_install_post %(echo '%{__os_install_post}' | sed -e 's!/usr/lib[^[:space:]]*/brp-python-bytecompile[[:space:]].*$!!g')
+%global __os_install_post %(echo '%{__os_install_post}' | <%= @platform.sed %> -e 's!/usr/lib[^[:space:]]*/brp-python-bytecompile[[:space:]].*$!!g')
 <% if @platform.is_cross_compiled_linux? -%>
 # Disable brp-strip-static-archive, which on EL platforms causes
 # cross-compiled static libs to end up with "no machine" as their
 # architure, breaking builds:
-%global __os_install_post %(echo '%{__os_install_post}' | sed -e 's!/usr/lib[^[:space:]]*/brp-strip-static-archive[[:space:]].*$!!g')
+%global __os_install_post %(echo '%{__os_install_post}' | <%= @platform.sed %> -e 's!/usr/lib[^[:space:]]*/brp-strip-static-archive[[:space:]].*$!!g')
 <% end -%>
 
 <% @package_overrides.each do |var| %>
@@ -86,15 +96,15 @@ Requires: chkconfig
 <%- end -%>
 
 <%- get_replaces.each do |replace| -%>
-Obsoletes: <%= replace.replacement %><%= replace.version ? " < #{replace.version}" : "" %>
+Obsoletes: <%= replace.replacement %><%= replace.version ? " #{replace.version}" : "" %>
 <%- end -%>
 
 <%- get_conflicts.each do |conflict| -%>
-Conflicts: <%= conflict.pkgname %><%= conflict.version ? " < #{conflict.version}" : "" %>
+Conflicts: <%= conflict.pkgname %><%= conflict.version ? " #{conflict.version}" : "" %>
 <%- end -%>
 
 <%- get_provides.each do |prov| -%>
-Provides: <%= prov.provide %><%= prov.version ? " >= #{prov.version}" : "" %>
+Provides: <%= prov.provide %><%= prov.version ? " #{prov.version}" : "" %>
 <%- end -%>
 
 %description
@@ -136,7 +146,7 @@ install -d %{buildroot}
   # automatically does this implicitly, but RPMv5 is more strict and you
   # need to list the dirs for them to be packaged properly.
   <%- get_directories.map {|d| "%{buildroot}#{d.path}"}.each do |dir| -%>
-    find <%= dir %> -type d | sed -e "s#%{buildroot}##" | sed -e 's/\(^.*\s.*$\)/"\1"/g' >> dir-list-rpm
+    find <%= dir %> -type d | <%= @platform.sed %> -e "s#%{buildroot}##" | <%= @platform.sed %> -e 's/\(^.*\s.*$\)/"\1"/g' >> dir-list-rpm
   <%- end -%>
   cat dir-list-rpm | sort | uniq >> %{SOURCE1}
 <%- end -%>
@@ -145,13 +155,13 @@ install -d %{buildroot}
 # %files section separately because rpm3 on aix errors on duplicate files in
 # the package.
 <%- (get_directories + get_files + get_configfiles).map do |filething| -%>
-  PATH=/opt/freeware/bin:$PATH sed -i 's|^<%= filething.path.include?(" ") ? %Q["#{filething.path}"] : filething.path %>$||g' %{SOURCE1}
+  PATH=/opt/freeware/bin:$PATH <%= @platform.sed %> -i 's|^<%= filething.path.include?(" ") ? %Q["#{filething.path}"] : filething.path %>$||g' %{SOURCE1}
 <%- end -%>
 
 # Here we turn all dirs in the file-list into %dir entries to avoid duplicate files
 while read entry; do
   if [ -n "$entry" -a -d "$entry" -a ! -L "$entry" ]; then
-    PATH=/opt/freeware/bin:$PATH sed -i "s|^\($entry\)\$|%dir \1|g" %{SOURCE1}
+    PATH=/opt/freeware/bin:$PATH <%= @platform.sed %> -i "s|^\($entry\)\$|%dir \1|g" %{SOURCE1}
   fi
 done < %{SOURCE1}
 

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

@@ -366,6 +366,16 @@ end" }
       expect(comp._component.conflicts.first.pkgname).to eq('thing1')
       expect(comp._component.conflicts.first.version).to eq('1.2.3')
     end
+
+    it "doesn't add a version operator if it's already there" do
+      operators = ['<', '>', '=', '<=', '>=']
+      operators.each do |operator|
+        comp = Vanagon::Component::DSL.new('conflicts-test', {}, {})
+        comp.conflicts('thing1', "#{operator}1.2.3")
+        expect(comp._component.conflicts.first.pkgname).to eq('thing1')
+        expect(comp._component.conflicts.first.version).to eq("#{operator}1.2.3")
+      end
+    end
   end
 
   describe '#add_actions' do

data/spec/lib/vanagon/platform/osx_spec.rb

@@ -0,0 +1,21 @@
+require 'vanagon/platform'
+
+describe "Vanagon::Platform::OSX" do
+  let(:block) {
+    %Q[ platform "osx-10.12-x86_64" do |plat|
+    end
+    ]
+  }
+  let(:plat) { Vanagon::Platform::DSL.new('osx-10.12-x86_64') }
+
+  before do
+    plat.instance_eval(block)
+  end
+
+  describe "osx has a different mktemp" do
+    it "uses the right mktemp options" do
+      expect(plat._platform.send(:mktemp)).to eq("mktemp -d -t 'tmp'")
+    end
+  end
+end
+

data/spec/lib/vanagon/platform/rpm/aix_spec.rb

@@ -20,7 +20,7 @@ describe "Vanagon::Platform::RPM::AIX" do
 
   describe "aix puts commands in weird places" do
     it "uses /opt/freeware/bin everwhere" do
-      ['tar', 'patch', 'install'].each do |cmd|
+      ['tar', 'patch', 'install', 'sed'].each do |cmd|
         expect(plat._platform.send(cmd.to_sym)).to eq(File.join('/opt/freeware/bin', cmd))
       end
     end

data/spec/lib/vanagon/platform/solaris_10_spec.rb

@@ -0,0 +1,29 @@
+require 'vanagon/platform'
+
+describe "Vanagon::Platform::Solaris10" do
+  let(:block) {
+    %Q[ platform "solaris-10-i386" do |plat|
+    end
+    ]
+  }
+  let(:plat) { Vanagon::Platform::DSL.new('solaris-10-i386') }
+
+  before do
+    plat.instance_eval(block)
+  end
+
+  describe "solaris10 has weird paths for gnu commands" do
+    it "has some in /opt/csw/bin" do
+      ['make', 'sed'].each do |cmd|
+        expect(plat._platform.send(cmd.to_sym)).to eq(File.join('/opt/csw/bin', "g#{cmd}"))
+      end
+    end
+    it "uses /usr/sfw/bin/gtar" do
+      expect(plat._platform.send(:tar)).to eq('/usr/sfw/bin/gtar')
+    end
+    it "uses /usr/bin/gpatch" do
+      expect(plat._platform.send(:patch)).to eq('/usr/bin/gpatch')
+    end
+  end
+end
+