SCA Java Development Guide

Unknown macro: {bgcolor}

General Guide

">

Unknown macro: {bgcolor}

General Guide

Welcome to the Tuscany SCA Java subproject project. We look forward to your participation and try to help you get on board. Feel free to ask your questions on the mailing list.

Here are some general guidelines we use in this project.

• Java SCA sub-project aims to provide enterprise-grade service infrastructure based on SCA.
• Tuscany SCA is not just a reference implementation. We encourage innovation based on the tenets of SCA. A lot of work we do provides feedback to the specifications.
• The Java SCA infrastructure should provide flexibility and choice. It should not dictate programming models but support many.
• The Java SCA infrastructure is very modularized and is designed to be highly extensible so users can customize it to fit their needs.

Unknown macro: {bgcolor}

Getting Source

">

Unknown macro: {bgcolor}

Getting Source

The Java SCA project Subversion repository is located at https://svn.apache.org/repos/asf/incubator/tuscany/java/sca.
The repository can also be viewed online at http://svn.apache.org/viewvc/incubator/tuscany/java/

Anyone can check code out of Subversion. You only need to specify a username and password in order to update the Subversion repository, and only Tuscany committers have the permissions to do so.

Checking out code from Subversion

Use the command as follows (note that it uses http scheme so if you're a committer change it to https):

svn checkout http://svn.apache.org/repos/asf/incubator/tuscany/java/sca

Committing Changes to Subversion

Any Tuscany committer should have a shell account on svn.apache.org. Before you can commit, you'll need to set a Subversion password for yourself. To do that, log in to svn.apache.org and run the command svnpasswd.

Once your password is set, you can use a command like this to commit:

svn commit

If Subversion can't figure out your username, you can tell it explicitly:

svn --username <name> commit

Subversion will prompt you for a password, and once you've entered it, it will remember it for you. Note this is the password you configured with svnpasswd not your shell or other password.

Unknown macro: {bgcolor}

Setup your Development Environment

">

Unknown macro: {bgcolor}

Setup your Development Environment

Prerequisites

Java SCA requires the following:

• JDK 5.0+ (J2SE 1.5.0+)
• Apache Maven (2.0.4+)
• Subversion (1.2+)

Build tree structure

The build tree is designed to facilitate modular development and releases. Maven modules are grouped by how they are released under an hierarchy. Java SCA currently have the below module hierarchy :

-java
 |-- sca
     |-- demos                SCA demo applications
     |-- distribution         SCA distributions
     |-- itest                SCA Integration Tests
     |-- modules              SCA Implementation Modules (core, runtimes, contribution, extensions, etc)
     |-- samples              SCA Sample Applications

The individual modules can be built separately or build with top-down build.

top-down build (recommended approach)

Check out all of the java source code.

svn checkout http://svn.apache.org/repos/asf/incubator/tuscany/java

Building the SCA source code is simple

cd java/sca
mvn

It should work even if you start with an empty Maven local repository, and it should always work. This assumes that maven is able to retrieve a SNAPSHOT version of SDO (and of course the rest of software that SCA depends on) as we haven't built anything other than SCA here.

There can be occasional problems downloading artifacts from remote Maven repositories so if mvn fails with network related sounding messages sometimes just trying again can fix the problem.

Once you have done a top-down build, and your local maven repository is populated, you can start using the maven off line option to speed up the build process

mvn -o

Unknown macro: {bgcolor}

Importing SCA modules into your Development IDE

">

Unknown macro: {bgcolor}

Importing SCA modules into your Development IDE

Using Eclipse

If this is the first time you are using your workspace with maven m2 local repository, you will need to tell your Eclipse workspace the location of the directory, and you can do this with the following command :

mvn -Declipse.workspace=[path-to-eclipse-workspace] eclipse:add-maven-rep

In order to generate the necessary project files to import the SCA modules to Eclipse, you can use the maven eclipse plugin

cd java/sca
mvn -Peclipse eclipse:eclipse

Now, launch your Eclipse IDE, select File->Import->Existing projects into Workplace, and then select the base SCA directory (e.g java/sca) and then press Finish, this should import all SCA modules into your Eclipse Workspace.

Unknown macro: {bgcolor}

Coding Guidelines

">

Unknown macro: {bgcolor}

Coding Guidelines

There are a few simple guidelines when developing for JAVA SCA:

• Formatting standards are defined by the .checkstyle and .pmd configurations in the source repository. Please be sure to check code is formatted properly before doing a checkin (see below). If you are unfamiliar with Checkstyle or PMD, please see http://checkstyle.sourceforge.net/ and http://pmd.sourceforge.net/. Consistent formatting makes it easier for others to follow and allows diffs to work properly.

• Always include the Apache License Headers on all files and the following version tag:

@version $Rev$ $Date$

• Please attempt to accompanied code with at least unit tests or verify it by existing tests before submitting a patch or checking in.

• Do not checkin IDE-specific resources such as project files.

• Prior to check-in, perform a clean build and run the complete battery of unit tests for the current module from the command line with Checkstyle enabled, as in:

mvn clean
mvn -o -Psourcecheck

• Please do not perform a checkin using an IDE as doing so is frequently problematic.

• Include a descriptive log message for checkins, for example "fixed such and such problem".

Naming conventions to increase consistency

Folder Names: Please use all lowercases and dashes in folder names (like in the jar names)

• Maven artifact id = tuscany-<folder name>

Package names: Package names within modules should include the module name so that source code can be located in the source tree easily. So, for example, java/sca/module/implementation-java would be in package structure org.apache.tuscany.implementation.java.*

Unknown macro: {bgcolor}

Testing

">

Unknown macro: {bgcolor}

Testing

All committs are expected to be accompanied by unit test and integration tests when appropriate. Unit tests should verify specific behavior relating to a single class or small set of related classes; integration tests verify code paths across subsystems. Testcases should be documented and clearly indicate what they verify. Also, avoid things that may cause side-effects when possible such as access of external resources.

Tuscany uses plain junit test cases to perform unit and integration testing, below is an example that can also be used as a template for writing new test cases; it demonstrates how to bootstrap the Tuscany SCA runtime in your test case, and because they are based on junit, you can run it from your IDE of choice or from Maven.

/**
 * Description of your test case and necessary details you find necessary
 */
public class YourTestCase extends TestCase {
    private SCADomain domain;
    private YourService service;


    @Override
    protected void setUp() throws Exception {
    	domain = SCADomain.newInstance("YourTest.composite");
        service = domain.getService(YourService.class, "serviceName");
    }

    @Override
    protected void tearDown() throws Exception {
    	domain.close();
    }


   ...
}

Note that we use surefire maven plugin to run the unit and integration tests, and in most cases, they are configured to match a **/*TestCase.java file name pattern. Because of this, if your test case has a different file name pattern, you might execute it from your IDE of choice, but the maven build won't execute the test.

We encourage and follow continuous integration. Martin Fowler has a concise write-up here

Unknown macro: {bgcolor}

Maven Build Structure

">

Unknown macro: {bgcolor}

Maven Build Structure

We use the term Module to refer to the leaf of maven tree.

• sca/pom.xml's parent will be pom/parent/pom.xml
• Other poms will use the pom from the parent folder as parent pom
• Group id: org.apache.tuscany.sca
• Version of our modules will be specified once in java/sca/pom.xml, child poms don't need specify a version as they get it from their parent
• pom names begin Apache Tuscany SCA
• Eclipse projects are generated for all built modules using mvn -Peclipse eclipse:eclipse

Adding a new module and not ready to integrate?

'work-in-progress' modules can be worked on in the same source tree and yet not break the top-down build. You can do this by not listing your module(s) in java/sca/modules/pom.xml.

Unknown macro: {bgcolor}

Reporting issues and providing patches

">

Unknown macro: {bgcolor}

Reporting issues and providing patches

Issue Tracking

Tuscany bug reports are handled via a JIRA issues list. Please use this list to report any bugs and track their status.

Reporting an Issue

Please search JIRA to see if the problem has already been reported. If it has not, please create a new JIRA issue. To help developers quickly resolve an issue, include as much information with your report as possible such as your platform, version numbers, error logs, configuration, steps to reproduce the problem, etc. Also, if possible, please include a testcase that demonstrates the problem.

Thanks for working with us to improve Apache Tuscany.

Submitting a Patch

To submit a patch, create an issue in JIRA that describes the problem and attach your patch file. Please include detailed steps to reproduce the problem in the issue description. Providing test cases in the patch will help us verify and apply it quicker. To create a patch, follow the steps below:

• Perform a full build with all tests enabled for the module the fix is for. Specific build procedures vary by sub-project.
• Confirm that the problem is fixed and include testcases where possible
• Generate the patch using svn diff File > patchfile
• Try to give your patch files meaningful names, including the JIRA number
• Add your patch file as an attachment to the associated JIRA issue

Once you have submitted the patch it will be picked up for review.