Spring Auto Reconfiguration is not operational when deploying EAR

[violetagg]

When Spring Auto Reconfiguration is enabled and there is spring-core*.jar artifacts [1]
in the application binaries, a modification of web.xml provided by web module will be made
and Spring Auto Reconfiguration jar file will be added to the additional libraries [2].

When the deployment artifact is WAR file the collection of the additional libraries will be added
to WEB-INF/lib [3]. Thus Spring Auto Reconfiguration will be able to load classes provided by spring-core*.jar.

In case of EAR the additional libraries will be added to <TomEE-Home>/lib [3]. Thus
Spring Auto Reconfiguration will not be able to load the classes provided by spring-core*.jar
because they are provided by the application binaries and not by TomEE installation.

The exception below will appear:

   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT Caused by: java.lang.NoClassDefFoundError: org/springframework/context/ApplicationContextInitializer
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.defineClass1(Native Method)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.defineClass(ClassLoader.java:763)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:142)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.net.URLClassLoader.defineClass(URLClassLoader.java:467)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.net.URLClassLoader.access$100(URLClassLoader.java:73)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.net.URLClassLoader$1.run(URLClassLoader.java:368)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.net.URLClassLoader$1.run(URLClassLoader.java:362)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.security.AccessController.doPrivileged(Native Method)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.net.URLClassLoader.findClass(URLClassLoader.java:361)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.loadClass(ClassLoader.java:411)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.loadClass(ClassLoader.java:411)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.openejb.core.TempClassLoader.loadClass(TempClassLoader.java:225)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.openejb.core.TempClassLoader.loadClass(TempClassLoader.java:83)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.cloudfoundry.reconfiguration.spring.AutoReconfigurationServletContainerInitializer.<clinit>(AutoReconfigurationServletContainerInitializer.java:33)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.Class.forName0(Native Method)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.Class.forName(Class.java:348)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.WebappServiceLoader.loadServices(WebappServiceLoader.java:188)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.WebappServiceLoader.load(WebappServiceLoader.java:159)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.ContextConfig.processServletContainerInitializers(ContextConfig.java:1622)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.OpenEJBContextConfig.processServletContainerInitializers(OpenEJBContextConfig.java:479)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.ContextConfig.webConfig(ContextConfig.java:1135)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.OpenEJBContextConfig.webConfig(OpenEJBContextConfig.java:402)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.ContextConfig.configureStart(ContextConfig.java:775)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.OpenEJBContextConfig.configureStart(OpenEJBContextConfig.java:123)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.startup.ContextConfig.lifecycleEvent(ContextConfig.java:299)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.util.LifecycleBase.fireLifecycleEvent(LifecycleBase.java:94)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.core.StandardContext.startInternal(StandardContext.java:5087)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:150)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	... 23 more
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT Caused by: java.lang.ClassNotFoundException: org.springframework.context.ApplicationContextInitializer
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
   2017-08-10T14:37:48.66-0400 [APP/PROC/WEB/0] OUT 	... 52 more

[1] https://github.com/cloudfoundry-community/tomee-buildpack/blob/master/lib/java_buildpack/framework/spring_auto_reconfiguration.rb#L53
[2] https://github.com/cloudfoundry-community/tomee-buildpack/blob/master/lib/java_buildpack/framework/spring_auto_reconfiguration.rb#L39
[3] https://github.com/cloudfoundry-community/tomee-buildpack/blob/master/lib/java_buildpack/container/tomee/tomee_instance.rb#L62

[violetagg]

cc @kelapure

[bijukunjummen]

@kelapure and I are starting to look at this @violetagg - one question though, how did you get this condition to trigger to simulate the scenario for the ear file:

@configuration['enabled'] && (@droplet.root + '**/*spring-core*.jar').glob.any?

[nebhale]

Any EAR file that contains a WAR using Spring Boot, would do it.

[bijukunjummen]

Thanks @nebhale, however then the war in the ear will have to be in an exploded form right for the jars in there to be visible to the buildpack. I will assume that to be the case and try to simulate the issue that @violetagg is seeing

[nebhale]

That is correct, and that is how the application we were working with was laid out.

[bijukunjummen]

Do you mind providing a sample @nebhale, @violetagg , a sample that I have with a spring boot war packaged in an ear is not starting up at all - https://github.com/bijukunjummen/ear-with-boot, for me to simulate the issue

//cc @kelapure

[bijukunjummen]

@violetagg, can you please provide your sample which has this issue.

[violetagg]

@bijukunjummen
test-ear.zip

Try with this one. You should be able to see

   2017-09-07T19:12:03.32+0300 [APP/PROC/WEB/0] OUT Caused by: java.lang.ClassNotFoundException: org.springframework.context.ApplicationContextInitializer
   2017-09-07T19:12:03.32+0300 [APP/PROC/WEB/0] OUT 	at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
   2017-09-07T19:12:03.32+0300 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
   2017-09-07T19:12:03.32+0300 [APP/PROC/WEB/0] OUT 	at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
   2017-09-07T19:12:03.32+0300 [APP/PROC/WEB/0] OUT 	... 52 more

[bijukunjummen]

Awesome, thanks @violetagg, will give this a try and get back to you

[bijukunjummen]

I can see only a couple of potential fixes @violetagg, @nebhale , @kelapure

1. Disable Spring Auto-reconfiguration altogether for ear files.
2. Add documentation to show how to disable auto-reconfiguration in case of exploded ear files
3. Copy auto-reconfiguration jars to ALL exploded wars in an ear file and NOT to tomee-lib.

1 and 2 should be very easy, 3 I feel will be tricky since there are now potentially more than 1 target folder. Let me know what you think and I can attempt a fix along those lines.

[mgvinuesa]

Hi,

In the issue you talk about a exploded EAR (with the wars "unzipped") but I have a EAR structure similar to this:

sample.ear
|____drivers
| |____driver.jar
|____war1-1.0.war
|____war2-1.0.war
|____lib
  |____ thirdlibrary1.jar
  |____ thirdlibrary2.jar
  |____...
|____META-INF|
 |____application.xml

My wars aren't exploded.

And to provide all the common libs out of the WARs included spring libs the skinnyWars option is enabled in maven plugin. But I have the same error in my logs.

2018-02-15T16:33:04.808+01:00 [APP/PROC/WEB/0] [OUT] Caused by: java.lang.NoClassDefFoundError: org/springframework/context/ApplicationContextInitializer .... 2018-02-15T16:33:04.808+01:00 [APP/PROC/WEB/0] [OUT] Caused by: java.lang.ClassNotFoundException: org.springframework.context.ApplicationContextInitializer

The problem is that I would have to put all the libraries inside the WAR due to if I put only the spring libraries the other libraries won't be able to access to spring classes (classpath hierarchy WAR -> EAR -> tomEE)

[mgvinuesa]

Hi @violetagg
Any news about this issue?