Skip to Content
Last modified by Pascal Robert on 2013/12/18 02:55
From version 50.1
edited by Pascal Robert
on 2023/11/13 11:56
Change comment: Renamed from xwiki:documentation.Building and Installing a Framework with Ant
To version 46.1
edited by Steve Peery
on 2012/10/23 23:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -Building a WebObjects Project
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.probert
1 +XWiki.speery
Tags
... ... @@ -1,1 +1,0 @@
1 -build
Content
... ... @@ -2,78 +2,39 @@
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}}
5 5  
6 -
7 -{{toc maxLevel="3"/}}
8 -
9 9  = Before You Build =
10 10  
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]].
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]].
12 12  
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.
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.
14 14  
15 15  Where Ant looks for this property is different for each method of building a Framework:
16 16  
17 -1. (((
18 -====== WOJenkins Jobs ======
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.
19 19  
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 ======
29 +{{note title="Can"}}
25 25  
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 -
32 -1. Properties specified in the //Properties// line of an Invoke Ant build task using (the equivalent of
33 -
34 -{{code language="none"}}-propertyfile <name>{{/code}})
35 -)))
36 -1. (((
37 -====== Eclipse/WOLips ======
38 -
39 -1. Properties specified for the Eclipse Workspace under Eclipse -> Preferences -> WOLips - > **System Frameworks**
40 -1. The
41 -
42 -{{code language="none"}}build.properties{{/code}} file in the same directory as the build.xml file as specified by
43 -
44 -{{code language="none"}}<property file="build.properties" />{{/code}} task in the build.xml file.
45 -)))
46 -1. (((
47 -====== Command Line ======
48 -
49 -1. Properties specified in the Ant command:
50 -
51 -{{code language="none"}}
52 --D<property>=<value>
53 -{{/code}}
54 -
55 -1. A properties file specified in the Ant command:
56 -
57 -{{code language="none"}}
58 --propertyfile <name>
59 -{{/code}}
60 -
61 -1. The
62 -
63 -{{code language="none"}}build.properties{{/code}} file in the same directory as the build.xml file as specified by
64 -
65 -{{code language="none"}}<property file="build.properties" />{{/code}} task in the build.xml file.
66 -)))
67 -
68 -{{note title="Can't Find WebObjects"}}
69 69  If Ant can't find the WebObjects frameworks, you will get compiler errors like this:
70 -
71 -{{noformat}}
32 +{noformat}
72 72  [wocompile] /MyProjects/MyFramework/Sources/com/mycompany/myapp/myclass:10:
73 73   package com.webobjects.appserver does not exist
74 74  [wocompile] import com.webobjects.appserver.WOContext;
36 +{noformat}
75 75  
76 -{{/noformat}}
77 77  {{/note}}
78 78  
79 79  = Building =
... ... @@ -84,69 +84,55 @@
84 84  
85 85  === Eclipse/WOLips ===
86 86  
87 -* (((
88 -===== Standard WebObjects Framework =====
89 -
48 +* h5. Standard WebObjects Framework
90 90  Right-Click on your project in Eclipse and select **WOLips Ant Tools > Install**
91 - [[image:attach:WOLipsAntInstall.png]]
50 +[[image:WOLipsAntInstall.png||border="1"]]
92 92  This will build and install the framework in the location defined in the WOLips preferences, overwriting any previously installed version of the framework.
93 93  
94 94  {{note title="BUILD FAILED"}}
95 -If Ant can't write to the WebObjects frameworks directory, you will get an error like this:
96 96  
97 -{{noformat}}
55 +If Ant can't write to the WebObjects frameworks directory, you will get an error like this:
56 +{noformat}
98 98  Directory /Library/WebObjects/Versions/WebObjects543/Library/Frameworks/YourFramework.framework
99 99  creation was not successful for an unknown reason.
100 -
101 -{{/noformat}}
102 -
59 +{noformat}
103 103  Give write access to the directory with these commands in Terminal:
104 - sudo chmod 757 /Library/WebObjects/Versions/WebObjects543/Library/Frameworks/
105 - sudo chmod 757 /Library/WebObjects/Versions/WebObjects543/Library/WebObjects/Applications
61 +sudo chmod 757 /Library/WebObjects/Versions/WebObjects543/Library/Frameworks/
62 +sudo chmod 757 /Library/WebObjects/Versions/WebObjects543/Library/WebObjects/Applications
63 +
106 106  {{/note}}
107 -)))
108 108  
109 -* (((
110 -===== Project Wonder Frameworks =====
111 -
66 +* h5. Project Wonder Frameworks
112 112  **You can not build projects from Wonder this way.** You must either use the command line or Hudson/Jenkins methods
113 -)))
114 114  
115 115  === Command Line / Terminal ===
116 116  
117 -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)
71 +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)
118 118  
119 -* (((
120 -===== Standard WebObjects Framework =====
121 -
73 +* h5. Standard WebObjects Framework
122 122  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.
123 123  
124 -{{code 0="none"}}
76 +{{code value="none"}}
77 +
125 125  cd /my/project/
126 126  ant build
127 127  
128 128  {{/code}}
129 129  
130 -By default, the built framework will be put in a {{code language="none"}}dist{{/code}} directory in your project's root.
131 -)))
83 +By default, the built framework will be put in a ##dist## directory in your project's root.
132 132  
133 -* (((
134 -===== Project Wonder Frameworks =====
85 +* h5. Project Wonder Frameworks
86 +This assumes that you have already downloaded the Wonder source code. Make a note of the location of the Wonder directory.
87 +If you are building Project Wonder's frameworks you will use these commands instead:
135 135  
136 -First download the Wonder source code (see [[doc:WEB.Home.Getting Started.Getting the Wonder Source Code.WebHome]]). Make a note of the location of the Wonder directory.
89 +{{code value="none"}}
137 137  
138 -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.
139 -
140 -To build Project Wonder's frameworks use these commands.
141 -
142 -{{code 0="none"}}
143 143  cd /path/to/Wonder
144 144  ant frameworks
145 145  
146 146  {{/code}}
147 147  
148 -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.
149 -)))
96 +By default, all the Wonder frameworks will be built to (##/Roots##) (in your home directory).
150 150  
151 151  = Customizing the Build =
152 152  
... ... @@ -158,21 +158,19 @@
158 158  
159 159  ===== Install the frameworks =====
160 160  
161 -{{code 0="none"}}
162 -sudo ant -Duser.home=$HOME frameworks.install
108 +{{code value="none"}}
109 +sudo ant frameworks.install
163 163  {{/code}}
164 164  
165 -This copies the built frameworks from {{code language="none"}}~/Roots{{/code}} to the runtime Frameworks directory:
112 +This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
166 166  
167 -* Mac OS X: {{code language="none"}}/Library/Frameworks/{{/code}} or {{code language="none"}}/Library/WebObjects/Versions/WebObjects543/Library/Frameworks/{{/code}}
168 -* Linux: {{code language="none"}}/Local/Library/Frameworks{{/code}}
114 +* Mac OS X: ##/Library/Frameworks/## or ##/Library/WebObjects/Versions/WebObjects543/Library/Frameworks/##
115 +* Linux: ##/Local/Library/Frameworks##
169 169  
170 -Setting the {{code language="none"}}user.home{{/code}} property is necessary. Otherwise {{code language="none"}}ant{{/code}} will think {{code language="none"}}user.home{{/code}} is {{code language="none"}}/var/root{{/code}} and {{code language="none"}}frameworks.install{{/code}} would look for built frameworks in {{code language="none"}}/var/root/Roots{{/code}} and would miss any custom locations set for {{code language="none"}}wo.local.frameworks{{/code}} that are set in your {{code language="none"}}wolips.properties{{/code}} file.
171 -
172 172  You can combine the build and install steps by simply executing this Ant command:
173 173  
174 -{{code 0="none"}}
175 -sudo ant -Duser.home=$HOME frameworks frameworks.install
119 +{{code value="none"}}
120 +sudo ant frameworks frameworks.install
176 176  {{/code}}
177 177  
178 178  === Upgrading ===
... ... @@ -179,38 +179,32 @@
179 179  
180 180  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.
181 181  
182 -1. (((
183 -===== Navigate to the original Wonder source directory that you created above during initial source installation =====
127 +1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
184 184  
185 -{{code 0="none"}}
129 +{{code value="none"}}
186 186  cd /path/to/WonderSource
187 187  {{/code}}
188 -)))
189 -1. (((
190 -===== Pull the changes you do not have and merge them with your local repository =====
191 191  
192 -{{code 0="none"}}
133 +1. h5. Pull the changes you do not have and merge them with your local repository
134 +
135 +{{code value="none"}}
193 193  git pull
194 194  {{/code}}
195 -)))
196 -1. (((
197 -===== Build the frameworks. =====
198 198  
199 -{{code 0="none"}}
139 +1. h5. Build the frameworks.
140 +
141 +{{code value="none"}}
200 200  ant frameworks
201 201  {{/code}}
202 -)))
203 -1. (((
204 -===== Navigate to the Roots directory that was automatically created by the initial Source installation procedure above =====
205 205  
206 -{{code 0="none"}}
145 +1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
146 +
147 +{{code value="none"}}
207 207  cd ~/Roots/
208 208  {{/code}}
209 -)))
210 -1. (((
211 -===== Delete all installed frameworks whose names match the built frameworks in this Roots build folder =====
212 212  
213 -{{code 0="none"}}
151 +1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
152 +
153 +{{code value="none"}}
214 214  for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
215 215  {{/code}}
216 -)))
WOLipsAntInstall.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -18.2 KB
Content