Add support for JRebel

This commit adds support for using JRebel in an IDE to live edit an
application running in Cloud Foundry. No service is required, only
the presense of the rebel.xml and rebel-remote.xml files in the
application that get's uploaded to Cloud Foundry. These files are
often generated by the IDE's JRebel plugin.

[#84050588]

Author: Christopher Frost

Diff for: README.md

@@ -43,6 +43,7 @@ To learn how to configure various properties of the buildpack, follow the "Confi
 * Standard Frameworks
 	* [AppDynamics Agent](docs/framework-app_dynamics_agent.md) ([Configuration](docs/framework-app_dynamics_agent.md#configuration))
 	* [Java Options](docs/framework-java_opts.md) ([Configuration](docs/framework-java_opts.md#configuration))
+	* [JRebel Agent](docs/framework-jrebel_agent.md) ([Configuration](docs/framework-jrebel_agent.md#configuration))
 	* [MariaDB JDBC](docs/framework-maria_db_jdbc.md) ([Configuration](docs/framework-maria_db_jdbc.md#configuration))
 	* [New Relic Agent](docs/framework-new_relic_agent.md) ([Configuration](docs/framework-new_relic_agent.md#configuration))
 	* [Play Framework Auto Reconfiguration](docs/framework-play_framework_auto_reconfiguration.md) ([Configuration](docs/framework-play_framework_auto_reconfiguration.md#configuration))

Diff for: config/components.yml

@@ -34,6 +34,7 @@ jres:
 frameworks:
   - "JavaBuildpack::Framework::AppDynamicsAgent"
   - "JavaBuildpack::Framework::JavaOpts"
+  - "JavaBuildpack::Framework::JrebelAgent"
   - "JavaBuildpack::Framework::MariaDbJDBC"
   - "JavaBuildpack::Framework::NewRelicAgent"
   - "JavaBuildpack::Framework::PlayFrameworkAutoReconfiguration"

Diff for: config/jrebel_agent.yml

@@ -0,0 +1,19 @@
+# Cloud Foundry Java Buildpack
+# Copyright (c) 2013 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.
+
+# Configuration for the JRebel framework
+---
+version: 6.+
+repository_root: "{default.repository.root}/jrebel"

Diff for: docs/framework-jrebel_agent.md

@@ -0,0 +1,31 @@
+# JRebel Agent Framework
+The JRebel Agent Framework causes an application to be automatically configured to work with an IDE using [JRebel][].
+
+<table>
+  <tr>
+    <td><strong>Detection Criterion</strong></td>
+    <td>Existence of the `rebel.xml` and `rebel-remote.xml` files in either the root or `WEB-INF/classes` directory or the application.</td>
+  </tr>
+  <tr>
+    <td><strong>Tags</strong></td>
+    <td><tt>jrebel-agent=&lt;version&gt;</tt></td>
+  </tr>
+</table>
+Tags are printed to standard output by the buildpack detect script
+
+## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
+The framework can be configured by modifying the [`config/jrebel_agent.yml`][] file in the buildpack fork.  The framework uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
+
+| Name | Description
+| ---- | -----------
+| `repository_root` | The URL of the JRebel repository index ([details][repositories]).
+| `version` | The version of Jrebel to use. Candidate versions can be found in [this listing][].
+
+[Configuration and Extension]: ../README.md#configuration-and-extension
+[`config/jrebel_agent.yml`]: ../config/jrebel_agent.yml
+[JRebel]: http://zeroturnaround.com/software/jrebel/
+[repositories]: extending-repositories.md
+[this listing]: http://download.pivotal.io.s3.amazonaws.com/jrebel/index.yml
+[version syntax]: extending-repositories.md#version-syntax-and-ordering

Diff for: java-buildpack.iml

@@ -281,13 +281,13 @@
     <orderEntry type="library" scope="PROVIDED" name="powerpack (v0.0.9, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rainbow (v2.0.0, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v10.4.2, rbenv: 1.9.3-p551) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="redcarpet (v3.2.1, rbenv: 1.9.3-p551) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="redcarpet (v3.2.2, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec (v3.1.0, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.1.7, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.1.2, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.1.3, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.1.2, rbenv: 1.9.3-p551) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.27.1, rbenv: 1.9.3-p551) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.28.0, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop-rspec (v1.2.1, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.7.0, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubyzip (v1.1.6, rbenv: 1.9.3-p551) [gem]" level="application" />

Diff for: lib/java_buildpack/component/java_opts.rb

@@ -33,7 +33,7 @@ def initialize(droplet_root)
         @droplet_root = droplet_root
       end
 
-      # Adds a +javaagent+ entry to the +JAVA_OPTS+.  Prepends +$PWD+ to the path (relative to the droplet root) to
+      # Adds a +javaagent+ entry to the +JAVA_OPTS+. Prepends +$PWD+ to the path (relative to the droplet root) to
       # ensure that the path is always accurate.
       #
       # @param [Pathname] path the path to the +javaagent+ JAR
@@ -43,7 +43,17 @@ def add_javaagent(path)
         self
       end
 
-      # Adds a system property to the +JAVA_OPTS+.  Ensures that the key is prepended with +-D+.  If the value is a
+      # Adds a +bootclasspath/p+ entry to the +JAVA_OPTS+. Prepends +$PWD+ to the path (relative to the droplet root) to
+      # ensure that the path is always accurate.
+      #
+      # @param [Pathname] path the path to the +javaagent+ JAR
+      # @return [JavaOpts]     +self+ for chaining
+      def add_bootclasspath_p(path)
+        self << "-Xbootclasspath/p:#{qualify_path path}"
+        self
+      end
+
+      # Adds a system property to the +JAVA_OPTS+. Ensures that the key is prepended with +-D+.  If the value is a
       # +Pathname+, then prepends +$PWD+ to the path (relative to the droplet root) to ensure that the path is always
       # accurate.  Otherwise, uses the value as-is.
       #
@@ -55,7 +65,7 @@ def add_system_property(key, value)
         self
       end
 
-      # Adds an option to the +JAVA_OPTS+.  Nothing is prepended to the key.  If the value is a +Pathname+, then
+      # Adds an option to the +JAVA_OPTS+. Nothing is prepended to the key.  If the value is a +Pathname+, then
       # prepends +$PWD+ to the path (relative to the droplet root) to ensure that the path is always accurate.
       # Otherwise, uses the value as-is.
       #

Diff for: lib/java_buildpack/framework/jrebel_agent.rb

@@ -0,0 +1,62 @@
+# Encoding: utf-8
+# Cloud Foundry Java Buildpack
+# Copyright 2013 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 'fileutils'
+require 'java_buildpack/component/versioned_dependency_component'
+require 'java_buildpack/framework'
+
+module JavaBuildpack
+  module Framework
+
+    # Encapsulates the functionality for enabling zero-touch JRebel support.
+    class JrebelAgent < JavaBuildpack::Component::VersionedDependencyComponent
+
+      # (see JavaBuildpack::Component::BaseComponent#compile)
+      def compile
+        download_zip false
+        FileUtils.mv(download_location + 'jrebel.jar', @droplet.sandbox + jar_name)
+        FileUtils.remove_dir(download_location, true)
+      end
+
+      # (see JavaBuildpack::Component::BaseComponent#release)
+      def release
+        @droplet.java_opts
+          .add_javaagent(@droplet.sandbox + jar_name)
+          .add_bootclasspath_p(@droplet.sandbox + jar_name)
+          .add_system_property('rebel.remoting_plugin', true)
+      end
+
+      protected
+
+      # (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)
+      def supports?
+        jrebel_configured?(@application.root) || jrebel_configured?(@application.root + 'WEB-INF/classes')
+      end
+
+      private
+
+      def jrebel_configured?(root_path)
+        (root_path + 'rebel.xml').exist? && (root_path + 'rebel-remote.xml').exist?
+      end
+
+      def download_location
+        @droplet.sandbox + 'jrebel'
+      end
+
+    end
+
+  end
+end

Diff for: spec/fixtures/framework_jrebel_app/rebel-remote.xml

@@ -0,0 +1,55 @@
+# Encoding: utf-8
+# Cloud Foundry Java Buildpack
+# Copyright 2013 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 'component_helper'
+require 'java_buildpack/framework/jrebel_agent'
+
+describe JavaBuildpack::Framework::JrebelAgent do
+  include_context 'component_helper'
+
+  it 'does not detect without JRebel config files present' do
+    expect(component.detect).to be_nil
+  end
+
+  it 'detects with JRebel config files are present',
+     app_fixture: 'framework_jrebel_app',
+     cache_fixture: 'stub-jrebel-archive.zip' do
+    expect(component.detect).to eq("jrebel-agent=#{version}")
+  end
+
+  it 'downloads JRebel agent JAR',
+     app_fixture: 'framework_jrebel_app',
+     cache_fixture: 'stub-jrebel-archive.zip' do
+
+    component.compile
+
+    expect(sandbox + "jrebel_agent-#{version}.jar").to exist
+  end
+
+  it 'updates JAVA_OPTS',
+     app_fixture: 'framework_jrebel_app',
+     cache_fixture: 'stub-jrebel-archive.zip' do
+    allow(services).to receive(:find_service).and_return('credentials' => { 'licenseKey' => 'test-license-key' })
+
+    component.release
+
+    expect(java_opts).to include("-javaagent:$PWD/.java-buildpack/jrebel_agent/jrebel_agent-#{version}.jar")
+    expect(java_opts).to include('-Drebel.remoting_plugin=true')
+    expect(java_opts).to include("-Xbootclasspath/p:$PWD/.java-buildpack/jrebel_agent/jrebel_agent-#{version}.jar")
+  end
+
+end