Skip to content

Developing on the service registry

mdutoo edited this page Jul 26, 2011 · 29 revisions

Development environment

Check out the easysoa-model-demo project, do a mvn eclipse:eclipse at the root of the maven projects (in plugins/), import them all in Eclipse and you're ready to go !

In order to build and deploy the plugins, you can either:

  • Use [Buildr](Development Environment) (recommended). Check out the easysoa-demo-dist to the same folder as the other repository, configure your Nuxeo location in build.yaml, then build and deploy by typing buildr nx_mvn nx_dist from the easysoa-demo-dist folder.
  • Build them using the buildPlugins.sh (or .bat) script, them move the target/plugins contents to your Nuxeo plugins folder (./nxserver/plugins).

About the "nuxeo-ecm" project

This pom project has only been set up to resolve compatibility issues between Nuxeo and Sonatype's M2Eclipse. You should keep this project open in your Eclipse workspace so that M2E refers to this projects pom.xml, and not to the "real one".

If you're having errors in the easysoa-demo-core-* projects, use M2Eclipse's "Update project configuration" option to update the dependencies references.

Debugging

To debug Nuxeo, in bin/nuxeo.conf uncomment or adapt the following line : JAVA_OPTS=$JAVA_OPTS -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n then restart the server, connect your debugging environment (ex. Eclipse > Debug configurations... > Remote Application) to said local port (here 8787), and start placing breakpoints.

WARNING this does not work on Windows with Nuxeo 5.4.1 and possibly earlier, see "Application crashes after switching debug mode on (Windows)" [NXP-6040] (https://jira.nuxeo.com/browse/NXP-6040).

Testing

To test (with JUnit) Nuxeo developments, there must be a runnning Nuxeo server, or at least part of it. There are several ways :

Embedded Nuxeo using custom Feature annotations

Use a custom JUnit Feature, and annotations to configure an embedded Nuxeo deployment. Available features :

(older, obsolete) Embedded Nuxeo using Nuxeo helpers

Extend org.nuxeo.runtime.test.NXRuntimeTestCase, and use the deployBundle, deployContrib methods & others to configure an embedded Nuxeo deployment. Example : see org.nuxeo.ecm.core.storage.sql.SQLRepositoryTestCase

Full Nuxeo deployment

Write tests that interact remotely with a manually deployed Nuxeo by extending [NotificationTestCase] (https://github.com/easysoa/easysoa-model-demo/blob/master/plugins/easysoa-model-demo-rest/src/test/java/org/easysoa/test/rest/tools/NotificationTestCase.java), or using other remote interaction alternatives as described above.

Clone this wiki locally