Changeset 7600

Timestamp:

Feb 22, 2019, 11:16:29 AM (5 years ago)

Author:

Nicklas Nordborg

Message:

References #2151: Pre-compile all JSP pages before releases

Added jsp target to the build-file. tomcat.home must be set and point to a directory with a Tomcat installation that includes the build tools (eg. ${tomcat.home}/bin/catalina-tasks.xml). Note that this is not included in all Tomcat distributions. We recommend using the ZIP file.

We recommend that a build.properties file is created in the root directory and that tomcat.home is set in that file.

The jsp target will load the jsp-precompile.xml file (which is an ant file), and will use <jasper> to pre-compile JSP to java and then a regular <javac> to compile the the java code. The compilation currently generates lots of warnings. The goal is to make them all go away with only Xlint:all,-serial. Currently all,-serial,-unchecked,-rawtypes,-deprecation,-cast is needed which can be specified by setting jsp.xlint in build.properties.

Use the jsp.clean ant target to clean files created by JSP compilation. This is also included in clean but it is typically overkill to have to recompile the entire BASE application.

Location:

trunk

Files:

• build.xml (modified) (3 diffs)
• jsp-precompile.xml (added)

trunk/build.xml

@@ -76 +76 @@
   <property name="javac.arg" value="-Xlint:all,-varargs" 
     description="Extra arguments sent to Java compiler" />
+  <property name="jsp.xlint" value="all,-serial" 
+    description="Xlint parameter when compiling JSP files (-serial is needed since jasper doesn't generate a serialVersionUID)" />
   <property name="javac.source" value="1.8"
     description="Default value for the 'source' attribute when compiling java code" />
@@ -400 +402 @@
     <path id="core.classpath">
       <path refid="lib.dist.classpath" />
-      <pathelement location="${info.build}" />
     </path>
   </target>
@@ -810 +811 @@
   </target>
   
+  <!-- Targets for JSP precompilation. Useful for checking that eveything works before a release is made. -->
+  <!-- Use as: 'ant web jsp' to also make sure that dependencies have been compiled -->
   <target 
-    name="web.jsp"
-    depends="web"
-    description="Compile all JSP pages to a temporary directory; used for checking only"
-    >
-    <property name="jsp.build" location="${build}/jsp" />
-    <property environment="env" />
-    <delete dir="${jsp.build}" />
-    <mkdir dir="${jsp.build}/src" />
-    <mkdir dir="${jsp.build}/classes" />
-    <path id="jsp.precompile.classpath">
-      <pathelement location="${java.home}/../lib/tools.jar" />
-      <fileset dir="${env.CATALINA_HOME}">
-        <include name="lib/*.jar" />
-      </fileset>
-      <fileset dir="${env.CATALINA_HOME}/bin">
-        <include name="*.jar" />
-      </fileset>
-    </path>
-    
-    <path id="jsp.compile.classpath">
-      <path refid="jsp.precompile.classpath" />
-      <fileset dir="${web.inf}/lib">
-        <include name="*.jar" />
-      </fileset>
-      <pathelement location="${info.build}" />
-    </path>
-
-    <taskdef
-      classname="org.apache.jasper.JspC" 
-      name="jasper2"
-      classpathref="jsp.precompile.classpath"
-    />
-    <jasper2
-      validateXml="false"
-      uriroot="www"
-      webXmlFragment="${jsp.build}/generated_web.xml"
-      outputdir="${jsp.build}/src"
-      javaencoding="${javac.encoding}"
-      
-    />
-    <javac
-      destdir="${jsp.build}/classes"
-      srcdir="${jsp.build}/src"
-      debug="true"
-      classpathref="jsp.compile.classpath"
-      memoryinitialsize="256m"
-      memorymaximumsize="512m"
-      fork="true"
-      source="${javac.source}"
-      target="${javac.target}"
-      encoding="${javac.encoding}"
-      bootclasspathref="lib.bootclasspath"
-      includeantruntime="false"
-      >
-    </javac>
+    name="jsp"
+    depends=""
+    >
+    <!-- check that tomcat.home exists and that required the required 'catalina-tasks.xml' is present -->
+    <fail unless="tomcat.home" 
+      message="{tomcat.home} has not been set. Create 'build.properties' in current directory and add 'tomcat.home' with path to your Tomcat installation directory. " />
+    
+    <available file="${tomcat.home}/bin/catalina-tasks.xml" property="catalina-tasks" />
+    
+    <fail unless="catalina-tasks" 
+      message="File '${tomcat.home}/bin/catalina-tasks.xml' does not exists. You may have to install this from the Tomcat ZIP distribution." />
+    
+    <!-- we are good to go -->
+    <mkdir dir="${build}/jsp" />
+    <ant antfile="jsp-precompile.xml" inheritall="false" target="all" >
+      <property name="tomcat.home" value="${tomcat.home}" />
+      <property name="jsp.src" value="www" />
+      <property name="jsp.build" value="${build}/jsp" />
+      <property name="javac.bootclasspath" value="${javac.bootclasspath}" />
+      <property name="javac.encoding" value="${javac.encoding}" />
+      <property name="javac.source" value="${javac.source}" />
+      <property name="javac.target" value="${javac.target}" />
+      <property name="jsp.xlint" value="${jsp.xlint}" />
+    </ant>
+  </target>
+  
+  <!-- Clean up after 'jsp' target -->
+  <target 
+    name="jsp.clean"
+    >
+    <delete dir="${build}/jsp" />
   </target>