buildpack-support 1.0.0

data/lib/buildpack_support/snake_case.rb

@@ -0,0 +1,30 @@
+# 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 turn a +String+ into snake case
+class String
+
+  # Converts a string to snake case. For example, the String +Rattle::SnakeCase+ would become +rattle/snake_case+.
+  #
+  # @return [String] The snake case rendering of this +String+
+  def snake_case
+    gsub(/::/, '/')
+    .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+    .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+    .tr('-', '_')
+    .downcase
+  end
+
+end

data/lib/buildpack_support/space_case.rb

@@ -0,0 +1,29 @@
+# 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 turn a +String+ into space case
+class String
+
+  # Converts a string to space case. For example, the String +SpaceCase+ would become +Space Case+.
+  #
+  # @return [String] The space case rendering of this +String+
+  def space_case
+    split('::').last
+    .gsub(/([A-Z]+)([A-Z][a-z])/, '\1 \2')
+    .gsub(/([a-z\d])([A-Z])/, '\1 \2')
+    .tr('-', ' ')
+  end
+
+end

data/lib/buildpack_support/test/application_helper.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 'spec_helper'
+require 'buildpack_support/test/environment_helper'
+require 'buildpack_support/test/scratch_helper'
+
+shared_context 'application_helper' do
+  include_context 'environment_helper'
+  include_context 'scratch_helper'
+
+  let(:application) { BuildpackSupport::Component::Application.new scratch_dir }
+
+  let(:vcap_application) { { 'application_name' => 'test-application-name' } }
+
+  let(:vcap_services) do
+    { 'test-service-n/a' => [{ 'name'        => 'test-service-name', 'label' => 'test-service-n/a',
+                               'tags'        => ['test-service-tag'], 'plan' => 'test-plan',
+                               'credentials' => { 'uri' => 'test-uri' } }] }
+  end
+
+  before do |example|
+    app_fixture = example.metadata[:app_fixture]
+    FileUtils.cp_r "spec/fixtures/#{app_fixture.chomp}/.", scratch_dir if app_fixture
+
+    application
+  end
+
+end

data/lib/buildpack_support/test/base_component_helper.rb

@@ -0,0 +1,59 @@
+# 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 'spec_helper'
+require 'buildpack_support/cache/application_cache'
+require 'buildpack_support/repository/configured_item'
+require 'buildpack_support/space_case'
+require 'buildpack_support/test/application_helper'
+require 'buildpack_support/test/base_droplet_helper'
+require 'buildpack_support/test/console_helper'
+require 'buildpack_support/test/internet_availability_helper'
+require 'buildpack_support/test/logging_helper'
+require 'buildpack_support/tokenized_version'
+require 'pathname'
+
+shared_context 'base_component_helper' do
+  include_context 'application_helper'
+  include_context 'base_droplet_helper'
+  include_context 'console_helper'
+  include_context 'internet_availability_helper'
+  include_context 'logging_helper'
+
+  let(:application_cache) { double('ApplicationCache') }
+
+  let(:component) { described_class.new context }
+  let(:configuration) { {} }
+
+  let(:context) do
+    { application:    application,
+      component_name: described_class.to_s.split('::').last.space_case,
+      configuration:  configuration,
+      droplet:        droplet }
+  end
+
+  let(:uri) { 'test-uri' }
+  let(:version) { '0.0.0' }
+
+  # Mock application cache with cache fixture
+  before do |example|
+    allow(BuildpackSupport::Cache::ApplicationCache).to receive(:new).and_return(application_cache)
+
+    cache_fixture = example.metadata[:cache_fixture]
+    allow(application_cache).to receive(:get).with(uri)
+                                .and_yield(Pathname.new("spec/fixtures/#{cache_fixture}").open, false) if cache_fixture
+  end
+
+end

data/lib/buildpack_support/test/base_droplet_helper.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.
+
+require 'spec_helper'
+require 'buildpack_support/component/base_droplet'
+require 'buildpack_support/snake_case'
+require 'buildpack_support/test/console_helper'
+require 'buildpack_support/test/logging_helper'
+require 'buildpack_support/test/scratch_helper'
+
+shared_context 'base_droplet_helper' do
+  include_context 'console_helper'
+  include_context 'logging_helper'
+  include_context 'scratch_helper'
+
+  let(:component_id) { described_class.to_s.split('::').last.snake_case }
+
+  let(:droplet) do
+    BuildpackSupport::Component::BaseDroplet.new(component_id, scratch_dir)
+  end
+
+  let(:sandbox) { droplet.sandbox }
+
+end

