Merge 49322113-default-jre to master

[Completes #49322113]

Author: nebhale

README.md

@@ -54,15 +54,23 @@ If the user does not specify a JRE vendor and version, a JRE is selected automat
 This buildpacks is designed to be extensible by other developers.  To this end, various bits of configuration are exposed that make it simple to add functionality.
 
 ## Adding JRES
-By default, this buildpack only allows users to choose from [OpenJDK][openjdk] JREs.  To allow users to choose a JRE from other vendors, these vendors must be specified in [`config/jres.yml`][jres_yml].  The file is [YAML][yaml] formatted with the following syntax:
+By default, this buildpack only allows users to choose from [OpenJDK][openjdk] JREs.  To allow users to choose a JRE from other vendors, these vendors must be specified in [`config/jres.yml`][jres_yml].  The file is [YAML][yaml] formatted  and in the simplest case is a mapping from a vendor name to a `String` repository root.
 
-```plain
+```yaml
 <vendor name>: <JRE repository root URI>
 ```
 
+When configured like this, if the user does not specify a version of the JRE to use, the latest possible version will be selected.  If a particular JRE should use a default that is not the latest (e.g. using `1.7.0_21` instead of `1.8.0_M7`), the default version can be specified by using a `Hash` instead of a `String` as the value.
+
+```yaml
+<vendor name>:
+  default_version: <default version pattern>
+  repository_root: <JRE repository root URI>
+```
+
 The JRE repository root must contain a `/index.yml` file ([example][index_yml]).  This file is also [YAML][yaml] formatted with the following syntax:
 
-```plain
+```yaml
 <JRE version>: <path relative to JRE repository root>
 ```
 

config/jres.yml

@@ -15,4 +15,6 @@
 
 # Configuration for JRE repositories keyed by vendor
 ---
-openjdk: "http://jres.gopivotal.com.s3.amazonaws.com/lucid/x86_64/openjdk"
+openjdk:
+  default_version: 1.7.0_+
+  repository_root: "http://jres.gopivotal.com.s3.amazonaws.com/lucid/x86_64/openjdk"

lib/java_buildpack/jre_properties.rb

@@ -39,16 +39,20 @@ class JreProperties
     # @param [String] app_dir The application to inspect for values specified by the user
     def initialize(app_dir)
       value_resolver = ValueResolver.new(app_dir)
-
       candidate_vendor = value_resolver.resolve(ENV_VAR_VENDOR, SYS_PROP_VENDOR)
       candidate_version = value_resolver.resolve(ENV_VAR_VERSION, SYS_PROP_VERSION)
 
-      jre_vendor_repositories = YAML.load_file JRES_YAML_FILE
-      @vendor = VendorResolver.resolve(candidate_vendor, jre_vendor_repositories.keys)
-      repository = jre_vendor_repositories[@vendor]
-      index = YAML.parse(open "#{repository}#{INDEX_PATH}").to_ruby
-      @version = VersionResolver.resolve(candidate_version, index.keys)
-      @uri = "#{repository}/#{index[@version]}"
+      vendors = load_vendors
+      @vendor = VendorResolver.resolve(candidate_vendor, vendors.keys)
+      vendor_details = vendors[@vendor]
+
+      repository_root = find_repository_root vendor_details
+      default_version = find_default_version vendor_details
+      versions = load_versions(repository_root)
+
+      @version = VersionResolver.resolve(candidate_version, default_version, versions.keys)
+
+      @uri = "#{repository_root}/#{versions[@version]}"
     end
 
     private
@@ -61,9 +65,41 @@ def initialize(app_dir)
 
     JRES_YAML_FILE = 'config/jres.yml'
 
+    KEY_DEFAULT_VERSION = 'default_version'
+
+    KEY_REPOSITORY_ROOT = 'repository_root'
+
     SYS_PROP_VENDOR = 'java.runtime.vendor'
 
     SYS_PROP_VERSION = 'java.runtime.version'
 
+    def find_default_version(vendor_details)
+      if vendor_details.is_a?(Hash) && vendor_details.has_key?(KEY_DEFAULT_VERSION)
+        default_version = vendor_details[KEY_DEFAULT_VERSION]
+      else
+        default_version = nil
+      end
+    end
+
+    def find_repository_root(vendor_details)
+      if vendor_details.is_a? String
+        repository_root = vendor_details
+      elsif vendor_details.is_a?(Hash) && vendor_details.has_key?(KEY_REPOSITORY_ROOT)
+        repository_root = vendor_details[KEY_REPOSITORY_ROOT]
+      else
+        raise "Vendor details must be either a String or a Hash with a key of '#{KEY_REPOSITORY_ROOT}' and a value that is a String that points to the root of a JRE repository."
+      end
+
+      repository_root
+    end
+
+    def load_versions(repository_root)
+      YAML.parse(open "#{repository_root}#{INDEX_PATH}").to_ruby
+    end
+
+    def load_vendors
+      YAML.load_file JRES_YAML_FILE
+    end
+
   end
 end

lib/java_buildpack/version_resolver.rb

@@ -24,11 +24,14 @@ class VersionResolver
     # The resolution returns the maximum of the versions that match the candidate version
     #
     # @param [String, nil] candidate_version the version, possibly containing a wildcard, to resolve
+    # @param [String, nil] default_version the version, possibly containing a wildcard, to resolve if
+    #                                      +candidate_version+ is +nil+
     # @param [Array<String>] versions the collection of versions to resolve against
     # @return [String] the resolved version
     # @raise if no version can be resolved
-    def self.resolve(candidate_version, versions)
-      tokenized_candidate_version = TokenizedVersion.new(candidate_version)
+    def self.resolve(candidate_version, default_version, versions)
+      tokenized_candidate_version = TokenizedVersion.new(
+        candidate_version.nil? || candidate_version.empty? ? default_version : candidate_version)
       tokenized_versions = versions.map { |version| TokenizedVersion.new(version, false) }
 
       version = tokenized_versions

spec/java_buildpack/jre_properties_spec.rb

@@ -21,6 +21,8 @@
 
   CANDIDATE_VERSION = 'candidate-version'
 
+  DEFAULT_VERSION = 'default-version'
+
   RESOLVED_PATH = 'resolved-path'
 
   RESOLVED_ROOT = 'resolved-root'
@@ -31,13 +33,28 @@
 
   RESOLVED_URI = "#{RESOLVED_ROOT}/#{RESOLVED_PATH}"
 
-  it 'returns the resolved vendor, version, and uri' do
+  it 'returns the resolved vendor, version, and uri from uri-only vendor details' do
+    JavaBuildpack::ValueResolver.any_instance.stub(:resolve).with('JAVA_RUNTIME_VENDOR', 'java.runtime.vendor').and_return(CANDIDATE_VENDOR)
+    JavaBuildpack::ValueResolver.any_instance.stub(:resolve).with('JAVA_RUNTIME_VERSION', 'java.runtime.version').and_return(CANDIDATE_VERSION)
     YAML.stub(:load_file).with('config/jres.yml').and_return(RESOLVED_VENDOR => RESOLVED_ROOT)
+    JavaBuildpack::VendorResolver.stub(:resolve).with(CANDIDATE_VENDOR, [RESOLVED_VENDOR]).and_return(RESOLVED_VENDOR)
     JavaBuildpack::JreProperties.any_instance.stub(:open).with("#{RESOLVED_ROOT}/index.yml").and_return(File.open('spec/fixtures/test-index.yml'))
+    JavaBuildpack::VersionResolver.stub(:resolve).with(CANDIDATE_VERSION, nil, [RESOLVED_VERSION]).and_return(RESOLVED_VERSION)
+
+    jre_properties = JavaBuildpack::JreProperties.new('spec/fixtures/no_system_properties')
+
+    expect(jre_properties.vendor).to eq(RESOLVED_VENDOR)
+    expect(jre_properties.version).to eq(RESOLVED_VERSION)
+    expect(jre_properties.uri).to eq(RESOLVED_URI)
+  end
+
+it 'returns the resolved vendor, version, and uri from extended vendor details' do
     JavaBuildpack::ValueResolver.any_instance.stub(:resolve).with('JAVA_RUNTIME_VENDOR', 'java.runtime.vendor').and_return(CANDIDATE_VENDOR)
     JavaBuildpack::ValueResolver.any_instance.stub(:resolve).with('JAVA_RUNTIME_VERSION', 'java.runtime.version').and_return(CANDIDATE_VERSION)
+    YAML.stub(:load_file).with('config/jres.yml').and_return(RESOLVED_VENDOR => { 'default_version' => DEFAULT_VERSION,  'repository_root' => RESOLVED_ROOT})
     JavaBuildpack::VendorResolver.stub(:resolve).with(CANDIDATE_VENDOR, [RESOLVED_VENDOR]).and_return(RESOLVED_VENDOR)
-    JavaBuildpack::VersionResolver.stub(:resolve).with(CANDIDATE_VERSION, [RESOLVED_VERSION]).and_return(RESOLVED_VERSION)
+    JavaBuildpack::JreProperties.any_instance.stub(:open).with("#{RESOLVED_ROOT}/index.yml").and_return(File.open('spec/fixtures/test-index.yml'))
+    JavaBuildpack::VersionResolver.stub(:resolve).with(CANDIDATE_VERSION, DEFAULT_VERSION, [RESOLVED_VERSION]).and_return(RESOLVED_VERSION)
 
     jre_properties = JavaBuildpack::JreProperties.new('spec/fixtures/no_system_properties')
 
@@ -46,4 +63,13 @@
     expect(jre_properties.uri).to eq(RESOLVED_URI)
   end
 
+  it 'raises an error if the vendor details are not of a valid structure' do
+    JavaBuildpack::ValueResolver.any_instance.stub(:resolve).with('JAVA_RUNTIME_VENDOR', 'java.runtime.vendor').and_return(CANDIDATE_VENDOR)
+    JavaBuildpack::ValueResolver.any_instance.stub(:resolve).with('JAVA_RUNTIME_VERSION', 'java.runtime.version').and_return(CANDIDATE_VERSION)
+    YAML.stub(:load_file).with('config/jres.yml').and_return(RESOLVED_VENDOR => { 'uri' => RESOLVED_ROOT})
+    JavaBuildpack::VendorResolver.stub(:resolve).with(CANDIDATE_VENDOR, [RESOLVED_VENDOR]).and_return(RESOLVED_VENDOR)
+
+    expect { JavaBuildpack::JreProperties.new('spec/fixtures/no_system_properties') }.to raise_error
+  end
+
 end

spec/java_buildpack/version_resolver_spec.rb

@@ -29,110 +29,117 @@
   ]
 
   it 'resolves the latest version if no candidate is supplied' do
