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		-Getting the Wonder Source Code
	1	+Download Wonder Source, Build, Install and Upgrade

Author

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

Content

...	...	@@ -1,88 +1,102 @@
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	+== Source Frameworks Initial Installation ==
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	+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.
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™.
	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	16
17		-== Download It ==
	18	+{{code title="Cloning Project Wonder for the First Time"}}
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.
	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
20	20
21		-1. h5. Clone the source repository from GitHub into a new directory named "WonderSource" or whatever you'd like.
	24	+# Navigate into the working copy root
	25	+cd WonderSource
22	22
23		-{{note title="Read Only"}}
24		-Note the URL shown here is the public read-only URL. Committers should use the SSH form of the URL for read-write.
25		-If "git://" does not work for you then use "http://"
26		-{{/note}}
	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.
27	27
28		-{{code value="none"}}
29		-git clone git://github.com/projectwonder/wonder.git WonderSource
	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)
	32	+ant frameworks
	33	+
	34	+# Install the frameworks (this just copies the built frameworks from ~/Roots to
	35	+# the runtime Frameworks directory, usually at /Library/Frameworks)
	36	+sudo ant frameworks.install
	37	+
30	30	{{/code}}
31	31
32		-You should see output something like this:
	40	+{{info value="Legacy WebObjects 5.3.3 Compatability"}}
33	33
34		-{{noformat}}
	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	+
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.
	49	+{{/info}}
42	42
43		-{{/noformat}}
	51	+== Source Frameworks Upgrade Installation ==
44	44
45		-1. h5. Navigate into the working copy root
	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.
46	46
47		-{{code value="none"}}
48		-cd WonderSource
49		-{{/code}}
	55	+{{code title="Updating your Source"}}
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}
	57	+# Navigate to the Roots directory that was automatically created by the initial Source installation procedure above
	58	+cd ~/Roots/
58	58
59		-{{/note}}
	60	+# Delete all installed frameworks whose names match the built frameworks in this Roots build folder
	61	+for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done
60	60
61		-{{info}}
	63	+# Navigate to the original Wonder source directory that you created above during initial source installation
	64	+cd /path/to/WonderSource
62	62
63		-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.
	66	+# Pull the changes you do not have and merge them with your local repository
	67	+git pull
64	64
65		-{{/info}}
	69	+# Clean, build and install the frameworks
	70	+ant clean; ant frameworks; sudo ant frameworks.install
66	66
67		-== Use It ==
	72	+{{/code}}
68	68
69		-* h5. Use Wonder source code projects in your Eclipse workspace
70		-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]]
	74	+
71	71
72		-{{note title="Ant Builds on your Development Machine"}}
	76	+{{info}}
73	73
74		-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.*
	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.
75	75
76		-{{/note}}
	80	+{{/info}}
77	77
78		-* h5. Build and Install Project Wonder Binary Frameworks
79		-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	+{{info value="Custom Development Enviroment File layout using Custom wolips.properties"}}
80	80
81		-{{note title="Using Both Binary and Source Code Frameworks on Your Development Machine"}}
	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.
82	82
83		-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	+For example:
84	84
85		-{{/note}}
	88	+{code}
	89	+$ cd my/special/purpose/clone/of/Wonder
	90	+$ ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties
	91	+{code}
86	86
87		-* h5. Build Project Wonder frameworks with Hudson/Jenkins
88		-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.
	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	+
	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	+{{/info}}