Skip to Content

Wiki source code of Debugging WOLips

Version 68.1 by Pascal Robert on 2012/02/11 05:22
Show last authors
1 = Debugging WOLips as the master does =
2
3 These instructions is intended for the developer who wants to compile and run WOLips source for the purpose of debugging or other exploration. Thanks very much to Mike Schrag for the guidance to get this setup and working
4
5 == Overview of what's going on ==
6
7 We're going to check out the latest source for WOLips, build it and arrange for Eclipse to launch is a debug mode to test it out. It's very handy that Eclipse has a built in ability to launch itself in debug mode and load the local versions of the plugins. If you read the old and out dated instructions floating about that talk about building an entire release and installing them into a new copy of Eclipse then you're going to like this method a whole lot better ;-)
8
9 == The setup ==
10
11 When I did this and wrote these notes, I was using:
12
13 * Mac OS X 10.5.7
14 * Java 1.5.0//19//
15 * Eclipse 3.4.2 (eclipse-SDK-3.4.2-macosx-carbon.tar.gz)
16
17 {{panel title="Snow Leopard Update" bgColor="#FFFFCE"}}
18
19 I gave this a go on Snow Leopard and it worked ok however there were a few problems which I've detailed near the end of this document.
20 Here's the setup I was using:
21 - Mac OS X 10.6.2
22 - WebObjects 5.4.3
23 - Java 1.6.0_15
24 - Eclipse 3.4.2 Build id: M20090211-1700 (eclipse-SDK-3.4.2-macosx-carbon.tar.gz)
25 - woproject svn repository version 6031
26 - Wonder svn repository version 10655
27 YMMV\!
28
29 {{/panel}}
30
31 == Checking out the source code ==
32
33 **A note for the impatient - don't try to checkout the source right into Eclipse. The files aren't structured in a way that allows this to work. I know because I tried to do it that way first** ;-)
34
35 === Check out the source code into a local folder ===
36
37 You're checking out a local copy of the code from the source repository. Next, we're going to selectively import (but **not** copy) parts of that code into Eclipse. I'm using command line subversion to check out the lastest version however feel free to use a different tool or different version, as you like.
38
39 git clone [[git://github.com/wolips/wolips.git]] /woproject
40
41 Note that I've checked out the source code into my home folder. It doesn't matter where you put the source code as long as you can find it in the steps below.
42
43 === Create a new eclipse workspace ===
44
45 Launch a clean copy of Eclipse with no plugings installed. Strictly speaking, probably not necessary however these are the steps which I took.
46
47 Create a new Workspace
48 I chose /WOLipsDebugging
49 [[image:Workspace.png]]
50
51 === Import woenvironment ===
52
53 Start off by importing the woenvironment project. From the File menu, select Import
54 [[image:ImportMenu.png]]
55 Click the disclosure triangle for General and select Existing Projects into Workspace
56 [[image:ExistingProject.png]]
57 Click Next button.
58 Ensure that "Select root directory" is selected and click Browse
59 Browse to the folder where you checked out the woproject source code above and select woenvironment.
60 [[image:woenvironmentCheckout.png]]
61 Eclipse should scan the folder and notice one project in the folder called woenvironment.
62 **It's important that you don't have 'Copy the project into your workspace' selected.**
63 [[image:woenvironmentProject.png]]
64 Click Finish.
65
66 Once Eclipse has finished building the project, there should be no errors If that's not the case, then you need to back up and make sure that you've followed all the steps above.
67
68 === Import wolips projects into your workspace ===
69
70 Repeat the steps above and import all the wolips projects except for 3
71 EntityModler, eomodeldoc and org.objectstyle.wolips.eomodeler.factories
72 are special projects which require special setup and caffination before touching.
73
74 The import of wolips should look like this:
75 [[image:wolipsImport.png]]
76
77 And Eclipse should identify a whole bunch of projects.
78 **Make sure that you deselect the 3 special cases noted above**
79 The list of projects should look something like this:
80 [[image:wolipsProjects.png]]
81
82 Click Finish and the projects should all be imported.
83
84 {{note}}
85
86 When I did this I got the following error message.
87 I have no idea what this means...
88 !ResourceErrorMessage.png!
89
90 {{/note}}
91
92 Once Eclipse finishes building the projects there are going to be a whole bunch of build errors. Don't Panic. Most of them will resolve themselves after the next steps.
93
94 === Import wolips plugins ===
95
96 In the same way as above, import the core plugins from wolips/core/plugins. Something like this:
97 [[image:corePluginImport.png]]
98 [[image:corePluginProjects.png]]
99
100 === Import 3rd party plugins ===
101
102 Finally, import the third party plugins from wolips/3rdparty/plugin. Something like this:
103 [[image:thridPartyImport.png]]
104 [[image:thirdPartyProjects.png]]
105
106 === Close special projects ===
107
108 In case you missed the notices above, close these projects.
109
110 * EntityModeler
111 * eomodeldoc
112 * org.objectstyle.wolips.eomodeler.factories
113 (Note: Working on these projects is beyond the scope of what I needed to do. Sorry.)
114
115 === Close projects which require additional resources to compile ===
116
117 These projects require additional resources to compile. As I didn't need them, I just closed them.
118
119 * org.objectstyle.wolips.groovy.ui
120 * org.objectstyle.wolips.jprofiler.launching
121 * org.objectstyle.wolips.jrebel
122 * org.objectstyle.wolips.mechanic
123
124 === Error message: Libraries not found for JavaEOAccess and other WebObjects libraries ===
125
126 A couple projects have been committed to the repository with references to WebObjects libraries in /Library/WebObjects/lib. You'll need to update these to the correct location on your machine. If you've done nothing special to your WebObjects environment then this should be something like: /System/Library/Frameworks
127 If you've done something else then you'll need to change the library locations (or perhaps update your WOLips properties file.)
128
129 === Error message: Cannot find artifact for parent POM... ===
130
131 When building woenvironment, you might hit this error:
132 Cannot find artifact for parent POM: org.objectstyle.woproject:woproject-all-parent::2.1 for project org.objectstyle.woproject.ant:woenvironment:jar:2.1-SNAPSHOT at /Users/...
133
134 The simple solution is delete the pom.xml file. Full details are here: [[http://wiki.objectstyle.org/confluence/display/WOL/mail/6259075]]
135
136 == The configuration setup ==
137
138 At this point, you should have a long list of packages which should all be compiling.
139 If that's not the case, please document additional steps here, making special note of your setup.
140
141 Getting on with the configuration to be able to test the software which is now compiling.
142 From the Run menu, select "Debug Configurations ..."
143 [[image:debugConfiguration.png]]
144
145 Select "Eclipse Application" from the list on the left
146 and then click the "New" button at the top.
147 [[image:newLaunchConfiguration.png]]
148 This creates a new launch configuration which you can customize as you like.
149 By default it's called 'New//configuration'. For this session, I named it DebugEclipse//
150
151 My preference is to explicitly set the workspace for testing however I'm sure the default will be fine if you like it.
152 I chose: $workspace//loc}/../WOLipsDebuggingWorkspace
153 My setup looked something like below however there are lots of configuration options which I didn't need to explore:
154 [[image:debugConfigured.png]]//
155
156 == Launch the debug version ==
157
158 Click the Debug button in the debug configuration window to launch the test version.
159 This will be a clean version of Eclipse with the workspace which you set and any other settings.
160 By default, all of the plugins are loaded and ready for testing
161 And now, you should be running inside the debug version of Eclipse with all the wolips bits to play with
162
163 == Snow Leopard Update ==
164
165 I was running the carbon version of Eclipse 3.4.2 Build id: M20090211-1700 on Snow Leopard 10.6.2
166 Up to this point, I was following the instructions above however when I tried to launch Eclipse, I got this error:
167
168 {{code value="java"}}
169
170 java.lang.UnsatisfiedLinkError: Cannot load 32-bit SWT libraries on 64-bit JVM
171 at org.eclipse.swt.internal.Library.loadLibrary(Library.java:177)
172 at org.eclipse.swt.internal.Library.loadLibrary(Library.java:151)
173 ...
174
175 {{/code}}
176
177 This is a known problem and is documented here: [[http://www.eclipse.org/swt/faq.php#cocoa32launch]]
178 The fix is to add the d32 parameter to the launch arguments.
179
180 Original: os $target.os} ws $target.ws} arch $target.arch} nl $target.nl}
181 Updated: os $target.os} ws $target.ws} arch $target.arch} nl $target.nl} d32
182
183 A second problem which I encountered was running out of memory while running test version of Eclipse
184 I had to add the VM argument "-Xmx2G" and then 'Run' as opposed to 'Debug' the app. For the most part, that worked.
185
186 My final setup looked like this:
187 [[image:32Bit_jvm_2GB_mem.png]]
188
189 == There was more than one SQL reverse engineer factory defined. ==
190
191 [[image:MoreThenOneReverseEngineeringFactory.png]]
192 This exception occurs when you've forgotten to close the org.objectstyle.wolips.eomodeler.factories project.
193 The fix is to close the project. Thanks to Mike Schrag for putting me on the right path when I was at my wits end with this damn problem.