omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/publisher.rb

@@ -61,20 +61,20 @@ module Omnibus
     # @return [Array<String>]
     #
     def packages
-      @packages ||= Dir.glob(@pattern).map { |path| Package.new(path) }
+      @packages ||= FileSyncer.glob(@pattern).map { |path| Package.new(path) }
     end
 
     #
     # @abstract
     #
-    # @param [Proc] block
+    # @param [Proc] _block
     #   if given, the block will yield the currently uploading "thing"
     #
     # @return [Array<String>]
     #   the list of uploaded packages
     #
     def publish(&_block)
-      raise AbstractMethod.new("#{self.class.name}#publish")
+      raise NotImplementedError
     end
 
     private

data/lib/omnibus/s3_cache.rb

@@ -64,18 +64,21 @@ module Omnibus
       #
       def populate
         missing.each do |software|
-          fetch(software)
+          without_caching do
+            software.fetch
+          end
 
-          key = key_for(software)
-          content = IO.read(software.project_file)
+          key     = key_for(software)
+          fetcher = software.fetcher
+          content = IO.read(fetcher.downloaded_file)
 
           log.info(log_key) do
-            "Caching '#{software.project_file}' to '#{Config.s3_bucket}/#{key}'"
+            "Caching '#{fetcher.downloaded_file}' to '#{Config.s3_bucket}/#{key}'"
           end
 
           client.store(key, content,
             access: :public_read,
-            content_md5: software.checksum
+            content_md5: software.fetcher.checksum
           )
         end
 
@@ -89,7 +92,9 @@ module Omnibus
       #
       def fetch_missing
         missing.each do |software|
-          fetch(software)
+          without_caching do
+            software.fetch
+          end
         end
       end
 
@@ -115,11 +120,11 @@ module Omnibus
           raise InsufficientSpecification.new(:version, software)
         end
 
-        unless software.checksum
-          raise InsufficientSpecification.new(:checksum, software)
+        unless software.fetcher.checksum
+          raise InsufficientSpecification.new('source md5 checksum', software)
         end
 
-        "#{software.name}-#{software.version}-#{software.checksum}"
+        "#{software.name}-#{software.version}-#{software.fetcher.checksum}"
       end
 
       private
@@ -161,7 +166,7 @@ module Omnibus
       def softwares
         Omnibus.projects.inject({}) do |hash, project|
           project.library.each do |software|
-            if software.source && software.source.key?(:url)
+            if software.fetcher.is_a?(NetFetcher)
               hash[software.name] = software
             end
           end
@@ -170,27 +175,13 @@ module Omnibus
         end.values.sort
       end
 
-      #
-      # Fetch the remote software definition onto disk.
-      #
-      # @param [Software] software
-      #   the software to fetch
-      #
-      # @return [true]
-      #
-      def fetch(software)
-        log.info(log_key) { "Fetching #{software.name}" }
-        fetcher = Fetcher.without_caching_for(software)
-
-        if fetcher.fetch_required?
-          log.debug(log_key) { 'Updating cache' }
-          fetcher.download
-          fetcher.verify_checksum!
-        else
-          log.debug(log_key) { 'Cached copy up to date, skipping.' }
-        end
+      def without_caching(&block)
+        original = Config.use_s3_caching
+        Config.use_s3_caching(false)
 
-        true
+        yield
+      ensure
+        Config.use_s3_caching(original)
       end
     end
   end

data/lib/omnibus/software.rb

@@ -18,23 +18,48 @@ require 'fileutils'
 require 'uri'
 
 module Omnibus
-  # Omnibus software DSL reader
   class Software
     class << self
       #
       # @param [Project] project
       #   the project that loaded this software definition
-      # @param [String] filepath
+      # @param [String] name
       #   the path to the software definition to load from disk
-      # @param [hash] overrides
-      #   a list of software overrides
       #
       # @return [Software]
       #
