Wiki source code of Downloading, Building, Installing and Upgrading Wonder Source Code
Version 124.1 by David Avendasora on 2011/04/25 14:40
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
112.1 | 1 | == Introduction == |
| |
77.1 | 2 | |
| |
112.1 | 3 | Instead of downloading the Wonder binaries, working from the latest source code directly can have some advantages such as: |
| |
77.1 | 4 | |
| |
112.1 | 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. | ||
| 11 | |||
| |
118.1 | 12 | == Downloading == |
| |
112.1 | 13 | |
| 14 | {{tip title="Now with more Git"}} | ||
| |
114.1 | 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. |
| |
106.1 | 16 | {{/tip}} |
| |
77.1 | 17 | |
| |
118.1 | 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. |
| |
77.1 | 19 | |
| |
124.1 | 20 | 1. h5. Clone the source repository from github into a new directory named "WonderSource". |
| |
77.1 | 21 | |
| |
114.1 | 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}} | ||
| 25 | |||
| |
124.1 | 26 | {{code value="none"}} |
| |
112.1 | 27 | git clone git://github.com/projectwonder/wonder.git WonderSource |
| 28 | {{/code}} | ||
| |
77.1 | 29 | |
| |
124.1 | 30 | You should see output something like this: |
| |
118.1 | 31 | |
| |
124.1 | 32 | {{noformat}} |
| 33 | |||
| 34 | Cloning into WonderSource... | ||
| 35 | remote: Counting objects: 174269, done. | ||
| 36 | remote: Compressing objects: 100% (57304/57304), done. | ||
| 37 | remote: Total 174269 (delta 107374), reused 173934 (delta 107067) | ||
| 38 | Receiving objects: 100% (174269/174269), 137.94 MiB | 8.29 MiB/s, done. | ||
| 39 | Resolving deltas: 100% (107374/107374), done. | ||
| 40 | |||
| 41 | {{/noformat}} | ||
| 42 | |||
| 43 | 1. h5. Navigate into the working copy root | ||
| 44 | |||
| 45 | {{code value="none"}} | ||
| |
112.1 | 46 | cd WonderSource |
| 47 | {{/code}} | ||
| |
77.1 | 48 | |
| |
112.1 | 49 | {{note title="WebObjects 5.3.3 Compatability"}} |
| |
124.1 | 50 | 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} |
| 51 | You should get output like this: | ||
| 52 | {noformat} | ||
| 53 | Branch Wonder_5_0_0_Legacy set up to track remote branch Wonder_5_0_0_Legacy from origin. | ||
| 54 | Switched to a new branch 'Wonder_5_0_0_Legacy' | ||
| 55 | {noformat} | ||
| |
79.1 | 56 | |
| |
112.1 | 57 | {{/note}} |
| 58 | |||
| |
118.1 | 59 | == Building == |
| |
112.1 | 60 | |
| |
124.1 | 61 | 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. |
| |
118.1 | 62 | |
| |
124.1 | 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. 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. | ||
| 65 | {{/tip}} | ||
| |
118.1 | 66 | |
| |
124.1 | 67 | {{note title="Requires WebObjects"}} |
| 68 | |||
| 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}} | ||
| 72 | |||
| 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} | ||
| 79 | |||
| 80 | {{/note}} | ||
| 81 | |||
| 82 | You can build the Wonder frameworks from the source code you just cloned to the default (##/Roots##) directory with the following command: | ||
| 83 | |||
| 84 | ===== Build the frameworks from the "cloned" source. ===== | ||
| 85 | |||
| 86 | {{code value="none"}} | ||
| |
112.1 | 87 | ant frameworks |
| |
106.1 | 88 | {{/code}} |
| |
90.1 | 89 | |
| |
124.1 | 90 | == Installing == |
| |
106.1 | 91 | |
| |
124.1 | 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"}} | ||
| |
112.1 | 97 | sudo ant frameworks.install |
| 98 | {{/code}} | ||
| |
106.1 | 99 | |
| |
124.1 | 100 | This copies the built frameworks from ##/Roots## to the runtime Frameworks directory: |
| |
106.1 | 101 | |
| |
124.1 | 102 | * Mac OS X: ##/Library/Framworks/## |
| 103 | * Linux: ##/Local/Library/Frameworks## | ||
| |
106.1 | 104 | |
| |
124.1 | 105 | You can combine the build and install steps by simply executing this Ant command: |
| |
77.1 | 106 | |
| |
124.1 | 107 | {{code value="none"}} |
| 108 | sudo ant frameworks frameworks.install | ||
| |
118.1 | 109 | {{/code}} |
| |
77.1 | 110 | |
| |
124.1 | 111 | == Upgrading == |
| |
118.1 | 112 | |
| |
124.1 | 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. |
| |
77.1 | 114 | |
| |
124.1 | 115 | 1. h5. Navigate to the original Wonder source directory that you created above during initial source installation |
| |
118.1 | 116 | |
| |
124.1 | 117 | {{code value="none"}} |
| |
112.1 | 118 | cd /path/to/WonderSource |
| |
118.1 | 119 | {{/code}} |
| |
86.1 | 120 | |
| |
124.1 | 121 | 1. h5. Pull the changes you do not have and merge them with your local repository |
| |
118.1 | 122 | |
| |
124.1 | 123 | {{code value="none"}} |
| |
112.1 | 124 | git pull |
| 125 | {{/code}} | ||
| |
106.1 | 126 | |
| |
124.1 | 127 | 1. h5. Build the frameworks. |
| |
120.1 | 128 | |
| |
124.1 | 129 | {{code value="none"}} |
| |
120.1 | 130 | ant frameworks |
| |
124.1 | 131 | {{/code}} |
| |
120.1 | 132 | |
| |
124.1 | 133 | 1. h5. Navigate to the Roots directory that was automatically created by the initial Source installation procedure above |
| 134 | |||
| 135 | {{code value="none"}} | ||
| 136 | cd ~/Roots/ | ||
| |
120.1 | 137 | {{/code}} |
| 138 | |||
| |
124.1 | 139 | 1. h5. Delete all installed frameworks whose names match the built frameworks in this Roots build folder |
| 140 | |||
| 141 | {{code value="none"}} | ||
| 142 | for FRAMEWORK in `echo *.framework`; do sudo rm -r /Library/Frameworks/${FRAMEWORK}; done | ||
| 143 | {{/code}} | ||
| 144 | |||
| |
106.1 | 145 | {{info}} |
| 146 | |||
| |
112.1 | 147 | 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. |
| |
106.1 | 148 | |
| 149 | {{/info}} | ||
| 150 | |||
| |
112.1 | 151 | {{info value="Custom Development Enviroment File layout using Custom wolips.properties"}} |
| |
106.1 | 152 | |
| |
112.1 | 153 | 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. |
| |
106.1 | 154 | |
| |
112.1 | 155 | For example: |
| |
106.1 | 156 | |
| |
124.1 | 157 | {code:none} |
| 158 | cd my/special/purpose/clone/of/Wonder | ||
| 159 | ln -s ~/Library/Application\ Support/WOLips/wolips.custom.properties build.properties | ||
| |
112.1 | 160 | {code} |
| |
106.1 | 161 | |
| |
112.1 | 162 | 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. |
| |
106.1 | 163 | |
| |
112.1 | 164 | *Tip:* Specify a custom build directory for Wonder by adding the property 'wo.external.root' to the custom wolips properties file, for example |
| |
124.1 | 165 | {code:none} |
| |
112.1 | 166 | wo.external.root=/Users/mike/Developer/special/directory/Roots |
| 167 | {code} | ||
| |
106.1 | 168 | |
| |
112.1 | 169 | *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. |
| |
106.1 | 170 | |
| |
112.1 | 171 | {{/info}} |