buildpack-support 1.0.0

data/spec/buildpack_support/cache/yield_file_with_content.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.
+
+require 'rspec/expectations'
+require 'rspec/matchers/built_in/yield'
+
+RSpec::Matchers.define :yield_file_with_content do |expected|
+  match do |block|
+    probe = RSpec::Matchers::BuiltIn::YieldProbe.probe(block)
+    probe.yielded_once?(:yield_with_args) && content(probe.single_yield_args.first) =~ expected
+  end
+
+  supports_block_expectations
+
+  def content(file)
+    File.read(file)
+  end
+end

data/spec/buildpack_support/component/application_spec.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 'spec_helper'
+require 'buildpack_support/component/application'
+require 'buildpack_support/test/application_helper'
+require 'buildpack_support/test/environment_helper'
+require 'fileutils'
+
+describe BuildpackSupport::Component::Application do
+  include_context 'application_helper'
+  include_context 'environment_helper'
+
+  let(:environment) do
+    { 'test-key'      => 'test-value', 'VCAP_APPLICATION' => vcap_application.to_yaml,
+      'VCAP_SERVICES' => vcap_services.to_yaml }
+  end
+
+  it 'should return a parsed version of VCAP_APPLICATION as details' do
+    expect(application.details).to eq(vcap_application)
+  end
+
+  it 'should remove VCAP_APPLICATION and VCAP_SERVICES from environment' do
+    expect(application.environment).to include('test-key')
+    expect(application.environment).not_to include('VCAP_APPLICATION')
+    expect(application.environment).not_to include('VCAP_SERVICES')
+  end
+
+  it 'should return a child path if it does not exist' do
+    expect(application.root + 'test-file').not_to be_nil
+  end
+
+  it 'should not return a child path that does not exist if it exists but is not in the initial contents' do
+    FileUtils.touch(scratch_dir + 'test-file')
+
+    expect(application.root + 'test-file').not_to exist
+  end
+
+  it 'should return a child path if it exists and is in the initial contents',
+     app_fixture: 'application' do
+
+    expect(application.root + 'test-file').not_to be_nil
+  end
+
+  it 'should only list children that exist initially',
+     app_fixture: 'application' do
+
+    FileUtils.mkdir_p(scratch_dir + '.ignore-directory')
+    FileUtils.mkdir_p(scratch_dir + 'ignore-directory')
+    FileUtils.touch(scratch_dir + '.ignore-file')
+    FileUtils.touch(scratch_dir + 'ignore-file')
+
+    children = application.root.children
+    expect(children.size).to eq(4)
+    expect(children).to include(scratch_dir + '.test-directory')
+    expect(children).to include(scratch_dir + 'test-directory')
+    expect(children).to include(scratch_dir + '.test-file')
+    expect(children).to include(scratch_dir + 'test-file')
+    expect(children).not_to include(scratch_dir + '.ignore-directory')
+    expect(children).not_to include(scratch_dir + 'ignore-directory')
+    expect(children).not_to include(scratch_dir + '.ignore-file')
+    expect(children).not_to include(scratch_dir + 'ignore-file')
+  end
+
+  it 'should return a parsed version of VCAP_SERVICES as services' do
+    expect(application.services.find_service(/test-service/)).to be
+  end
+
+end