-    expect(JavaBuildpack::VersionResolver.resolve(nil, VERSIONS)).to eq('2.0.0')
-    expect(JavaBuildpack::VersionResolver.resolve('', VERSIONS)).to eq('2.0.0')
+    expect(JavaBuildpack::VersionResolver.resolve(nil, nil, VERSIONS)).to eq('2.0.0')
+    expect(JavaBuildpack::VersionResolver.resolve('', nil, VERSIONS)).to eq('2.0.0')
+    expect(JavaBuildpack::VersionResolver.resolve(nil, '', VERSIONS)).to eq('2.0.0')
+    expect(JavaBuildpack::VersionResolver.resolve('', '', VERSIONS)).to eq('2.0.0')
+  end
+
+    it 'resolves the default version if no candidate is supplied' do
+    expect(JavaBuildpack::VersionResolver.resolve(nil, '1.6.0_+', VERSIONS)).to eq('1.6.0_27')
+    expect(JavaBuildpack::VersionResolver.resolve('', '1.6.0_+', VERSIONS)).to eq('1.6.0_27')
   end
 
   it 'resolves a wildcard major version' do
-    expect(JavaBuildpack::VersionResolver.resolve('+', VERSIONS)).to eq('2.0.0')
+    expect(JavaBuildpack::VersionResolver.resolve('+', nil, VERSIONS)).to eq('2.0.0')
   end
 
   it 'resolves a wildcard minor version' do
