Having been working at the periphery of the Hibernate source and submitting simple patches for the Ingres dialect and some tests I am now in a position to start debugging some of the issues discovered whilst testing. I have been dabbling with building maven projects from Eclipse using m2eclipse, but have not managed to perform source level debugging. I found this article Dealing with the Eclipse IDE that provides some clues on how it is done.

Essentially it involves a remote debug session from a container project to a running maven goal configured to listen.

Versions

The versions of software that I’ve been playing with

• Eclipse Galileo ~SR1 – Build id: 20090920-1017
• Eclipse Helios M5 – Build id: 20100204-0846 (I started to install the m2eclipse plugin and import the projects, but needs more work)
• Ingres 9.3.1 (int.lnx/106)
• java version “1.6.0_16″
• mvn Apache Maven 2.2.1 (r801777; 2009-08-06 20:16:01+0100)
• Apache Ant version 1.7.1 compiled on June 27 2008
• Hibernate 3.5.0-Final

Path: .
URL: http://anonsvn.jboss.org/repos/hibernate/core/tags/hibernate-3.5.0-Final
Repository Root: http://anonsvn.jboss.org/repos/hibernate
Repository UUID: 1b8cb986-b30d-0410-93ca-fae66ebed9b2
Revision: 19149
Node Kind: directory
Schedule: normal
Last Changed Author: steve.ebersole@jboss.com
Last Changed Rev: 19148
Last Changed Date: 2010-03-31 18:38:55 +0100 (Wed, 31 Mar 2010)


These notes assume that the software has been installed and configured. For example, the Maven local repository location is available and that the Maven remote repository is accessible.

Installing m2eclipse

The article Dealing with the Eclipse IDE includes links on how to install m2eclipse, but in summary, to install new software in Eclipse use the built-in update manager:

• Using the menus select
  • Help > Install New Software
  • In the dialog add the URL http://m2eclipse.sonatype.org/sites/m2e
  • Check the boxes of the packages that should be installed
    • NB” Version 0.9.8 should be un-installed before upgrading to 0.10.

Import the Hibernate project

Once the m2eclipse extensions have been installed into Eclipse the preparation for importing the Hibernate Project Object Model (POM) XML file into the IDE is complete. Importing the Hibernate project is optional and is only required if you intend to build Hibernate from Eclipse. The remote Java application perspective will connect to either a command line invoked maven process or an Eclipse invoked maven process.

• Start Eclipse
  • Create a new workspace for the Hibernate project.
• Using the menu File > Import
  • Select Maven > Existing Maven Projects
  • Click Next and use the browse button to specify the root directory of the Hibernate source code, this is the directory in which the top level pom.xml file exists.
  • The sub-projects appear in the tree view in addition to the hierarchy beneath the top level project.

The initial import and build of the workspace can take a while.

Create a Surefire Debug Configuration

Create a run configuration for a specific test class for debugging. In this example the filter.DynamicFilterTest has been cut down into filter.IngresDynamicFilterTest.

• Select the menu Run > Run configuration option or from the context menu using a right click.
• In the Run Configuration dialog select ”maven” and create a new configuration
  • Enter a name for the configuration
  • Surefire Debug
  • Set the base directory to the test suite directory by browsing the file system
  • Set the goals
  • test -Dmaven.surefire.debug
  • Use a JDBC profile if one is required and has been configured
  • Set the ”test” parameter to a specific test class intended for debugging
    • test=org.hibernate.test.filter.IngresDynamicFilterTest

Create a Debugging Container Project

The container java project does not contain any source and is used as the launch point for a remote debugging configuration.

• Using the File->New->Project->Java Project (or equivalent)
• Set the project name in the wizard
• Project Name: Maven Debug and finish

In order to debug a maven project a container project is used to connect to maven in debug mode.

Create Container Project from Ray Fan on Vimeo.

• Use the Run->Debug Configurations menu to create a configuration for the Remote Java Application
  • Set the nameName: Maven
  • Keep all the existing settings and apply

  

  • Select the Source tab and add source
    • File System Directory and browse to the Hibernate route source directory
    • Select the Search subfolders check box
    • Apply and close

    

• Use the Run > Debug Configurations menu to duplicate the Maven configuration for the Remote Java Application
  • Set the name
    • Name: Maven Debug
  • Change the port value
    • Port: 5005
  • Apply and close

  

Set breakpoints and start the test

At least one breakpoint should be set in the source prior to the run configuration Surefire Debug is started

• Browse the source tree in the package explorer to the test class
• Set a breakpoint
• Use the Run->Run Configurations menu and select the Maven->Surefire Debug configuration
  • Click debug to start maven

Eclipse breakpoint setting and starting maven from Ray Fan on Vimeo.

Using Eclipse to browse the project source and set a breakpoint prior to starting maven to run the test.

Start the debugger

• Use the Debug->Debug Configurations menu and select the Maven Debug remote debugging configuration
  • Click debug to start the debugging session
  • Switch to the debugging perspective when prompted
  • Once execution of the test starts the breakpoint set previously should be hit

