buildpack-support 1.0.0 → 1.1.0

data/lib/buildpack_support/cache/cached_file.rb

@@ -29,13 +29,15 @@ module BuildpackSupport
       #
       # @param [Pathname] cache_root the filesystem root for the file created and expected by this class
       # @param [String] uri a uri which uniquely identifies the file in the cache
-      def initialize(cache_root, uri)
-        FileUtils.mkdir_p cache_root
-
-        key            = URI.escape(uri, '/')
+      # @param [Boolean] mutable whether the cached file should be mutable
+      def initialize(cache_root, uri, mutable)
+        key            = URI.escape(uri, ':/')
         @cached        = cache_root + "#{key}.cached"
         @etag          = cache_root + "#{key}.etag"
         @last_modified = cache_root + "#{key}.last_modified"
+        @mutable       = mutable
+
+        FileUtils.mkdir_p cache_root if mutable
       end
 
       # Opens the cached file
@@ -58,7 +60,7 @@ module BuildpackSupport
 
       # Destroys the cached file
       def destroy
-        [@cached, @etag, @last_modified].each { |f| f.delete if f.exist? }
+        [@cached, @etag, @last_modified].each { |f| f.delete if f.exist? } if @mutable
       end
 
       # Opens the etag file

data/lib/buildpack_support/cache/download_cache.rb

@@ -66,7 +66,7 @@ module BuildpackSupport
         cached_file, downloaded = from_immutable_caches(uri), false unless cached_file
 
         fail "Unable to find cached file for #{uri}" unless cached_file
-        cached_file.cached(File::RDONLY, downloaded, &block)
+        cached_file.cached(File::RDONLY | File::BINARY, downloaded, &block)
       end
 
       # Removes an item from the mutable cache.
@@ -74,7 +74,7 @@ module BuildpackSupport
       # @param [String] uri the URI of the item
       # @return [Void]
       def evict(uri)
-        CachedFile.new(@mutable_cache_root, uri).destroy
+        CachedFile.new(@mutable_cache_root, uri, true).destroy
       end
 
       private
@@ -138,7 +138,7 @@ module BuildpackSupport
       end
 
       def cache_content(response, cached_file)
-        cached_file.cached(File::CREAT | File::WRONLY) do |f|
+        cached_file.cached(File::CREAT | File::WRONLY | File::BINARY) do |f|
           @logger.debug { "Persisting content to #{f.path}" }
 
           f.truncate(0)
@@ -156,7 +156,7 @@ module BuildpackSupport
 
         @logger.debug { "Persisting etag: #{etag}" }
 
-        cached_file.etag(File::CREAT | File::WRONLY) do |f|
+        cached_file.etag(File::CREAT | File::WRONLY | File::BINARY) do |f|
           f.truncate(0)
           f.write etag
           f.fsync
@@ -170,7 +170,7 @@ module BuildpackSupport
 
         @logger.debug { "Persisting last-modified: #{last_modified}" }
 
-        cached_file.last_modified(File::CREAT | File::WRONLY) do |f|
+        cached_file.last_modified(File::CREAT | File::WRONLY | File::BINARY) do |f|
           f.truncate(0)
           f.write last_modified
           f.fsync
@@ -178,7 +178,7 @@ module BuildpackSupport
       end
 
       def from_mutable_cache(uri)
-        cached_file = CachedFile.new(@mutable_cache_root, uri)
+        cached_file = CachedFile.new @mutable_cache_root, uri, true
         cached      = update URI(uri), cached_file
         [cached_file, cached]
       rescue => e
@@ -188,7 +188,7 @@ module BuildpackSupport
 
       def from_immutable_caches(uri)
         @immutable_cache_roots.each do |cache_root|
-          candidate = CachedFile.new cache_root, uri
+          candidate = CachedFile.new cache_root, uri, false
 
           next unless candidate.cached?
 
@@ -226,11 +226,11 @@ module BuildpackSupport
         request = Net::HTTP::Get.new(uri.request_uri)
 
         if cached_file.etag?
