Latest revision as of 01:44, 2 January 2012

Technical Specifications

Introduction

Overview

• Tasks:
  • Define time schedule together with TT and FT for organize the switch to maven build process
  • Prepare training for all developers who don't know about maven building philosophy and how it works in the ADempiere world

References

Feature Request

1. 3403603 "Mavenize ADempiere" [1]

Related task that includes an analysis of the current ant-based build process

Feature: Cleanup of Ant build scripts

Forum thread about this task

http://sourceforge.net/projects/adempiere/forums/forum/611167/topic/4659270

Maven

home page: http://maven.apache.org/

Maven IDE for eclipse: http://mevenide.codehaus.org/

ADempiere Software development procedure

http://www.adempiere.com/Software_Development_Procedure

Mercurial home page

http://mercurial.selenic.com/

• Mercurial flow extension https://bitbucket.org/yinwm/hgflow/wiki/UserManual

ADempiere HG repo

http://adempiere.hg.sourceforge.net:8000/hgroot/adempiere/adempiere

ADempiere Maven-Repo

http://nexus.adempiere.de/nexus

• Tobi 08:28, 7 September 2011 (UTC) : feel free to contact me for a "deployer" account, meaning that you can deploy artifacts to this repo, if they are not found anywhere else

Development

Directory Layout

common

contains the common code: base, patches-ecs (extracted from tools with a meaningful name)

desktop client

the desktop client

web-client

the various web clients and application, with code separated from webapp to ease dependency management of extensions

JasperReports

the jasper report library, ejb bean, and web application

lagacy

contains unused projects: looks and interface (both was empty), serverApps and serverRoot (what remains after the code and webapp has been extracted), tools, JasperReportsTools, sqlj and posterita

server

the server components, and installation

assembly

the ear assemblies, will contain the webstart client when its ready, and the final assemblies

As of now the ear and war assemblies have still to be finalized, because it will depends on how all of adempiere will be assembled. Webstart client has still to be done, and there are still some directory layout changes that could be done.

Developers

• Tobias Schöneberg
• Banym
• Freepath
• Philip Gossweiler
• Teo Sarca

Please add you here if you want to help.

Testers

Sponsors

Tobi 06:28, 23 November 2011 (UTC) Other developers, testers and so on: feel free to add your company, if it donated time, money or infrastructure (or something else I forgot to mention :-) )

• metas Group (donating office hours)
• Freepath srl (donating office hours)

Branch code

• Branch name is feature/FR3403603_mavenize

Roadmap Document

Use/Extend the table as required

Tracker

• http://sourceforge.net/projects/adempiere/forums/forum/611167/topic/4659270

Migration Script

Oracle

/misc/src/main/resources/migration/370lts-release/oracle/820_FR3403603_drop_MyValidator.sql

PostgreSQL

/misc/src/main/resources/migration/370lts-release/postgresql/820_FR3403603_drop_MyValidator.sql

Install Step

Running the mavenized adempiere-server

• Download and extract the latest snapshot from

http://nexus.adempiere.de/nexus/content/repositories/snapshots/org/adempiere/adempiere-dist-jboss/3.7.0-FR3403603-SNAPSHOT/

• Execute RUN_Setup
  • IMPORTANT Currently, the setup will only work with JBoss
  • After making the settings, the setup process will finish very quickly. This is because most of the thing done by the old process ^have already been done during the maven build
• Import the DB seed (Execute utils/)
• Execute the migration script to get rid of the "MyModelValidator" sample GardenWorld validator
• Start the server with /utils/RUN_Server2.sh

Developing with the mavenized adempiere

Notes:

• We are still looking for better ways to work with the mavenized project(s) and modules
• Currently, we check out the whole thing, which is a big overhead in most cases

Preparations

• Paste this into your local maven settings.xml to access the repository:

<repository>
	<releases>
		<enabled>true</enabled>
		<updatePolicy>always</updatePolicy>
		<checksumPolicy>fail</checksumPolicy>
	</releases>
	<snapshots>
		<enabled>true</enabled>
	</snapshots>
	<id>adempiere-public</id>
	<url>http://nexus.adempiere.de/nexus/content/groups/public/</url>
</repository>

• Make sure that you have maven-3.0.3 installed

mvn --version

• Make sure that the following environment variable is set (following is how to do it on WindowsXP command line)

set MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=256M

Note: maven might have trouble with " signs, so pls be sure not to use them

Building from commandline

• Check out the FR-branch from the adempiere repo
• Go to the checked-out base directory and run

mvn install

This should build adempiere at

/assembly/adempiere-dist/jboss/target

Working with Eclipse

Note Tobi 14:16, 27 November 2011 (UTC)

If you want to work with mavenized adempiere in eclipse, I recomment to proceed as follows.

However, I doubt that this is already the optimal way, so it would be nice if someone found and documented better ways

• Install the m2e plugin
  • I recomment using the external maven-3.0.3 and make sure that this maven installation is also used by the eclipse plugin
    • => Window -> Preferences -> Maven -> Instalations -> "Add-Button"

To make sure that maven runs with enought mem, you can refer to this http://stackoverflow.com/questions/1705736/how-do-i-get-m2eclipse-to-recognize-m2-opts (however, the M2_OPTS solution didn't work for me!) or you can create a launch config and pass the parameters to java that way.

• Important: If you build from command line, while eclipse with the m2e plugin is running, duplicate entries might turn up in artifacts. This will cause the jnlp build to fail, because it can't handle archives with duplicate entries. So, better make sure to close eclipse when running maven from command line.