Skip to Content
Last modified by Pascal Robert on 2013/12/18 02:55
From version 23.1
edited by David Avendasora
on 2011/04/29 14:44
Change comment: There is no comment for this version
To version 18.1
edited by D Tim Cummings
on 2013/12/18 02:39
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Building and Installing a WO Framework with Ant
1 +Building and Installing a Framework with Ant
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.avendasora
1 +XWiki.timcu
Content
... ... @@ -2,66 +2,159 @@
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  
7 -= Building =
8 8  
9 -{{note title="Requires WebObjects"}}
7 +{{toc maxLevel="3"/}}
10 10  
11 -These build instructions require the WebObjects frameworks to already be installed in the normal location:
12 -* Mac OS X: {{/System/Library/Framworks/}}
13 -* Linux: {{/Library/Frameworks}}
9 += Before You Build =
14 14  
15 -Otherwise you will get compiler errors like this:
16 -{noformat}
17 -[wocompile] /MyProjects/MyFramework/Sources/com/mycompany/myapp/myclass:10:
18 - package com.webobjects.appserver does not exist
19 -[wocompile] import com.webobjects.appserver.WOContext;
20 -{noformat}
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]].
21 21  
22 -{{/note}}
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.
23 23  
24 -=== Command Line / Terminal ===
15 +Where Ant looks for this property is different for each method of building a Framework:
25 25  
26 -* h5. Standard WebObjects Framework
27 -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.
17 +1. (((
18 +====== WOJenkins Jobs ======
28 28  
29 -{{code value="none"}}
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  
31 -cd /my/project/
32 -ant build
26 +1. Properties specified in the //Targets// line of an Invoke Ant build task using
33 33  
28 +{{code language="none"}}
29 +-D<property>=<value>
34 34  {{/code}}
31 +1. Properties specified in the //Properties// line of an Invoke Ant build task using (the equivalent of
35 35  
36 -By default, the built framework will be put in a ##dist## directory in your project's root.
33 +{{code language="none"}}
34 +-propertyfile <name>
35 +{{/code}})
36 +)))
37 +1. (((
38 +====== Eclipse/WOLips ======
37 37  
38 -* h5. Project Wonder Frameworks
39 -This assumes that you have already downloaded the Wonder source code. Make a note of the location of the Wonder directory.
40 -If you are building Project Wonder's frameworks you will use these commands instead:
40 +1. Properties specified for the Eclipse Workspace under Eclipse -> Preferences -> WOLips - > **System Frameworks**
41 +1. The
41 41  
42 -{{code value="none"}}
43 +{{code language="none"}}
44 +build.properties
45 +{{/code}} file in the same directory as the build.xml file as specified by
43 43  
44 -cd /path/to/Wonder
45 -ant frameworks
47 +{{code language="none"}}
48 +<property file="build.properties" />
49 +{{/code}} task in the build.xml file.
50 +)))
51 +1. (((
52 +====== Command Line ======
46 46  
54 +1. Properties specified in the Ant command:
55 +
56 +{{code language="none"}}
57 +-D<property>=<value>
47 47  {{/code}}
59 +1. A properties file specified in the Ant command:
48 48  
49 -By default, all the Wonder frameworks will be built to (##/Roots##) (in your home directory).
61 +{{code language="none"}}
62 +-propertyfile <name>
63 +{{/code}}
64 +1. The
50 50  
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"}}
76 +If Ant can't find the WebObjects frameworks, you will get compiler errors like this:
77 +
78 +{{noformat}}
79 +[wocompile] /MyProjects/MyFramework/Sources/com/mycompany/myapp/myclass:10:
80 + package com.webobjects.appserver does not exist
81 +[wocompile] import com.webobjects.appserver.WOContext;
82 +
83 +{{/noformat}}
84 +{{/note}}
85 +
86 += Building =
87 +
88 +=== WOJenkins ===
89 +
90 +Using Jenkins is the recommended way to build a Framework and WOJenkins makes the process almost as easy as building from within Eclipse/WOLips.
91 +
51 51  === Eclipse/WOLips ===
52 52  
53 -* h5. Standard WebObjects Framework
94 +* (((
95 +===== Standard WebObjects Framework =====
96 +
54 54  Right-Click on your project in Eclipse and select **WOLips Ant Tools > Install**
55 -[[image:WOLipsAntInstall.png||border="1"]]
98 + [[image:attach:WOLipsAntInstall.png]]
56 56  This will build and install the framework in the location defined in the WOLips preferences, overwriting any previously installed version of the framework.
57 57  
58 -* 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 +
59 59  **You can not build projects from Wonder this way.** You must either use the command line or Hudson/Jenkins methods
120 +)))
60 60  
61 -=== Hudson/Jenkins ===
122 +=== Command Line / Terminal ===
62 62  
63 -In general, it is recommended that you use Hudson/Jenkins to build your WebObjects frameworks and applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse/WOlips directly (except for Project Wonder's frameworks).
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)
64 64  
126 +* (((
127 +===== Standard WebObjects Framework =====
128 +
129 +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.
130 +
131 +{{code 0="none"}}
132 +cd /my/project/
133 +ant build
134 +
135 +{{/code}}
136 +
137 +By default, the built framework will be put in a {{code language="none"}}dist{{/code}} directory in your project's root.
138 +)))
139 +
140 +* (((
141 +===== Project Wonder Frameworks =====
142 +
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.
144 +
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"}}
150 +cd /path/to/Wonder
151 +ant frameworks
152 +
153 +{{/code}}
154 +
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 +)))
157 +
65 65  = Customizing the Build =
66 66  
67 67  By modifying the values in the build.properties and wolips.properties files or by passing in arguments to the Ant command, you can change where Ant will look for dependencies (binary frameworks, libraries, etc.) and where it will install the build products.
... ... @@ -72,19 +72,19 @@
72 72  
73 73  ===== Install the frameworks =====
74 74  
75 -{{code value="none"}}
76 -sudo ant frameworks.install
168 +{{code 0="none"}}
169 +sudo ant -Duser.home=$HOME frameworks.install
77 77  {{/code}}
78 78  
79 -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:
80 80  
81 -* Mac OS X: ##/Library/Framworks/##
82 -* 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}}
83 83  
84 84  You can combine the build and install steps by simply executing this Ant command:
85 85  
86 -{{code value="none"}}
87 -sudo ant frameworks frameworks.install
179 +{{code 0="none"}}
180 +sudo ant -Duser.home=$HOME frameworks frameworks.install
88 88  {{/code}}
89 89  
90 90  === Upgrading ===
... ... @@ -91,32 +91,38 @@
91 91  
92 92  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.
93 93  
94 -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 =====
95 95  
96 -{{code value="none"}}
190 +{{code 0="none"}}
97 97  cd /path/to/WonderSource
98 98  {{/code}}
193 +)))
194 +1. (((
195 +===== Pull the changes you do not have and merge them with your local repository =====
99 99  
100 -1. h5. Pull the changes you do not have and merge them with your local repository
101 -
102 -{{code value="none"}}
197 +{{code 0="none"}}
103 103  git pull
104 104  {{/code}}
200 +)))
201 +1. (((
202 +===== Build the frameworks. =====
105 105  
106 -1. h5. Build the frameworks.
107 -
108 -{{code value="none"}}
204 +{{code 0="none"}}
109 109  ant frameworks
110 110  {{/code}}
207 +)))
208 +1. (((
209 +===== Navigate to the Roots directory that was automatically created by the initial Source installation procedure above =====
111 111  
112 -1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
113 -
114 -{{code value="none"}}
211 +{{code 0="none"}}
115 115  cd ~/Roots/
116 116  {{/code}}
214 +)))
215 +1. (((
216 +===== Delete all installed frameworks whose names match the built frameworks in this Roots build folder =====
117 117  
118 -1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
119 -
120 -{{code value="none"}}
218 +{{code 0="none"}}
121 121  for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
122 122  {{/code}}
221 +)))