vanagon 0.9.3 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79f3affb2f2797cad077ac7341d99cc2f613dd96
-  data.tar.gz: 4a90613f59d7e96c9015e61ff0200404f063fb3d
+  metadata.gz: f50d333d7dc08205687fc7058b19a3580a0b5028
+  data.tar.gz: c345a2510f5d6fb4d522a680da59f2aebaa274f3
 SHA512:
-  metadata.gz: 0f6b28cd90a8917063035914d5a094ce123aad6991aa721df89bab0c8bd9251e9aafbe924c5253b9c1ea8a6d046fa20149870b448496d126a0d354dd7ebee925
-  data.tar.gz: 6bc644ee0a223cebe705c0c43d7e69cc4de66b099dc05cfb436967298d21b194b320cb9d385e7beafb9132737eedd945268a93b7b8a75b45540940fdeae3a3c2
+  metadata.gz: 259aac01aa4832879c74a99e3578bc9d59d76e07e283729f78ebd71e4807650c508b306f7a1da13c2d7738b989cb0b40f9583ad629e0fe68ad828a35d74f421e
+  data.tar.gz: 7b72a6e2947e07cc178fd373cfc381e28f84259715bfa260362334dedda3a6e99a4fe56f1f228ead0f7bbc74d8cdcc41b25e2be9086b55e530bc3a6b30e1d5c4

data/lib/makefile.rb

@@ -1,3 +1,5 @@
+require 'vanagon/environment'
+
 class Makefile
   # The Rule class defines a single Makefile rule.
   #
@@ -11,6 +13,11 @@ class Makefile
     #   @return [Array<String>] A list of dependencies that this rule depends on.
     attr_accessor :dependencies
 
+    # @!attribute [rw] environment
+    #   @return [Array<String>] A list of environment variables that this rule
+    #     will export
+    attr_accessor :environment
+
     # @!attribute [rw] recipe
     #   @return [Array<String>] A list of commands to execute upon invocation of this rule.
     attr_accessor :recipe
@@ -36,28 +43,84 @@ class Makefile
     #         "make cpplint",
     #       ]
     #     end
-    def initialize(target, dependencies: [], recipe: [], &block)
+    def initialize(target, dependencies: [], environment: Vanagon::Environment.new, recipe: [], &block)
       @target = target
       @dependencies = dependencies
+      @environment = environment
       @recipe = recipe
 
       yield(self) if block
     end
 
+    # @return [String, Nil] the name of all dependencies for a given rule,
+    #   flattened and joined for a Makefule target
+    def flatten_dependencies
+      return nil if dependencies.empty?
+      dependencies.flatten.join("\s")
+    end
+
+    # @return [String] the base Rule for a Makefile target, including
+    #   all dependencies.
+    def base_target
+      ["#{target}:", dependencies].flatten.compact.join("\s")
+    end
+
+    # @return [String] the Makefile target's name, rendered in a format
+    # suitable for using as a Graphite group -- any periods in the name of
+    # the component being built will be removed.
+    #   e.g. "ruby-2.1.9-unpack" will become "ruby-219.unpack"
+    def tokenize_target_name
+      target_name, _, rule = target.rpartition('-')
+      [target_name.tr('.', ''), rule]
+        .select { |s| !(s.nil? || s.empty?) }
+        .join('.')
+    end
+
+    def tokenized_environment_variable
+      "#{target}: export VANAGON_TARGET := #{tokenize_target_name}"
+    end
+
+    def environment_variables
+      environment.map { |k, v| "#{k} := #{v}" }.map do |env|
+        "#{target}: export #{env}"
+      end
+    end
+
     # Format this rule as a Makefile rule.
     #
     # Recipes that have multiline statements will have tabs inserted after each
     # newline to ensure that the recipe is parsed as part of a single makefile rule.
     #
     # @return [String]
-    def format
-      s = @target + ":"
-      unless @dependencies.empty?
-        s << " " << @dependencies.join(" ")
+    def format # rubocop:disable Metrics/AbcSize
+      # create a base target inside an Array, and construct the rest of
+      # the rule around that.
+      t = [base_target]
+
+      # prepend an environment variable that can be used inside a
+      # given Make rule/target. We have to do it this way instead of
+      # appending it to #environment because for reasons that I cannot
+      # work out, the "sane" way results in previous/incorrect names
+      # being used and objects being recycled. My working theory is
+      # a corner case between metaprogrammed methods in Component::Rules,
+      # and Ruby's preference for pass-by-reference.
+      # Ryan McKern 2017-02-02
+      t.unshift tokenized_environment_variable
+
+      # prepend any environment variables to the existing target,
+      # using the target prefix to identify them as such. they should
+      # end up ahead of the dependencies and the build recipe.
+      environment_variables.each do |env|
+        t.unshift env
       end
