buildpack-support 1.0.0

data/spec/buildpack_support/format_duration_spec.rb

@@ -0,0 +1,60 @@
+# 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/format_duration'
+
+describe 'format duration' do
+
+  it 'should display seconds' do
+    expect_time_string '0.0s', MILLISECOND
+    expect_time_string '0.1s', TENTH
+    expect_time_string '1.0s', SECOND
+    expect_time_string '1.1s', SECOND + TENTH
+    expect_time_string '1.1s', SECOND + TENTH + MILLISECOND
+  end
+
+  it 'should display minutes' do
+    expect_time_string '1m 0s', MINUTE
+    expect_time_string '1m 1s', MINUTE + SECOND
+    expect_time_string '1m 1s', MINUTE + SECOND + TENTH
+    expect_time_string '1m 1s', MINUTE + SECOND + TENTH + MILLISECOND
+  end
+
+  it 'should display hours' do
+    expect_time_string '1h 0m', HOUR
+    expect_time_string '1h 1m', HOUR + MINUTE
+    expect_time_string '1h 1m', HOUR + MINUTE + SECOND
+    expect_time_string '1h 1m', HOUR + MINUTE + SECOND + TENTH
+    expect_time_string '1h 1m', HOUR + MINUTE + SECOND + TENTH + MILLISECOND
+  end
+
+  private
+
+  MILLISECOND = 0.001.freeze
+
+  TENTH = (100 * MILLISECOND).freeze
+
+  SECOND = (10 * TENTH).freeze
+
+  MINUTE = (60 * SECOND).freeze
+
+  HOUR = (60 * MINUTE).freeze
+
+  def expect_time_string(expected, time)
+    expect(time.duration).to eq(expected)
+  end
+
+end

data/spec/buildpack_support/logging/delegating_logger_spec.rb

@@ -0,0 +1,62 @@
+# 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/logging/delegating_logger'
+require 'logger'
+
+describe BuildpackSupport::Logging::DelegatingLogger do
+
+  let(:block) { ->() { 'test-message' } }
+  let(:delegate1) { double('delegate1') }
+  let(:delegate2) { double('delegate2') }
+  let(:delegating_logger) { described_class.new('test-klass', [delegate1, delegate2]) }
+
+  it 'should delegate FATAL calls' do
+    expect(delegate1).to receive(:add).with(Logger::FATAL, nil, 'test-klass')
+    expect(delegate2).to receive(:add).with(Logger::FATAL, nil, 'test-klass')
+
+    delegating_logger.fatal
+  end
+
+  it 'should delegate ERROR calls' do
+    expect(delegate1).to receive(:add).with(Logger::ERROR, nil, 'test-klass')
+    expect(delegate2).to receive(:add).with(Logger::ERROR, nil, 'test-klass')
+
+    delegating_logger.error
+  end
+
+  it 'should delegate WARN calls' do
+    expect(delegate1).to receive(:add).with(Logger::WARN, nil, 'test-klass')
+    expect(delegate2).to receive(:add).with(Logger::WARN, nil, 'test-klass')
+
+    delegating_logger.warn
+  end
+
+  it 'should delegate INFO calls' do
+    expect(delegate1).to receive(:add).with(Logger::INFO, nil, 'test-klass')
+    expect(delegate2).to receive(:add).with(Logger::INFO, nil, 'test-klass')
+
+    delegating_logger.info
+  end
+
+  it 'should delegate DEBUG calls' do
+    expect(delegate1).to receive(:add).with(Logger::DEBUG, nil, 'test-klass')
+    expect(delegate2).to receive(:add).with(Logger::DEBUG, nil, 'test-klass')
+
+    delegating_logger.debug
+  end
+
+end

data/spec/buildpack_support/logging/logger_factory_spec.rb