-    expect(JavaBuildpack::VersionResolver.resolve('1.+', VERSIONS)).to eq('1.8.0_05')
+    expect(JavaBuildpack::VersionResolver.resolve('1.+', nil, VERSIONS)).to eq('1.8.0_05')
   end
 
   it 'resolves a wildcard micro version' do
-    expect(JavaBuildpack::VersionResolver.resolve('1.6.+', VERSIONS)).to eq('1.6.1_14')
+    expect(JavaBuildpack::VersionResolver.resolve('1.6.+', nil, VERSIONS)).to eq('1.6.1_14')
   end
 
   it 'resolves a wildcard qualifier' do
-    expect(JavaBuildpack::VersionResolver.resolve('1.6.0_+', VERSIONS)).to eq('1.6.0_27')
-    expect(JavaBuildpack::VersionResolver.resolve('1.8.0_+', VERSIONS)).to eq('1.8.0_05')
+    expect(JavaBuildpack::VersionResolver.resolve('1.6.0_+', nil, VERSIONS)).to eq('1.6.0_27')
+    expect(JavaBuildpack::VersionResolver.resolve('1.8.0_+', nil, VERSIONS)).to eq('1.8.0_05')
   end
 
   it 'resolves a non-wildcard version' do
-    expect(JavaBuildpack::VersionResolver.resolve('1.6.0_26', VERSIONS)).to eq('1.6.0_26')
-    expect(JavaBuildpack::VersionResolver.resolve('2.0.0', VERSIONS)).to eq('2.0.0')
+    expect(JavaBuildpack::VersionResolver.resolve('1.6.0_26', nil, VERSIONS)).to eq('1.6.0_26')
+    expect(JavaBuildpack::VersionResolver.resolve('2.0.0', nil, VERSIONS)).to eq('2.0.0')
   end
 
   it 'resolves a non-digit qualifier' do