-      s << "\n"
-      s << @recipe.map { |line| "\t" + line.gsub("\n", "\n\t") + "\n" }.join
-      s
+
+      # finally, append the build recipe after the base target condition.
+      # also, here's a fun edge case: if one were to call #squeeze on
+      # the iterator 'line', basically all of the phony make tasks that
+      # `touch` a file just disapear. Fragility ++.
+      # - Ryan McKern 2017-02-02
+      t.push recipe.compact.map { |line| "\t" + line.gsub("\n", "\n\t") + "\n" }.join
+      t.join("\n")
     end
 
     alias to_s format

data/lib/vanagon/component.rb

@@ -7,12 +7,101 @@ class Vanagon
     # @!attribute [r] files
     #   @return [Set] the list of files marked for installation
 
-    attr_accessor :name, :version, :source, :url, :configure, :build, :check, :install
-    attr_accessor :environment, :extract_with, :dirname, :build_requires, :build_dir
-    attr_accessor :settings, :platform, :patches, :requires, :service, :options
-    attr_accessor :directories, :replaces, :provides, :conflicts, :cleanup_source
-    attr_accessor :sources, :preinstall_actions, :postinstall_actions
-    attr_accessor :preremove_actions, :postremove_actions, :license
+    # 30 accessors is too many. These have got to be refactored.
+    # - Ryan McKern, 2017-01-27
+
+    # The name, version, primary source, supplementary sources,
+    # associated patches, upstream URL, and license of a given component
+    attr_accessor :name
+    attr_accessor :version
+    attr_accessor :source
+    attr_accessor :sources
+    attr_accessor :patches
+    attr_accessor :url
+    attr_accessor :license
+
+    # holds an OpenStruct describing all of the particular details about
+    # how any services associated with a given component should be defined.
+    attr_accessor :service
+
+    # holds the expected directory name of a given component, once it's
+    # been unpacked/decompressed. For git repos, it's usually the directory
+    # that they were cloned to. For the outlying flat files, it'll
+    # end up being defined explicitly as the string './'
+    attr_accessor :dirname
+    # what special tool should be used to extract the primary source
+    attr_accessor :extract_with
+    # how should this component be configured?
+    attr_accessor :configure
+    # the optional name of a directory to build a component in; most
+    # likely to be used for cmake projects, which do not like to be
+    # configured or compiled in their own top-level directories.
+    attr_accessor :build_dir
+    # build will hold an Array of the commands required to build
+    # a given component
+    attr_accessor :build
+    # check will hold an Array of the commands required to validate/test
+    # a given component
+    attr_accessor :check
+    # install will hold an Array of the commands required to install
+    # a given component
+    attr_accessor :install
+
+    # holds a Vanagon::Environment object, to map out any desired
+    # environment variables that should be rendered into the Makefile
+    attr_accessor :environment
+    # holds a OpenStruct, or an Array, or maybe it's a Hash? It's often
+    # overloaded as a freeform key-value lookup for platforms that require
+    # additional configuration beyond the "basic" component attributes.
+    # it's pretty heavily overloaded and should maybe be refactored before
+    # Vanagon 1.0.0 is tagged.
+    attr_accessor :settings
+    # used to hold the checksum settings or other weirdo metadata related
+    # to building a given component (git ref, sha, etc.). Probably conflicts
+    # or collides with #settings to some degree.
+    attr_accessor :options
+    # the platform that a given component will be built for -- due to the
+    # fact that Ruby is pass-by-reference, it's usually just a reference
+    # to the same Platform object that the overall Project object also
+    # contains. This is a definite code smell, and should be slated
+    # for refactoring ASAP because it's going to have weird side-effects
+    # if the underlying pass-by-reference assumptions change.
+    attr_accessor :platform
+
+    # directories holds an Array with a list of expected directories that will
+    # be packed into the resulting artifact's bill of materials.
+    attr_accessor :directories
+    # build_requires holds an Array with a list of the dependencies that a given
+    # component needs satisfied before it can be built.
+    attr_accessor :build_requires
+    # requires holds an Array with a list of all dependencies that a given
+    # component needs satisfied before it can be installed.
+    attr_accessor :requires
+    # replaces holds an Array of OpenStructs that describe a package that a given
+    # component will replace on installation.
+    attr_accessor :replaces
+    # provides holds an Array of OpenStructs that describe any capabilities that
+    # a given component will provide beyond the its filesystem payload.
+    attr_accessor :provides
+    # conflicts holds an Array of OpenStructs that describe a package that a
+    # given component will replace on installation.
+    attr_accessor :conflicts
+    # preinstall_actions is a two-dimensional Array, describing scripts that
+    # should be executed before a given component is installed.
+    attr_accessor :preinstall_actions
+    # postinstall_actions is a two-dimensional Array, describing scripts that
+    # should be executed after a given component is installed.
+    attr_accessor :postinstall_actions
+    # preremove_actions is a two-dimensional Array, describing scripts that
+    # should be executed before a given component is uninstalled.
+    attr_accessor :preremove_actions
+    # preinstall_actions is a two-dimensional Array, describing scripts that
+    # should be executed after a given component is uninstalled.
+    attr_accessor :postremove_actions
+    # cleanup_source contains whatever value a given component's Source has
+    # specified as instructions for cleaning up after a build is completed.
+    # usually a String, but not required to be.
+    attr_accessor :cleanup_source
 
     # Loads a given component from the configdir
     #
