vanagon 0.10.0 → 0.11.0

data/lib/vanagon/component/rules.rb

@@ -22,7 +22,7 @@ class Vanagon
       #   @return [Makefile::Rule] The $1 rule
       def self.rule(target, &block)
         define_method("#{target}_rule") do
-          Makefile::Rule.new("#{component.name}-#{target}", environment: component.environment) do |rule|
+          Makefile::Rule.new("#{component.name}-#{target}") do |rule|
             instance_exec(rule, &block)
           end
         end
@@ -70,7 +70,7 @@ class Vanagon
       #
       # @return [Makefile::Rule]
       def component_rule
-        Makefile::Rule.new(component.name, environment: component.environment) do |rule|
+        Makefile::Rule.new(component.name) do |rule|
           rule.dependencies = ["#{component.name}-install"]
         end
       end
@@ -81,7 +81,7 @@ class Vanagon
       # @see [Vanagon::Component::Source]
       rule("unpack") do |r|
         r.dependencies = ['file-list-before-build']
-        r.recipe << component.extract_with
+        r.recipe << andand_multiline(component.environment_variables, component.extract_with)
         r.recipe << "touch #{r.target}"
       end
 
@@ -109,6 +109,7 @@ class Vanagon
 
         unless component.configure.empty?
           r.recipe << andand_multiline(
+            component.environment_variables,
             "cd #{component.get_build_dir}",
             component.configure
           )
@@ -122,6 +123,7 @@ class Vanagon
         r.dependencies = ["#{component.name}-configure"]
         unless component.build.empty?
           r.recipe << andand_multiline(
+            component.environment_variables,
             "cd #{component.get_build_dir}",
             component.build
           )
@@ -135,6 +137,7 @@ class Vanagon
         r.dependencies = ["#{component.name}-build"]
         unless component.check.empty? || project.settings[:skipcheck]
           r.recipe << andand_multiline(
+            component.environment_variables,
             "cd #{component.get_build_dir}",
             component.check
           )
@@ -148,6 +151,7 @@ class Vanagon
         r.dependencies = ["#{component.name}-check"]
         unless component.install.empty?
           r.recipe << andand_multiline(
+            component.environment_variables,
             "cd #{component.get_build_dir}",
             component.install
           )

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

@@ -108,7 +108,7 @@ class Vanagon
           when "xz"
             %(unxz "#{file}")
           when "zip"
-            "unzip '#{file}' || 7za x -r -tzip -o'#{File.basename(file, '.zip')}' '#{file}'"
+            "unzip -d '#{File.basename(file, '.zip')}' '#{file}' || 7za x -r -tzip -o'#{File.basename(file, '.zip')}' '#{file}'"
           else
             raise Vanagon::Error, "Don't know how to decompress #{extension} archives"
           end

data/lib/vanagon/driver.rb

@@ -31,7 +31,7 @@ class Vanagon
       filter_out_components(only_build) if only_build
       loginit('vanagon_hosts.log')
 
-      @remote_workdir = options[:remote_workdir]
+      @remote_workdir = options[:"remote-workdir"]
 
       load_engine(engine, @platform, target)
     rescue LoadError => e
@@ -120,14 +120,18 @@ class Vanagon
       puts "Target is #{@engine.target}"
       retry_task { install_build_dependencies }
       retry_task { @project.fetch_sources(@workdir) }
+
       @project.make_makefile(@workdir)
       @project.make_bill_of_materials(@workdir)
       @project.generate_packaging_artifacts(@workdir)
       @engine.ship_workdir(@workdir)
       @engine.dispatch("(cd #{@engine.remote_workdir}; #{@platform.make})")
       @engine.retrieve_built_artifact
-      @engine.teardown unless @preserve
-      cleanup_workdir unless @preserve
+
+      unless @preserve
+        @engine.teardown
+        cleanup_workdir
+      end
     rescue => e
       puts e
       puts e.backtrace.join("\n")
@@ -146,6 +150,8 @@ class Vanagon
 
       puts "rendering Makefile"
       retry_task { @project.fetch_sources(@workdir) }
+      @project.make_bill_of_materials(@workdir)
+      @project.generate_packaging_artifacts(@workdir)
       @project.make_makefile(@workdir)
     end
 