-    expect(JavaBuildpack::VersionResolver.resolve('1.8.0_M-7', VERSIONS)).to eq('1.8.0_M-7')
+    expect(JavaBuildpack::VersionResolver.resolve('1.8.0_M-7', nil, VERSIONS)).to eq('1.8.0_M-7')
   end
 
   it 'should order qualifiers correctly' do
-    expect(JavaBuildpack::VersionResolver.resolve('1.7.0_+', ['1.7.0_28', '1.7.0_28a'])).to eq('1.7.0_28a')
+    expect(JavaBuildpack::VersionResolver.resolve('1.7.0_+', nil, ['1.7.0_28', '1.7.0_28a'])).to eq('1.7.0_28a')
   end
 
   it 'should raise an exception when the major version is not numeric' do
-    expect { JavaBuildpack::VersionResolver.resolve('A', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('A', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when the minor version is not numeric' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.A', VERSIONS) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1..0', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.A', nil, VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1..0', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when the micro version is not numeric' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.A', VERSIONS) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1.6..', VERSIONS) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1.6_26', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.A', nil, VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6..', nil, VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6_26', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception if no version can be resolved' do
-    expect { JavaBuildpack::VersionResolver.resolve('2.1.0', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('2.1.0', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when major version is not legal' do
-    expect { JavaBuildpack::VersionResolver.resolve('1+', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1+', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when minor version is not legal' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6+', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6+', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when micro version is not legal' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0+', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0+', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when qualifier version is not legal' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_05+', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_05+', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when the qualifier is not letter, number, or hyphen' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_?', VERSIONS) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0__5', VERSIONS) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_A.', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_?', nil, VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0__5', nil, VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_A.', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when a major version wildcard is folowed by anything' do
-    expect { JavaBuildpack::VersionResolver.resolve('+.6.0_26', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('+.6.0_26', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when a minor version wildcard is folowed by anything' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.+.0_26', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.+.0_26', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when a micro version wildcard is folowed by anything' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.+_26', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.+_26', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when too many components are specified' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0.25', VERSIONS) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0.25_27', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0.25', nil, VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0.25_27', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when not enough components are specified' do
-    expect { JavaBuildpack::VersionResolver.resolve('_25', VERSIONS) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('_25', nil, VERSIONS) }.to raise_error
   end
 
   it 'should raise an exception when a wildcard is specified in the versions collection' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_25', ['+']) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.6.0_25', nil, ['+']) }.to raise_error
   end
 
   it 'should raise an exception when a version ends with a component separator' do
-    expect { JavaBuildpack::VersionResolver.resolve('1.', ['1.']) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1.7.', ['1.7.']) }.to raise_error
-    expect { JavaBuildpack::VersionResolver.resolve('1.7.0_', ['1.7.0_']) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.', nil, ['1.']) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.7.', nil, ['1.7.']) }.to raise_error
+    expect { JavaBuildpack::VersionResolver.resolve('1.7.0_', nil, ['1.7.0_']) }.to raise_error
   end
 
 end