-          cached_file.etag(File::RDONLY) { |f| request['If-None-Match'] = File.read(f) }
+          cached_file.etag(File::RDONLY | File::BINARY) { |f| request['If-None-Match'] = File.read(f) }
         end
 
         if cached_file.last_modified?
-          cached_file.last_modified(File::RDONLY) { |f| request['If-Modified-Since'] = File.read(f) }
+          cached_file.last_modified(File::RDONLY | File::BINARY) { |f| request['If-Modified-Since'] = File.read(f) }
         end
 
         @logger.debug { "Request: #{request.path}, #{request.to_hash}" }
@@ -265,7 +265,7 @@ module BuildpackSupport
       def validate_size(expected_size, cached_file)
         return unless expected_size
 
-        actual_size = cached_file.cached(File::RDONLY) { |f| f.size }
+        actual_size = cached_file.cached(File::RDONLY | File::BINARY) { |f| f.size }
         @logger.debug { "Validated content size #{actual_size} is #{expected_size}" }
 
         return if expected_size.to_i == actual_size

data/lib/buildpack_support/cache/internet_availability.rb

@@ -45,15 +45,34 @@ module BuildpackSupport
       #
       # @param [Boolean] available whether the internet is available
       # @param [String, nil] message an optional message to be printed when the availability is set
+      # @yields an environment with internet availability temporarily overridden if block given
       def available(available, message = nil)
         @monitor.synchronize do
-          @available = available
-          @logger.warn { "Internet availability set to #{available}: #{message}" } if message
+          if block_given?
+            preserve_availability do
+              @available = available
+              @logger.warn { "Internet availability temporarily set to #{available}: #{message}" } if message
+
+              yield
+            end
+          else
+            @available = available
+            @logger.warn { "Internet availability set to #{available}: #{message}" } if message
+          end
         end
       end
 
       private
 
+      def preserve_availability
+        previous = @available
+        begin
+          yield
+        ensure
+          @available = previous
+        end
+      end
+
       def remote_downloads?
         BuildpackSupport::ConfigurationUtils.new.load('cache')['remote_downloads'] != 'disabled'
       end

data/lib/buildpack_support/test/application_helper.rb

@@ -14,6 +14,7 @@
 # limitations under the License.
 
 require 'spec_helper'
+require 'buildpack_support/component/application'
 require 'buildpack_support/test/environment_helper'
 require 'buildpack_support/test/scratch_helper'
 

data/lib/buildpack_support/test/base_component_helper.rb

@@ -22,6 +22,7 @@ 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/test/repository_helper'
 require 'buildpack_support/tokenized_version'
 require 'pathname'
 
@@ -31,6 +32,7 @@ shared_context 'base_component_helper' do
   include_context 'console_helper'
   include_context 'internet_availability_helper'
   include_context 'logging_helper'
+  include_context 'repository_helper'
 
   let(:application_cache) { double('ApplicationCache') }
 

data/lib/buildpack_support/test/repository_helper.rb

@@ -0,0 +1,38 @@
+# 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/tokenized_version'
+
+shared_context 'repository_helper' do
+
+  let(:configured_item) { double('configured_item') }
+
+  let(:uri) { 'test-uri' }
+
+  let(:version) { '0.0.0' }
+
+  before do
+    tokenized_version = BuildpackSupport::TokenizedVersion.new(version)
+
+    allow(BuildpackSupport::Repository::ConfiguredItem).to receive(:new).and_return configured_item
+
+    allow(configured_item).to receive(:find_item) do |&block|
+      block.call(tokenized_version) if block
+    end.and_return([tokenized_version, uri])
+  end
+
+end

data/lib/buildpack_support/version.rb

@@ -18,6 +18,6 @@ require 'buildpack_support'
 module BuildpackSupport
 
   # The version of the gem
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
 end

data/spec/buildpack_support/cache/cached_file_spec.rb

@@ -22,12 +22,30 @@ require 'fileutils'
 describe BuildpackSupport::Cache::CachedFile do
   include_context 'scratch_helper'
 
