Change detect output

nebhale · nebhale · commit be124ef5a40f · 2013-10-22T13:01:59.000+01:00
Previously, the detect output of the buildpack looked something like
the following:

openjdk-1.7.0_40, tomcat-7.0.42, spring-auto-reconfiguration-0.9.1

Per request from the Cloud Foundry core team, this output has been
modified to delimit each entry's name and version number with an
equals sign and each entry from one another with a space.  The output
now looks like:

openjdk=1.7.0_40 tomcat=7.0.42 spring-auto-reconfiguration=0.9.1

[#58810508]
diff --git a/bin/detect b/bin/detect
@@ -28,5 +28,5 @@ components = JavaBuildpack::Buildpack.drive_buildpack_with_logger(build_dir, 'De
 if components.empty?
   abort
 else
-  puts components.join(', ')
+  puts components.join(' ')
 end
diff --git a/docs/container-groovy.md b/docs/container-groovy.md
@@ -10,7 +10,7 @@ The Groovy Container allows a uncompiled (i.e. `*.groovy`) to be run.
 		</ul></td>
 	</tr>
 	<tr>
-		<td><strong>Tags</strong></td><td><tt>groovy-&lang;version&rang;</tt></td>
+		<td><strong>Tags</strong></td><td><tt>groovy=&lang;version&rang;</tt></td>
 	</tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/container-play.md b/docs/container-play.md
@@ -7,7 +7,7 @@ The Play Container allows Play applications to be run.
 	directory or one of its immediate subdirectories (but not in both)</td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>play-&lt;version&gt;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>play-framework=&lt;version&gt;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/container-spring-boot-cli.md b/docs/container-spring-boot-cli.md
@@ -11,7 +11,7 @@ The Spring Boot CLI Container runs one or more Groovy (i.e. `*.groovy`) files us
 		</ul></td>
 	</tr>
 	<tr>
-		<td><strong>Tags</strong></td><td><tt>spring-boot-cli-&lang;version&rang;</tt></td>
+		<td><strong>Tags</strong></td><td><tt>spring-boot-cli=&lang;version&rang;</tt></td>
 	</tr>
 </table>
 Tags are printed to standard output by the buildpack detect script.
diff --git a/docs/container-tomcat.md b/docs/container-tomcat.md
@@ -6,7 +6,7 @@ The Tomcat Container allows a web application to be run.  These applications are
     <td><strong>Detection Criterion</strong></td><td>Existence of a <tt>WEB-INF/</tt> folder in the application directory and <a href="container-java-main.md">Java Main Class</a> not detected</td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>tomcat-&lang;version&rang;</tt>, <tt>tomcat-buildpack-support-&lang;version&rang;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>tomcat=&lang;version&rang;</tt>, <tt>tomcat-buildpack-support=&lang;version&rang;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/framework-java_opts.md b/docs/framework-java_opts.md
@@ -6,7 +6,7 @@ The `JAVA_OPTS` Framework contributes arbitrary Java options to the application
     <td><strong>Detection Criterion</strong></td><td><tt>java_opts</tt> set</td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>java-opts</tt></td>
+    <td><strong>Tags</strong></td><td><tt>java_opts</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/framework-new-relic.md b/docs/framework-new-relic.md
@@ -6,7 +6,7 @@ The New Relic Framework causes an application to be automatically configured to
     <td><strong>Detection Criterion</strong></td><td>Existence of a single bound New Relic service</td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>new-relic-&lt;version&gt;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>new-relic-agent=&lt;version&gt;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/framework-play-auto-reconfiguration.md b/docs/framework-play-auto-reconfiguration.md
@@ -6,7 +6,7 @@ The Play Auto Reconfiguration Framework causes an application to be automaticall
     <td><strong>Detection Criterion</strong></td><td>An application is a Play application</td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>play-auto-reconfiguration-&lt;version&gt;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>play-auto-reconfiguration=&lt;version&gt;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/framework-play-jpa-plugin.md b/docs/framework-play-jpa-plugin.md
@@ -12,7 +12,7 @@ The Play JPA Plugin Framework causes an application to be automatically reconfig
     </td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>play-jpa-plugin-&lt;version&gt;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>play-jpa-plugin=&lt;version&gt;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/framework-spring-auto-reconfiguration.md b/docs/framework-spring-auto-reconfiguration.md
@@ -6,7 +6,7 @@ The Spring Auto Reconfiguration Framework causes an application to be automatica
     <td><strong>Detection Criterion</strong></td><td>Existence of a <tt>spring-core*.jar</tt> file in the application directory</td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>spring-auto-reconfiguration-&lt;version&gt;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>spring-auto-reconfiguration=&lt;version&gt;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/jre-openjdk.md b/docs/jre-openjdk.md
@@ -6,7 +6,7 @@ The OpenJDK JRE provides Java runtimes from the [OpenJDK][] project.  Versions o
     <td><strong>Detection Criterion</strong></td><td>Unconditional</td>
   </tr>
   <tr>
-    <td><strong>Tags</strong></td><td><tt>openjdk-&lang;version&rang;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>openjdk=&lang;version&rang;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/lib/java_buildpack/base_component.rb b/lib/java_buildpack/base_component.rb
@@ -38,6 +38,8 @@ class BaseComponent
     # @param [Hash] context A shared context provided to all components
     def initialize(component_name, context)
       @component_name = component_name
+      @parsable_component_name = component_name.gsub(/ /, '-').downcase
+
       @context = context
       @context.each { |key, value| instance_variable_set("@#{key}", value) }
     end
@@ -46,7 +48,7 @@ def initialize(component_name, context)
     #
     # @return [Array<String>, String, nil] If the component should be used when staging the application, a +String+ or
     #                                      an +Array<String>+ that uniquely identifies the component (e.g.
-    #                                      +openjdk-1.7.0_40+).  Otherwise, +nil+.
+    #                                      +openjdk=1.7.0_40+).  Otherwise, +nil+.
     def detect
       fail "Method 'detect' must be defined"
     end
diff --git a/lib/java_buildpack/container/groovy.rb b/lib/java_buildpack/container/groovy.rb
@@ -51,10 +51,6 @@ def release
 
     protected
 
-    def id(version)
-      "groovy-#{version}"
-    end
-
     def supports?
       main_groovy
     end
diff --git a/lib/java_buildpack/container/main.rb b/lib/java_buildpack/container/main.rb
@@ -32,7 +32,7 @@ def initialize(context)
     end
 
     def detect
-      main_class ? id : nil
+      main_class ? @parsable_component_name : nil
     end
 
     def compile
@@ -67,10 +67,6 @@ def classpath
       "-cp #{classpath.join(':')}"
     end
 
-    def id
-      'java-main'
-    end
-
     def main_class
       JavaBuildpack::Util::JavaMainUtils.main_class(@app_dir, @configuration)
     end
diff --git a/lib/java_buildpack/container/play.rb b/lib/java_buildpack/container/play.rb
@@ -55,16 +55,6 @@ def release
       "#{path_string}#{java_home_string}#{start_script_string}#{java_opts_string}"
     end
 
-    protected
-
-    # The unique indentifier of the component, incorporating the version of the dependency (e.g. +play-2.2.0+)
-    #
-    # @param [String] version the version of the dependency
-    # @return [String] the unique identifier of the component
-    def id(version)
-      "play-#{version}"
-    end
-
     private
 
     KEY_HTTP_PORT = 'http.port'.freeze
@@ -105,6 +95,10 @@ def add_libs_to_dist_classpath
       end
     end
 
+    def id(version)
+      "#{@parsable_component_name}=#{version}"
+    end
+
     def replace_bootstrap(root)
       update_file JavaBuildpack::Util::PlayUtils.start_script(root), /play\.core\.server\.NettyServer/, 'org.cloudfoundry.reconfiguration.play.Bootstrap'
     end
diff --git a/lib/java_buildpack/container/spring_boot_cli.rb b/lib/java_buildpack/container/spring_boot_cli.rb
@@ -52,10 +52,6 @@ def release
 
     protected
 
-    def id(version)
-      "spring-boot-cli-#{version}"
-    end
-
     def supports?
       gf = JavaBuildpack::Util::GroovyUtils.groovy_files(@app_dir)
       gf.length > 0 && all_pogo(gf) && no_main_method(gf) && !has_web_inf
diff --git a/lib/java_buildpack/container/tomcat.rb b/lib/java_buildpack/container/tomcat.rb
@@ -64,20 +64,20 @@ def release
 
     protected
 
-    # The unique indentifier of the component, incorporating the version of the dependency (e.g. +tomcat-7.0.42+)
+    # The unique indentifier of the component, incorporating the version of the dependency (e.g. +tomcat=7.0.42+)
     #
     # @param [String] version the version of the dependency
     # @return [String] the unique identifier of the component
     def tomcat_id(version)
-      "tomcat-#{version}"
+      "#{@parsable_component_name}=#{version}"
     end
 
-    # The unique indentifier of the component, incorporating the version of the dependency (e.g. +tomcat-buildpack-support-1.1.0+)
+    # The unique indentifier of the component, incorporating the version of the dependency (e.g. +tomcat-buildpack-support=1.1.0+)
     #
     # @param [String] version the version of the dependency
     # @return [String] the unique identifier of the component
     def support_id(version)
-      "tomcat-buildpack-support-#{version}"
+      "tomcat-buildpack-support=#{version}"
     end
 
     # Whether or not this component supports this application
@@ -135,7 +135,7 @@ def root
     end
 
     def support_jar_name
-      "#{support_id @support_version}.jar"
+      "tomcat-buildpack-support-#{@support_version}.jar"
     end
 
     def tomcat_home
diff --git a/lib/java_buildpack/framework/java_opts.rb b/lib/java_buildpack/framework/java_opts.rb
@@ -28,7 +28,7 @@ def initialize(context)
     end
 
     def detect
-      @configuration.key?(CONFIGURATION_PROPERTY) ? id : nil
+      @configuration.key?(CONFIGURATION_PROPERTY) ? @parsable_component_name : nil
     end
 
     def compile
@@ -45,10 +45,6 @@ def release
 
     CONFIGURATION_PROPERTY = 'java_opts'.freeze
 
-    def id
-      'java-opts'
-    end
-
     def memory_option?(option)
       option =~ /-Xms/ || option =~ /-Xmx/ || option =~ /-XX:MaxMetaspaceSize/ || option =~ /-XX:MaxPermSize/ ||
           option =~ /-Xss/
diff --git a/lib/java_buildpack/framework/new_relic.rb b/lib/java_buildpack/framework/new_relic.rb
@@ -48,10 +48,6 @@ def release
 
     protected
 
-    def id(version)
-      "new-relic-#{version}"
-    end
-
     def supports?
       JavaBuildpack::Util::ServiceUtils.find_service(@vcap_services, SERVICE_NAME)
     end
@@ -65,7 +61,7 @@ def supports?
     SERVICE_NAME = /newrelic/.freeze
 
     def jar_name
-      "#{id @version}.jar"
+      "#{@parsable_component_name}-#{@version}.jar"
     end
 
     def license_key
diff --git a/lib/java_buildpack/framework/play_auto_reconfiguration.rb b/lib/java_buildpack/framework/play_auto_reconfiguration.rb
@@ -40,18 +40,14 @@ def release
 
     protected
 
-    def id(version)
-      "play-auto-reconfiguration-#{version}"
-    end
-
     def supports?
       JavaBuildpack::Util::PlayUtils.root(@app_dir)
     end
 
     private
 
     def jar_name
-      "#{id @version}.jar"
+      "#{@parsable_component_name}-#{@version}.jar"
     end
 
   end
diff --git a/lib/java_buildpack/framework/play_jpa_plugin.rb b/lib/java_buildpack/framework/play_jpa_plugin.rb
@@ -41,10 +41,6 @@ def release
 
     protected
 
-    def id(version)
-      "play-jpa-plugin-#{version}"
-    end
-
     def supports?
       candidate = false
 
diff --git a/lib/java_buildpack/framework/spring_auto_reconfiguration.rb b/lib/java_buildpack/framework/spring_auto_reconfiguration.rb
@@ -41,10 +41,6 @@ def release
 
     protected
 
-    def id(version)
-      "spring-auto-reconfiguration-#{version}"
-    end
-
     def supports?
       Dir["#{@app_dir}/**/#{SPRING_JAR_PATTERN}"].any?
     end
@@ -56,7 +52,7 @@ def supports?
     WEB_XML = File.join 'WEB-INF', 'web.xml'.freeze
 
     def jar_name
-      "#{id @version}.jar"
+      "#{@parsable_component_name}-#{@version}.jar"
     end
 
     def modify_web_xml
diff --git a/lib/java_buildpack/jre/openjdk.rb b/lib/java_buildpack/jre/openjdk.rb
@@ -33,7 +33,7 @@ class OpenJdk < JavaBuildpack::VersionedDependencyComponent
     KILLJAVA_FILE_NAME = 'killjava'.freeze
 
     def initialize(context)
-      super('OpenJDK JRE', context)
+      super('OpenJDK', context)
       @java_home.concat JAVA_HOME
     end
 
@@ -50,10 +50,6 @@ def release
 
     protected
 
-    def id(version)
-      "openjdk-#{version}"
-    end
-
     def supports?
       true
     end
diff --git a/lib/java_buildpack/versioned_dependency_component.rb b/lib/java_buildpack/versioned_dependency_component.rb
@@ -35,21 +35,13 @@ def initialize(component_name, context, &version_validator)
     #
     # @return [Array<String>, String, nil] If the component should be used when staging the application, a +String+ or
     #                                      an +Array<String>+ that uniquely identifies the component (e.g.
-    #                                      +openjdk-1.7.0_40+).  Otherwise, +nil+.
+    #                                      +openjdk=1.7.0_40+).  Otherwise, +nil+.
     def detect
       @version ? id(@version) : nil
     end
 
     protected
 
-    # The unique indentifier of the component, incorporating the version of the dependency (e.g. +openjdk-1.7.0_40+)
-    #
-    # @param [String] version the version of the dependency
-    # @return [String] the unique identifier of the component
-    def id(version)
-      fail "Method 'id(version)' must be defined"
-    end
-
     # Whether or not this component supports this application
     #
     # @return [Boolean] whether or not this component supports this application
@@ -76,6 +68,12 @@ def download_jar(jar_name, target_directory = @lib_directory, description = @com
       download(description) { |file| shell "cp #{file.path} #{File.join(target_directory, jar_name)}" }
     end
 
+    private
+
+    def id(version)
+      "#{@parsable_component_name}=#{version}"
+    end
+
   end
 
 end
diff --git a/spec/java_buildpack/container/groovy_spec.rb b/spec/java_buildpack/container/groovy_spec.rb
@@ -62,7 +62,7 @@ module JavaBuildpack::Container
           configuration: {}
       ).detect
 
-      expect(detected).to include('groovy-2.1.5')
+      expect(detected).to include('groovy=2.1.5')
     end
 
     it 'should detect a Groovy file with non-POGO' do
@@ -73,7 +73,7 @@ module JavaBuildpack::Container
           configuration: {}
       ).detect
 
-      expect(detected).to include('groovy-2.1.5')
+      expect(detected).to include('groovy=2.1.5')
     end
 
     it 'should detect a Groovy file with #!' do
@@ -84,7 +84,7 @@ module JavaBuildpack::Container
           configuration: {}
       ).detect
 