data/lib/buildpack_support/test/console_helper.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.
+
+require 'spec_helper'
+require 'tee'
+
+shared_context 'console_helper' do
+
+  STDOUT.sync
+  STDERR.sync
+
+  let(:stdout) { StringIO.new }
+  let(:stderr) { StringIO.new }
+
+  before do |example|
+    $stdout = Tee.open(stdout, stdout: nil)
+    $stderr = Tee.open(stderr, stdout: nil)
+
+    if example.metadata[:show_output]
+      $stdout.add STDOUT
+      $stderr.add STDERR
+    end
+  end
+
+  after do
+    $stderr = STDERR
+    $stdout = STDOUT
+  end
+
+  def capture_output(out, err)
+    t_out = Thread.new { copy_stream(out, $stdout) }
+    t_err = Thread.new { copy_stream(err, $stderr) }
+
+    t_out.join
+    t_err.join
+  end
+
+  def copy_stream(source, destination)
+    while (buff = source.read(1))
+      destination.write(buff)
+      destination.flush
+    end
+  end
+
+end

data/lib/buildpack_support/test/environment_helper.rb

@@ -0,0 +1,32 @@
+# 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 'spec_helper'
+
+shared_context 'environment_helper' do
+
+  previous_environment = ENV.to_hash
+
+  let(:environment) { {} }
+
+  before do
+    ENV.update environment
+  end
+
+  after do
+    ENV.replace previous_environment
+  end
+
+end

data/lib/buildpack_support/test/internet_availability_helper.rb

@@ -0,0 +1,29 @@
+# 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 'spec_helper'
+require 'buildpack_support/cache/internet_availability'
+require 'buildpack_support/test/logging_helper'
+
+shared_context 'internet_availability_helper' do
+  include_context 'logging_helper'
+
+  # Re-initialize internet availability
+  before do |example|
+    BuildpackSupport::Cache::InternetAvailability.instance.send :initialize
+    BuildpackSupport::Cache::InternetAvailability.instance.available false if example.metadata[:disable_internet]
+  end
+
+end

data/lib/buildpack_support/test/logging_helper.rb

@@ -0,0 +1,50 @@
+# 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 'spec_helper'
+require 'buildpack_support/test/console_helper'
+require 'buildpack_support/test/scratch_helper'
+require 'fileutils'
+require 'buildpack_support/logging/logger_factory'
+
+shared_context 'logging_helper' do
+  include_context 'console_helper'
+  include_context 'scratch_helper'
+
+  previous_log_level     = ENV['JBP_LOG_LEVEL']
+  previous_debug_level   = $DEBUG
+  previous_verbose_level = $VERBOSE
+
+  let(:log_contents) { (scratch_dir + '.buildpack.log').read }
+
+  before do |example|
+    log_level            = example.metadata[:log_level]
+    ENV['BP_LOG_LEVEL'] = log_level if log_level
+
+    $DEBUG   = example.metadata[:debug]
+    $VERBOSE = example.metadata[:verbose]
+
+    BuildpackSupport::Logging::LoggerFactory.instance.setup scratch_dir
+  end
+
+  after do
+    BuildpackSupport::Logging::LoggerFactory.instance.reset
+
+    ENV['BP_LOG_LEVEL'] = previous_log_level
+    $VERBOSE             = previous_verbose_level
+    $DEBUG               = previous_debug_level
+  end
+
+end

data/lib/buildpack_support/test/scratch_helper.rb

@@ -0,0 +1,32 @@
+# 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 'spec_helper'
+require 'fileutils'
+require 'pathname'
+
+shared_context 'scratch_helper' do
+
+  let(:scratch_dir) { Pathname.new Dir.mktmpdir }
+
+  before do
+    FileUtils.mkdir_p scratch_dir
+  end
+
+  after do
+    FileUtils.rm_rf scratch_dir
+  end
+
+end

data/lib/buildpack_support/test/versioned_dependency_component_helper.rb

@@ -0,0 +1,32 @@
+# 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 'spec_helper'
+require 'buildpack_support/repository/configured_item'
+require 'buildpack_support/test/base_component_helper'
+
+shared_context 'versioned_dependency_component_helper' do
+  include_context 'base_component_helper'
+
+  # Mock repository
+  before do
+    tokenized_version = BuildpackSupport::TokenizedVersion.new(version)
+
+    allow_any_instance_of(BuildpackSupport::Repository::ConfiguredItem).to receive(:find_item) do |&block|
+      block.call(tokenized_version) if block
+    end.and_return([tokenized_version, uri])
+  end
+
+end

data/lib/buildpack_support/test/with_load_path_helper.rb

@@ -0,0 +1,27 @@
+# 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 'spec_helper'
+
+shared_context 'with_load_path_helper' do
+
+  def with_load_path(load_path)
+    $LOAD_PATH.unshift load_path
+    yield
+  ensure
+    $LOAD_PATH.shift
+  end
+
+end