-      def load(project, filepath, overrides = {})
-        instance = new(project, overrides, filepath)
-        instance.evaluate_file(filepath)
-        instance
+      def load(project, name)
+        loaded_softwares[name] ||= begin
+          filepath = Omnibus.software_path(name)
+
+          if filepath.nil?
+            raise MissingSoftware.new(name)
+          else
+            log.internal(log_key) do
+              "Loading software `#{name}' from `#{filepath}'."
+            end
+          end
+
+          instance = new(project, filepath)
+          instance.evaluate_file(filepath)
+          instance.load_dependencies
+
+          # Add the loaded compontent to the library
+          project.library.component_added(instance)
+
+          instance
+        end
+      end
+
+      private
+
+      #
+      # The list of softwares loaded thus far.
+      #
+      # @return [Hash<String, Software>]
+      #
+      def loaded_softwares
+        @loaded_softwares ||= {}
       end
     end
 
@@ -47,17 +72,14 @@ module Omnibus
     #
     # Create a new software object.
     #
-    # @param [String] NullBuilder.new(self)
     # @param [Project] project
     #   the Omnibus project that instantiated this software definition
-    # @param [Hash] repo_overrides
-    #   @see Omnibus::Overrides
     # @param [String] filepath
     #   the path to where this software definition lives on disk
     #
     # @return [Software]
     #
-    def initialize(project, repo_overrides = {}, filepath = nil)
+    def initialize(project, filepath = nil)
       unless project.is_a?(Project)
         raise ArgumentError,
           "`project' must be a kind of `Omnibus::Project', but was `#{project.class.inspect}'!"
@@ -68,8 +90,7 @@ module Omnibus
       @project  = project
 
       # Overrides
-      @overrides      = NULL
-      @repo_overrides = repo_overrides
+      @overrides = NULL
     end
 
     #
@@ -97,26 +118,11 @@ module Omnibus
     end
     expose :project
 
-    #
-    # Retrieves the overriden version.
-    #
-    # @deprecated Use {#version} or test with {#overridden?} instead.
-    #
-    # @return [Hash]
-    #
-    def override_version
-      log.deprecated(log_key) do
-        'Software#override_version. Please use #version or ' \
-        'test with #overridden?'
-      end
-
-      overrides[:version]
-    end
-    expose :override_version
-
     #
     # **[Required]** Sets or retreives the name of the software.
     #
+    # @raise [MissingRequiredAttribute]
+    #
     # @example
     #   name 'libxslt'
     #
@@ -127,7 +133,7 @@ module Omnibus
     #
     def name(val = NULL)
       if null?(val)
-        @name || raise(MissingSoftwareConfiguration.new(name, 'name', 'libxslt'))
+        @name || raise(MissingRequiredAttribute.new(self, :name, 'libxslt'))
       else
         @name = val
       end
@@ -226,7 +232,7 @@ module Omnibus
             "be a kind of `Hash', but was `#{val.class.inspect}'")
         end
 
-        extra_keys = val.keys - [:git, :path, :url, :md5, :cookie, :warning]
+        extra_keys = val.keys - [:git, :path, :url, :md5, :cookie, :warning, :unsafe]
         unless extra_keys.empty?
           raise InvalidValue.new(:source,
             "only include valid keys. Invalid keys: #{extra_keys.inspect}")
@@ -274,33 +280,22 @@ module Omnibus
     #     source path: '/local/path/to/software-1.2.3'
     #   end
     #
-    # @deprecated passing only a string without a block to set the version is
-    #   deprecated. Please use {#default_version} instead.
-    #
     # @param [String] val
     #   the version of the software
-    #
     # @param [Proc] block
     #   the block to run if the version we are building matches the argument
     #
     # @return [String, Proc]
     #
-    def version(val = NULL)
+    def version(val = NULL, &block)
       if block_given?
         if val.equal?(NULL)
           raise InvalidValue.new(:version,
             'pass a block when given a version argument')
         else
           if val == apply_overrides(:version)
-            yield
-          end
-        end
-      else
-        unless val.equal?(NULL)
-          log.deprecated(log_key) do
-            'Software#version. Please use #default_version instead.'
+            block.call
           end
-          @version = val
         end
       end
 
@@ -333,14 +328,14 @@ module Omnibus
     # @example
     #   relative_path 'example-1.2.3'
     #
-    # @param [String] relative_path
+    # @param [String] val
     #   the relative path inside the tarball
     #
     # @return [String]
     #
     def relative_path(val = NULL)
       if null?(val)
