Skip to Content
Version 44.1 by Steve Peery on 2012/10/23 23:20
Hide last authors
David Avendasora 31.1 1 {{tip title="Pro Tip"}}
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 {{/tip}}
4
5 {{toc maxLevel="3"}}{{/toc}}
6
David Avendasora 37.1 7 = Before You Build =
David Avendasora 27.1 8
David Avendasora 37.1 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]].
David Avendasora 27.1 10
David Avendasora 37.1 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.
David Avendasora 27.1 12
David Avendasora 37.1 13 Where Ant looks for this property is different for each method of building a Framework:
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.
28
29 {{note title="Can"}}
30
31 If Ant can't find the WebObjects frameworks, you will get compiler errors like this:
David Avendasora 27.1 32 {noformat}
David Avendasora 31.1 33 [wocompile] /MyProjects/MyFramework/Sources/com/mycompany/myapp/myclass:10:
34 package com.webobjects.appserver does not exist
David Avendasora 27.1 35 [wocompile] import com.webobjects.appserver.WOContext;
36 {noformat}
37
38 {{/note}}
39
David Avendasora 37.1 40 = Building =
41
42 === WOJenkins ===
43
44 Using Jenkins is the recommended way to build a Framework and WOJenkins makes the process almost as easy as building from within Eclipse/WOLips.
45
46 === Eclipse/WOLips ===
47
48 * h5. Standard WebObjects Framework
49 Right-Click on your project in Eclipse and select **WOLips Ant Tools > Install**
50 [[image:WOLipsAntInstall.png||border="1"]]
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
Steve Peery 43.1 53 {{note title="BUILD FAILED"}}
54
55 If Ant can't write to the WebObjects frameworks directory, you will get an error like this:
56 {noformat}
57 Directory /Library/WebObjects/Versions/WebObjects543/Library/Frameworks/YourFramework.framework
58 creation was not successful for an unknown reason.
59 {noformat}
60 Give write access to the directory with this command in Terminal:
61 sudo chmod 757 /Library/WebObjects/Versions/WebObjects543/Library/Frameworks/
62
63 {{/note}}
64
David Avendasora 37.1 65 * h5. Project Wonder Frameworks
66 **You can not build projects from Wonder this way.** You must either use the command line or Hudson/Jenkins methods
67
David Avendasora 27.1 68 === Command Line / Terminal ===
69
Steve Peery 39.1 70 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)
71
David Avendasora 27.1 72 * h5. Standard WebObjects Framework
73 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.
74
75 {{code value="none"}}
76
77 cd /my/project/
78 ant build
79
80 {{/code}}
81
82 By default, the built framework will be put in a ##dist## directory in your project's root.
83
David Avendasora 31.1 84 * h5. Project Wonder Frameworks
85 This assumes that you have already downloaded the Wonder source code. Make a note of the location of the Wonder directory.
86 If you are building Project Wonder's frameworks you will use these commands instead:
David Avendasora 27.1 87
88 {{code value="none"}}
89
90 cd /path/to/Wonder
91 ant frameworks
92
93 {{/code}}
94
David Avendasora 31.1 95 By default, all the Wonder frameworks will be built to (##/Roots##) (in your home directory).
David Avendasora 27.1 96
David Avendasora 31.1 97 = Customizing the Build =
David Avendasora 27.1 98
David Avendasora 37.1 99 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.
David Avendasora 33.1 100
David Avendasora 31.1 101 = Installing =
David Avendasora 27.1 102
David Avendasora 31.1 103 Assuming you already cloned and built Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.
David Avendasora 27.1 104
105 ===== Install the frameworks =====
106
107 {{code value="none"}}
108 sudo ant frameworks.install
109 {{/code}}
110
111 This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
112
Steve Peery 41.1 113 * Mac OS X: ##/Library/Frameworks/## or ##/Library/WebObjects/Versions/WebObjects543/Library/Frameworks/##
David Avendasora 27.1 114 * Linux: ##/Local/Library/Frameworks##
115
116 You can combine the build and install steps by simply executing this Ant command:
117
118 {{code value="none"}}
119 sudo ant frameworks frameworks.install
120 {{/code}}
121
122 === Upgrading ===
123
124 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.
125
126 1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
127
128 {{code value="none"}}
129 cd /path/to/WonderSource
130 {{/code}}
131
132 1. h5. Pull the changes you do not have and merge them with your local repository
133
134 {{code value="none"}}
135 git pull
136 {{/code}}
137
138 1. h5. Build the frameworks.
139
140 {{code value="none"}}
141 ant frameworks
142 {{/code}}
143
144 1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
145
146 {{code value="none"}}
147 cd ~/Roots/
148 {{/code}}
149
150 1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
151
152 {{code value="none"}}
153 for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
154 {{/code}}