buildpack-support 1.0.0

data/lib/buildpack_support/rake/repository_configuration_finder.rb

@@ -0,0 +1,66 @@
+# 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/configuration_utils'
+require 'buildpack_support/rake'
+require 'buildpack_support/snake_case'
+require 'yaml'
+
+module BuildpackSupport
+  module Rake
+
+    # A class that finds all eligible repository configurations
+    class RepositoryConfigurationFinder
+
+      # Creates a new instance
+      def initialize
+        @configuration_utils = BuildpackSupport::ConfigurationUtils.new
+      end
+
+      # Returns a collection of hashes that contain repository configurations
+      #
+      # @return [Array<Hash>] a collection of hashes that contain repository configurations
+      def find
+        component_ids.map do |component_id|
+          configurations(@configuration_utils.load(component_id))
+        end.flatten
+      end
+
+      private
+
+      def component_ids
+        @configuration_utils.load('components').values.flatten.map { |component| component.split('::').last.snake_case }
+      end
+
+      def configurations(configuration)
+        configurations = []
+
+        if repository_configuration?(configuration)
+          configurations << configuration
+        else
+          configuration.values.each { |v| configurations << configurations(v) if v.is_a? Hash }
+        end
+
+        configurations
+      end
+
+      def repository_configuration?(configuration)
+        configuration['version'] && configuration['repository_root']
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/rake/write_version_file_task.rb

@@ -0,0 +1,82 @@
+# 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 task that creates version file.
+    class WriteVersionFileTask < ::Rake::TaskLib
+
+      # @!attribute [rw] buildpack_version
+      # @return [BuildpackSupport::BuildpackVersion] the version of the buildpack.
+      attr_accessor :buildpack_version
+
+      # @!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 'buildpack_version must be configured' unless buildpack_version
+        abort 'package_name must be configured' unless package_name
+        abort 'staging_dir must be configured' unless staging_dir
+
+        create_task buildpack_version, package_name, staging_dir, verbose
+      end
+
+      # Runs the task
+      #
+      # @param [String] name the file to write to
+      # @param [BuildpackSupport::BuildpackVersion] buildpack_version the buildpack version to write to the file
+      # @param [Boolean] verbose whether to print messages to the console
+      # @return [void]
+      def run_task(name, buildpack_version, verbose)
+        RakeFileUtils.verbose(verbose) { mkdir_p File.dirname(name) }
+        File.open(name, 'w') { |f| f.write(buildpack_version.to_hash.to_yaml) }
+        rake_output_message "Wrote buildpack version to #{name}" if verbose
+      end
+
+      private
+
+      def create_task(buildpack_version, package_name, staging_dir, verbose)
+        target = target staging_dir
+        task package_name => target
+        file(target) { |t| run_task t.name, buildpack_version, verbose }
+      end
+
+      def target(staging_dir)
+        "#{staging_dir}/config/version.yml"
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/repository.rb

@@ -0,0 +1,24 @@
+# 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'
+
+module BuildpackSupport
+
+  # A module encapsulating all of the code for the repository utilities
+  module Repository
+  end
+
+end

data/lib/buildpack_support/repository/configured_item.rb

@@ -0,0 +1,81 @@
+# 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/repository'
+require 'buildpack_support/repository/repository_index'
+require 'buildpack_support/repository/wildcard_version_resolver'
+require 'buildpack_support/tokenized_version'
+
+module BuildpackSupport
+  module Repository
+
+    # A class encapsulating details of a file stored in a versioned repository.
+    class ConfiguredItem
+
+      # Creates a new instance
+      #
+      # @param [VersionResolver] version_resolver the version resolver to use when finding items
+      def initialize(version_resolver = WildcardVersionResolver.new)
+        @version_resolver = version_resolver
+      end
+
+      # Finds an instance of the file based on the configuration and wraps any exceptions
+      # to identify the component.
+      #
+      # @param [String] component_name the name of the component
+      # @param [Hash] configuration the configuration
+      # @option configuration [String] :repository_root the root directory of the repository
+      # @option configuration [String] :version the version of the file to resolve
+      # @yield the version to a block for validation.  An error should be raised if the version is not valid
+      # @yieldparam version [BuildpackSupport::TokenizedVersion] the version to validate
+      # @return [String] the URI of the chosen version of the file
+      # @return [TokenizedVersion] the chosen version of the file
+      def find_item(component_name, configuration)
+        repository_root = repository_root(configuration)
+        version         = version(configuration)
+
+        yield version if block_given?
+
+        index = index(repository_root)
+        index.find_item version
+      rescue => e
+        raise RuntimeError, "#{component_name} error: #{e.message}", e.backtrace
+      end
+
+      private
+
+      KEY_REPOSITORY_ROOT = 'repository_root'.freeze
+
+      KEY_VERSION = 'version'.freeze
+
+      private_constant :KEY_REPOSITORY_ROOT, :KEY_VERSION
+
+      def index(repository_root)
+        RepositoryIndex.new(repository_root, @version_resolver)
+      end
+
+      def repository_root(configuration)
+        fail "A repository root must be specified as a key-value pair of '#{KEY_REPOSITORY_ROOT}'' to the URI of the repository." unless configuration.key? KEY_REPOSITORY_ROOT
+        configuration[KEY_REPOSITORY_ROOT]
+      end
+
+      def version(configuration)
+        BuildpackSupport::TokenizedVersion.new(configuration[KEY_VERSION])
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/repository/repository_index.rb