-        @relative_path ||= name
+        @relative_path || name
       else
         @relative_path = val
       end
@@ -380,56 +375,6 @@ module Omnibus
     end
     expose :install_dir
 
-    #
-    # The path where this software is installed on disk.
-    #
-    # @deprecated Use {#install_dir} instead
-    #
-    # @return (see #install_dir)
-    #
-    def install_path
-      log.deprecated(log_key) do
-        'install_path (DSL). Please use install_dir instead.'
-      end
-
-      install_dir
-    end
-    expose :install_path
-
-    #
-    # Returns the platform of the machine on which Omnibus is running, as
-    # determined by Ohai.
-    #
-    # @deprecated Use +Ohai['platform']+ instead.
-    #
-    # @return [String]
-    #
-    def platform
-      log.deprecated(log_key) do
-        "Software#platform. Please use Ohai['platform'] instead."
-      end
-
-      Ohai['platform']
-    end
-    expose :platform
-
-    #
-    # Return the architecture of the machine, as determined by Ohai.
-    #
-    # @deprecated Will not be replaced.
-    #
-    # @return [String]
-    #   Either "sparc" or "intel", as appropriate
-    #
-    def architecture
-      log.deprecated(log_key) do
-        "Software#architecture. Please use Ohai['kernel']['machine'] instead."
-      end
-
-      Ohai['kernel']['machine'] =~ /sun/ ? 'sparc' : 'intel'
-    end
-    expose :architecture
-
     #
     # Define a series of {Builder} DSL commands that are executed to build the
     # software.
@@ -448,31 +393,36 @@ module Omnibus
     expose :build
 
     #
-    # The path on disk to the downloaded asset. This method requires the
-    # presence of a +source_uri+.
+    # The path to the downloaded file from a NetFetcher.
     #
-    # @todo This is really a property of the {NetFetcher} and should be
-    #   implemented on that class.
+    # @deprecated There is no replacement for this DSL method
     #
-    def downloaded_file
-      @downloaded_file ||= begin
-        raise MissingSoftwareSourceURI.new(self) unless source_uri
+    def project_file
+      if fetcher && fetcher.is_a?(NetFetcher)
+        log.deprecated(log_key) do
+          "project_file (DSL). This is a property of the NetFetcher and will " \
+          "not be publically exposed in the next major release. In general, " \
+          "you should not be using this method in your software definitions " \
+          "as it is an internal implementation detail of the NetFetcher. If " \
+          "you disagree with this statement, you should open an issue on the " \
+          "Omnibus repository on GitHub an explain your use case. For now, " \
+          "I will return the path to the downloaded file on disk, but please " \
+          "rethink the problem you are trying to solve :)."
+        end
 
-        filename = source_uri.path.split('/').last
-        "#{Config.cache_dir}/#{filename}"
-      end
-    end
-    expose :downloaded_file
+        fetcher.downloaded_file
+      else
+        log.warn(log_key) do
+          "Cannot retrieve a `project_file' for software `#{name}'. This " \
+          "attribute is actually an internal representation that is unique " \
+          "to the NetFetcher class and requires the use of a `source' " \
+          "attribute that is declared using a `:url' key. For backwards-" \
+          "compatability, I will return `nil', but this is most likely not " \
+          "your desired behavior."
+        end
 
-    #
-    # @deprecated Use {#downloaded_file} instead
-    #
-    def project_file
-      log.deprecated(log_key) do
-        "project_file (DSL). Please use `downloaded_file' instead."
+        nil
       end
-
-      downloaded_file
     end
     expose :project_file
 
@@ -483,8 +433,8 @@ module Omnibus
     # Supported options:
     #    :aix => :use_gcc    force using gcc/g++ compilers on aix
     #
-    # @params [Hash] env
-    # @params [Hash] opts
+    # @param [Hash] env
+    # @param [Hash] opts
     #
     # @return [Hash]
     #
@@ -568,7 +518,7 @@ module Omnibus
     # project's embedded/bin directory prepended. The correct path separator
     # for the platform is used to join the paths.
     #
-    # @params [Hash] env
+    # @param [Hash] env
     #
     # @return [Hash]
     #