Starting to debug from Ray Fan on Vimeo.

Starting to debug, switching perspective and hitting the breakpoint.

Related posts

• Hibernate 3.5.0-Final released
• Donnez-moi un café Ingres
• Rapid
• Ingres Migration Toolset
• Useful or useless? Follow on post …

Most notably, I extended the work started by Enrico Schenk in introducing additional Ingres dialects. There are now three possible dialects.

• IngresDialect – for use with Ingres II 9.2
• Ingres9Dialect – for use with Ingres II 9.3
• Ingres10Dialect – for use with Ingres II 10.0 – at the moment this is a place holder and uses the 9.3 dialect

The Ingres9Dialect switches uses the ISO date/time types and functions for mapping to their Hibernate equivalents. This changes the behaviour from the IngresDialect which used ingresdate type and functions.

Further changes to Ingres9Dialect will include the introduction of auto-increment columns; a whole host of additions will be required for the Ingres10Dialect and not forgetting the inclusions from the Ingres GeoSpatial project.
A list of new features introduced into each release is published on the “Ingres New Features Per Release” page.

Related posts

• Debugging the Hibernate project with Eclipse
• Useful or useless? Follow on post …
• In the market for JDBC properties
• Donnez-moi un café Ingres
• Google Summer of Code (GSoC) 2008

drop ima_dbms_fis;
\p\g
register table ima_dbms_fis (
        server varchar(64) not null not default is
                'SERVER',
        id integer4 not null not default is
                'exp.adf.adg.fi_id',
        complement integer4 not null not default is
                'exp.adf.adg.fi_cmplmnt',
        type varchar(20) not null not default is
                'exp.adf.adg.fi_type',
        flags integer4 not null not default is
                'exp.adf.adg.fi_flags',
        opid integer4 not null not default is
                'exp.adf.adg.fi_opid',
        args integer4 not null not default is
                'exp.adf.adg.fi_numargs',
        dtresult integer4 not null not default is
                'exp.adf.adg.fi_dtresult',
        dtarg1 integer4 not null not default is
                'exp.adf.adg.fi_dtarg1',
        dtarg2 integer4 not null not default is
                'exp.adf.adg.fi_dtarg2',
        dtarg3 integer4 not null not default is
                'exp.adf.adg.fi_dtarg3',
        dtarg4 integer4 not null not default is
                'exp.adf.adg.fi_dtarg4'
)
as import from 'tables'
with dbms = IMA,
structure = sortkeyed,
key = (server);
\p\g
grant all on ima_dbms_fis to ingres;
\p\g
grant select on ima_dbms_fis to public;
\p\g

Adding this table to ima_dbms_types and ima_dbms_operators adds the ability to retrieve the list of functions and their signatures.  The query makes use of an internal function iitypename which translates the numeric type code into a name.

select
    a.name,
    case when a.type='COMPARISON' then
        trim(iitypename(b.dtresult)) + ' = ( ' +
        trim(iitypename(b.dtarg1)) + ' ' +
        a.name + ' ' +
        trim(iitypename(b.dtarg2)) + ' )'
        when a.type='OPERATOR' then
        trim(iitypename(b.dtresult)) + ' = ( ' +
        trim(iitypename(b.dtarg1)) + ' ' +
        a.name + ' ' +
        trim(iitypename(b.dtarg2)) + ' )'
    else
        trim(iitypename(b.dtresult)) + ' = ' +
        a.name + '( ' +
            case when b.dtarg1 != '' then trim(iitypename(b.dtarg1)) else '' end +
            case when b.dtarg2 != '' then ', ' + trim(iitypename(b.dtarg2)) else '' end +
            case when b.dtarg3 != '' then ', ' + trim(iitypename(b.dtarg3)) else '' end +
            case when b.dtarg4 != '' then ', ' + trim(iitypename(b.dtarg4)) else '' end
        + ' )'
    end as signature
from
    ima_dbms_operators a,
    ima_dbms_fis b
where
    a.opid = b.opid
group by a.name, 2
order by a.name

Some sample output from this query:

|name                          |signature                       |
|soundex                       |char = soundex( text )          |
|soundex                       |char = soundex( varchar )       |
|sqrt                          |float = sqrt( float )           |
|squeeze                       |nvarchar = squeeze( nchar )     |
|squeeze                       |nvarchar = squeeze( nvarchar )  |
|squeeze                       |text = squeeze( c )             |

So in answer to my own question; yes, it is useful.  I’ll be trying this on an IngresGeospatial build when I get my hands on one.

Related posts

• Debugging the Hibernate project with Eclipse
• Hibernate 3.5.0-Final released
• Google Summer of Code (GSoC) 2008
• IMA Guru (Pronounced, I’m A Guru) – I definitely am not
• Data Access Message Protocol – Wireshark dissector

There is an project within Eclipse called the Eclipse Communication Framework (ECF) that transforms the Eclipse IDE into a instant collaboration tool that includes shared editing.  The shared editing feature in ECF allows multiple contributors to make simultaneous edits and differentiates it from other tools where each contributor needs to hold the