@@ -0,0 +1,262 @@
+# 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/configuration_utils'
+require 'buildpack_support/logging/logger_factory'
+require 'buildpack_support/test/console_helper'
+require 'buildpack_support/test/logging_helper'
+
+describe BuildpackSupport::Logging::LoggerFactory do
+  include_context 'console_helper'
+  include_context 'logging_helper'
+
+  let(:logger) { described_class.instance.get_logger String }
+
+  it 'should maintain backwards compatibility' do
+    expect(described_class.get_logger String).to be
+  end
+
+  it 'should log all levels to file',
+     log_level: 'FATAL' do
+
+    trigger
+
+    expect(log_contents).to match(/DEBUG block-debug-message/)
+    expect(log_contents).to match(/INFO  block-info-message/)
+    expect(log_contents).to match(/WARN  block-warn-message/)
+    expect(log_contents).to match(/ERROR block-error-message/)
+    expect(log_contents).to match(/FATAL block-fatal-message/)
+
+    expect(log_contents).to match(/DEBUG param-debug-message/)
+    expect(log_contents).to match(/INFO  param-info-message/)
+    expect(log_contents).to match(/WARN  param-warn-message/)
+    expect(log_contents).to match(/ERROR param-error-message/)
+    expect(log_contents).to match(/FATAL param-fatal-message/)
+  end
+
+  it 'should log all levels to console when BP_LOG_LEVEL set to DEBUG',
+     log_level: 'DEBUG' do
+
+    trigger
+
+    expect(stderr.string).to match(/DEBUG block-debug-message/)
+    expect(stderr.string).to match(/INFO  block-info-message/)
+    expect(stderr.string).to match(/WARN  block-warn-message/)
+    expect(stderr.string).to match(/ERROR block-error-message/)
+    expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+    expect(stderr.string).to match(/DEBUG param-debug-message/)
+    expect(stderr.string).to match(/INFO  param-info-message/)
+    expect(stderr.string).to match(/WARN  param-warn-message/)
+    expect(stderr.string).to match(/ERROR param-error-message/)
+    expect(stderr.string).to match(/FATAL param-fatal-message/)
+  end
+
+  it 'should log all levels above INFO to console when BP_LOG_LEVEL set to INFO',
+     log_level: 'INFO' do
+
+    trigger
+
+    expect(stderr.string).not_to match(/DEBUG block-debug-message/)
+    expect(stderr.string).to match(/INFO  block-info-message/)
+    expect(stderr.string).to match(/WARN  block-warn-message/)
+    expect(stderr.string).to match(/ERROR block-error-message/)
+    expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+    expect(stderr.string).not_to match(/DEBUG param-debug-message/)
+    expect(stderr.string).to match(/INFO  param-info-message/)
+    expect(stderr.string).to match(/WARN  param-warn-message/)
+    expect(stderr.string).to match(/ERROR param-error-message/)
+    expect(stderr.string).to match(/FATAL param-fatal-message/)
+  end
+
+  it 'should log all levels above WARN to console when BP_LOG_LEVEL set to WARN',
+     log_level: 'WARN' do
+
+    trigger
+
+    expect(stderr.string).not_to match(/DEBUG block-debug-message/)
+    expect(stderr.string).not_to match(/INFO  block-info-message/)
+    expect(stderr.string).to match(/WARN  block-warn-message/)
+    expect(stderr.string).to match(/ERROR block-error-message/)
+    expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+    expect(stderr.string).not_to match(/DEBUG param-debug-message/)
+    expect(stderr.string).not_to match(/INFO  param-info-message/)
+    expect(stderr.string).to match(/WARN  param-warn-message/)
+    expect(stderr.string).to match(/ERROR param-error-message/)
+    expect(stderr.string).to match(/FATAL param-fatal-message/)
+  end
+
+  it 'should log all levels above ERROR to console when BP_LOG_LEVEL set to ERROR',
+     log_level: 'ERROR' do
+
+    trigger
+
+    expect(stderr.string).not_to match(/DEBUG block-debug-message/)
+    expect(stderr.string).not_to match(/INFO  block-info-message/)
+    expect(stderr.string).not_to match(/WARN  block-warn-message/)
+    expect(stderr.string).to match(/ERROR block-error-message/)
+    expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+    expect(stderr.string).not_to match(/DEBUG param-debug-message/)
+    expect(stderr.string).not_to match(/INFO  param-info-message/)
+    expect(stderr.string).not_to match(/WARN  param-warn-message/)
+    expect(stderr.string).to match(/ERROR param-error-message/)
+    expect(stderr.string).to match(/FATAL param-fatal-message/)
+  end
+
+  it 'should log FATAL to console when BP_LOG_LEVEL set to FATAL',
+     log_level: 'FATAL' do
+
+    trigger
+
+    expect(stderr.string).not_to match(/DEBUG block-debug-message/)
+    expect(stderr.string).not_to match(/INFO  block-info-message/)
+    expect(stderr.string).not_to match(/WARN  block-warn-message/)
+    expect(stderr.string).not_to match(/ERROR block-error-message/)
+    expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+    expect(stderr.string).not_to match(/DEBUG param-debug-message/)
+    expect(stderr.string).not_to match(/INFO  param-info-message/)
+    expect(stderr.string).not_to match(/WARN  param-warn-message/)
+    expect(stderr.string).not_to match(/ERROR param-error-message/)
+    expect(stderr.string).to match(/FATAL param-fatal-message/)
+  end
+
+  it 'should log all levels to console when $DEBUG set',
+     :debug do
+
+    trigger
+
+    expect(stderr.string).to match(/DEBUG block-debug-message/)
+    expect(stderr.string).to match(/INFO  block-info-message/)
+    expect(stderr.string).to match(/WARN  block-warn-message/)
+    expect(stderr.string).to match(/ERROR block-error-message/)
+    expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+    expect(stderr.string).to match(/DEBUG param-debug-message/)
+    expect(stderr.string).to match(/INFO  param-info-message/)
+    expect(stderr.string).to match(/WARN  param-warn-message/)
+    expect(stderr.string).to match(/ERROR param-error-message/)
+    expect(stderr.string).to match(/FATAL param-fatal-message/)
+
+  end
+
+  it 'should log all levels to console when $VERBOSE set',
+     :verbose do
+
+    trigger
+
+    expect(stderr.string).to match(/DEBUG block-debug-message/)
+    expect(stderr.string).to match(/INFO  block-info-message/)
+    expect(stderr.string).to match(/WARN  block-warn-message/)
+    expect(stderr.string).to match(/ERROR block-error-message/)
+    expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+    expect(stderr.string).to match(/DEBUG param-debug-message/)
+    expect(stderr.string).to match(/INFO  param-info-message/)
+    expect(stderr.string).to match(/WARN  param-warn-message/)
+    expect(stderr.string).to match(/ERROR param-error-message/)
+    expect(stderr.string).to match(/FATAL param-fatal-message/)
+
+  end
+
+  it 'should return the log file' do
+    expect(described_class.instance.log_file).to eq(scratch_dir + '.buildpack.log')
+  end
+
+  context do
+
+    before do
+      allow_any_instance_of(BuildpackSupport::ConfigurationUtils).to receive(:load).with('logging')
+                                                                     .and_return('default_log_level' => 'DEBUG')
+      described_class.instance.setup scratch_dir
+    end
+
+    it 'should log all levels to console when default_log_level set to DEBUG in configuration file' do
+      trigger
+
+      expect(stderr.string).to match(/DEBUG block-debug-message/)
+      expect(stderr.string).to match(/INFO  block-info-message/)
+      expect(stderr.string).to match(/WARN  block-warn-message/)
+      expect(stderr.string).to match(/ERROR block-error-message/)
+      expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+      expect(stderr.string).to match(/DEBUG param-debug-message/)
+      expect(stderr.string).to match(/INFO  param-info-message/)
+      expect(stderr.string).to match(/WARN  param-warn-message/)
+      expect(stderr.string).to match(/ERROR param-error-message/)
+      expect(stderr.string).to match(/FATAL param-fatal-message/)
+    end
+  end
+
+  context do
+
+    before do
+      allow_any_instance_of(BuildpackSupport::ConfigurationUtils).to receive(:load).with('logging').and_return({})
+      described_class.instance.setup scratch_dir
+    end
+
+    it 'should log all levels above INFO to console when no configuration has been set' do
+      trigger
+
+      expect(stderr.string).not_to match(/DEBUG block-debug-message/)
+      expect(stderr.string).to match(/INFO  block-info-message/)
+      expect(stderr.string).to match(/WARN  block-warn-message/)
+      expect(stderr.string).to match(/ERROR block-error-message/)
+      expect(stderr.string).to match(/FATAL block-fatal-message/)
+
+      expect(stderr.string).not_to match(/DEBUG param-debug-message/)
+      expect(stderr.string).to match(/INFO  param-info-message/)
+      expect(stderr.string).to match(/WARN  param-warn-message/)
+      expect(stderr.string).to match(/ERROR param-error-message/)
+      expect(stderr.string).to match(/FATAL param-fatal-message/)
+    end
+  end
+
+  context do
+
+    before do
+      described_class.instance.reset
+    end
+
+    it 'should raise an error if get_logger called and not yet initialized' do
+      expect { described_class.instance.get_logger String }
+      .to raise_error 'Attempted to get Logger for String before initialization'
+    end
+
+    it 'should raise an error if log_file called and not yet initialized' do
+      expect { described_class.instance.log_file }
+      .to raise_error 'Attempted to get log file before initialization'
+    end
+  end
+
+  def trigger
+    logger.debug { 'block-debug-message' }
+    logger.info { 'block-info-message' }
+    logger.warn { 'block-warn-message' }
+    logger.error { 'block-error-message' }
+    logger.fatal { 'block-fatal-message' }
+
+    logger.debug 'param-debug-message'
+    logger.info 'param-info-message'
+    logger.warn 'param-warn-message'
+    logger.error 'param-error-message'
+    logger.fatal 'param-fatal-message'
+  end
+
+end