@@ -597,88 +547,17 @@ module Omnibus
     expose :prepend_path
 
     #
-    # The source directory.
-    #
-    # @deprecated Use {Config.source_dir} instead
-    #
-    # @return [String]
-    #
-    def source_dir
-      log.deprecated(log_key) do
-        'source_dir (DSL). Please use Config.source_dir instead.'
-      end
-
-      Config.source_dir
-    end
-    expose :source_dir
-
-    #
-    # The cache directory.
-    #
-    # @deprecated Use {Config.cache_dir} instead
-    #
-    # @return [String]
-    #
-    def cache_dir
-      log.deprecated(log_key) do
-        'cache_dir (DSL). Please use Config.cache_dir instead.'
-      end
-
-      Config.cache_dir
-    end
-    expose :cache_dir
-
-    #
-    # Convenience method for accessing the global Omnibus configuration object.
-    #
-    # @deprecated Use {Config} instead
-    #
-    # @return Config
-    #
-    # @see Config
-    #
-    def config
-      log.deprecated(log_key) do
-        'config (DSL). Please use Config.(thing) instead (capital C).'
-      end
-
-      Config
-    end
-    expose :config
-
-    #
-    # The list of software dependencies for this software. These is the software
-    # that comprises your software, and is distinct from runtime dependencies.
-    #
-    # @deprecated Use {#dependency} instead (as a setter; the getter will stay)
-    #
-    # @todo Remove the "setter" part of this method and unexpose it as part of
-    # the DSL in the next major release
+    # A proxy method to the underlying Ohai system.
     #
-    # @see #dependency
-    #
-    # @param [Array<String>]
+    # @example
+    #   ohai['platform_family']
     #
-    # @return [Array<String>]
+    # @return [Ohai]
     #
-    def dependencies(*args)
-      @dependencies ||= []
-
-      # Handle the case where an array or list of args were given
-      flattened_args = Array(args).flatten
-
-      if flattened_args.empty?
-        @dependencies
-      else
-        log.deprecated(log_key) do
-          "dependencies (DSL). Please specify each dependency on its own " \
-          "line like `dependency '#{flattened_args.first}'`."
-        end
-
-        @dependencies = flattened_args
-      end
+    def ohai
+      Ohai
     end
-    expose :dependencies
+    expose :ohai
 
     #
     # @!endgroup
@@ -691,6 +570,19 @@ module Omnibus
     # be the "public API" for a software.
     # --------------------------------------------------
 
+    #
+    # Recursively load all the dependencies for this software.
+    #
+    # @return [true]
+    #
+    def load_dependencies
+      dependencies.each do |dependency|
+        software = Software.load(project, dependency)
+      end
+
+      true
+    end
+
     #
     # The builder object for this software definition.
     #
@@ -709,11 +601,6 @@ module Omnibus
     #   true if the software was fetched, false if it was cached
     #
     def fetch
-      # Create the directories we need
-      [build_dir, Config.source_dir, Config.cache_dir, project_dir].each do |dir|
-        FileUtils.mkdir_p(dir)
-      end
-
       if fetcher.fetch_required?
         fetcher.fetch
         true
@@ -722,6 +609,20 @@ module Omnibus
       end
     end
 
+    #
+    # The list of software dependencies for this software. These is the software
+    # that comprises your software, and is distinct from runtime dependencies.
+    #
+    # @see #dependency
+    #
+    # @param [Array<String>]
+    #
+    # @return [Array<String>]
+    #
+    def dependencies
+      @dependencies ||= []
+    end
+
     #
     # The list of files to ignore in the healthcheck.
     #
@@ -751,9 +652,6 @@ module Omnibus
         # lazily initialized because we need the 'name' to be parsed first
         @overrides = {}
         @overrides = project.overrides[name.to_sym].dup if project.overrides[name.to_sym]
-        if @repo_overrides[name]
-          @overrides[:version] = @repo_overrides[name]
-        end
       end
 
       @overrides
@@ -774,24 +672,9 @@ module Omnibus
     # @!endgroup
     # --------------------------------------------------
 