@@ -58,7 +147,7 @@ class Vanagon
       @replaces = []
       @provides = []
       @conflicts = []
-      @environment = {}
+      @environment = Vanagon::Environment.new
       @sources = []
       @preinstall_actions = []
       @postinstall_actions = []
@@ -111,7 +200,7 @@ class Vanagon
         @source = Vanagon::Component::Source.source(url, opts)
         source.fetch
         source.verify
-        @extract_with = source.respond_to?(:extract) ? source.extract(platform.tar) : ':'
+        @extract_with = source.respond_to?(:extract) ? source.extract(platform.tar) : nil
         @cleanup_source = source.cleanup if source.respond_to?(:cleanup)
         @dirname = source.dirname
 
@@ -126,7 +215,7 @@ class Vanagon
         @dirname = './'
 
         # If there is no source, there is nothing to do to extract
-        @extract_with = ':'
+        @extract_with = ': no source, so nothing to extract'
       end
     end
 
@@ -144,10 +233,9 @@ class Vanagon
     # @param workdir [String] working directory to put the source into
     def get_sources(workdir)
       sources.each do |source|
-        src = Vanagon::Component::Source.source source.url,
-                                                workdir: workdir,
-                                                ref: source.ref,
-                                                sum: source.sum
+        src = Vanagon::Component::Source.source(
+          source.url, workdir: workdir, ref: source.ref, sum: source.sum
+        )
         src.fetch
         src.verify
       end
@@ -165,12 +253,20 @@ class Vanagon
     end
 
     # Prints the environment in a way suitable for use in a Makefile
-    # or shell script.
+    # or shell script. This is deprecated, because all Env. Vars. are
+    # moving directly into the Makefile (and out of recipe subshells).
     #
     # @return [String] environment suitable for inclusion in a Makefile
+    # @deprecated
     def get_environment
+      warn <<-eos.undent
+        #get_environment is deprecated; environment variables have been moved
+        into the Makefile, and should not be used within a Makefile's recipe.
+        The #get_environment method will be removed by Vanagon 1.0.0.
+      eos
+
       if @environment.empty?