data/lib/vanagon/environment.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'vanagon/extensions/string'
 
 class Vanagon
   # Environment is a validating wrapper around a delegated Hash,
@@ -46,22 +47,21 @@ class Vanagon
       @data = {}
     end
 
-    # Associates the value given by value with the key given by key. Keys must
-    # be strings, and should conform to the Open Group's guidelines for portable
-    # shell variable names:
+    # Associates the value given by value with the key given by key. Keys will
+    # be cast to Strings, and should conform to the Open Group's guidelines for
+    # portable shell variable names:
     #     Environment variable names used by the utilities in the Shell and
     #     Utilities volume of IEEE Std 1003.1-2001 consist solely of uppercase
     #     letters, digits, and the '_' (underscore) from the characters defined
     #     in Portable Character Set and do not begin with a digit.
     #
-    # Values must be Strings or Integers, and will be stored precisely as given,
+    # Values will be cast to Strings, and will be stored precisely as given,
     # so any escaped characters, single or double quotes, or whitespace will be
     # preserved exactly as passed during assignment.
     #
     # @param key [String]
     # @param value [String, Integer]
-    # @raise [ArgumentError] if key is not a String, or if value is not a
-    #   String or an Integer
+    # @raise [ArgumentError] if key or value cannot be cast to a String
     def []=(key, value)
       @data.update({ validate_key(key) => validate_value(value) })
     end
@@ -133,32 +133,49 @@ class Vanagon
     end
     alias to_string to_s
 
-    def sanitize_value(str)
-      escaped_variables = str.scan(/\$\$([\w]+)/).flatten
+    def sanitize_subshells(str)
+      pattern = %r{\$\$\((.*?)\)}
+      escaped_variables = str.scan(pattern).flatten
       return str if escaped_variables.empty?
 