-    #
-    # Retieve the {#default_version} of the software.
-    #
-    # @deprecated Use {#default_version} instead.
-    #
-    # @return [String]
-    #
-    def given_version
-      log.deprecated(log_key) do
-        'Software#given_version. Please use #default_version instead.'
-      end
-
-      default_version
-    end
-
     # @todo see comments on {Omnibus::Fetcher#without_caching_for}
     def version_guid
-      Fetcher.for(self).version_guid
+      fetcher.version_guid
     end
 
     # Returns the version to be used in cache.
@@ -811,42 +694,42 @@ module Omnibus
       end
     end
 
-    # @todo Code smell... this only has meaning if the software was
-    #   defined with a :uri, and this is only used in
-    #   {Omnibus::NetFetcher}.  This responsibility is distributed
-    #   across two classes, one of which is a specific interface
-    #   implementation
-    # @todo Why the caching of the URI?
-    def source_uri
-      @source_uri ||= URI(source[:url])
-    end
-
-    # @todo Code smell... this only has meaning if the software was
-    #   defined with a :uri, and this is only used in
-    #   {Omnibus::NetFetcher}.  This responsibility is distributed
-    #   across two classes, one of which is a specific interface
-    #   implementation
-    def checksum
-      source[:md5]
-    end
-
-    # The fetcher for this software.
+    #
+    # The fetcher for this software, based off of the +source+ attribute.
+    #
+    # - +:url+ - {NetFetcher}
+    # - +:git+ - {GitFetcher}
+    # - +:path+ - {PathFetcher}
     #
     # @return [Fetcher]
+    #
     def fetcher
-      @fetcher ||= Fetcher.for(self)
+      @fetcher ||= if source
+        if source[:url]
+          NetFetcher.new(self)
+        elsif source[:git]
+          GitFetcher.new(self)
+        elsif source[:path]
+          PathFetcher.new(self)
+        end
+      else
+        NullFetcher.new(self)
+      end
     end
 
     # Actually build the software package
     def build_me
       # Build if we need to
       if always_build?
-        execute_build(fetcher)
+        log.info(log_key) { "Forcing build because `always_build' was given" }
+        execute_build
       else
         if GitCache.new(self).restore
+          log.info(log_key) { "Restored from cache" }
           true
         else
-          execute_build(fetcher)
+          log.info(log_key) { "Could not restore from cache, building..." }
+          execute_build
         end
       end
 
@@ -890,12 +773,6 @@ module Omnibus
       @shasum ||= begin
         digest = Digest::SHA256.new
 
-        log.debug(log_key) { "project (SHA): #{project.shasum.inspect}" }
-        log.debug(log_key) { "builder (SHA): #{builder.shasum.inspect}" }
-        log.debug(log_key) { "name: #{name.inspect}" }
-        log.debug(log_key) { "version_for_cache: #{version_for_cache.inspect}" }
-        log.debug(log_key) { "overrides: #{overrides.inspect}" }
-
         update_with_string(digest, project.shasum)
         update_with_string(digest, builder.shasum)
         update_with_string(digest, name)
@@ -903,18 +780,12 @@ module Omnibus
         update_with_string(digest, JSON.fast_generate(overrides))
 
         if filepath && File.exist?(filepath)
-          log.debug(log_key) { "filepath: #{filepath.inspect}" }
           update_with_file_contents(digest, filepath)
         else
-          log.debug(log_key) { "filepath: <DYNAMIC>" }
           update_with_string(digest, '<DYNAMIC>')
         end
 
-        shasum = digest.hexdigest
-
-        log.debug(log_key) { "shasum: #{shasum.inspect}" }
-
-        shasum
+        digest.hexdigest
       end
     end
 
@@ -967,23 +838,13 @@ module Omnibus
       end
     end
 
-    # @todo Remove this in the next major release
-    def command(*)
-      log.deprecated(log_key) do
-        'Software#command. Please use something else.'
-      end
-
-      raise 'Method Moved.'
-    end
-
-    def execute_build(fetcher)
+    def execute_build
       fetcher.clean
       builder.build
 
       if Config.use_git_caching
-        log.info(log_key) { 'Caching build' }
         GitCache.new(self).incremental
-        log.info(log_key) { 'Dirtied the cache!' }
+        log.info(log_key) { 'Dirtied the cache' }
       end
 
       project.dirty!