Skip to Content

Changes for page Building WOLips

Last modified by Johann Werner on 2015/02/13 01:40
From version 50.1
edited by Mike Schrag
on 2005/09/08 00:08
Change comment: There is no comment for this version
To version 51.1
edited by Pascal Robert
on 2012/02/11 08:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mschrag
1 +XWiki.probert
Content
... ... @@ -1,70 +1,157 @@
1 -== WOLips Dependencies ==
1 +{{tip title="Not Required!"}}
2 +You do not have to build WOLips to use it. It is easily available via Eclipse's Software Update functionality. The update site is: [http://wocommunity.org/wolips/3.7/stable/]
2 2  
3 -Recent version of WOLips in CVS have more extensive dependencies than prior builds (mostly due to the HTML editor that is part of the web tools project).
4 +{{/tip}}
4 4  
5 -Additionally you will need to download and install Eclipse 3.1.1, currently a build of Eclipse that does not currently have an official release.
6 +{{note}}
6 6  
7 -You can get a 3.1.1 build from [[Eclipse.org>>http://download.eclipse.org/eclipse/downloads/index.php]].
8 +The following instructions about building WOLips are fine if you need to build a distribution of WOLips. However, they aren't so great if you're debugging WOLips. Instructions on how to do that are posted here [Debugging WOLips].
8 8  
9 -After installing Eclipse 3.1.1 and before building or installing WOLips, you will need to download and install the following plugins and features:
10 +{{/note}}
10 10  
11 -1. [[EMF>>http://eclipse.org/downloads/download.php?file=/tools/emf/downloads/drops/2.1.0/R200507070200/emf-sdo-xsd-SDK-2.1.0.zip]]
12 -1. [[GEF>>http://www.eclipse.org/downloads/download.php?file=/tools/gef/downloads/drops/R-3.1-200507071758/GEF-SDK-3.1.zip]]
13 -1. [[JEM>>http://www.eclipse.org/downloads/download.php?file=/tools/ve/downloads/drops/R-1.1-200507221721/JEM-SDK-1.1.zip]]
14 -1. [[WTP>>http://www.eclipse.org/downloads/download.php?file=/webtools/downloads/drops/R-0.7-200507290654/wtp-sdk-0.7.zip]]
12 +Prior to building WOLips, you will want to get your dependencies installed properly. Check out the [[Installing WOLips]] page for information on the dependencies for WOLips.
15 15  
14 +{{color value="#000000"}}
15 +{*}Prerequisites{*}
16 +{{/color}}
17 +
18 +==== Install eGit or another Git client ====
19 +
20 +See [[Getting Started With Git>>documentation:Getting Started with Git]] for information on how to obtain a Git client.
21 +
22 +==== Install the m2eclipse plugin (Eclipse 3.5 instructions) ====
23 +
24 +1. Help > Install New Software
25 +1. Click "Add..."
26 +11. Name = M2Eclipse
27 +11. Location = [[http://m2eclipse.sonatype.org/update/]]
28 +11. Click "OK"
29 +1. Expand "Maven Integration"
30 +1. Select "Maven Embedder"
31 +1. Select "Maven Integration for Eclipse"
32 +1. Click "Next>"
33 +1. Click "Finish"
34 +
16 16  == Checking out and Building from the Commandline ==
17 17  
18 -1. cvs --d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/woproject login--
19 -11. username = anonymous
20 -11. no password
21 -1. cvs --d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/woproject co woproject--
22 -1. cd woproject/projects
23 -1. ant
24 -1. The first build will fail out telling you that it couldn't find wobuild.properties ~-~- That's OK
25 -1. Edit ,,/Library/wobuild.properties,,
26 -1. Add a line eclipse.home=/path/to/your/eclipse
27 -1. ant again and it should succeed this time
28 -11. If you get the error 'build.xml:73: taskdef A class needed by class org.apache.velocity.anakia.AnakiaTask cannot be found: org/jdom/JDOMException', you can do one of two things. You can build with --Dno.docs=true to skip the javadoc step, or (untested) you can drop jdom--b8.jar from woproject/projects/lib into your ANT//HOME/lib folder.//
29 -1. The build went into temp/dist
37 +1. Checkout the ##trunk/woproject## folder from Subversion
38 +##git clone## ##[[git://github.com/wolips/wolips.git]]## woproject
39 +1. ##cd woproject##
40 +1. ##ant##
41 +1. The first build will fail out telling you that it couldn't find ##wobuild.properties## ~-~- That's OK
42 +1. Edit ##/Library/wobuild.properties##
43 +1. Add a line: ##eclipse.home=/path/to/your/eclipse##
44 +1. Call ant with the build.version argument:
45 +
46 +{{code}}
47 +ant -Dbuild.version=3.7.SomeNumber
48 +{{/code}}
49 +
50 +1.
51 +11. If you get the error ##'build.xml:73: taskdef A class needed by class org.apache.velocity.anakia.AnakiaTask cannot be found: org/jdom/JDOMException'##, you can do one of two things. You can build with ##Dno.docs=true## to skip the javadoc step, or (untested) you can drop ##jdom-b8.jar## from ##woproject/projects/lib## into your ##ANT//HOME/lib//##// folder.//
52 +1. The build went into ##temp/dist##
30 30  1. Profit
31 -1. [[Installing WOLips]]
32 32  
33 33  == Checking out and Building inside of Eclipse for Deployment ==
34 34  
35 -1. install jmechanic plugin from [[The JMechanic Site>>http://sourceforge.net/project/showfiles.php?group_id=68316&release_id=136699]]
36 -11. just untar this into your plugins folder
37 -1. Add the wolips CVS repository
38 -11. host = cvs.sourceforge.net
39 -11. root = /cvsroot/woproject
40 -11. protocol = pserver
41 -11. login = anonymous
42 -11. no password
43 -1. In CVS perspective, browse WOLips repository on HEAD, checkout woproject/projects as "projects"
44 -1. Right-click (or equiv) on the build.xml inside of the "projects" project and Run As=>Ant Build ...
45 -1. Switch to the Classpath tab and "Add Jar"
46 -1. Browse to projects/lib and select jdom-b8.jar
47 -1. Make sure the target is the default ("dist")
57 +1. Add the wolips Git repository [[https://github.com/wolips/wolips/]] in the Git Perspective's Repository View
58 +1. Right-click (or equiv) on the ##build.xml## inside of the "woproject" project and Run As=>Ant Build ...
59 +1. Switch to the Properties tab and check for the definition of eclipse.home in the Properties list
60 +1. If ##eclipse.home## does not exist, uncheck "Use global properties" and then click "Add Property"
61 +1. In the Add Property dialog, make the name ##eclipse.home##, click Add Variable, select ##eclipse//home//##// from the list, and click OK//
62 +1. Click Apply to save your changes
48 48  1. Run
49 -1. Once it is complete, you will have to right-click=>refresh the "projects" project and you will have a temp/dist folders with the plugin site in it.
50 -1. [[Installing WOLips]]
64 +1. Once it is complete, you may need to right-click=>refresh your project and you will have a ##temp/dist## folder with the plugin site in it.
51 51  
52 52  == Checking out and Building inside of Eclipse for Development (PDE) ==
53 53  
54 -1. install jmechanic plugin from [[The JMechanic Site>>http://sourceforge.net/project/showfiles.php?group_id=68316&release_id=136699]]
55 -11. just untar this into your plugins folder
56 -1. Add the wolips CVS repository
57 -11. host = cvs.sourceforge.net
58 -11. root = /cvsroot/woproject
59 -11. protocol = pserver
60 -11. login = anonymous
61 -11. no password
62 -1. From the Java perspective, Import=>Team Project Set and select wolips.psf (see below)
63 -1. This will cause a really long checkout and you'll have a TON of build errors ... Don't fret.
64 -1. Copy ##projects/lib/cayenne-1.1RC3-dev.jar## to ##org.objectstyle.wolips.cayenne/lib/cayenne.jar## and refresh the org.objectstyle.wolips.cayenne project
65 -1. Add a classpath variable ANT//HOME that points to ##eclipse/plugins/org.apache.ant##//##1.6.5## (Preferences=>Java=>Build Path=>Classpath Variables, New... name ANT//HOME, Folder... =>youreclipsehome/plugins/org.apache.ant//1.6.5)
66 -1. make ##projects/temp##, ##projects/temp/classes##, and ##projects/temp/doc## folders
67 -1. run ##projects/build.xml## as "Ant Build ...", select the "woenvironment" and "woproject" targets and select Order... and move woenvironment above woproject in the order, Build
68 -1. copy ##projects/temp/build/woproject//$build.version/lib/woproject.jar//##// to ##org.objectstyle.wolips.woproject/lib## and refresh the org.objectstyle.wolips.woproject//
68 +1. Add the wolips Git repository [[https://github.com/wolips/wolips/]] in the Git Perspective's Repository View
69 +1. You can select individual plugins you would like to work on by browsing to ##trunk/woproject/wolips/## in the Subversion repository and checking out the plugins you are interested in. To checkout complete sets of plugins, you could also use the [[Eclipse Team Project Set]].
69 69  
70 -You should end up with no source or build path errors.
71 +== An approach to setting up the development and test environment for WOLips Plugin. ==
72 +
73 +In order to do WOLips Plugin development you will need two eclipse environments: Development and Test.
74 +
75 +1. Follow the Checking out and Building inside of Eclipse for Deployment in you primary Eclipse installation (i.e. /Application/eclipse) and workspace. This will be you development environment.
76 +1. the ##temp/dist## folder is your Local Site for the Test Environment.
77 +1. Create a second copy of "clean" Eclipse under /Users/<me>/Developer/eclipse (this could be any where). This will be your Test Environment.
78 +1. In the test environment, follow the [[Installing WOLips]] instructions, using your ##temp/dist## directory as the Local Site. Install the plugins.
79 +1. Use the Test environment to exercise/test the changes from your locally modified Plugin.
80 +
81 +1. When you need to repeat the process, shut down the Test Environment, delete the org.objectstyle. files in the features and plugins directories under the /Users/<me>/Developer/eclipse directory. Change the source code in the primary environment and build. (Each build took 3 min 37 seconds on my Mac Book Pro 17"). Once the build is done, then reinstall the plugin in the Test Environment. The Local Site should still be selected.
82 +
83 +== Building WOLips with Jenkins Continuous Build server ==
84 +
85 +Hudson is a Java base continuous build server that allows you to build and test your project automatically. It can be easily configured to build WOLips in a few simple steps.
86 +
87 +1. Install Eclipse 3.7. You need it to be able to build WOLips.
88 +1. Copy the necessary plugins from your machine to the Eclipse installation on the server. In this example it has been copied to /usr/local/eclipse
89 +The currently required plugins for a deployment build are
90 + JProfiler (Update Site:&nbsp;[[http://wocommunity.org/documents/tools/jprofiler6/]])
91 + JRebel (Update Site :&nbsp;[[http://www.zeroturnaround.com/update-site/]])
92 +1. Create a new job in Jenkins to build WOLips. You can use the [[following sample config>>https://github.com/wocommunity/JenkinsJobs/tree/master/WOLips]]&nbsp;or you can add a new job with the following configuration:
93 +11. Project Name: WOLips
94 +11. Git Repositories:&nbsp;git:~/~/github.com/wolips/wolips.git
95 +11. Use update: Checked
96 +11. Poll SCM: 59 * ** * ** //(59 can be replaced with any number between 0 and 59)//
97 +1. Add the following build tasks to the job
98 +
99 +{{code title="Execute Shell"}}
100 +
101 +echo build.version=3.7.${BUILD_NUMBER} > build.properties
102 +echo eclipse.home=/usr/local/eclipse >> build.properties
103 +echo user.home=${WORKSPACE} >> build.properties
104 +
105 +{{/code}}
106 +
107 +{{code title="Invoke Ant"}}
108 +
109 +Targets: dist
110 +
111 +{{/code}}
112 +
113 +If you want to deploy the build to a web server to serve as an update site add a task that is something like this
114 +
115 +{{code title="Execute Shell"}}
116 +
117 +rm -fr /usr/local/www/apache22/data/wolips/*
118 +/bin/cp -prv ${WORKSPACE}/wolips/temp/dist/ /usr/local/www/apache22/data/wolips/
119 +
120 +{{/code}}
121 +
122 +== Preparation for building WOLips on Windows operating systems (NT 5.0 and higher) ==
123 +
124 +For building WOLips on Windows operating systems, some minor changes have to be made. Instead of following and solving the build errors, you may follow the steps described below.
125 +
126 +1. Install the [[BuildingWOLips-Prerequisites>>||anchor="BuildingWOLips-Prerequisites"]]. Do also follow the [[BuildingWOLips-CheckingoutandBuildinginsideofEclipseforDeployment>>||anchor="BuildingWOLips-CheckingoutandBuildinginsideofEclipseforDeployment"]] section, but don't run the build until the changes described below have been made.
127 +1. Set the VMs encoding to MacRoman
128 +1*. Right click on ##build.xml## > Properties > JRE > VM arguments
129 +1**. Dfile.encoding=MacRoman
130 +1. Edit ##woproject/wolips/goodies/plugins/build.xml##
131 +1*. Comment out the subsequent lines (mac goodies)
132 +1**. <ant dir="org.objectstyle.wolips.goodies.core.mac" target="all" />
133 +1**. <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="all" />
134 +1**. <ant dir="org.objectstyle.wolips.goodies.core.mac" target="dist" />
135 +1**. <ant dir="org.objectstyle.wolips.goodies.ui.mac" target="dist" />
136 +1. Edit ##woproject/wolips/features/build.xml##
137 +1*. Comment out the subsequent lines (mac features)
138 +1**. <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="all" />
139 +1**. <ant dir="org.objectstyle.wolips.goodies.mac.feature" target="dist" />
140 +1. Edit ##woproject/wolips/build.xml## (you may skip this one if you've got JProfiler installed)
141 +1*. Comment out the subsequent lines
142 +1**. <ant dir="jprofiler" target="all" />
143 +1**. <ant dir="jprofiler" target="dist" />
144 +1. Run the build
145 +
146 +== Installing from a Local Build ==
147 +
148 +1. If you made changes locally, Eclipse will not automatically install your changed plugins if the version number is the same. You have two options - either uninstall WOLips or cheat and increment the WOLips build version prior to building your local copy. To uninstall WOLips, just delete all org.objectstyle features and plug ins from your eclipse folder. To increment the build server version, open buildserver.version in your projects folder and increment the last number. Note that you will now be "competing" with version numbers from the official build server, so the next official build will not install because you already used the next number, but sometimes it's a quick hack to force an update if you're lazy :-)
149 +1. Assuming you now have your build versions under control, you should follow the instructions for [[Building WOLips]]
150 +1. Launch Eclipse
151 +1. Select the menu: Help->Software Updates.
152 +1. Click on the 'Available Software' tab at the top of the window.
153 +1. Click on the 'Add Site...' button. This will bring up a dialog box.
154 +1. Click on the 'Local...' button on the dialog box.
155 +1. Browse to and select your workspace/projects/temp/dist folder or your woproject/temp/dist folder (depending on whether you checked out in eclipse or command line). Check the box next to it.
156 +1. If you updated the version number in your local copy (instead of uninstalling), you must now click on the 'Installed Software' tab at the top of the window and click on the 'Update...' button.
157 +1. Then continue, and just keep selecting the "Yes"/"OK"/"Approve"/etc buttons