Changes for page Alternative Ant Build Script for Fully Embedded and Split Install Bundles

Last modified by Pascal Robert on 2012/07/21 20:39

Manage
- Copy
Actions
Viewers
- Source
- Children
- Content
- Comments
- Attachments (8)
- History
- Information
- Likes

From 61.1 to 62.1 From 65.1 to 66.1

From version 62.1

edited by George Domurot
on 2009/07/14 10:09

Change comment: There is no comment for this version

To version 65.1

edited by Pascal Robert
on 2012/07/21 20:39

Change comment: Migrated to Confluence 5.3

Raw
Rendered

Summary

Page properties (4 modified, 0 added, 0 removed)
Attachments (0 modified, 8 added, 0 removed)

Details

Page properties

Parent

...	...	@@ -1,0 +1,1 @@
	1	+Deprecated info

Author

@@ -1,1 +1,1 @@
--XWiki.gedo820
++XWiki.probert

Tags

...	...	@@ -1,0 +1,1 @@
	1	+favourite

Content

@@ -4,8 +4,12 @@
  == WOLips 3.4.x, and later, Side-note ==
--For WOLips 3.4.x and later, while embedding is built-in, it's not enabled by default.  To enable embedding:
++{{warning}}
++If you are updating an older project, make sure you get the latest build.xml file. Create a new project, then copy/paste the contents of the fresh build.xml file into your project's build.xml file.
++{{/warning}}
++For WOLips 3.4.x and later, while embedding is built-in, it's not enabled by default. To enable embedding:
++
  * make sure you are in the WO Explorer view
  * right-click your project folder, select Properties, select WOLips Deployment
  * check the related, if not all, options under Embed Frameworks
@@ -14,54 +14,47 @@
  * make sure you are in the Navigator view
  * edit build.properties, and add:
--* ##build.app.name=MyApp-2009-07-14##
++* {{code language="none"}}build.app.name=MyApp-2009-07-14{{/code}}
--There is a known bug with WO 5.4.x (for those not using the latest Wonder release) regarding proper linking to your web server resources within the embedded frameworks.  The WOFrameworksBaseURL isn't set correctly.  To do this you'll need to programmatically set this within your Application constructor:
++There is a known bug with WO 5.4.x (for those not using the latest Wonder release) regarding proper linking to your web server resources within the embedded frameworks. The WOFrameworksBaseURL isn't set correctly. To do this you'll need to programmatically set this within your Application constructor:
--* ##setFrameworksBaseURL("/WebObjects/MyApp-2009-07-14.woa/Frameworks");##
++* {{code language="none"}}setFrameworksBaseURL("/WebObjects/MyApp-2009-07-14.woa/Frameworks");{{/code}}
  Within build.properties (I may need to be corrected on this), the best approach to linking your embedded framework's web server resources automatically is to include (however the bug noted above breaks this):
