buildpack-support 1.0.0

data/lib/buildpack_support/format_duration.rb

@@ -0,0 +1,57 @@
+# Encoding: utf-8
+# Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# A mixin that adds the ability to format a +Numeric+ as a user-readable duration
+class Numeric
+
+  # Formats a number as a user-readable duration
+  #
+  # @return [String] a user-readable duration. Follows the following algorithm
+  #                   1. If more than an hour, print hours and minutes
+  #                   2. If less than an hour and more than a minute, print minutes and seconds
+  #                   3. If less than a minute and more than a second, print seconds.tenths
+  def duration
+    remainder = self
+
+    hours     = (remainder / HOUR).to_int
+    remainder -= HOUR * hours
+
+    minutes   = (remainder / MINUTE).to_int
+    remainder -= MINUTE * minutes
+
+    return "#{hours}h #{minutes}m" if hours > 0
+
+    seconds   = (remainder / SECOND).to_int
+    remainder -= SECOND * seconds
+
+    return "#{minutes}m #{seconds}s" if minutes > 0
+
+    tenths = (remainder / TENTH).to_int
+    "#{seconds}.#{tenths}s"
+  end
+
+  MILLISECOND = 0.001.freeze
+
+  TENTH = (100 * MILLISECOND).freeze
+
+  SECOND = (10 * TENTH).freeze
+
+  MINUTE = (60 * SECOND).freeze
+
+  HOUR = (60 * MINUTE).freeze
+
+  private_constant :MILLISECOND, :TENTH, :SECOND, :MINUTE, :HOUR
+
+end

data/lib/buildpack_support/logging.rb

@@ -0,0 +1,22 @@
+# Encoding: utf-8
+# Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BuildpackSupport
+
+  # A module encapsulating all of the code for the logging utilities
+  module Logging
+  end
+
+end

data/lib/buildpack_support/logging/delegating_logger.rb

@@ -0,0 +1,48 @@
+# Encoding: utf-8
+# Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'buildpack_support/logging'
+require 'logger'
+
+module BuildpackSupport
+  module Logging
+
+    # A +Logger+ subclass that forwards all messages to a collection of delegates
+    class DelegatingLogger < ::Logger
+
+      # Creates an instance
+      #
+      # @param [Class] klass the class to use as the +progname+ for log messages
+      # @param [Array<Logger>] delegates the +Logger+ instances to delegate to
+      def initialize(klass, delegates)
+        @klass     = klass
+        @delegates = delegates
+      end
+
+      # Adds a message to the delegate +Logger+ instances
+      #
+      # @param [Logger::Severity] severity the severity of the message
+      # @param [String] message the message
+      # @param [String] progname the message when passed in as a parameter
+      # @yield evaluated for the message
+      # @return [Void]
+      def add(severity, message = nil, progname = nil, &block)
+        @delegates.each { |delegate| delegate.add severity, message || progname, @klass, &block }
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/logging/logger_factory.rb