data/spec/buildpack_support/component/base_component_spec.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 'spec_helper'
+require 'buildpack_support/component/base_component'
+require 'buildpack_support/test/base_component_helper'
+
+describe BuildpackSupport::Component::BaseComponent do
+  include_context 'base_component_helper'
+
+  let(:component) { StubBaseComponent.new context }
+
+  it 'should assign application to an instance variable' do
+    expect(component.application).to equal(application)
+  end
+
+  it 'should assign component name to an instance variable' do
+    expect(component.component_name).to eq('Stub Base Component')
+  end
+
+  it 'should assign configuration to an instance variable' do
+    expect(component.configuration).to equal(configuration)
+  end
+
+  it 'should assign droplet to an instance variable' do
+    expect(component.droplet).to equal(droplet)
+  end
+
+  it 'should fail if methods are unimplemented' do
+    expect { component.detect }.to raise_error
+    expect { component.compile }.to raise_error
+    expect { component.release }.to raise_error
+  end
+
+  it 'should download file and yield it',
+     cache_fixture: 'stub-download.tar.gz' do
+
+    component.download(version, uri) { |file| expect(file.path).to eq('spec/fixtures/stub-download.tar.gz') }
+    expect(stdout.string).to match(/Downloading Stub Base Component #{version} from #{uri}/)
+  end
+
+  it 'should download and expand TAR file in the sandbox',
+     cache_fixture: 'stub-download.tar.gz' do
+
+    component.download_tar(version, uri)
+    expect(droplet.sandbox + 'test-file').to exist
+  end
+
+  it 'should download and expand ZIP file in the sandbox',
+     cache_fixture: 'stub-download.zip' do
+
+    component.download_zip(version, uri, false)
+    expect(droplet.sandbox + 'test-file').to exist
+  end
+
+  it 'should download and expand ZIP file, stripping the top level directory in the sandbox',
+     cache_fixture: 'stub-download-with-top-level.zip' do
+
+    component.download_zip(version, uri)
+    expect(droplet.sandbox + 'test-file').to exist
+  end
+
+end
+
+class StubBaseComponent < BuildpackSupport::Component::BaseComponent
+
+  attr_reader :application, :component_name, :configuration, :droplet
+
+end

data/spec/buildpack_support/component/base_droplet_spec.rb

@@ -0,0 +1,72 @@
+# 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/test/base_droplet_helper'
+require 'buildpack_support/test/scratch_helper'
+require 'fileutils'
+require 'pathname'
+
+describe BuildpackSupport::Component::BaseDroplet do
+  include_context 'base_droplet_helper'
+  include_context 'scratch_helper'
+
+  it 'should return component_id' do
+    expect(droplet.component_id).to eq(component_id)
+  end
+
+  it 'should return an existent child if in application' do
+    FileUtils.touch(scratch_dir + 'test-file')
+
+    expect(droplet.root + 'test-file').to exist
+  end
+
+  it 'should return an existent child if in sandbox' do
+    FileUtils.mkdir_p(scratch_dir + '.buildpack/base_droplet')
+    FileUtils.touch(scratch_dir + '.buildpack/base_droplet/test-file')
+
+    expect(droplet.sandbox + 'test-file').to exist
+  end
+
+  it 'should return a non-existent child if in buildpack but not sandbox' do
+    FileUtils.mkdir_p(scratch_dir + '.buildpack')
+    FileUtils.touch(scratch_dir + '.buildpack/test-file')
+
+    expect(droplet.root + '.buildpack/test-file').not_to exist
+  end
+
+  it 'should expose a sandbox for the component based on its component_id' do
+    expect(droplet.sandbox).to eq(scratch_dir + '.buildpack/base_droplet')
+  end
+
+  context do
+    let(:fixtures_directory) { Pathname.new('spec/fixtures') }
+
+    it 'should copy resources if resources directory exists' do
+      stub_const(described_class.to_s + '::RESOURCES_DIRECTORY', fixtures_directory)
+      allow(fixtures_directory).to receive(:+).with('base_droplet').and_return(fixtures_directory + 'droplet-resources')
+
+      droplet.copy_resources
+
+      expect(droplet.sandbox + 'droplet-resource').to exist
+    end
+  end
+
+  it 'should not copy resources if resource directory does not exist' do
+    droplet.copy_resources
+  end
+
+end

data/spec/buildpack_support/component/downloads_spec.rb

@@ -0,0 +1,63 @@
+# 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/downloads'
+require 'buildpack_support/test/base_component_helper'
+
+describe BuildpackSupport::Component::Downloads do
+  include_context 'base_component_helper'
+
+  let(:component) { StubDownloadsClass.new droplet }
+
+  it 'should download file and yield it',
+     cache_fixture: 'stub-download.tar.gz' do
+
+    component.download(version, uri) { |file| expect(file.path).to eq('spec/fixtures/stub-download.tar.gz') }
+    expect(stdout.string).to match(/Downloading Stub Component #{version} from #{uri}/)
+  end
+
+  it 'should download and expand TAR file in the sandbox',
+     cache_fixture: 'stub-download.tar.gz' do
+
+    component.download_tar(version, uri)
+    expect(droplet.sandbox + 'test-file').to exist
+  end
+
+  it 'should download and expand ZIP file in the sandbox',
+     cache_fixture: 'stub-download.zip' do
+
+    component.download_zip(version, uri, false)
+    expect(droplet.sandbox + 'test-file').to exist
+  end
+
+  it 'should download and expand ZIP file, stripping the top level directory in the sandbox',
+     cache_fixture: 'stub-download-with-top-level.zip' do
+
+    component.download_zip(version, uri)
+    expect(droplet.sandbox + 'test-file').to exist
+  end
+
+end
+
+class StubDownloadsClass
+  include BuildpackSupport::Component::Downloads
+
+  def initialize(droplet)
+    @component_name = 'Stub Component'
+    @droplet = droplet
+  end
+
+end

data/spec/buildpack_support/component/services_spec.rb

@@ -0,0 +1,80 @@
+# 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/services'
+require 'buildpack_support/test/logging_helper'
+
+describe BuildpackSupport::Component::Services do
+  include_context 'logging_helper'
+
+  let(:service) do
+    { 'name'        => 'test-name', 'label' => 'test-label', 'tags' => ['test-tag'], 'plan' => 'test-plan',
+      'credentials' => { 'uri' => 'test-uri' } }
+  end
+
+  let(:services) { described_class.new('test' => [service]) }
+
+  it 'should return false from one_service? if there is no service that matches' do
+    expect(services.one_service? 'bad-test').not_to be
+    expect(services.one_service?(/bad-test/)).not_to be
+  end
+
+  it 'should return true from one_service? if there is a matching name' do
+    expect(services.one_service? 'test-name').to be
+    expect(services.one_service?(/test-name/)).to be
+  end
+
+  it 'should return true from one_service? if there is a matching label' do
+    expect(services.one_service? 'test-label').to be
+    expect(services.one_service?(/test-label/)).to be
+  end
+
+  it 'should return true from one_service? if there is a matching tag' do
+    expect(services.one_service? 'test-tag').to be
+    expect(services.one_service?(/test-tag/)).to be
+  end
+
+  it 'should return false from one_service? if there is a matching service without required credentials' do
+    expect(services.one_service? 'test-tag', 'bad-credential').not_to be
+    expect(services.one_service?(/test-tag/, 'bad-credential')).not_to be
+  end
+
+  it 'should return true from one_service? if there is a matching service with required credentials' do
+    expect(services.one_service? 'test-tag', 'uri').to be
+    expect(services.one_service?(/test-tag/, 'uri')).to be
+  end
+
+  it 'should return nil from find_service? if there is no service that matches' do
+    expect(services.find_service 'bad-test').to be_nil
+    expect(services.find_service(/bad-test/)).to be_nil
+  end
+
+  it 'should return service from find_service? if there is a matching name' do
+    expect(services.find_service 'test-name').to be(service)
+    expect(services.find_service(/test-name/)).to be(service)
+  end
+
+  it 'should return service from find_service? if there is a matching label' do
+    expect(services.find_service 'test-label').to be(service)
+    expect(services.find_service(/test-label/)).to be(service)
+  end
+
+  it 'should return service from find_service? if there is a matching tag' do
+    expect(services.find_service 'test-tag').to be(service)
+    expect(services.find_service(/test-tag/)).to be(service)
+  end
+
+end

data/spec/buildpack_support/component/versioned_dependency_component_spec.rb

@@ -0,0 +1,58 @@
+# 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/versioned_dependency_component'
+require 'buildpack_support/test/versioned_dependency_component_helper'
+
+describe BuildpackSupport::Component::VersionedDependencyComponent do
+  include_context 'versioned_dependency_component_helper'
+
+  let(:component) { StubVersionedDependencyComponent.new context }
+
+  it 'should fail if methods are unimplemented' do
+    expect { component.compile }.to raise_error
+    expect { component.release }.to raise_error
+    expect { component.supports? }.to raise_error
+  end
+
+  context do
+    before do
+      allow_any_instance_of(StubVersionedDependencyComponent).to receive(:supports?).and_return(false)
+    end
+
+    it 'should return nil from detect if not supported' do
+      expect(component.detect).to be_nil
+    end
+  end
+
+  context do
+
+    before do
+      allow_any_instance_of(StubVersionedDependencyComponent).to receive(:supports?).and_return(true)
+    end
+
+    it 'should return name and version string from detect if supported' do
+      expect(component.detect).to eq("stub-versioned-dependency-component=#{version}")
+    end
+  end
+
+end
+
+class StubVersionedDependencyComponent < BuildpackSupport::Component::VersionedDependencyComponent
+
+  public :supports?
+
+end