Development Build Tasks
This document discusses the ant tasks used during the build process of Openbravo ERP. It explains what the ant tasks are used for and which properties can be used to control their behavior. Notice that ant is case sensitive.
Main Build Tasks
This section explains the main build tasks following the steps as illustrated in the image.
In most of the cases it is only necessary to use 3 tasks (install.source, smartbuild and export.database). There are a number of other tasks that can be used but they are not required for the standard process, they are explained in the Detailed Build Tasks section.
The main task for the standard process is smartbuild which performs all the required processes as explained below. This task accepts an optional property:
- local for local or remote developments which by default is set to yes.
The difference between local and remote development is illustrated in the diagram on the right. Local development are changes by the developer him/herself. Remote developments are changes done by other developers. Changes by remote developments are pulled from the source code revision system.
After downloading the Openbravo ERP source files (for example with an hg clone from mercurial). It is necessary to install and deploy it.
The first step is to properly configure all the required configuration files (Openbravo.properties, log4j.lcf, Eclipse's .classpath, etc). All properties are stored in the Openbravo.properties file. This file is not in the base source but it can be easily generated from the Openbravo.properties.template. Another way to set up it is to execute the setup tool for the current platform. (run ant setup).
Note: More about the properties and setup ant task can be found at Openbravo.properties.
After all the properties are configured the following step is to build the application from scratch and to deploy it. All this is done by the install.source task. This task creates the database, inserts sample data on it and compiles and deploys the application accordingly with the chosen deployment mode. To execute it just type in the Openbravo ERP source directory:
Once Openbravo ERP is up and running it is possible to develop on it. Generally, new developments should be done through modules, further explanations about how to develop modules can be found in the Modularity article.
Once the developments are ready to be tested it is necessary to build the application. It is not necessary to do a complete build, but just incremental builds, that is building only what has been modified. This is done with the smartbuild command:
This task generates and compiles the sources for the modified elements, and, depending on the deploy mode, it also deploys them.
To build Openbravo to be deployed on Wildfly, application.server property needs to be set with value
In most cases developments include modifications on the database. This modifications can be persisted in xml files using the DBSourceManager tool. DBSourceManager exports to xml files only the modules (including core) that are set as In Development. To export the database execute:
After this step the changed model xml files can be pushed/committed to the source code revision system, so that other developers can pick them up and continue working on top of it.
When a module is exported using the export.database task it is first validated to check for common errors. If the validation fails then the export.database task will also fail and export is not possible.
The following checks are currently done:
- A table defined in the Application Dictionary should be present in the database and vice versa.
- Column definitions in the database and the Application Dictionary are compared, any mismatch is reported. The column datatype, default value and length are checked.
- Tables should have a primary key.
- Foreign key fields should be part of a foreign key constraint.
- Names of tables, columns and constraints are checked for their length (Oracle has a 30 character limit there).
Database model changes are distributed by committing the database schema as xml to SCM. Other developers pull the changes from SCM and can apply them to update their own database. After updating the database the process is exactly the same as the local one, that is compile and deploy the elements that have been modified since last build. All the required actions (update database, compile last modifications and deploy them) can be done with only the smartbuild command:
ant smartbuild -Dlocal=no # note the -Dlocal=no
The only difference with the local development is in the local parameter which makes the process to update the database in case the xml files were changed.
When a module is packaged with the package.module ant task, then first it is checked for some common errors. If an error is detected then the package.module task will fail.
Specifically the following checks are done:
- A module should depend on the Core module, or depend on a module which depends on the Core module (recursively).
- The path in side the modules/.../src directory must correspond to the javapackage defined for the module.
- The javapackages of the DataPackages which are part of the module must be in line with the Java package defined for the module. So if the module has the javapackage org.example, then all Data Packages should have a Java package which starts with org.example.
- The license type and text must be set.
- If the module is an Industry Template then it must depend on core and the dependency must be set to 'Included'.
- If the module adds UI artifacts such as a window or tab then its 'translation required' field must be set to yes.
Module Consistency Check
An instance is consistent in case the dependencies all the modules it has installed are satisfied. Development instances can define inconsistencies (for example by creating a dependency on a module version which is not installed) whereas production instances where all the modules are installed through obx or Central Repository shouldn't be inconsistent because it is guaranteed by the installation process.
Inconsistent instances can be in a situation where it is not possible to update any of the modules (including core) they have installed. This is due the fact that Central Repository only proposes updates to consistent sets of versions and it is possible the inconsistency cannot be resolved by any.
This ant task helps to detect which are the modules that cause this inconsitency and which are the dependencies that are not satisfied, in this way it makes easier to solve the problem.
Test Ant Tasks
Openbravo has a number of ant tasks for running Junit test cases. The main one is run.tests:
It will run the tests which are side effect free. The test ant tasks assume that the Small Bazaar and Accounting Test clients have been installed.
Detailed Build Tasks
This section contains a detailed listing of all available build tasks.
Libraries build tasks
|core.lib||Compiles and generates a .jar file from the src-core project. Which is needed by wad.lib and the rest of build tasks.|| Required by: wad.lib
|wad.lib||Compiles and generates a .jar file from the src-wad project. Which is needed by the build tasks. This project contains the WAD, the automatic window generator.|| Requires: core.lib, database created
Required by: compile.*
|trl.lib||Compiles and generates a .jar file from the src-trl project. Which is needed by the translate task. This project allows to translate to different languages manual windows.||Requires: core.lib|
|smartbuild|| Makes an incremental build of the application. Including:
All these tasks are done only if needed.
Database must be created and populated with data.
|generate.entities||Generates the Java files for src-gen directory, and compiles them. They are used by DAL to access to the database information.|| Requires:
Database must be created and populated with data.
|install.source||Installs the whole application: creates the database, compiles it and generates a war file to be deployed or copies the classes to Tomcat's directory (depending on the deploy.mode property set in Openbravo.properties).|| Calls:
create.database, core.lib, wad.lib, trl.lib, compile.complete.deploy, applyModule
|compile|| Generates Java classes for the WAD windows that are required, this is, the ones that contain processes with standard UI implemented within 2.50 windows or windows compatible only with 2.50 but not with 3.0; the rest of windows are not generated unless they are forced through || Requires:
wad.lib, trl.lib, database created and populated.
|translate||Checks in the manual windows User Interface files the translateable elements that have not been yet registered and registers them, this is necessary to be able to translate those interfaces to different languages.|| Requires:
Called by: This task is called by the compile.* tasks in case the tr property is not set to "no"
|war||Generates a war file from the existing built code. In fact it only zips the application in a single war file.|| Requires:
compile.*: the application must be built before calling this task.
|deploy.context||Deploy the existing war file in the tomcat context using the tomcat manager.|| Requires:
|update.database||Synchronizes database with the current database xml files. By default it checks that no changes in application dictionary in database are done, if so the process stops.|| Properties:
|create.database|| Creates the database from the xml files, note that the database is first removed.
If the apply.on.create property is set, masterdata and sampledata will be inserted in the database. If not, only sourcedata will be inserted.
|export.database||Synchronizes xml files with the database current contents. By default they are only exported in case there are modifications in the database. In addition performs database validations for the modules which are exported.|| Properties:
export.database tasks support multi-thread parallel execution for some of their actions such as index creation or function standardization. By default, the number of threads used is calculated as the half of the available number of cores in the machine where the task is executed. This value can be set by adding the
|package.module||Validates the module and if no errors are found generates the obx file for the module.|| Properties
|export.config.script||Generates the configuration script for the current active template (if any). More information about Industry Templates and configuration scripts can be found here||Note: export.database must be executed before running this process|
|check.module.consistency||Checks the locally installed modules satisfy all their dependencies, this is, the instance is consistent. In case there are modules that define dependencies that are not installed a message is shown indicating which is the module and which dependency is not satisfied.|
|run.tests||The default, it runs the suite: org.openbravo.test.AntTaskTests. These tests are side effect free and can be run multiple times, after the run the database should be in the same state as before.|
|run.quick.tests||This task runs test cases which are fast and which test the most important parts of the system. It runs the test suite: org.openbravo.test.AllQuickAntTaskTests.|
|run.all.tests||Runs the suite org.openbravo.test.AllAntTaskTests. This suite contains all the test cases, also tests which can change the database.|
|migrate.attachments||Migrates the attachments to the new attachment model. For more information on the new attachment model refer here.|
|host.name|| Prints local host name, to be used to create an instance |