-      warning = [%(Value "#{str}" looks like it's escaping one or more strings for shell interpolation.)]
-      escaped_variables.each { |v| warning.push "\t$$#{v} (will be coerced to $(#{v})" }
+      warning = [%(Value "#{str}" looks like it's escaping one or more values for subshell interpolation.)]
+      escaped_variables.each { |v| warning.push %(\t"$$(#{v})" will be coerced to "$(shell #{v})") }
       warning.push <<-eos.undent
-        All environment variables will be resolved by Make; these variables will
-        be unesecaped for now, but you should update your projects parameters.
+        All environment variables will now be resolved by Make before they're executed
+        by the shell. These variables will be mangled for you for now, but you should
+        update your project's parameters.
       eos
 
       warn warning.join("\n")
-      str.gsub(/\$\$([\w]+)/, '$(\1)')
+      str.gsub(pattern, '$(shell \1)')
     end
-    private :sanitize_value
+    private :sanitize_subshells
 
-    # Validate that a key is a String, that it does not contain invalid
+    def sanitize_variables(str)
+      pattern = %r{\$\$([\w]+)}
+      escaped_variables = str.scan(pattern).flatten
+      return str if escaped_variables.empty?
+
+      warning = [%(Value "#{str}" looks like it's escaping one or more shell variable names for shell interpolation.)]
+      escaped_variables.each { |v| warning.push %(\t"$$#{v}" will be coerced to "$(#{v})") }
+      warning.push <<-eos.undent
+        All environment variables will now be resolved by Make before they're executed
+        by the shell. These variables will be mangled for you for now, but you should
+        update your project's parameters.
+      eos
+
+      warn warning.join("\n")
+      str.gsub(pattern, '$(\1)')
+    end
+    private :sanitize_variables
+
+    # Cast key to a String, and validate that it does not contain invalid
     #   characters, and that it does not begin with a digit
-    # @param key [String]
+    # @param key [Object]
     # @raise [ArgumentError] if key is not a String, if key contains invalid
     #   characters, or if key begins with a digit
     def validate_key(str)
-      unless str.is_a?(String)
-        raise ArgumentError,
-              'environment variable Name must be a String'
-      end
+      str = str.to_s
 
       if str[0] =~ /\d/
         raise ArgumentError,
@@ -175,19 +192,13 @@ class Vanagon
     end
     private :validate_key
 
-    # Validate that str is a String or an Integer, and that the value
+    # Cast str to a String, and validate that the value
     # of str cannot be split into more than a single String by #shellsplit.
-    # @param value [String, Integer]
-    # @raise [ArgumentError] if key is not a String or an Integer
+    # @param value [Object]
     def validate_value(str)
-      unless str.is_a?(String) || str.is_a?(Integer)
-        raise ArgumentError,
-              'Value must be a String or an Integer'
-      end
-
       # sanitize the value, which should look for any Shell escaped
       # variable names inside of the value.
-      str.is_a?(String) ? sanitize_value(str) : str
+      sanitize_variables(sanitize_subshells(str.to_s))
     end
     private :validate_value
   end

data/lib/vanagon/optparse.rb

@@ -4,7 +4,7 @@ class Vanagon
   class OptParse
     FLAGS = {
         :workdir => ['-w DIR', '--workdir DIR', "Working directory where build source should be put (defaults to a tmpdir)"],
-        :remote_workdir => ['--remote_workdir DIR', "Working directory where build source should be put on the remote host (defaults to a tmpdir)"],
+        :"remote-workdir" => ['-r DIR', '--remote-workdir DIR', "Working directory where build source should be put on the remote host (defaults to a tmpdir)"],
         :configdir => ['-c', '--configdir DIR', 'Configs dir (defaults to $pwd/configs)'],
         :target => ['-t HOST', '--target HOST', 'Configure a target machine for build and packaging (defaults to grabbing one from the pooler)'],
         :engine => ['-e ENGINE', '--engine ENGINE', "A custom engine to use (defaults to the pooler) [base, local, docker, pooler currently supported]"],

data/lib/vanagon/platform.rb

@@ -72,6 +72,11 @@ class Vanagon
     # cross-compiled or natively compiled.
     attr_accessor :cross_compiled
 
+    # Stores a string, pointing at the shell that should be used
+    # if a user needs to change the path or name of the shell that
+    # Make will run build recipes in.
+    attr_accessor :shell
+
     # A string, containing the script that will be executed on
     # the remote build target to determine how many CPU cores
     # are available on that platform. Vanagon will use that count
@@ -208,9 +213,15 @@ class Vanagon
       @find ||= "find"
       @sort ||= "sort"
       @copy ||= "cp"
+
+      # Our first attempt at defining metadata about a platform
       @cross_compiled ||= false
     end
 
+    def shell
+      @shell ||= "/bin/bash"
+    end
+
     # This allows instance variables to be accessed using the hash lookup syntax
     def [](key)
       if instance_variable_get("@#{key}")
@@ -389,5 +400,34 @@ class Vanagon
     def is_cross_compiled_linux?
       return (is_cross_compiled? && is_linux?)
     end
+
+    # Pass in a packaging override. This needs to be implemented for each
+    # individual platform so that this input ends up in the right place.
+    #
+    # @param project
+    # @param var the string that should be added to the build script.
+    def package_override(project, var)
+      fail "I don't know how to set package overrides for #{name}, teach me?"
+    end
+
+    # Generic adder for build repositories
+    #
+    # @param *args [Array<String>] List of arguments to pass on to the platform specific method
+    # @raise [Vanagon::Error] an arror is raised if the current platform does not define add_repository
+    def add_build_repository(*args)
+      if self.respond_to?(:add_repository)
+        self.provision_with self.send(:add_repository, *args)
+      else
+        raise Vanagon::Error, "Adding a build repository not defined for #{name}"
+      end
+    end
+
+    # Set the command to turn the target machine into a builder for vanagon
+    #
+    # @param command [String] Command to enable the target machine to build packages for the platform
+    def provision_with(command)
+      provisioning << command
+      provisioning.flatten!
+    end
   end
 end

data/lib/vanagon/platform/deb.rb

@@ -102,6 +102,16 @@ class Vanagon
         provisioning << "apt-get -qq update"
       end
 
+
+      # Pass in a packaging override. This will get added to the rules file, and
+      # is a good way to pass in arbitrary environment variables
+      #
+      # @param project
+      # @param var the string that should be added to the build script.
+      def package_override(project, var)
+        project.package_overrides << var
+      end
+
       # Constructor. Sets up some defaults for the debian platform and calls the parent constructor
       #
       # @param name [String] name of the platform

data/lib/vanagon/platform/dsl.rb

@@ -26,7 +26,7 @@ class Vanagon
       #
       # @param name [String] name of the platform
       # @param block [Proc] DSL definition of the platform to call
-      def platform(platform_name, &block) # rubocop:disable Metrics/AbcSize
+      def platform(platform_name, &block)
         @platform = case platform_name
                     when /^aix-/
                       Vanagon::Platform::RPM::AIX.new(@name)
@@ -51,7 +51,6 @@ class Vanagon
                     end
 
         yield(self)
-        environment 'VANAGON_PLATFORM', platform_name.tr('-', '.')
         @platform
       end
 
@@ -98,6 +97,13 @@ class Vanagon
         @platform.make = make_cmd
       end
 
+      # Set the path for Make's SHELL for the platform
+      #
+      # @param shell_path [String] Full path to the shell Make should use
+      def shell(shell_path)
+        @platform.shell = shell_path
+      end
+
       # Set the path to tar for the platform
       #
       # @param tar [String] Full path to the tar command for the platform
@@ -138,7 +144,6 @@ class Vanagon
       # @param xcc [Boolean] True if this is a cross-compiled platform
       def cross_compiled(xcc_flag)
         @platform.cross_compiled = !!xcc_flag
-        environment 'VANAGON_PLATFORM_XCC', @platform.cross_compiled.to_s
       end
 
       # define an explicit Dist for the platform (most likely used for RPM platforms)
@@ -179,8 +184,7 @@ class Vanagon
       #
       # @param command [String] Command to enable the target machine to build packages for the platform
       def provision_with(command)
-        @platform.provisioning << command
-        @platform.provisioning.flatten!
+        @platform.provision_with(command)
       end
 
       # Set the command to install any needed build dependencies for the target machine
@@ -316,7 +320,6 @@ class Vanagon
       # @param user[String] a user string to login with.
       def target_user(user = "root")
         @platform.target_user = user
-        environment 'VANAGON_PLATFORM_USER', user
       end
 
       # Set the target ip address or hostname to start build
@@ -339,7 +342,6 @@ class Vanagon
       # @param codename [String] codename for this platform (squeeze for example)
       def codename(codename)
         @platform.codename = codename
-        environment 'VANAGON_PLATFORM_CODENAME', codename
       end
 
       def output_dir(directory)
@@ -379,11 +381,7 @@ class Vanagon
       # @param *args [Array<String>] List of arguments to pass on to the platform specific method
       # @raise [Vanagon::Error] an arror is raised if the current platform does not define add_repository
       def add_build_repository(*args)
-        if @platform.respond_to?(:add_repository)
-          self.provision_with @platform.send(:add_repository, *args)
-        else
-          raise Vanagon::Error, "Adding a build repository not defined for #{@platform.name}"
-        end
+        @platform.add_build_repository(*args)
       end
     end
   end

data/lib/vanagon/platform/rpm.rb

@@ -69,6 +69,15 @@ class Vanagon
         commands
       end
 
+      # Pass in a packaging override. This will get added to the spec file, and
+      # is a good way to pass in arbitrary `%_define` or `%_global`
+      #
+      # @param project
+      # @param var the string that should be added to the build script.
+      def package_override(project, var)
+        project.package_overrides << var
+      end
+
       # Constructor. Sets up some defaults for the rpm platform and calls the parent constructor
       #
       # @param name [String] name of the platform

data/lib/vanagon/project.rb

@@ -73,6 +73,13 @@ class Vanagon
     # project should pass to each platform
     attr_accessor :environment
 
+    # Extra vars to be set in the spec file or debian rules.
+    # Good for setting extra %define or %global things for RPM, or env
+    # variables needed in the debian rules file
+    # No extra munging will be performed, so these should be set as you want
+    # them to appear in your spec/rules files!
+    attr_accessor :package_overrides
+
     # Loads a given project from the configdir
     #
     # @param name [String] the name of the project
@@ -114,6 +121,7 @@ class Vanagon
       @replaces = []
       @provides = []
       @conflicts = []
+      @package_overrides = []
     end
 
     # Magic getter to retrieve settings in the project
@@ -393,7 +401,7 @@ class Vanagon
       files.push get_files.map(&:path)
       files.push get_configfiles.map(&:path)
       if @platform.is_windows?
-        files.flatten.map { |f| "$$(cygpath --mixed --long-name '#{f}')" }
+        files.flatten.map { |f| "$(shell cygpath --mixed --long-name '#{f}')" }
       else
         files.flatten
       end
@@ -462,7 +470,6 @@ class Vanagon
     #
     # @param workdir [String] workdir to put the packaging files into
     def generate_packaging_artifacts(workdir)
-      FileUtils.install File.join(VANAGON_ROOT, "resources", "metrics", "profiling_shell.sh"), File.join(workdir, "profiling_shell.sh"), :mode => 0775
       @platform.generate_packaging_artifacts(workdir, @name, binding)
     end
   end

data/lib/vanagon/project/dsl.rb

@@ -24,7 +24,6 @@ class Vanagon
       # @param block [Proc] DSL definition of the project to call
       def project(name, &block)
         yield(self)
-        environment 'VANAGON_PROJECT', @name
       end
 
       # Accessor for the project.
@@ -70,6 +69,10 @@ class Vanagon
         @project.settings[name] = value
       end
 
+      def settings
+        @project.settings
+      end
+
       # Sets the description of the project. Mainly for use in packaging.
       #
       # @param descr [String] description of the project
@@ -82,9 +85,6 @@ class Vanagon
       # @param the_name [String] name of the project
       def name(the_name)
         @project.name = the_name
-        # Overwrite the environment variable name using the reset name
-        # of the project.
-        environment 'VANAGON_PROJECT_NAME', @project.name
       end
 
       # Sets the homepage for the project. Mainly for use in packaging.
@@ -99,7 +99,6 @@ class Vanagon
       # @param page [Integer] timeout in seconds
       def timeout(to)
         @project.timeout = to
-        environment 'VANAGON_PROJECT_TIMEOUT', @project.timeout
       end
 
       # Sets the run time requirements for the project. Mainly for use in packaging.
@@ -140,7 +139,6 @@ class Vanagon
       # @param ver [String] version of the project
       def version(ver)
         @project.version = ver.tr('-', '.')
-        environment 'VANAGON_PROJECT_VERSION', @project.version
       end
 
       # Sets the release for the project. Mainly for use in packaging.
@@ -148,7 +146,6 @@ class Vanagon
       # @param rel [String] release of the project
       def release(rel)
         @project.release = rel
-        environment 'VANAGON_PROJECT_RELEASE', @project.release
       end
 
       # Sets the version for the project based on a git describe of the
@@ -162,12 +159,28 @@ class Vanagon
         warn "Directory '#{dirname}' 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 '.'
+      # delimited string of numbers of any length and return that as the version.
+      # For example, 'maint/1.7.0/fixing-some-bugs' will return '1.7.0' and '4.8.x'
+      # will return '4.8'.
+      #
+      # @return version string parsed from branch name, fails if unable to find version
+      def version_from_branch
+        branch = Git.open(File.expand_path("..", Vanagon::Driver.configdir)).current_branch
+        if branch =~ /(\d+(\.\d+)+)/
+          return $1
+        else
+          fail "Can't find a version in your branch, make sure it matches <number>.<number>, like maint/1.7.0/fixing-some-bugs"
+        end
+      rescue Git::GitExecuteError => e
+        fail "Something went wrong trying to find your git branch.\n#{e}"
+      end
+
       # Sets the vendor for the project. Used in packaging artifacts.
       #
       # @param vend [String] vendor or author of the project
       def vendor(vend)
         @project.vendor = vend
-        environment 'VANAGON_PROJECT_VENDOR', @project.vendor
       end
 
       # Adds a directory to the list of directories provided by the project, to be included in any packages of the project
@@ -262,7 +275,15 @@ class Vanagon
       # Counter for the number of times a project should retry a task
       def retry_count(retry_count)
         @project.retry_count = retry_count
-        environment 'VANAGON_PROJECT_RETRY_COUNT', @project.retry_count
+      end
+
+      # Set a package override. Will call the platform-specific implementation
+      # This will get set in the spec file, deb rules, etc.
+      #
+      # @param var the string to be included in the build script
+      def package_override(var)
+        platform = @project.platform
+        platform.package_override(self._project, var)
       end
     end
   end