-      expect(detected).to include('groovy-2.1.5')
+      expect(detected).to include('groovy=2.1.5')
     end
 
     it 'should fail when a malformed version is detected' do
diff --git a/spec/java_buildpack/container/play_spec.rb b/spec/java_buildpack/container/play_spec.rb
diff --git a/spec/java_buildpack/container/spring_boot_cli_spec.rb b/spec/java_buildpack/container/spring_boot_cli_spec.rb
diff --git a/spec/java_buildpack/container/tomcat_spec.rb b/spec/java_buildpack/container/tomcat_spec.rb
diff --git a/spec/java_buildpack/framework/java_opts_spec.rb b/spec/java_buildpack/framework/java_opts_spec.rb
diff --git a/spec/java_buildpack/framework/new_relic_spec.rb b/spec/java_buildpack/framework/new_relic_spec.rb
diff --git a/spec/java_buildpack/framework/play_auto_reconfiguration_spec.rb b/spec/java_buildpack/framework/play_auto_reconfiguration_spec.rb
diff --git a/spec/java_buildpack/framework/play_jpa_plugin_spec.rb b/spec/java_buildpack/framework/play_jpa_plugin_spec.rb
diff --git a/spec/java_buildpack/framework/spring_auto_reconfiguration_spec.rb b/spec/java_buildpack/framework/spring_auto_reconfiguration_spec.rb
diff --git a/spec/java_buildpack/jre/openjdk_spec.rb b/spec/java_buildpack/jre/openjdk_spec.rb
diff --git a/spec/java_buildpack/versioned_dependency_component_spec.rb b/spec/java_buildpack/versioned_dependency_component_spec.rb