-        ":"
+        ": no environment variables defined"
       else
         env = @environment.map { |key, value| %(#{key}="#{value}") }
         "export #{env.join(' ')}"

data/lib/vanagon/component/dsl.rb

@@ -230,14 +230,14 @@ class Vanagon
       # upgrade if it has been modified
       #
       # @param file [String] name of the configfile
-      def configfile(file, mode: nil, owner: nil, group: nil)
+      def configfile(file)
         # I AM SO SORRY
         @component.delete_file file
         if @component.platform.name =~ /solaris-10|osx/
           @component.install << "mv '#{file}' '#{file}.pristine'"
-          @component.add_file Vanagon::Common::Pathname.configfile("#{file}.pristine", mode: mode, owner: owner, group: group)
+          @component.add_file Vanagon::Common::Pathname.configfile("#{file}.pristine")
         else
-          @component.add_file Vanagon::Common::Pathname.configfile(file, mode: mode, owner: owner, group: group)
+          @component.add_file Vanagon::Common::Pathname.configfile(file)
         end
       end
 
@@ -245,9 +245,9 @@ class Vanagon
       #
       # @param source [String] path to the configfile to copy
       # @param target [String] path to the desired target of the configfile
-      def install_configfile(source, target, mode: '0644', owner: nil, group: nil)
-        install_file(source, target, mode: mode, owner: owner, group: group)
-        configfile(target, mode: mode, owner: owner, group: group)
+      def install_configfile(source, target)
+        install_file(source, target)
+        configfile(target)
       end
 
       # link will add a command to the install to create a symlink from source to target
@@ -339,8 +339,25 @@ class Vanagon
       # This environment is included in the configure, build and install steps.
       #
       # @param env [Hash] mapping of keys to values to add to the environment for the component
-      def environment(env)
-        @component.environment.merge!(env)
+      def environment(*env) # rubocop:disable Metrics/AbcSize
+        if env.size == 1 && env.first.is_a?(Hash)
+          warn <<-eos.undent
+            the component DSL method signature #environment({Key => Value}) is deprecated
+            and will be removed by Vanagon 1.0.0.
+
+            Please update your project configurations to use the form:
+              #environment(key, value)
+          eos
+          return @component.environment.merge!(env.first)
+        elsif env.size == 2
+          return @component.environment[env.key] = env.value
+        end
+        raise ArgumentError, <<-eos.undent
+          component DSL method #environment only accepts a single Hash (deprecated)
+          or a key-value pair (preferred):
+            environment({"KEY" => "value"})
+            environment("KEY", "value")
+        eos
       end
 
       # Adds action to run during the preinstall phase of packaging

data/lib/vanagon/component/rules.rb

@@ -20,14 +20,18 @@ class Vanagon
       #
       # @!macro [attach] rule
       #   @return [Makefile::Rule] The $1 rule
-      def self.rule(target, dependencies: [], &block)
+      def self.rule(target, &block)
         define_method("#{target}_rule") do
-          Makefile::Rule.new("#{@component.name}-#{target}", dependencies: dependencies) do |rule|
+          Makefile::Rule.new("#{component.name}-#{target}", environment: component.environment) do |rule|
             instance_exec(rule, &block)
           end
         end
       end
 
+      attr_accessor :component
+      attr_accessor :project
+      attr_accessor :platform
+
       # @param component [Vanagon::Component] The component to create rules for.
       # @param project [Vanagon::Project] The project associated with the component.
       # @param platform [Vanagon::Platform] The platform where this component will be built.
@@ -55,7 +59,7 @@ class Vanagon
           clean_rule,
           clobber_rule,
         ]
-        if @project.cleanup
+        if project.cleanup
           list << cleanup_rule
         end
 
@@ -66,27 +70,29 @@ class Vanagon
       #
       # @return [Makefile::Rule]
       def component_rule
-        Makefile::Rule.new(@component.name, dependencies: ["#{@component.name}-install"])
+        Makefile::Rule.new(component.name, environment: component.environment) do |rule|
+          rule.dependencies = ["#{component.name}-install"]
+        end
       end
 
       # Unpack the source for this component. The unpacking behavior depends on
       # the source type of the component.
       #
       # @see [Vanagon::Component::Source]
-      rule("unpack", dependencies: ['file-list-before-build']) do |r|
-        r.recipe << andand(@component.get_environment, @component.extract_with)
+      rule("unpack") do |r|
+        r.dependencies = ['file-list-before-build']
+        r.recipe << component.extract_with
         r.recipe << "touch #{r.target}"
       end
 
       # Apply any patches for this component.
       rule("patch") do |r|
-        r.dependencies = ["#{@component.name}-unpack"]
-
-        after_unpack_patches = @component.patches.select { |patch| patch.after == "unpack" }
+        r.dependencies = ["#{component.name}-unpack"]
+        after_unpack_patches = component.patches.select { |patch| patch.after == "unpack" }
         unless after_unpack_patches.empty?
           r.recipe << andand_multiline(
-            "cd #{@component.dirname}",
-            after_unpack_patches.map { |patch| patch.cmd(@platform) }
+            "cd #{component.dirname}",
+            after_unpack_patches.map { |patch| patch.cmd(platform) }
           )
         end
 
@@ -96,17 +102,15 @@ class Vanagon
       # Create a build directory for this component if an out of source tree build is specified,
       # and any configure steps, if any.
       rule("configure") do |r|
-        r.dependencies = ["#{@component.name}-patch"].concat(@project.list_component_dependencies(@component))
-
-        if @component.get_build_dir
-          r.recipe << "[ -d #{@component.get_build_dir} ] || mkdir -p #{@component.get_build_dir}"
+        r.dependencies = ["#{component.name}-patch"].concat(project.list_component_dependencies(component))
+        if component.get_build_dir
+          r.recipe << "[ -d #{component.get_build_dir} ] || mkdir -p #{component.get_build_dir}"
         end
 
-        unless @component.configure.empty?
+        unless component.configure.empty?
           r.recipe << andand_multiline(
-            "cd #{@component.get_build_dir}",
-            @component.get_environment,
-            @component.configure
+            "cd #{component.get_build_dir}",
+            component.configure
           )
         end
 
@@ -115,13 +119,11 @@ class Vanagon
 
       # Build this component.
       rule("build") do |r|
-        r.dependencies = ["#{@component.name}-configure"]
-
-        unless @component.build.empty?
+        r.dependencies = ["#{component.name}-configure"]
+        unless component.build.empty?
           r.recipe << andand_multiline(
-            "cd #{@component.get_build_dir}",
-            @component.get_environment,
-            @component.build
+            "cd #{component.get_build_dir}",
+            component.build
           )
         end
 
@@ -130,13 +132,11 @@ class Vanagon
 
       # Run tests for this component.
       rule("check") do |r|
-        r.dependencies = ["#{@component.name}-build"]
-
-        unless @component.check.empty? || @project.settings[:skipcheck]
+        r.dependencies = ["#{component.name}-build"]
+        unless component.check.empty? || project.settings[:skipcheck]
           r.recipe << andand_multiline(
-            "cd #{@component.get_build_dir}",
-            @component.get_environment,
-            @component.check
+            "cd #{component.get_build_dir}",
+            component.check
           )
         end
 
@@ -145,21 +145,19 @@ class Vanagon
 
       # Install this component.
       rule("install") do |r|
-        r.dependencies = ["#{@component.name}-check"]
-
-        unless @component.install.empty?
+        r.dependencies = ["#{component.name}-check"]
+        unless component.install.empty?
           r.recipe << andand_multiline(
-            "cd #{@component.get_build_dir}",
-            @component.get_environment,
-            @component.install
+            "cd #{component.get_build_dir}",
+            component.install
           )
         end
 
-        after_install_patches = @component.patches.select { |patch| patch.after == "install" }
+        after_install_patches = component.patches.select { |patch| patch.after == "install" }
         after_install_patches.each do |patch|
           r.recipe << andand(
             "cd #{patch.destination}",
-            patch.cmd(@platform),
+            patch.cmd(platform),
           )
         end
 
@@ -171,8 +169,8 @@ class Vanagon
       # This component is only included by {#rules} if the associated project has
       # the `cleanup` attribute set.
       rule("cleanup") do |r|
-        r.dependencies = ["#{@component.name}-install"]
-        r.recipe = [@component.cleanup_source, "touch #{r.target}"]
+        r.dependencies = ["#{component.name}-install"]
+        r.recipe = [component.cleanup_source, "touch #{r.target}"]
       end
 
       # Clean up any files generated while building this project.
@@ -181,13 +179,13 @@ class Vanagon
       # for the configure/build/install steps.
       rule("clean") do |r|
         r.recipe << andand(
-          "[ -d #{@component.get_build_dir} ]",
-          "cd #{@component.get_build_dir}",
-          "#{@platform[:make]} clean"
+          "[ -d #{component.get_build_dir} ]",
+          "cd #{component.get_build_dir}",
+          "#{platform[:make]} clean"
         )
 
         %w(configure build install).each do |type|
-          touchfile = "#{@component.name}-#{type}"
+          touchfile = "#{component.name}-#{type}"
           r.recipe << andand(
             "[ -e #{touchfile} ]",
             "rm #{touchfile}"
@@ -197,10 +195,10 @@ class Vanagon
 
       # Remove all files associated with this component.
       rule("clobber") do |r|
-        r.dependencies = ["#{@component.name}-clean"]
+        r.dependencies = ["#{component.name}-clean"]
         r.recipe = [
-          andand("[ -d #{@component.dirname} ]", "rm -r #{@component.dirname}"),
-          andand("[ -e #{@component.name}-unpack ]", "rm #{@component.name}-unpack")
+          andand("[ -d #{component.dirname} ]", "rm -r #{component.dirname}"),
+          andand("[ -e #{component.name}-unpack ]", "rm #{component.name}-unpack")
         ]
       end