@@ -0,0 +1,98 @@
+# 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/logging/logger_factory'
+require 'buildpack_support/repository'
+require 'buildpack_support/repository/wildcard_version_resolver'
+require 'rbconfig'
+require 'yaml'
+
+module BuildpackSupport
+  module Repository
+
+    # A repository index represents the index of repository containing various versions of a file.
+    class RepositoryIndex
+
+      # Creates a new repository index, populating it with values from an index file.
+      #
+      # @param [String] repository_root the root of the repository to create the index for
+      # @param [VersionResolver] version_resolver the version resolver to use when finding items
+      def initialize(repository_root, version_resolver = WildcardVersionResolver.new)
+        @logger           = BuildpackSupport::Logging::LoggerFactory.instance.get_logger RepositoryIndex
+        @version_resolver = version_resolver
+
+        default_repository_root = BuildpackSupport::ConfigurationUtils.new.load('repository')['default_repository_root'].chomp('/')
+        cache.get("#{canonical default_repository_root, repository_root}#{INDEX_PATH}") do |file|
+          @index = YAML.load_file(file)
+          @logger.debug { @index }
+        end
+      end
+
+      # Finds a version of the file matching the given, possibly wildcarded, version.
+      #
+      # @param [String] version the possibly wildcarded version to find
+      # @return [TokenizedVersion] the version of the file found
+      # @return [String] the URI of the file found
+      def find_item(version)
+        version = @version_resolver.resolve(version, @index.keys)
+        uri     = @index[version.to_s]
+        [version, uri]
+      end
+
+      private
+
+      INDEX_PATH = '/index.yml'.freeze
+
+      private_constant :INDEX_PATH
+
+      def architecture
+        `uname -m`.strip
+      end
+
+      def cache
+        BuildpackSupport::Cache::DownloadCache.new(Pathname.new(Dir.tmpdir),
+                                                   BuildpackSupport::Cache::DownloadCache::CACHED_RESOURCES_DIRECTORY)
+      end
+
+      def canonical(default_root, raw)
+        cooked = raw
+        .gsub(/\{default.repository.root\}/, default_root)
+        .gsub(/\{platform\}/, platform)
+        .gsub(/\{architecture\}/, architecture)
+        .chomp('/')
+        @logger.debug { "#{raw} expanded to #{cooked}" }
+        cooked
+      end
+
+      def platform
+        redhat_release = Pathname.new('/etc/redhat-release')
+
+        if redhat_release.exist?
+          "centos#{redhat_release.read.match(/CentOS release (\d)/)[1]}"
+        elsif `uname -s` =~ /Darwin/
+          'mountainlion'
+        elsif !`which lsb_release 2> /dev/null`.empty?
+          `lsb_release -cs`.strip
+        else
+          fail 'Unable to determine platform'
+        end
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/repository/wildcard_version_resolver.rb

@@ -0,0 +1,75 @@
+# 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/repository'
+require 'buildpack_support/tokenized_version'
+
+module BuildpackSupport
+  module Repository
+
+    # A resolver that selects values from a collection based on a set of rules governing wildcards
+    class WildcardVersionResolver
+
+      # Resolves a version from a collection of versions.  The +candidate_version+ must be structured like:
+      #   * up to three numeric components, followed by an optional string component
+      #   * the final component may be a +
+      # The resolution returns the maximum of the versions that match the candidate version
+      #
+      # @param [TokenizedVersion] candidate_version the version, possibly containing a wildcard, to resolve.  If +nil+,
+      #                                        substituted with +.
+      # @param [Array<String>] versions the collection of versions to resolve against
+      # @return [TokenizedVersion] the resolved version
+      # @raise if no version can be resolved
+      def resolve(candidate_version, versions)
+        tokenized_candidate_version = safe_candidate_version candidate_version
+        tokenized_versions          = versions.map { |version| BuildpackSupport::TokenizedVersion.new(version, false) }
+
+        version = tokenized_versions
+        .select { |tokenized_version| matches? tokenized_candidate_version, tokenized_version }
+        .max { |a, b| a <=> b }
+
+        fail "No version resolvable for '#{candidate_version}' in #{versions.join(', ')}" if version.nil?
+        version
+      end
+
+      private
+
+      TOKENIZED_WILDCARD = BuildpackSupport::TokenizedVersion.new('+').freeze
+
+      private_constant :TOKENIZED_WILDCARD
+
+      def safe_candidate_version(candidate_version)
+        if candidate_version.nil?
+          TOKENIZED_WILDCARD
+        else
+          unless candidate_version.is_a?(BuildpackSupport::TokenizedVersion)
+            fail "Invalid TokenizedVersion '#{candidate_version}'"
+          end
+          candidate_version
+        end
+      end
+
+      def matches?(tokenized_candidate, tokenized_version)
+        (0..3).all? do |i|
+          tokenized_candidate[i].nil? ||
+            tokenized_candidate[i] == BuildpackSupport::TokenizedVersion::WILDCARD ||
+            tokenized_candidate[i] == tokenized_version[i]
+        end
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/shell.rb

@@ -0,0 +1,41 @@
+# 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'
+require 'open3'
+
+module BuildpackSupport
+
+  # A mixin that provides a +shell()+ command
+  module Shell
+
+    # A +system()+-like command that ensure that the execution fails if the command returns a non-zero exit code
+    #
+    # @param [String] command the command to run
+    # @return [Void]
+    def shell(command)
+      Open3.popen3(command) do |_stdin, stdout, stderr, wait_thr|
+        if wait_thr.value != 0
+          puts "\nCommand '#{command}' has failed"
+          puts "STDOUT: #{stdout.gets}"
+          puts "STDERR: #{stderr.gets}"
+
+          fail
+        end
+      end
+    end
+
+  end
+end