What differentiates the shared editing in ECF with other tools is that multiple contributors can make real time edits simultaneously.

I’ve been working with colleagues who are distributed across the globe looking at some java code so we installed ECF to try shared editing and ended up with more than we expected.

I’m using Eclipse Galileo SR1 and followed the instructions for ECF installation on http://www.eclipse.org/ecf/downloads.php.

To get file sharing an ECF generic server is required for workspace collaboration, installation instructions are on http://wiki.eclipse.org/ECF_Servers and I also followed the section “Starting an ECF Generic Server with java only”.  I updated versions of the jar files using the ones from my updated Eclipse plug-ins:

• org.eclipse.core.jobs_3.4.100.v20090429-1800.jar
• org.eclipse.core.runtime.compatibility_3.2.0.v20090413.jar
• org.eclipse.equinox.app_1.2.0.v20090520-1800.jar
• org.eclipse.equinox.common_3.5.1.R35x_v20090807-1100.jar
• org.eclipse.equinox.registry_3.4.100.v20090520-1800.jar
• org.eclipse.osgi.services_3.2.0.v20090520-1800.jar
• org.eclipse.osgi_3.5.1.R35x_v20090827.jar
• org.eclipse.ecf.discovery_3.0.0.v20090616-0832.jar
• org.eclipse.ecf.identity_3.0.0.v20090831-1906.jar
• org.eclipse.ecf.server.generic_2.0.0.v20090616-0832.jar
• org.eclipse.ecf.provider_2.0.0.v20090616-0832.jar
• org.eclipse.ecf.sharedobject_2.0.0.v20090616-0832.jar
• org.eclipse.ecf_3.0.0.v20090831-1906.jar

I also created a simple server.xml file for changing the listening port number to facilitate navigation through firewalls.
Assuming JRE, paths and permissions are already configured I start the server using this script created based on the instructions.

#!/bin/bash
HOME=/home/eclipse
LOG=.
java -Dfile.encoding=ISO-8859-1 -classpath ${HOME}/plugins/org.eclipse.equinox.common_3.5.1.R35x_v20090807-1100.jar:\
${HOME}/plugins/org.eclipse.core.runtime.compatibility_3.2.0.v20090413.jar:\
${HOME}/plugins/org.eclipse.equinox.registry_3.4.100.v20090520-1800.jar:\
${HOME}/plugins/org.eclipse.osgi.services_3.2.0.v20090520-1800.jar:\
${HOME}/plugins/org.eclipse.osgi_3.5.1.R35x_v20090827.jar:\
${HOME}/plugins/org.eclipse.core.jobs_3.4.100.v20090429-1800.jar:\
${HOME}/plugins/org.eclipse.equinox.app_1.2.0.v20090520-1800.jar:\
${HOME}/plugins/org.eclipse.ecf.discovery_3.0.0.v20090616-0832.jar:\
${HOME}/plugins/org.eclipse.ecf.identity_3.0.0.v20090831-1906.jar:\
${HOME}/plugins/org.eclipse.ecf.server.generic_2.0.0.v20090616-0832.jar:\
${HOME}/plugins/org.eclipse.ecf.provider_2.0.0.v20090616-0832.jar:\
${HOME}/plugins/org.eclipse.ecf.sharedobject_2.0.0.v20090616-0832.jar:\
${HOME}/plugins/org.eclipse.ecf_3.0.0.v20090831-1906.jar\
 org.eclipse.ecf.server.generic.app.ServerApplication -c ${HOME}/server.xml > ${LOG}/ecf-server.log 2>&1 &

Once the server is running connect to it from Eclipse using the collaboration icon.  A collaboration view is opened with the members of the session ready in a group chat .

To make shared edits to a file; open the file in the editor, right click in the editor pane and select the context menu option Share Editor With and select the name of a collaborating editor, both of you can start editing.

Related posts

• Debugging the Hibernate project with Eclipse
• Hello, Eclipse calling …
• Donnez-moi un café Ingres
• Ingres Migration Toolset
• Vectorise your data

Ingres CAFÉ is a complete Web application development stack and runtime building upon Ingres 9.2.0, Ingres Eclipse DTP and various other Java and Eclipse components, details of which can be found on the project Wiki page.

Exemplifies mentored community development, congratulations.

Related posts

• Debugging the Hibernate project with Eclipse
• Vectorise your data
• Hibernate 3.5.0-Final released
• Learning to share
• Rapid

I have the privilege of being accepted as a mentor for Ingres.  All of the project mentors have been introducing themselves on the mentors mailing list and there must be a few hundred of us.  What strikes me, from the brief biographies, is the number of people who manage to dedicate their personal time for their projects.  I have to take my hat off to them.  Any Ingres community members who would like to mentor a project can register and get more information at  Guide to the GSoC Web App for Mentors and Organization Administrators.

I’m really looking forward to seeing what develops

Related posts

• Ingres Documentation site relaunched
• Debugging the Hibernate project with Eclipse
• Hibernate 3.5.0-Final released
• Useful or useless? Follow on post …
• Data Access Message Protocol – Wireshark dissector