Skip to Content
Last modified by Bastian Triller on 2013/10/05 10:40
From version 110.1
edited by David Avendasora
on 2011/06/16 18:24
Change comment: There is no comment for this version
To version 118.1
edited by David Avendasora
on 2011/04/25 14:34
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Getting the Wonder Source Code
1 +Downloading, Building, Installing and Upgrading Wonder Source Code
Content
... ... @@ -1,39 +1,32 @@
1 -{{tip title="Now with more Git"}}
1 +== Introduction ==
2 2  
3 -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.
3 +Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
4 4  
5 -{{/tip}}
5 +* Learn a lot about WebObjects and EOF (and Java development styles)
6 +* Easily browse and search the source
7 +* Work with a specific source control version (teams, quality control, development cycles)
8 +* Provide opportunities to submit patches for bug fixes or enhancements
9 +* Add logging statements in Wonder source so you can better understand what is going when tracking down hard to find bugs
10 +* Discover the many Hidden Treasures of Wonder.
6 6  
7 -== Why? ==
12 +== Downloading ==
8 8  
9 -Instead of constantly re-downloading and installing the latest Project Wonder binaries you should work directly with the latest source code. It has several advantages including:
14 +{{tip title="Now with more Git"}}
15 +As of March 25th, 2011 the Wonder source code is now maintained on [GitHub|https://github.com/] at [https://github.com/projectwonder]. So you'll need to be familiar with the [Git|http://git-scm.com/] Source Code Management system. You will use it to checkout a local copy of the repository (a "clone" in Git terms) allowing you to have direct access to the Wonder source.
16 +{{/tip}}
10 10  
11 -* You'll learn a lot about WebObjects, EOF and Object-Oriented Patterns
12 -* Easily search and browse Project Wonder
13 -* Work with a specific revision of Project Wonder, which is key for teams, quality control and development cycles
14 -* Add logging statements to Project Wonder so you can better understand what it is doing when tracking down hard to find bugs
15 -* Discover the Many Hidden Treasures of Wonder™.
18 +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 16  
17 -== Download It ==
20 +1. h5. Clone the source repository from github into a new directory named "WonderSource".
18 18  
19 -Open a terminal and navigate to a directory where you want to maintain a source "working copy" and just use the following commands to clone Wonder source to your computer.
22 +{{note title="Read Only"}}
23 +Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
24 +{{/note}}
20 20  
21 -1. h5. Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like.
22 -
23 23  {{code value="none"}}
24 24  git clone git://github.com/projectwonder/wonder.git WonderSource
25 25  {{/code}}
26 26  
27 -If "git:~/~/" does not work for you then use "http:~/~/"
28 -
29 -{{note title="Wonder Committers"}}
30 -
31 -The URL above is the public, read-only URL.
32 -People with commit privileges for Project Wonder should use: *{{git@github.com:projectwonder/wonder.git}}*
33 -{warning}Do *not* change "git@..." to be your username.{warning}
34 -
35 -{{/note}}
36 -
37 37  You should see output something like this:
38 38  
39 39  {{noformat}}
... ... @@ -63,31 +63,110 @@
63 63  
64 64  {{/note}}
65 65  
66 -{{info}}
59 +== Building ==
67 67  
68 -If you have any trouble or errors due to your local repository getting corrupted, simply delete the entire local repository (the {{\~/Roots}} directory) and start over using the same clone command above.
61 +In general, it is recommended that you use Hudson/Jenkins to build your WebObjects applications, but it is not required. You can build either from the Terminal as outlined below, or from within Eclipse.
69 69  
70 -{{/info}}
63 +{{tip title="Pro Tip"}}
64 +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.
65 +{{/tip}}
71 71  
72 -== Use It ==
67 +{{note title="Requires WebObjects"}}
73 73  
74 -* h5. Use Wonder source code projects in your Eclipse workspace
75 -The best way to make use of Project Wonder is obviously to import the source code projects directly into your Eclipse workspace. Why would you be reading this page if that isn't what you are trying to do? Detailed instructions are here: [[WONDER:Working with Wonder source in Eclipse]]
69 +These build instructions require the WebObjects frameworks to already be installed in the normal location:
70 +* Mac OS X: {{/System/Library/Framworks/}}
71 +* Linux: {{/Library/Frameworks}}
76 76  
77 -{{note title="Ant Builds on your Development Machine"}}
73 +Otherwise you will get compiler errors like this:
74 +{noformat}
75 +[wocompile] /Wonder/WonderGit/WonderSource/Frameworks/Core/JavaWOExtensions/Sources/com/webobjects/woextensions/JSAlertPanel.java:10:
76 + package com.webobjects.appserver does not exist
77 +[wocompile] import com.webobjects.appserver.WOContext;
78 +{noformat}
78 78  
79 -WOlips' "Incremental Builder" is an incredibly helpful feature during development, but it does things that the Ant deployment build does not do. If you are *either* using WOLips to build your WebObjects Applications (_WOLips Ant Tools > Install_) *or* are [running Hudson/Jenkins|WO:Installing and Using the Hudson build server] locally to do it, you *must* also build and install your workspace's Frameworks that your Application depends upon -- including your own, Project Wonder's and any others. *The standard Ant build does* {color:#ff0000}{*}NOT{*}{color} *do this for you.*
80 -
81 81  {{/note}}
82 82  
83 -* h5. Build and Install Project Wonder Binary Frameworks
84 -For building and installing the Wonder Frameworks, please see the standard [[Building and Installing WO Frameworks with Ant>>WO:Building and Installing a WO Framework with Ant]] pages.
82 +You can build the Wonder frameworks from the source code you just cloned to the default (##/Roots##) directory with the following command:
85 85  
86 -{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}
84 +===== Build the frameworks from the "cloned" source. =====
87 87  
88 -If you have both Source Code projects and the built, Binary Frameworks installed, you need to make sure you build all source code frameworks that your project depends upon first. _The standard Ant build does not do this for you._ Ant builds only use binary frameworks so if the installed frameworks are not up to date your Ant build could fail, or worse, succeed but contain run-time errors.
86 +{{code value="none"}}
87 +ant frameworks
88 +{{/code}}
89 89  
90 -{{/note}}
90 +== Installing ==
91 91  
92 -* h5. Build Project Wonder frameworks with Hudson/Jenkins
93 -The ideal way to build WebObjects frameworks and applications is to use a "Continuous Integration Server" or "Build Server" like Hudson or Jenkins. This allows you to automate the often complex process of building WebObjects projects that have several dependencies on frameworks. Instructions on how to setup a Hudson/Jenkins server is are available on the [[WO:Installing and Using Jenkins and Hudson Build Servers]] page.
92 +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.
93 +
94 +===== Install the frameworks =====
95 +
96 +{{code value="none"}}
97 +sudo ant frameworks.install
98 +{{/code}}
99 +
100 +This copies the built frameworks from ##/Roots## to the runtime Frameworks directory:
101 +
102 +* Mac OS X: ##/Library/Framworks/##
103 +* Linux: ##/Local/Library/Frameworks##
104 +
105 +You can combine the build and install steps by simply executing this Ant command:
106 +
107 +{{code value="none"}}
108 +sudo ant frameworks frameworks.install
109 +{{/code}}
110 +
111 +== Upgrading ==
112 +
113 +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.
114 +
115 +1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
116 +
117 +{{code value="none"}}
118 +cd ~/Roots/
119 +{{/code}}
120 +
121 +1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder
122 +
123 +{{code value="none"}}
124 +for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
125 +{{/code}}
126 +
127 +1. h5. Navigate to the original Wonder source directory that you created above during initial source installation
128 +
129 +{{code value="none"}}
130 +cd /path/to/WonderSource
131 +{{/code}}
132 +
133 +1. h5. Pull the changes you do not have and merge them with your local repository
134 +
135 +{{code value="none"}}
136 +git pull
137 +{{/code}}
138 +
139 +{{info}}
140 +
141 +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.
142 +
143 +{{/info}}
144 +
145 +{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
146 +
147 +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.
148 +
149 +For example:
150 +
151 +{code:none}
152 +cd my/special/purpose/clone/of/Wonder
153 +ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
154 +{code}
155 +
156 +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.
157 +
158 +*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
159 +{code:none}
160 +wo.external.root=/Users/mike/Developer/special/directory/Roots
161 +{code}
162 +
163 +*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.
164 +
165 +{{/info}}