@@ -0,0 +1,148 @@
+# Encoding: utf-8
+# Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'buildpack_support/logging'
+require 'buildpack_support/logging/delegating_logger'
+require 'buildpack_support/configuration_utils'
+require 'buildpack_support/constantize'
+require 'fileutils'
+require 'logger'
+require 'monitor'
+require 'singleton'
+
+module BuildpackSupport
+  module Logging
+
+    # Responsible for configuring and creating all +Logger+ instances.  +Logger+s created by the factory log all messages
+    # to a file located at +app_dir/.buildpack.log+.  They also log all messages, filtered by the configured
+    # severity, to +$stderr+.  Severity can be configured (in decreasing priority) by using the +JBP_LOG_LEVEL+
+    # environment variable, the Ruby +$DEBUG+ and +$VERBOSE+ flags, and the +config/logging.yml+ file.  If none of these
+    # is set, then the severity defaults to +INFO+.
+    class LoggerFactory
+      include ::Singleton
+
+      attr_reader :initialized
+
+      def initialize
+        @configuration_utils = BuildpackSupport::ConfigurationUtils.new false
+        @monitor = Monitor.new
+      end
+
+      # Sets up the logger factory
+      #
+      # @param [Pathname] app_dir the application directory
+      # @return [Void]
+      def setup(app_dir)
+        @monitor.synchronize do
+          @log_file    = app_dir + '.buildpack.log'
+          @delegates   = [file_logger, console_logger]
+          @initialized = true
+        end
+      end
+
+      # Returns a configured logger for a given +Class+.  The +Class+ that is passed in is used as the +progname+, for all
+      # messages logged by the logger. If this is called before the +setup()+ method, a failure will be generated.
+      #
+      # @param [Class] klass the class that the logger is created for
+      # @return [Logger] the logger that was requested
+      def get_logger(klass)
+        @monitor.synchronize do
+          fail "Attempted to get Logger for #{short_class(klass)} before initialization" unless @initialized
+          DelegatingLogger.new wrapped_short_class(klass), @delegates
+        end
+      end
+
+      # Returns the location of the log file.  If this is called before the +setup()+ method, a failure will be generated.
+      #
+      # @return [Pathname] the location of the log file
+      def log_file
+        @monitor.synchronize do
+          fail 'Attempted to get log file before initialization' unless @initialized
+          @log_file
+        end
+      end
+
+      # Resets the configuration of the factory
+      #
+      # @return [Void]
+      def reset
+        @monitor.synchronize do
+          @initialized = false
+        end
+      end
+
+      class << self
+
+        # Returns a configured logger for a given +Class+.  The +Class+ that is passed in is used as the +progname+, for all
+        # messages logged by the logger. If this is called before the +setup()+ method, a failure will be generated.  Note this
+        #
+        # @param [Class] klass the class that the logger is created for
+        # @return [Logger] the logger that was requested
+        # @deprecated use +LoggerFactory.instance.get_logger(klass)+ instead
+        def get_logger(klass)
+          LoggerFactory.instance.get_logger(klass)
+        end
+
+      end
+
+      private
+
+      def console_logger
+        logger           = Logger.new($stderr)
+        logger.level     = severity
+        logger.formatter = lambda do |severity, _datetime, klass, message|
+          "#{klass.ljust(32)} #{severity.ljust(5)} #{message}\n"
+        end
+
+        logger
+      end
+
+      def file_logger
+        FileUtils.mkdir_p File.dirname(@log_file)
+
+        logger           = Logger.new(@log_file)
+        logger.level     = ::Logger::DEBUG
+        logger.formatter = lambda do |severity, datetime, klass, message|
+          "#{datetime.strftime('%FT%T.%2N%z')} #{klass.ljust(32)} #{severity.ljust(5)} #{message}\n"
+        end
+
+        logger
+      end
+
+      def ruby_mode
+        $VERBOSE || $DEBUG ? 'DEBUG' : nil
+      end
+
+      def severity
+        severity = ENV['BP_LOG_LEVEL']
+        severity = ruby_mode unless severity
+        severity = @configuration_utils.load('logging')['default_log_level'] unless severity
+        severity = 'INFO' unless severity
+
+        "::Logger::Severity::#{severity.upcase}".constantize
+      end
+
+      def short_class(klass)
+        klass.to_s.split('::').last
+      end
+
+      def wrapped_short_class(klass)
+        "[#{short_class(klass)}]"
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/qualify_path.rb

@@ -0,0 +1,36 @@
+# Encoding: utf-8
+# Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License. language governing permissions and
+# limitations under the License.
+
+require 'buildpack_support'
+
+module BuildpackSupport
+
+  # Mixin with a method for qualifying a given path relative to a root
+  module QualifyPath
+
+    # Qualifies the path such that is is formatted as +$PWD/<path>+.  Also ensures that the path is relative to a root,
+    # which defaults to the +@droplet_root+ of the class.
+    #
+    # @param [Pathname] path the path to qualify
+    # @param [Pathname] root the root to make relative to
+    # @return [String] the qualified path
+    def qualify_path(path, root = @droplet_root)
+      "$PWD/#{path.relative_path_from(root)}"
+    end
+
+  end
+
+end

data/lib/buildpack_support/rake.rb

@@ -0,0 +1,22 @@
+# Encoding: utf-8
+# Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module BuildpackSupport
+
+  # A module encapsulating all of the code for the Rake utilities
+  module Rake
+  end
+
+end

data/lib/buildpack_support/rake/buildpack_stage_task.rb

