Merge 72265294-auto-reconfig-kill-switch to master

nebhale · nebhale · commit 1703374e03f2 · 2014-05-30T12:18:12.000+01:00
[Completes #72265294]
diff --git a/config/play_framework_auto_reconfiguration.yml b/config/play_framework_auto_reconfiguration.yml
@@ -19,3 +19,4 @@
 ---
 version: 1.+
 repository_root: "{default.repository.root}/auto-reconfiguration"
+enabled: true
diff --git a/config/play_framework_jpa_plugin.yml b/config/play_framework_jpa_plugin.yml
@@ -17,3 +17,4 @@
 ---
 version: 1.+
 repository_root: "{default.repository.root}/play-jpa-plugin"
+enabled: true
diff --git a/config/spring_auto_reconfiguration.yml b/config/spring_auto_reconfiguration.yml
@@ -19,3 +19,4 @@
 ---
 version: 1.+
 repository_root: "{default.repository.root}/auto-reconfiguration"
+enabled: true
diff --git a/docs/framework-play_framework_auto_reconfiguration.md b/docs/framework-play_framework_auto_reconfiguration.md
@@ -1,5 +1,5 @@
-# Play Framework Auto Reconfiguration Framework
-The Play Framework Auto Reconfiguration Framework causes an application to be automatically reconfigured to work with configured cloud services.
+# Play Framework Auto-reconfiguration Framework
+The Play Framework Auto-reconfiguration Framework causes an application to be automatically reconfigured to work with configured cloud services.
 
 <table>
   <tr>
@@ -21,8 +21,9 @@ The framework can be configured by modifying the [`config/play_framework_auto_re
 
 | Name | Description
 | ---- | -----------
-| `repository_root` | The URL of the Auto Reconfiguration repository index ([details][repositories]).
-| `version` | The version of Auto Reconfiguration to use. Candidate versions can be found in [this listing][].
+| `repository_root` | The URL of the Auto-reconfiguration repository index ([details][repositories]).
+| `version` | The version of Auto-reconfiguration to use. Candidate versions can be found in [this listing][].
+| `enabled` | Whether to attempt auto-reconfiguration
 
 [Configuration and Extension]: ../README.md#configuration-and-extension
 [`config/play_framework_auto_reconfiguration.yml`]: ../config/config/play_framework_auto_reconfiguration.yml
diff --git a/docs/framework-play_framework_jpa_plugin.md b/docs/framework-play_framework_jpa_plugin.md
@@ -27,6 +27,7 @@ The framework can be configured by modifying the [`config/play_framework_jpa_plu
 | ---- | -----------
 | `repository_root` | The URL of the Play Framework JPA Plugin repository index ([details][repositories]).
 | `version` | The version of the Play Framework JPA Plugin to use. Candidate versions can be found in [this listing][].
+| `enabled` | Whether to attempt reconfiguration
 
 [Configuration and Extension]: ../README.md#configuration-and-extension
 [`config/play_framework_jpa_plugin.yml`]: ../config/play_framework_jpa_plugin.yml
diff --git a/docs/framework-spring_auto_reconfiguration.md b/docs/framework-spring_auto_reconfiguration.md
@@ -1,5 +1,5 @@
-# Spring Auto Reconfiguration Framework
-The Spring Auto Reconfiguration Framework causes an application to be automatically reconfigured to work with configured cloud services.
+# Spring Auto-reconfiguration Framework
+The Spring Auto-reconfiguration Framework causes an application to be automatically reconfigured to work with configured cloud services.
 
 <table>
   <tr>
@@ -13,10 +13,7 @@ The Spring Auto Reconfiguration Framework causes an application to be automatica
 </table>
 Tags are printed to standard output by the buildpack detect script
 
-If a `/WEB-INF/web.xml` file exists, the framework will modify it in addition to making the auto reconfiguration JAR available on the classpath.  These modifications include:
-
-1. Augmenting `contextConfigLocation`.  The function starts be enumerating the current `contextConfigLocation`s. If none exist, a default configuration is created with `/WEB-INF/application-context.xml` or `/WEB-INF/<servlet-name>-servlet.xml` as the default.  An additional location is then added to the collection of locations; `classpath:META- INF/cloud/cloudfoundry-auto-reconfiguration-context.xml` if the `ApplicationContext` is XML-based, `org.cloudfoundry.reconfiguration.spring.web.CloudAppAnnotationConfigAutoReconfig` if the `ApplicationContext` is annotation-based.
-1. Augmenting `contextInitializerClasses`.  The function starts by enumerating the current `contextInitializerClasses`.  If none exist, a default configuration is created with no value as the default. The `org.cloudfoundry.reconfiguration.spring.CloudApplicationContextInitializer` class is then added to the collection of classes.
+If a `/WEB-INF/web.xml` file exists, the framework will modify it in addition to making the auto-reconfiguration JAR available on the classpath.  This modification consists of adding `org.cloudfoundry.reconfiguration.spring.CloudProfileApplicationContextInitializer`, `org.cloudfoundry.reconfiguration.spring.CloudPropertySourceApplicationContextInitializer`, and `org.cloudfoundry.reconfiguration.spring.CloudAutoReconfigurationApplicationContextInitializer` to the collection of `contextInitializerClasses`.
 
 ## Configuration
 For general information on configuring the buildpack, refer to [Configuration and Extension][].
@@ -25,8 +22,9 @@ The framework can be configured by modifying the [`config/spring_auto_reconfigur
 
 | Name | Description
 | ---- | -----------
-| `repository_root` | The URL of the Auto Reconfiguration repository index ([details][repositories]).
-| `version` | The version of Auto Reconfiguration to use. Candidate versions can be found in [this listing][].
+| `repository_root` | The URL of the Auto-reconfiguration repository index ([details][repositories]).
+| `version` | The version of Auto-reconfiguration to use. Candidate versions can be found in [this listing][].
+| `enabled` | Whether to attempt auto-reconfiguration
 
 [Configuration and Extension]: ../README.md#configuration-and-extension
 [`config/spring_auto_reconfiguration.yml`]: ../config/spring_auto_reconfiguration.yml
diff --git a/lib/java_buildpack/framework/play_framework_auto_reconfiguration.rb b/lib/java_buildpack/framework/play_framework_auto_reconfiguration.rb
@@ -41,7 +41,7 @@ def release
 
       # (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)
       def supports?
-        JavaBuildpack::Util::Play::Factory.create @droplet
+        @configuration['enabled'] && JavaBuildpack::Util::Play::Factory.create(@droplet)
       end
 
     end
diff --git a/lib/java_buildpack/framework/play_framework_jpa_plugin.rb b/lib/java_buildpack/framework/play_framework_jpa_plugin.rb
@@ -47,7 +47,7 @@ def supports?
         play_app  = JavaBuildpack::Util::Play::Factory.create @droplet
         candidate = uses_jpa?(play_app) || play20?(play_app.version) if play_app
 
-        candidate
+        @configuration['enabled'] && candidate
       end
 
       private
diff --git a/lib/java_buildpack/framework/spring_auto_reconfiguration.rb b/lib/java_buildpack/framework/spring_auto_reconfiguration.rb
@@ -51,7 +51,7 @@ def release
 
       # (see JavaBuildpack::Component::VersionedDependencyComponent#supports?)
       def supports?
-        (@droplet.root + '**/*spring-core*.jar').glob.any?
+        @configuration['enabled'] && (@droplet.root + '**/*spring-core*.jar').glob.any?
       end
 
       private
diff --git a/spec/java_buildpack/framework/play_framework_auto_reconfiguration_spec.rb b/spec/java_buildpack/framework/play_framework_auto_reconfiguration_spec.rb
@@ -21,6 +21,8 @@
 describe JavaBuildpack::Framework::PlayFrameworkAutoReconfiguration do
   include_context 'component_helper'
 
+  let(:configuration) { { 'enabled' => true } }
+
   it 'should detect with application configuration',
      app_fixture: 'container_play_2.1_dist' do
 
@@ -33,6 +35,16 @@
     expect(component.detect).to be_nil
   end
 
+  context do
+    let(:configuration) { { 'enabled' => false } }
+
+    it 'should not detect if disabled',
+       app_fixture: 'container_play_2.1_dist' do
+
+      expect(component.detect).to be_nil
+    end
+  end
+
   it 'should download additional libraries',
      app_fixture:   'container_play_2.1_dist',
      cache_fixture: 'stub-auto-reconfiguration.jar' do
diff --git a/spec/java_buildpack/framework/play_framework_jpa_plugin_spec.rb b/spec/java_buildpack/framework/play_framework_jpa_plugin_spec.rb
@@ -21,12 +21,24 @@
 describe JavaBuildpack::Framework::PlayFrameworkJPAPlugin do
   include_context 'component_helper'
 
+  let(:configuration) { { 'enabled' => true } }
+
   it 'should detect Play 2.0 application',
      app_fixture: 'framework_play_jpa_plugin_play20' do
 
     expect(component.detect).to eq("play-framework-jpa-plugin=#{version}")
   end
 
+  context do
+    let(:configuration) { { 'enabled' => false } }
+
+    it 'should not detect if disabled',
+       app_fixture: 'framework_play_jpa_plugin_play20' do
+
+      expect(component.detect).to be_nil
+    end
+  end
+
   it 'should detect staged application',
      app_fixture: 'framework_play_jpa_plugin_staged' do
 
diff --git a/spec/java_buildpack/framework/spring_auto_reconfiguration_spec.rb b/spec/java_buildpack/framework/spring_auto_reconfiguration_spec.rb
@@ -22,6 +22,8 @@
 describe JavaBuildpack::Framework::SpringAutoReconfiguration do
   include_context 'component_helper'
 
+  let(:configuration) { { 'enabled' => true } }
+
   it 'should detect with Spring JAR',
      app_fixture: 'framework_auto_reconfiguration_servlet_3' do
 
@@ -38,6 +40,16 @@
     expect(component.detect).to be_nil
   end
 
+  context do
+    let(:configuration) { { 'enabled' => false } }
+
+    it 'should not detect if disabled',
+       app_fixture: 'framework_auto_reconfiguration_servlet_3' do
+
+      expect(component.detect).to be_nil
+    end
+  end
+
   it 'should download additional libraries',
      app_fixture:   'framework_auto_reconfiguration_servlet_3',
      cache_fixture: 'stub-auto-reconfiguration.jar' do
