Changes for page Building and Installing a Framework with Ant
Last modified by Pascal Robert on 2013/12/18 02:55
From version 20.1
edited by michaelsd
on 2012/07/01 11:35
on 2012/07/01 11:35
Change comment:
There is no comment for this version
To version 18.1
edited by D Tim Cummings
on 2013/12/18 02:39
on 2013/12/18 02:39
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. michaelsd1 +XWiki.timcu - Content
-
... ... @@ -2,39 +2,85 @@ 2 2 If you use Hudson/Jenkins to build your WebObjects Frameworks and Applications, then you do not need to build or install either the Project Wonder frameworks or even your own Frameworks on your development machine, just having yours and the individual Wonder source code projects (ERJars, ERExtensions, AJAX, etc) open in your eclipse workspace is sufficient. 3 3 {{/tip}} 4 4 5 -{{toc maxLevel="3"}}{{/toc}} 6 6 6 + 7 +{{toc maxLevel="3"/}} 8 + 7 7 = Before You Build = 8 8 9 -When building a Framework project, Ant needs to be able to find WebObjects. WebObjects itself is a set of Frameworks just like the one you are building. They can be installed anywhere using [[these instructions>>WO :Installing WebObjects 5.4 on Snow Leopard]].11 +When building a Framework project, Ant needs to be able to find WebObjects. WebObjects itself is a set of Frameworks just like the one you are building. They can be installed anywhere using [[these instructions>>doc:WO.Installing WebObjects 5\.4 on Snow Leopard]]. 10 10 11 -Where Ant will look for WebObjects is specified by the ##wo.system.frameworks##build property. This property can be set in a number of locations, or even passed as a command-line property to Ant.13 +Where Ant will look for WebObjects is specified by the {{code language="none"}}wo.system.frameworks{{/code}} build property. This property can be set in a number of locations, or even passed as a command-line property to Ant. 12 12 13 13 Where Ant looks for this property is different for each method of building a Framework: 14 14 15 -1. h6. WOJenkins Jobs 16 -11. Completely managed for you by WOJenkins 17 -11. Manually overridden as defined in Manual Jenkins Jobs below. 18 -1. h6. Manual Jenkins Jobs 19 -11. Properties specified in the //Targets// line of an Invoke Ant build task using **##-D<property>=<value>##** 20 -11. Properties specified in the //Properties// line of an Invoke Ant build task using (the equivalent of **##-propertyfile <name>##**) 21 -1. h6. Eclipse/WOLips 22 -11. Properties specified for the Eclipse Workspace under Eclipse -> Preferences -> WOLips - > **System Frameworks** 23 -11. The ##build.properties## file in the same directory as the build.xml file as specified by **##<property file="build.properties" />##** task in the build.xml file. 24 -1. h6. Command Line 25 -11. Properties specified in the Ant command: **##-D<property>=<value>##** 26 -11. A properties file specified in the Ant command: **##-propertyfile <name>##** 27 -11. The ##build.properties## file in the same directory as the build.xml file as specified by **##<property file="build.properties" />##** task in the build.xml file. 17 +1. ((( 18 +====== WOJenkins Jobs ====== 28 28 29 -{{note title="Can"}} 20 +1. Completely managed for you by WOJenkins 21 +1. Manually overridden as defined in Manual Jenkins Jobs below. 22 +))) 23 +1. ((( 24 +====== Manual Jenkins Jobs ====== 30 30 26 +1. Properties specified in the //Targets// line of an Invoke Ant build task using 27 + 28 +{{code language="none"}} 29 +-D<property>=<value> 30 +{{/code}} 31 +1. Properties specified in the //Properties// line of an Invoke Ant build task using (the equivalent of 32 + 33 +{{code language="none"}} 34 +-propertyfile <name> 35 +{{/code}}) 36 +))) 37 +1. ((( 38 +====== Eclipse/WOLips ====== 39 + 40 +1. Properties specified for the Eclipse Workspace under Eclipse -> Preferences -> WOLips - > **System Frameworks** 41 +1. The 42 + 43 +{{code language="none"}} 44 +build.properties 45 +{{/code}} file in the same directory as the build.xml file as specified by 46 + 47 +{{code language="none"}} 48 +<property file="build.properties" /> 49 +{{/code}} task in the build.xml file. 50 +))) 51 +1. ((( 52 +====== Command Line ====== 53 + 54 +1. Properties specified in the Ant command: 55 + 56 +{{code language="none"}} 57 +-D<property>=<value> 58 +{{/code}} 59 +1. A properties file specified in the Ant command: 60 + 61 +{{code language="none"}} 62 +-propertyfile <name> 63 +{{/code}} 64 +1. The 65 + 66 +{{code language="none"}} 67 +build.properties 68 +{{/code}} file in the same directory as the build.xml file as specified by 69 + 70 +{{code language="none"}} 71 +<property file="build.properties" /> 72 +{{/code}} task in the build.xml file. 73 +))) 74 + 75 +{{note title="Can't Find WebObjects"}} 31 31 If Ant can't find the WebObjects frameworks, you will get compiler errors like this: 32 -{noformat} 77 + 78 +{{noformat}} 33 33 [wocompile] /MyProjects/MyFramework/Sources/com/mycompany/myapp/myclass:10: 34 34 package com.webobjects.appserver does not exist 35 35 [wocompile] import com.webobjects.appserver.WOContext; 36 -{noformat} 37 37 83 +{{/noformat}} 38 38 {{/note}} 39 39 40 40 = Building = ... ... @@ -45,42 +45,69 @@ 45 45 46 46 === Eclipse/WOLips === 47 47 48 -* h5. Standard WebObjects Framework 94 +* ((( 95 +===== Standard WebObjects Framework ===== 96 + 49 49 Right-Click on your project in Eclipse and select **WOLips Ant Tools > Install** 50 -[[image:WOLipsAntInstall.png ||border="1"]]98 + [[image:attach:WOLipsAntInstall.png]] 51 51 This will build and install the framework in the location defined in the WOLips preferences, overwriting any previously installed version of the framework. 52 52 53 -* h5. Project Wonder Frameworks 101 +{{note title="BUILD FAILED"}} 102 +If Ant can't write to the WebObjects frameworks directory, you will get an error like this: 103 + 104 +{{noformat}} 105 +Directory /Library/WebObjects/Versions/WebObjects543/Library/Frameworks/YourFramework.framework 106 +creation was not successful for an unknown reason. 107 + 108 +{{/noformat}} 109 + 110 +Give write access to the directory with these commands in Terminal: 111 + sudo chmod 757 /Library/WebObjects/Versions/WebObjects543/Library/Frameworks/ 112 + sudo chmod 757 /Library/WebObjects/Versions/WebObjects543/Library/WebObjects/Applications 113 +{{/note}} 114 +))) 115 + 116 +* ((( 117 +===== Project Wonder Frameworks ===== 118 + 54 54 **You can not build projects from Wonder this way.** You must either use the command line or Hudson/Jenkins methods 120 +))) 55 55 56 56 === Command Line / Terminal === 57 57 58 -You have to install woproject.jar first and make it available for ant before the following instructions will work. (see [[Building a WebObjects Project||anchor="Overview"]] first) 124 +You have to install woproject.jar first and make it available for ant before the following instructions will work. (see [[doc:WEB.Building a WebObjects Project||anchor="Overview"]] first) 59 59 60 -* h5. Standard WebObjects Framework 126 +* ((( 127 +===== Standard WebObjects Framework ===== 128 + 61 61 You can build a standard WebObjects Framework project by calling Ant and passing it the Project directory, and the name of the build target contained in the build.xml file at your project's root. 62 62 63 -{{code value="none"}} 64 - 131 +{{code 0="none"}} 65 65 cd /my/project/ 66 66 ant build 67 67 68 68 {{/code}} 69 69 70 -By default, the built framework will be put in a ##dist## directory in your project's root. 137 +By default, the built framework will be put in a {{code language="none"}}dist{{/code}} directory in your project's root. 138 +))) 71 71 72 -* h5. Project Wonder Frameworks 73 -This assumes that you have already downloaded the Wonder source code. Make a note of the location of the Wonder directory. 74 -If you are building Project Wonder's frameworks you will use these commands instead: 140 +* ((( 141 +===== Project Wonder Frameworks ===== 75 75 76 - {{codevalue="none"}}143 +First download the Wonder source code (see [[doc:WEB.Getting the Wonder Source Code]]). Make a note of the location of the Wonder directory. 77 77 145 +The Wonder build script will use properties defined in ~~/Library/Application Support/WOLips/wolips.properties. This is a good place to set {{code language="none"}}wo.system.frameworks{{/code}} property. 146 + 147 +To build Project Wonder's frameworks use these commands. 148 + 149 +{{code 0="none"}} 78 78 cd /path/to/Wonder 79 79 ant frameworks 80 80 81 81 {{/code}} 82 82 83 -By default, all the Wonder frameworks will be built to (##/Roots##) (in your home directory). 155 +By default, all the Wonder frameworks will be built to ({{code language="none"}}~/Roots{{/code}}) (in your home directory). To build elsewhere, set the {{code language="none"}}wo.external.root{{/code}} property. 156 +))) 84 84 85 85 = Customizing the Build = 86 86 ... ... @@ -92,19 +92,19 @@ 92 92 93 93 ===== Install the frameworks ===== 94 94 95 -{{code value="none"}}96 -sudo ant frameworks.install 168 +{{code 0="none"}} 169 +sudo ant -Duser.home=$HOME frameworks.install 97 97 {{/code}} 98 98 99 -This copies the built frameworks from ##/Roots##to the runtime Frameworks directory:172 +This copies the built frameworks from {{code language="none"}}~/Roots{{/code}} to the runtime Frameworks directory: 100 100 101 -* Mac OS X: ##/Library/Framworks/##102 -* Linux: ##/Local/Library/Frameworks##174 +* Mac OS X: {{code language="none"}}/Library/Frameworks/{{/code}} or {{code language="none"}}/Library/WebObjects/Versions/WebObjects543/Library/Frameworks/{{/code}} 175 +* Linux: {{code language="none"}}/Local/Library/Frameworks{{/code}} 103 103 104 104 You can combine the build and install steps by simply executing this Ant command: 105 105 106 -{{code value="none"}}107 -sudo ant frameworks frameworks.install 179 +{{code 0="none"}} 180 +sudo ant -Duser.home=$HOME frameworks frameworks.install 108 108 {{/code}} 109 109 110 110 === Upgrading === ... ... @@ -111,32 +111,38 @@ 111 111 112 112 This will clean out the existing versions of the frameworks. This isn't strictly necessary, you could just re-install over the top of the old frameworks, but deleting then manually copying over the new ones will clean up any old frameworks that are no longer included in the standard build. 113 113 114 -1. h5. Navigate to the original Wonder source directory that you created above during initial source installation 187 +1. ((( 188 +===== Navigate to the original Wonder source directory that you created above during initial source installation ===== 115 115 116 -{{code value="none"}}190 +{{code 0="none"}} 117 117 cd /path/to/WonderSource 118 118 {{/code}} 193 +))) 194 +1. ((( 195 +===== Pull the changes you do not have and merge them with your local repository ===== 119 119 120 -1. h5. Pull the changes you do not have and merge them with your local repository 121 - 122 -{{code value="none"}} 197 +{{code 0="none"}} 123 123 git pull 124 124 {{/code}} 200 +))) 201 +1. ((( 202 +===== Build the frameworks. ===== 125 125 126 -1. h5. Build the frameworks. 127 - 128 -{{code value="none"}} 204 +{{code 0="none"}} 129 129 ant frameworks 130 130 {{/code}} 207 +))) 208 +1. ((( 209 +===== Navigate to the Roots directory that was automatically created by the initial Source installation procedure above ===== 131 131 132 -1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above 133 - 134 -{{code value="none"}} 211 +{{code 0="none"}} 135 135 cd ~/Roots/ 136 136 {{/code}} 214 +))) 215 +1. ((( 216 +===== Delete all installed frameworks whose names match the built frameworks in this Roots build folder ===== 137 137 138 -1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder 139 - 140 -{{code value="none"}} 218 +{{code 0="none"}} 141 141 for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done 142 142 {{/code}} 221 +)))