@@ -0,0 +1,86 @@
+# Encoding: utf-8
+# Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'buildpack_support/rake'
+require 'rake'
+require 'rake/tasklib'
+require 'yaml'
+
+module BuildpackSupport
+  module Rake
+
+    # A task generator for the tasks that copy files to the staging directory
+    class BuildpackStageTask < ::Rake::TaskLib
+
+      # @!attribute [rw] files
+      # @return [Array<String>] the files to copy to the +staging_dir+
+      attr_accessor :files
+
+      # @!attribute [rw] package_name
+      # @return [String] the name of the package
+      attr_accessor :package_name
+
+      # @!attribute [rw] staging_dir
+      # @return [String] the directory to zip the contents of
+      attr_accessor :staging_dir
+
+      # @!attribute [rw] verbose
+      # @return [Boolean] the verbosity of the task.  Defaults to +false+.
+      attr_accessor :verbose
+
+      # Creates an instance
+      def initialize(&task_block)
+        @verbose = false
+
+        task_block.call(*[self].slice(0, task_block.arity)) if task_block
+        abort 'files must be configured' unless files
+        abort 'package_name must be configured' unless package_name
+        abort 'staging_dir must be configured' unless staging_dir
+
+        create_copy_tasks files, package_name, staging_dir, verbose
+      end
+
+      # Runs the task
+      #
+      # @param [String] source the file to copy
+      # @param [String] target where to copy the file to
+      # @param [Boolean] verbose whether to print messages to the console
+      # @return [void]
+      def run_task(source, target, verbose)
+        RakeFileUtils.verbose(verbose) do
+          mkdir_p File.dirname(target)
+          cp source, target
+        end
+      end
+
+      private
+
+      def create_copy_tasks(files, package_name, staging_dir, verbose)
+        files.reject { |f| File.directory? f }.each do |source|
+          target = target(source, staging_dir)
+
+          task package_name => target
+          file(target => source) { |t| run_task t.source, t.name, verbose }
+        end
+      end
+
+      def target(file, staging_dir)
+        "#{staging_dir}/#{file}"
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/rake/cached_artifact_finder.rb

@@ -0,0 +1,99 @@
+# Encoding: utf-8
+# # Copyright 2013-2014 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'buildpack_support/cache/download_cache'
+require 'buildpack_support/configuration_utils'
+require 'buildpack_support/rake'
+require 'buildpack_support/repository/wildcard_version_resolver'
+require 'buildpack_support/tokenized_version'
+require 'yaml'
+
+module BuildpackSupport
+  module Rake
+
+    # A class that finds all artifacts eligible to be cached
+    class CachedArtifactFinder
+
+      # Creates a new instance
+      def initialize
+        @cache                   = BuildpackSupport::Cache::DownloadCache.new
+        @configuration_utils     = BuildpackSupport::ConfigurationUtils.new
+        @default_repository_root = @configuration_utils.load('repository')['default_repository_root'].chomp('/')
+        @version_resolver        = BuildpackSupport::Repository::WildcardVersionResolver.new
+      end
+
+      # Returns a collection of URIs to be cached
+      #
+      # @param [Array<Hash>] configurations a collection of hashes that contain repository configurations
+      # @return [Array<String>] a collection of uris to be cached
+      def find(configurations)
+        configurations.map do |configuration|
+          index_uris(configuration).map do |index_uri|
+            [index_uri, cached_artifact(configuration, index_uri)]
+          end
+        end.flatten
+      end
+
+      private
+
+      ARCHITECTURES = %w(x86_64).freeze
+
+      PLATFORMS = %w(centos6 lucid mountainlion precise trusty).freeze
+
+      private_constant :ARCHITECTURES, :PLATFORMS
+
+      def augment(raw, pattern, candidates)
+        raw =~ pattern ? candidates.map { |p| raw.gsub pattern, p } : raw
+      end
+
+      def augment_architecture(raw)
+        augment(raw, /\{architecture\}/, ARCHITECTURES)
+      end
+
+      def augment_path(raw)
+        "#{raw.chomp('/')}/index.yml"
+      end
+
+      def augment_platform(raw)
+        augment(raw, /\{platform\}/, PLATFORMS)
+      end
+
+      def augment_repository_root(raw)
+        raw.gsub(/\{default.repository.root\}/, @default_repository_root)
+      end
+
+      def cached_artifact(configuration, index_uri)
+        @cache.get(index_uri) do |f|
+          index = YAML.load f
+          index[resolved_version(configuration, index).to_s]
+        end
+      end
+
+      def index_uris(configuration)
+        [configuration['repository_root']]
+        .map { |r| augment_repository_root r }
+        .map { |r| augment_platform r }.flatten
+        .map { |r| augment_architecture r }.flatten
+        .map { |r| augment_path r }
+      end
+
+      def resolved_version(configuration, index)
+        @version_resolver.resolve(BuildpackSupport::TokenizedVersion.new(configuration['version']), index.keys)
+      end
+
+    end
+
+  end
+end