Changes for page Getting the Wonder Source Code

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

...	...	@@ -1,1 +1,1 @@
1		-Download Wonder Source, Build, Install and Upgrade
	1	+Download Wonder Source, Build and Install

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.paulh
	1	+XWiki.kieran

Content

...	...	@@ -2,33 +2,45 @@
2	2
3	3	Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as:
4	4
5		-* Learn a lot about WebObjects and EOF (and Java development styles)
	5	+* Learn very much about WebObjects and EOF (and java dev styles?)
6	6	* Easily browse and search the source
7		-* Work with a specific source control version (teams, quality control, development cycles)
	7	+* Work with a specific svn version (teams, quality control, development cycles)
8	8	* Provide opportunities to submit patches for bug fixes or enhancements
9	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.
	10	+* Discover the many Hidden Treasures of Wonder
11	11
12	12	== Source Frameworks Initial Installation ==
13	13
14		-As of March 25th, 2011, Wonder is maintained on [[GitHub>>https://github.com/]]. So [[Git>>http://git-scm.com/]] is what we use to get a local clone of the repository allowing us to directly use Wonder source.
	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:
15	15
16		-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 own hard-drive.
	16	+{{code title="Procedure for WebObjects 5.4.X"}}
17	17
18		-{{code title="Cloning Project Wonder for the First Time"}}
	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
19	19
20		-# Clone the source repository from github into a new directory named "WonderSource".
21		-# Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write
22		-git clone git://github.com/projectwonder/wonder.git WonderSource
23		-
24	24	# Navigate into the working copy root
25	25	cd WonderSource
26	26
27		-# If you are still using old WebObjects 5.3.3, then you need to execute one git command at this point
28		-# before you build Wonder to switch to the branch that is source-compatible with WO 5.3.3. See the tip at the bottom of the page.
	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
29	29
30		-# Build the frameworks from the source (Assumes you are using WebObjects 5.4.3,
31		-# which is currently compatible with 'master' branch. See note below for WebObjects 5.3.3 compatible install)
	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
	31	+
	32	+{{/code}}
	33	+
	34	+{{code title="Procedure for WebObjects 5.3.X"}}
	35	+
	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
	39	+
	40	+# Navigate into the working copy root
	41	+cd WonderSource
	42	+
	43	+# Build the frameworks from the source (BTW, they get built into a directory named Roots in your home dir)
32	32	ant frameworks
33	33
34	34	# Install the frameworks (this just copies the built frameworks from ~/Roots to
...	...	@@ -37,23 +37,38 @@
37	37
38	38	{{/code}}
39	39
40		-{{info value="Legacy WebObjects 5.3.3 Compatability"}}
	52	+== Source Frameworks Upgrade Installation ==
41	41
42		-If you are still stuck on WebObjects 5.3.3, for whatever reason, then you need to checkout and switch to the Wonder_5_0_0_Legacy branch *before* you build (before you run 'ant frameworks'). And this is *much* easier with git than it used to be with subversion. Just one command:
43		-
44		-{code}
45		-git checkout --track origin/Wonder_5_0_0_Legacy
46		-{code}
47		-
	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.
48	48
49		-{{/info}}
	56	+{{code title="Procedure for WebObjects 5.4.X"}}
50	50
51		-== Source Frameworks Upgrade Installation ==
	58	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	59	+cd ~/Roots/
52	52
53		-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.
	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
54	54
55		-{{code title="Updating your Source"}}
	64	+# Navigate to the original Wonder source directory that you created above during initial source installation
	65	+cd /path/to/WonderSource
56	56
	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
	70	+
	71	+# Clean the previous build artifacts
	72	+ant -Dwonder.patch=54 clean
	73	+
	74	+# Build from the latest source
	75	+ant -Dwonder.patch=54 frameworks
	76	+
	77	+# Install the latest built frameworks
	78	+sudo ant -Dwonder.patch=54 frameworks.install
	79	+
	80	+{{/code}}
	81	+
	82	+{{code title="Procedure for WebObjects 5.3.X"}}
	83	+
57	57	# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
58	58	cd ~/Roots/
59	59
...	...	@@ -63,40 +63,33 @@
63	63	# Navigate to the original Wonder source directory that you created above during initial source installation
64	64	cd /path/to/WonderSource
65	65
66		-# Pull the changes you do not have and merge them with your local repository
67		-git pull
	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
68	68
69	69	# Clean, build and install the frameworks
70	70	ant clean; ant frameworks; sudo ant frameworks.install
71	71
	100	+
72	72	{{/code}}
73	73
74		-
75		-
76	76	{{info}}
77	77
78		-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.
79	79
80	80	{{/info}}
81	81
82	82	{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
83	83
84		-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.
85	85
86	86	For example:
87	87
88	88	{code}
89		-$ cd my/special/purpose/clone/of/Wonder
	116	+$ cd my/special/purpose/working/copy/of/Wonder
90	90	$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
91	91	{code}
92	92
93	93	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.
94	94
95		-*Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example
96		-{code}
97		-wo.external.root=/Users/mike/Developer/special/directory/Roots
98		-{code}
99		-
100		-*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.
101		-
102	102	{{/info}}