data/spec/buildpack_support/qualify_path_spec.rb

@@ -0,0 +1,42 @@
+# 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/qualify_path'
+
+describe 'qualify_path' do
+
+  let(:pathQualifier) { StubPathQualifierClass.new }
+
+  it 'should return a path relative to the provided path' do
+    foo = Pathname.new('/foo')
+    bar = Pathname.new('/bar/bam')
+    expect(pathQualifier.qualify_path(foo, bar)).to eq('$PWD/../../foo')
+  end
+
+  it 'should return a path relative to the droplet root' do
+    foo = Pathname.new('/droplet/foo')
+    expect(pathQualifier.qualify_path(foo)).to eq('$PWD/foo')
+  end
+
+end
+
+class StubPathQualifierClass
+  include BuildpackSupport::QualifyPath
+
+  def initialize
+    @droplet_root = Pathname.new('/droplet')
+  end
+end

data/spec/buildpack_support/rake/buildpack_stage_task_spec.rb

@@ -0,0 +1,88 @@
+# 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/rake/buildpack_stage_task'
+require 'buildpack_support/test/console_helper'
+require 'buildpack_support/test/scratch_helper'
+require 'rake'
+require 'rake/clean'
+
+describe BuildpackSupport::Rake::BuildpackStageTask do
+  include_context 'console_helper'
+  include_context 'scratch_helper'
+
+  before { Rake::Task.clear }
+
+  let(:task) do
+    described_class.new do |t|
+      t.files        = Dir['spec/fixtures/zip-contents/**/*']
+      t.package_name = 'test-package-name'
+      t.staging_dir  = scratch_dir
+    end
+  end
+
+  it 'should raise an error if files is not specified' do
+    expect { described_class.new }.to raise_error('files must be configured')
+  end
+
+  it 'should raise an error if package_name is not specified' do
+    expect do
+      described_class.new do |t|
+        t.files = []
+      end
+    end.to raise_error('package_name must be configured')
+  end
+
+  it 'should raise an error if staging_dir is not specified' do
+    expect do
+      described_class.new do |t|
+        t.files        = []
+        t.package_name = 'test-package-name'
+      end
+    end.to raise_error('staging_dir must be configured')
+  end
+
+  it 'should call block if provided' do
+    called = false
+
+    described_class.new do |t|
+      t.files        = []
+      t.package_name = 'test-package-name'
+      t.staging_dir  = ''
+      called         = true
+    end
+
+    expect(called).to be
+  end
+
+  it 'should create staging_dir tasks for all files and no directories' do
+    task
+
+    expect(Rake::Task.task_defined?(scratch_dir + 'spec/fixtures/zip-contents/test-file')).to be
+    expect(Rake::Task.task_defined?(scratch_dir + 'spec/fixtures/zip-contents/test-directory')).not_to be
+    expect(Rake::Task.task_defined?(scratch_dir + 'spec/fixtures/zip-contents/test-directory/test-deep-file')).to be
+  end
+
+  it 'should copy files' do
+    task
+
+    target = scratch_dir + 'spec/fixtures/zip-contents/test-directory/test-deep-file'
+    Rake::Task[target].invoke
+
+    expect(target).to exist
+  end
+
+end