-  let(:file_cache) { described_class.new(scratch_dir, 'http://foo-uri/') }
+  let(:cache_root) { scratch_dir + 'cache/root' }
+
+  let(:file_cache) { described_class.new(scratch_dir, 'http://foo-uri/', true) }
 
   it 'should not create any files on initialization' do
     %w(cached etag last_modified).each { |extension| expect(cache_file(extension)).not_to exist }
   end
 
+  it 'should create cache_root if mutable' do
+    expect(cache_root).not_to exist
+
+    described_class.new(cache_root, 'http://foo-uri/', true)
+
+    expect(cache_root).to exist
+  end
+
+  it 'should not create cache_root if immutable' do
+    expect(cache_root).not_to exist
+
+    described_class.new(cache_root, 'http://foo-uri/', false)
+
+    expect(cache_root).not_to exist
+  end
+
   it 'should not detect cached file' do
     expect(file_cache.cached?).not_to be
   end
@@ -62,6 +80,12 @@ describe BuildpackSupport::Cache::CachedFile do
       %w(cached etag last_modified).each { |extension| expect(cache_file(extension)).not_to exist }
     end
 
+    it 'should not destroy all files if immutable' do
+      described_class.new(scratch_dir, 'http://foo-uri/', false).destroy
+
+      %w(cached etag last_modified).each { |extension| expect(cache_file(extension)).to exist }
+    end
+
     it 'should call the block with the content of the etag file' do
       expect { |b| file_cache.etag(File::RDONLY, 'test-arg', &b) }.to yield_file_with_content(/foo-etag/)
     end
@@ -80,7 +104,7 @@ describe BuildpackSupport::Cache::CachedFile do
   end
 
   def cache_file(extension)
-    scratch_dir + "http:%2F%2Ffoo-uri%2F.#{extension}"
+    scratch_dir + "http%3A%2F%2Ffoo-uri%2F.#{extension}"
   end
 
   def touch(extension, content = '')

data/spec/buildpack_support/cache/download_cache_spec.rb

@@ -242,11 +242,11 @@ describe BuildpackSupport::Cache::DownloadCache do
   end
 
   def cache_file(root, extension)
-    root + "http:%2F%2Ffoo-uri%2F.#{extension}"
+    root + "http%3A%2F%2Ffoo-uri%2F.#{extension}"
   end
 
   def credential_cache_file(root, extension)
-    root + "http:%2F%2Ftest-username:test-password@foo-uri%2F.#{extension}"
+    root + "http%3A%2F%2Ftest-username%3Atest-password@foo-uri%2F.#{extension}"
   end
 
   def expect_complete_cache(root)

data/spec/buildpack_support/cache/internet_availability_spec.rb

@@ -54,4 +54,22 @@ describe BuildpackSupport::Cache::InternetAvailability do
     expect(log_contents).to match(/Internet availability set to false: test message/)
   end
 
+  it 'should temporarily set internet unavailable' do
+    expect(described_class.instance.available?).to be
+
+    described_class.instance.available(false) { expect(described_class.instance.available?).not_to be }
+
+    expect(described_class.instance.available?).to be
+  end
+
+  it 'should temporarily set internet available',
+     :disable_internet do
+
+    expect(described_class.instance.available?).not_to be
+
+    described_class.instance.available(true) { expect(described_class.instance.available?).to be }
+
+    expect(described_class.instance.available?).not_to be
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildpack-support
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -261,6 +261,7 @@ files:
 - lib/buildpack_support/test/environment_helper.rb
 - lib/buildpack_support/test/internet_availability_helper.rb
 - lib/buildpack_support/test/logging_helper.rb
+- lib/buildpack_support/test/repository_helper.rb
 - lib/buildpack_support/test/scratch_helper.rb
 - lib/buildpack_support/test/versioned_dependency_component_helper.rb
 - lib/buildpack_support/test/with_load_path_helper.rb
@@ -346,13 +347,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3626864302089607718
+      hash: 2138916088248865313
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2138916088248865313
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2