--* ##frameworksBaseURL=/WebObjects/$build.app.name.woa/Frameworks##
++* {{code language="none"}}frameworksBaseURL=/WebObjects/${build.app.name}.woa/Frameworks{{/code}}
--And finally, there is a bud in the build.xml file that you may need to clean-up:
--[[http://issues.objectstyle.org/jira/browse/WOL-979]]
--
  == Introduction ==
--The previous tutorial articles provide details of customization of the default ant build script that is present in your WebObjects projects. This article provides a fully custom build script that you can just drop into your project and use it as an alternative to the default build.xml. This script is called the "split//embedded//build" script. Along with providing the script, this article explains in detail what deployment artifacts are produced by the build. Hopefully the functionality in this script will make their way into the standard script someday with configuration parameters settable in a simple way in the build.properties file.
++The previous tutorial articles provide details of customization of the default ant build script that is present in your WebObjects projects. This article provides a fully custom build script that you can just drop into your project and use it as an alternative to the default build.xml. This script is called the "split_embedded_build" script. Along with providing the script, this article explains in detail what deployment artifacts are produced by the build. Hopefully the functionality in this script will make their way into the standard script someday with configuration parameters settable in a simple way in the build.properties file.
  == Pre-requisites ==
--This [[script>>^split_embedded_build.xml]] only works with the modern WOLips project format and the WOnderApplication project template format (since the layout of regular projects is now similar to Wonder layout). However the script is easily changed to accommodate the "old" standard format by changing the dir names in the script (for example "Sources" in the new project layout was "src" in the old layout)
++This [[script>>attach:split_embedded_build.xml]] only works with the modern WOLips project format and the WOnderApplication project template format (since the layout of regular projects is now similar to Wonder layout). However the script is easily changed to accommodate the "old" standard format by changing the dir names in the script (for example "Sources" in the new project layout was "src" in the old layout)
  {{info title="Modern WebObjects Project Layout"}}
--
  This layout is the standard layout for all WebObjects projects created by WOLips (rev #4735 at least). The distinct folder names indicate if your project is in this modern format and if yours is the same, then this ant script should work.
--!modern_project_layout.jpg!
--
++[[image:attach:modern_project_layout.jpg]]
  {{/info}}
  == Installation and Usage of the Script ==
--Have no fear ;-) , you will not break anything by dropping this script as is into your project and trying it out. You can just use it as is without replacing your default build.xml
++Have no fear , you will not break anything by dropping this script as is into your project and trying it out. You can just use it as is without replacing your default build.xml
--* So, download the [[script>>^split_embedded_build.xml]] by right-clicking this [[link>>^split_embedded_build.xml]] and selecing Save As... or whatever your browser uses for saving contents at a link destination.
++* So, download the [[script>>attach:split_embedded_build.xml]] by right-clicking this [[link>>attach:split_embedded_build.xml]] and selecing Save As... or whatever your browser uses for saving contents at a link destination.
  * Drag it to the root of your project.
--* Open the Ant run configuration for the script by right-clicking on the script and selecting the menu shown below.
++* Open the Ant run configuration for the script by right-clicking on the script and selecting the menu shown below.
  {{info title="Using the Ant Script"}}
-- !running_the_script.jpg!
--
++[[image:attach:running_the_script.jpg]]
  {{/info}}
--* Next select the "clean" and compileAndBuild" tasks. If necessary use the "Order..." button to ensure that "clean" comes before "compileAndBuild".
++* Next select the "clean" and compileAndBuild" tasks. If necessary use the "Order..." button to ensure that "clean" comes before "compileAndBuild".
  {{info title="Configure the Ant Tasks to be run"}}
-- !ant_tasks.jpg!
--
++[[image:attach:ant_tasks.jpg]]
  {{/info}}
  * Click the Run button to run the ant script and your fully embedded split install deployment bundles will be created in the "dist" folder.
@@ -77,8 +77,7 @@
  OK, so getting to the point, an optional custom app name can be set in the project's build.properties file by simply adding a property "build.app.name" as shown below.
  {{info title="Customizing the Application Build Name"}}
-- !custom_app_name.jpg!
--
++[[image:attach:custom_app_name.jpg]]
  {{/info}}
  == Features ==
@@ -90,15 +90,13 @@
  * Self-contained deployment bundles - all required frameworks are embedded - minimal dependency on target server configuration and versions. For example, there is no need to install Wonder frameworks on your deployment server since the ones you developed and tested with are embedded in the deployment bundles. Experience has shown that this improves consistency of deployment reliability.
  * Compressed gzipped tar archives of both application and webserver bundles are created, ready for copying to target server(s)
  ** This is easily decompressed on the server using
--** $ sudo tar xvzf bundle.tar.gz
++** $ sudo tar -xvzf bundle.tar.gz
  == Anatomy of Embedded Split Install Bundles produced by this Ant Script ==
  {{info title="The Deployment Files"}}
--
  The two compressed "ready-to-deploy" bundles are highlighted below
--!build_artifacts.jpg!
--
++[[image:attach:build_artifacts.jpg]]
  {{/info}}
  The notable aspects of the embedded build structure are shown below.
@@ -106,11 +106,10 @@
  === Application Bundle ===
  {{info title="Embedded Application Bundle Layout"}}
++[[image:attach:app_bundle_layout.jpg]]
--!app_bundle_layout.jpg!
  * Opening the app executable (command line script at bundle root having the application name as its name) and looking at the end will reveal that the WOFrameworksBaseURL references the frameworks inside the webserver embedded bundle.
  * Examining the Contents/MacOS/MacOSClassPath.txt file will reveal that the java classpath refers to all the jars inside the embedded bundle.
--
  {{/info}}
  The application bundle typically gets installed as follows:
@@ -117,13 +117,12 @@
  * Install Location = /Library/WebObjects/Applications/
  * chown (ownership) = appserver:appserveradm
--* chmod (permissions) = 755   (750 if you wish, but your server login id needs to be a member of appserveradm group to cd into the bundle)
++* chmod (permissions) = 755 (750 if you wish, but your server login id needs to be a member of appserveradm group to cd into the bundle)
  === WebServer Bundle ===
  {{info title="Embedded WebServer Bundle Layout"}}
-- !webserver_bundle_layout.jpg!
--
++[[image:attach:webserver_bundle_layout.jpg]]
  {{/info}}
  The webserver bundle typically gets installed as follows:

ant_tasks.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+37.0 KB

Content

app_bundle_layout.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+63.2 KB

Content

build_artifacts.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+17.6 KB

Content

custom_app_name.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+40.8 KB

Content

modern_project_layout.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+25.3 KB

Content

running_the_script.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+46.9 KB

Content

split_embedded_build.xml

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+13.7 KB

Content

@@ -1,0 +1,294 @@
++<project name="Workbench" default="build" basedir=".">
++    <!-- KK: WARNING: The embedded webserver bundle may not be generated correctly with WOLips versions
++            earlier than 4118 -->
++    <!-- KK: This build script is based on standard WOLips script that comes with WOApplication template
++            Changes and additions are commented. Use diff tool to compare this to standard WOLips build.xml if u like -->
++
++    <!-- main targets  -->
++    <!-- add optional targets to depends list if needed -->
++    <!-- KK: additional depends targets added: record.build.info, ws.split.embed -->
++    <target name="build" depends="setProps,init.build,build.woapp,ws.split.embed,ssdd,war"/>
++
++  <target name="compileAndBuild" depends="setProps,init.build,compile,build.woapp,ws.split.embed,ssdd,war" />
++
++    <target name="install" depends="setProps,init.install,build.woapp,ws.split.embed,ssdd,war"/>
++
++    <target name="clean" depends="setProps">
++          <delete dir="dist"/>
++    </target>
++
++    <!-- property determination  -->
++    <target name="setProps">
++        <property file="${user.home}${file.separator}build.properties"/>
++        <property file="build.properties"/>
++        <property file="${user.home}${file.separator}Library${file.separator}wobuild.properties"/>
++        <condition property="wo.properties.check.failed">
++            <not>
++                <and>
++                      <isset property="wo.wosystemroot"/>
++                      <isset property="wo.wolocalroot"/>
++                </and>
++            </not>
++          </condition>
++          <fail message="Could not find ${user.home}${file.separator}Library${file.separator}wobuild.properties." if="wo.properties.check.failed"/>
++        <property name="install.dir" value="${wo.wolocalroot}/Library/WebObjects/Applications"/>
++
++        <!-- KK: the next property supports webserver split install bundle installation location -->
++        <property name="wsinstall.dir" value="${wo.wolocalroot}/Library/WebServer/Documents"/>
++
++        <!-- KK: Defaults property 'build.app.name' to be 'project.name' if not already defined explicitly -->
++        <condition property="build.app.name" value="${build.app.name}" else="${project.name}">
++            <and>
++                <isset property="build.app.name"/>
++            </and>
++        </condition>
++
++        <!-- KK: This next line logs all ant properties to console - useful for troubleshooting build failures -->
++        <echoproperties />
++    </target>
++
++    <!-- basic initializations  -->
++    <target name="init.install">
++         <tstamp/>
++        <property name="dest.dir" value="${install.dir}"/>
++        <!-- KK: Sets the webserver document root as destination -->
++        <property name="wsdest.dir" value="${wsinstall.dir}"/>
++    </target>
++
++    <target name="init.build">
++         <tstamp/>
++        <property name="dest.dir" value="dist"/>
++        <!-- KK: Since the bundle names are the same for app and ws split bundle, put ws bundle in sub-dir -->
++        <property name="wsdest.dir" value="dist/ws_root"/>
++    </target>
++
++    <!-- This copies webserver resources from app.woa's embedded frameworks into split install bundle -->
++    <target name="ws.split.embed"
++            depends="setProps,build.woapp"
++            description="Adds embedded framework webserver resources to the split install bundle by copying from deployment build bundle">
++        <copy todir="${wsdest.dir}/WebObjects/${build.app.name}.woa"
++                verbose="true">
++            <fileset dir="${dest.dir}/${build.app.name}.woa/Contents/Library">
++                <include name="Frameworks/*.framework/WebServerResources/**"/>
++            </fileset>
++        </copy>
++        <!-- create a tar archive of the webserver bundle -->
++        <tar destfile="${wsdest.dir}/WebObjects/${build.app.name}-webserver-bundle.tar.gz"
++            compression="gzip"
++            basedir="${wsdest.dir}/WebObjects"
++            longfile="gnu"
++            includes="${build.app.name}.woa/**">
++        </tar>
++    </target>
++
++    <!-- woproject tasks -->
++    <target name="build.woapp" depends="setProps,init.build,compile">
++
++        <taskdef name="woapplication" classname="org.objectstyle.woproject.ant.WOApplication">
++        </taskdef>
++
++        <!-- add webXML="true" in build.properties file to generate a web.xml file -->
++        <!-- KK: added wsDestDir and frameworksBaseURL properties here -->
++        <!-- using build.app.name instead of project name -->
++        <!-- KK: About frameworksBaseURL: This is not documented, but basically it adds this info as a
++            launch argument inside the application executable script resulting in ALL webserver
++            resource URLs pointing to our embedded webserver resource frameworks.
++            Consequently, we MUST embed ALL frameworks including Apple's frameworks, not
++            just the 3rd party ones in wo.localroot if we are to use this feature -->
++        <woapplication name="${build.app.name}"  stdFrameworks="false"
++                                             destDir="${dest.dir}"
++                                             customInfoPListContent="${customInfoPListContent}"
++                                             principalClass="${principalClass}"
++                                             webXML="${webXML}"
++                                             webXML_CustomContent="${webXML_CustomContent}"
++                                             wsDestDir="${wsdest.dir}"
++                                             frameworksBaseURL="/WebObjects/${build.app.name}.woa/Frameworks">
++               <classes dir="${classes.dir}">
++                  <patternset>
++                      <includesfile name="woproject/classes.include.patternset"/>
++                    <excludesfile name="woproject/classes.exclude.patternset"/>
++                </patternset>
++               </classes>
++               <wsresources dir=".">
++                  <patternset>
++                      <includesfile name="woproject/wsresources.include.patternset"/>
++                    <excludesfile name="woproject/wsresources.exclude.patternset"/>
++                </patternset>
++            </wsresources>
++               <resources dir=".">
++                  <patternset>
++                      <includesfile name="woproject/resources.include.patternset"/>
++                    <excludesfile name="woproject/resources.exclude.patternset"/>
++                </patternset>
++               </resources>
++               <!-- KK: Changed embed to true -->
++               <frameworks root="${wo.wolocalroot}" embed="true">
++                  <patternset>
++                      <includesfile name="woproject/ant.frameworks.wo.wolocalroot"/>
++                </patternset>
++               </frameworks>
++               <!-- KK: Changed embed to true -->
++            <frameworks root="${wo.wosystemroot}" embed="true">
++                  <patternset>
++                      <includesfile name="woproject/ant.frameworks.wo.wosystemroot"/>
++                </patternset>
++               </frameworks>
++               <!-- KK: Changed embed to true -->
++            <frameworks root="${user.home}" embed="true">
++                  <patternset>
++                      <includesfile name="woproject/ant.frameworks.user.home"/>
++                </patternset>
++               </frameworks>
++            <otherclasspath root="${wo.wosystemroot}">
++                   <patternset>
++                      <includesfile name="woproject/ant.classpaths.wo.wosystemroot"/>
++                </patternset>
++            </otherclasspath>
++            <lib dir="Libraries">
++                <include name="*.jar"/>
++                <exclude name="**/*.woa/**"/>
++            </lib>
++           </woapplication>
++
++        <!-- create a tar archive of the application bundle -->
++        <tar destfile="${dest.dir}/${build.app.name}-app-bundle.tar.gz"
++            compression="gzip"
++            basedir="${dest.dir}"
++            longfile="gnu"
++            includes="${build.app.name}.woa/**">
++        </tar>
++    </target>
++
++    <!-- optional targets -->
++
++    <!-- war target-->
++    <!-- To use this target remove the if="${never}" statement and create the LICENSE in your project
++         and create the web.xml file with the woapplication task.-->
++    <target name="war" if="${never}"  depends="ssdd">
++        <war destfile="${dest.dir}/${project.name}.war" webxml="${dest.dir}/${project.name}/WEB-INF/web.xml" basedir="${dest.dir}/${project.name}">
++            <lib dir="${wo.wosystemroot}/Library/Frameworks/JavaWOJSPServlet.framework/WebServerResources/Java/">
++                <include name="JavaWOJSPServlet_client.jar"/>
++            </lib>
++        </war>
++        <copy todir="/tmp/${project.name}.dst/Library/WebObjects/Applications/">
++            <fileset dir="${dest.dir}">
++                <include name="${project.name}.woa/**"/>
++            </fileset>
++        </copy>
++    </target>
++
++    <!-- ssdd target-->
++    <!-- To use this target
++        1)  remove the if="${never}" statement
++        2)  change embed=true  in the woapp target above
++        3)  create the LICENSE in your project directory
++        4)  add JavaWOJSPServlet in your WOFrameworks build path
++        5)  Edit the build.properties file
++        6)     set webXML = true
++    -->
++    <target name="ssdd" if="${never}" depends="build.woapp">
++        <mkdir dir="${dest.dir}/${project.name}/WEB-INF/classes"/>
++        <mkdir dir="${dest.dir}/${project.name}/WEB-INF/tlds"/>
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/">
++            <fileset dir="${dest.dir}/${project.name}.woa/Contents/">
++                <include name="web.xml"/>
++            </fileset>
++        </copy>
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/">
++            <fileset dir=".">
++                <include name="LICENSE"/>
++            </fileset>
++        </copy>
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/">
++            <fileset dir="${dest.dir}">
++                <include name="${project.name}.woa/**"/>
++            </fileset>
++        </copy>
++        <!-- copy the frameworks to the WEBINFROOT/Library directory -->
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/">
++            <fileset dir="${dest.dir}/${project.name}.woa/Contents">
++                <include name="Library/**"/>
++            </fileset>
++        </copy>
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/">
++            <fileset dir="${dest.dir}/${project.name}.woa">
++                <include name="Resources/**"/>
++            </fileset>
++        </copy>
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/lib/">
++            <fileset dir="${dest.dir}/${project.name}/WEB-INF">
++                <include name="**/Resources/**/*.jar"/>
++            </fileset>
++             <mapper type="flatten"/>
++        </copy>
++
++        <!--  Get the necessary Frameworks from the webobjects system root instead of the project wrapper -->
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/lib"
++            file="${wo.wosystemroot}/Library/Frameworks/JavaWOJSPServlet.framework/WebServerResources/Java/JavaWOJSPServlet_client.jar" />
++
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/tlds">
++            <fileset dir="${wo.wosystemroot}/Library/Frameworks/JavaWOJSPServlet.framework/Resources/">
++                <include name="WOtaglib_1_0.tld"/>
++            </fileset>
++        </copy>
++        <!-- the WebObject Extensions -->
++        <copy todir="${dest.dir}/${project.name}/WEB-INF/lib">
++            <fileset dir="/Library/WebObjects/Extensions/">
++                <include name="*.jar"/>
++                <exclude name="servlet.jar"/>
++            </fileset>
++             <mapper type="flatten"/>
++        </copy>
++
++
++        <!-- fix the Macos*ClassPath.txt files  -->
++
++         <replaceregexp file="${dest.dir}/${project.name}/WEB-INF/${project.name}.woa/Contents/MacOS/MacOSClassPath.txt"
++            match="APPROOT/Resources/Java/${project.name.lowercase}.jar"
++            replace="APPROOT/${project.name}.woa/Contents/Resources/Java/${project.name.lowercase}.jar" byline="true" />
++
++        <replaceregexp file="${dest.dir}/${project.name}/WEB-INF/${project.name}.woa/Contents/MacOS/MacOSXServerClassPath.txt"
++            match="APPROOT/Resources/Java/${project.name.lowercase}.jar"
++            replace="APPROOT/${project.name}.woa/Contents/Resources/Java/${project.name.lowercase}.jar" byline="true" />
++
++        <!-- fix the web.xml file:  the app itself needs project.name/Contents -->
++
++        <replaceregexp file="${dest.dir}/${project.name}/WEB-INF/web.xml" match="WEBINFROOT/Resources/Java/${project.name.lowercase}.jar"
++            replace="WEBINFROOT/${project.name}.woa/Contents/Resources/Java/${project.name.lowercase}.jar" byline="true" />
++
++        <!-- fix the web.xml file to remove the extra Frameworks/ directory level for the frameworks -->
++
++        <replaceregexp file="${dest.dir}/${project.name}/WEB-INF/web.xml" match="WEBINFROOT/Frameworks//"
++            replace="WEBINFROOT/" byline="true" />
++
++     </target>
++
++    <!-- copy strings files -->
++    <target name="copy.strings">
++            <copy todir="${dest.dir}/${project.name}.woa/Contents/Resources">
++                   <fileset dir="." casesensitive="yes">
++                <include name="*.strings"/>
++                    <include name="**/*.strings"/>
++                </fileset>
++                 <mapper type="flatten"/>
++             </copy>
++     </target>
++
++  <target name = "compile" depends = "setProps,init.build" >
++    <mkdir dir = "bin"/>
++    <javac srcdir = "Sources" destdir = "bin">
++      <classpath>
++        <fileset dir="${wo.dir.user.home.library.frameworks}" includesfile = "woproject/ant.frameworks.user.home">
++          <include name = "**/*.jar"/>
++        </fileset>
++        <fileset dir="${wo.wolocalroot}" includesfile = "woproject/ant.frameworks.wo.wolocalroot">
++          <include name = "**/*.jar"/>
++        </fileset>
++        <fileset dir="${wo.wosystemroot}" includesfile = "woproject/ant.frameworks.wo.wosystemroot">
++          <include name = "**/*.jar"/>
++        </fileset>
++      </classpath>
++    </javac>
++  </target>
++</project>
++

webserver_bundle_layout.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.XWikiGuest

Size

...	...	@@ -1,0 +1,1 @@
	1	+37.2 KB

Content

Changes for page Alternative Ant Build Script for Fully Embedded and Split Install Bundles

Summary

Details

Applications

Navigation

My Recent Modifications

Need help?