Skip to Content
Last modified by Bastian Triller on 2013/10/05 10:40
From version 129.1
edited by David Avendasora
on 2011/04/25 15:18
Change comment: There is no comment for this version
To version 145.1
edited by Kieran Kelleher
on 2010/09/27 04:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Downloading, Building, Installing and Upgrading Wonder Source Code
1 +Download Wonder Source, Build and Install
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.avendasora
1 +XWiki.kieran
Content
... ... @@ -1,173 +3,122 @@
1 -{{toc maxLevel="2"}}{{/toc}}
2 -
3 3  == Introduction ==
4 4  
5 5  Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
6 6  
7 -* Learn a lot about WebObjects and EOF (and Java development styles)
5 +* Learn very much about WebObjects and EOF (and java dev styles?)
8 8  * Easily browse and search the source
9 -* Work with a specific source control version (teams, quality control, development cycles)
7 +* Work with a specific svn version (teams, quality control, development cycles)
10 10  * Provide opportunities to submit patches for bug fixes or enhancements
11 11  * Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
12 -* Discover the many Hidden Treasures of Wonder.
10 +* Discover the many Hidden Treasures of Wonder
13 13  
14 -== Downloading ==
12 +== Source Frameworks Initial Installation ==
15 15  
16 -{{tip title="Now with more Git"}}
17 -As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. You'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. [Here's|WO:Getting Started with Git] a good place to start. You will use Git to checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.
18 -{{/tip}}
14 +Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following easy-peasy commands to download the Wonder source. Note that the build and installation commands are slighly different for WebObjects 5.4.X. So procedures for both WebObjects 5.4.X and 5.3.X are shown below. Pick you poison:
19 19  
20 -Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following easy-peasy commands to clone Wonder source to your computer.
16 +{{code title="Procedure for WebObjects 5.4.X"}}
21 21  
22 -1. h5. Clone the source repository from github into a new directory named "WonderSource".
18 +# Checkout the source from subversion repository into a new directory named "WonderSource"
19 +# Note instead of HEAD, you can use a specific svn version number if you want
20 +svn co http://wonder.svn.sourceforge.net/svnroot/wonder/branches/Wonder_5_0_0_WebObjects_5_4_Branch/Wonder --revision HEAD WonderSource
23 23  
24 -{{note title="Read Only"}}
25 -Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
26 -{{/note}}
22 +# Navigate into the working copy root
23 +cd WonderSource
27 27  
28 -{{code value="none"}}
29 -git clone git://github.com/projectwonder/wonder.git WonderSource
30 -{{/code}}
25 +# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
26 +ant -Dwonder.patch=54 frameworks
31 31  
32 -You should see output something like this:
28 +# Install the frameworks (this just copies the built frameworks from ~/Roots to
29 +# the runtime Frameworks directory, usually at /Library/Frameworks)
30 +sudo ant -Dwonder.patch=54 frameworks.install
33 33  
34 -{{noformat}}
32 +{{/code}}
35 35  
36 -Cloning into WonderSource...
37 -remote: Counting objects: 174269, done.
38 -remote: Compressing objects: 100% (57304/57304), done.
39 -remote: Total 174269 (delta 107374), reused 173934 (delta 107067)
40 -Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done.
41 -Resolving deltas: 100% (107374/107374), done.
34 +{{code title="Procedure for WebObjects 5.3.X"}}
42 42  
43 -{{/noformat}}
36 +# Checkout the source from subversion repository into a new directory named "WonderSource"
37 +# Note instead of HEAD, you can use a specific svn version number if you want
38 +svn co http://wonder.svn.sourceforge.net/svnroot/wonder/trunk/Wonder --revision HEAD WonderSource
44 44  
45 -1. h5. Navigate into the working copy root
46 -
47 -{{code value="none"}}
40 +# Navigate into the working copy root
48 48  cd WonderSource
49 -{{/code}}
50 50  
51 -{{note title="WebObjects 5.3.3 Compatability"}}
52 -If you are still using old WebObjects 5.3.3, then you need to execute this git command to switch to the branch for WebObjects 5.3.3: {code}git checkout --track origin/Wonder_5_0_0_Legacy{code}
53 -You should get output like this:
54 -{noformat}
55 -Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin.
56 -Switched to a new branch 'Wonder_5_0_0_Legacy'
57 -{noformat}
43 +# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
44 +ant frameworks
58 58  
59 -{{/note}}
46 +# Install the frameworks (this just copies the built frameworks from ~/Roots to
47 +# the runtime Frameworks directory, usually at /Library/Frameworks)
48 +sudo ant frameworks.install
60 60  
61 -== Building ==
50 +{{/code}}
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 directly.
52 +== Source Frameworks Upgrade Installation ==
64 64  
65 -{{tip title="Pro Tip"}}
66 -If you use Hudson/Jenkins to build your WebObjects applications, then you do not need to actually build or install the Project Wonder frameworks on your development machine, just having the individual Wonder source code projects open in your eclipse workspace is sufficient. Your Hudson/Jenkins server will need the built frameworks installed. See the [Hudson/Jenkins Page|WO:Installing and Using the Hudson build server] for more information.
67 -{{/tip}}
54 +Assuming you already installed Wonder from source using the method outlined above, you can use the following procedure to upgrade to a newer, or just different version. Note that the procedure for both WebObjects 5.4.X and 5.3.X are outlined below. They are the same except for the last 3 ant commands.
68 68  
69 -{{note title="Requires WebObjects"}}
56 +{{code title="Procedure for WebObjects 5.4.X"}}
70 70  
71 -These build instructions require the WebObjects frameworks to already be installed in the normal location:
72 -* Mac OS X: {{/System/Library/Framworks/}}
73 -* Linux: {{/Library/Frameworks}}
58 +# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
59 +cd ~/Roots/
74 74  
75 -Otherwise you will get compiler errors like this:
76 -{noformat}
77 -[wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10:
78 - package com.webobjects.appserver does not exist
79 -[wocompile] import com.webobjects.appserver.WOContext;
80 -{noformat}
61 +# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
62 +for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
81 81  
82 -{{/note}}
64 +# Navigate to the original Wonder source directory that you created above during initial source installation
65 +cd /path/to/WonderSource
83 83  
84 -You can build the Wonder frameworks from the source code you just cloned to the default (##/Roots##) directory with the following command:
67 +# Update the source to the HEAD revision (aka latest). You can also use a specific svn
68 +# repository version instead of the term 'HEAD', for example 11272
69 +svn update --force --accept theirs-full --revision HEAD
85 85  
86 -===== Build the frameworks from the "cloned" source. =====
71 +# Clean the previous build artifacts
72 +ant -Dwonder.patch=54 clean
87 87  
88 -{{code value="none"}}
89 -ant frameworks
90 -{{/code}}
74 +# Build from the latest source
75 +ant -Dwonder.patch=54 frameworks
91 91  
92 -== Installing ==
77 +# Install the latest built frameworks
78 +sudo ant -Dwonder.patch=54 frameworks.install
93 93  
94 -Assuming you already cloned and installed Wonder from source using the method outlined above, you can use the following procedure pull the latest changes into your local repository.
95 -
96 -===== Install the frameworks =====
97 -
98 -{{code value="none"}}
99 -sudo ant frameworks.install
100 100  {{/code}}
101 101  
102 -This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
82 +{{code title="Procedure for WebObjects 5.3.X"}}
103 103  
104 -* Mac OS X: ##/Library/Framworks/##
105 -* Linux: ##/Local/Library/Frameworks##
84 +# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
85 +cd ~/Roots/
106 106  
107 -You can combine the build and install steps by simply executing this Ant command:
87 +# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
88 +for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
108 108  
109 -{{code value="none"}}
110 -sudo ant frameworks frameworks.install
111 -{{/code}}
112 -
113 -== Upgrading ==
114 -
115 -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.
116 -
117 -1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
118 -
119 -{{code value="none"}}
90 +# Navigate to the original Wonder source directory that you created above during initial source installation
120 120  cd /path/to/WonderSource
121 -{{/code}}
122 122  
123 -1. h5. Pull the changes you do not have and merge them with your local repository
93 +# Update the source to the HEAD revision (aka latest). You can also use a specific svn
94 +# repository version instead of the term 'HEAD', for example 11272
95 +svn update --force --accept theirs-full --revision HEAD
124 124  
125 -{{code value="none"}}
126 -git pull
127 -{{/code}}
97 +# Clean, build and install the frameworks
98 +ant clean; ant frameworks; sudo ant frameworks.install
128 128  
129 -1. h5. Build the frameworks.
130 130  
131 -{{code value="none"}}
132 -ant frameworks
133 133  {{/code}}
134 134  
135 -1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
136 -
137 -{{code value="none"}}
138 -cd ~/Roots/
139 -{{/code}}
140 -
141 -1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
142 -
143 -{{code value="none"}}
144 -for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
145 -{{/code}}
146 -
147 147  {{info}}
148 148  
149 -If you have any trouble or errors due to your local repository getting hosed, then simply delete the entire local repository directory, the \~/Roots directory and just start over using the initial source clone and installation procedure outlined above.
105 +If you have any trouble or errors due to your working copy getting hosed, then simply delete the entire working copy directory, the \~/Roots directory and just start over using the initial source installation procedure outlined above.
150 150  
151 151  {{/info}}
152 152  
153 153  {{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
154 154  
155 -If you have a custom wolips properties file for a specific workspace and you want to have a specific Wonder clone for that workspace, you can simply link your custom wolips properties file to a soft link named build.properties in the working copy root directory. The Wonder build script will supersede all other filesystem layout poperties with the properties in that file.
111 +If you have a custom wolips properties file for a specific workspace and you want to have a specific Wonder source working copy for that workspace, you can simply link your custom wolips properties file to a soft link named build.properties in the working copy root directory. The Wonder build script will supersede all other filesystem layout poperties with the properties in that file.
156 156  
157 157  For example:
158 158  
159 -{code:none}
160 -cd my/special/purpose/clone/of/Wonder
161 -ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
162 162  {code}
116 +$ cd my/special/purpose/working/copy/of/Wonder
117 +$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
118 +{code}
163 163  
164 164  An example of where this approach might be used would be when you have different projects (perhaps in a specially designated workspace) that use a specific version of WebObjects and a specific version or branch of Wonder.
165 165  
166 -*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
167 -{code:none}
168 -wo.external.root=/Users/mike/Developer/special/directory/Roots
169 -{code}
170 -
171 -*Tip:* A custom WebServer install directory can be specified to Wonder by adding the property 'wo.server.root' to the custom wolips properties file also.
172 -
173 173  {{/info}}