This document is the development guideline for SCA Java project.
GeneralGuide"> General GuideWelcome 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.
Prerequisites"> PrerequisitesJava SCA requires the following: GettingSourcecode"> Getting Source codeThe Java SCA project Subversion repository is located at https://svn.apache.org/repos/asf/tuscany/branches/sca-java-1.x/sca. 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 SubversionUse 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/tuscany/branches/sca-java-1.x/sca Committing Changes to SubversionAny 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. Tuscany committers should configure these properties in the svn per-user config. On Unix-like systems, this area appears as a directory named .subversion in the user's home directory. On Win32 systems, Subversion creates a folder named Subversion, typically inside the Application Data area of the user's profile directory (C:\Documents and Settings\<user name>\Application Data\Subversion, which, by the way, is usually a hidden directory). Please make sure the following properties are set in the "config" file: [miscellany] ... enable-auto-props = yes [auto-props] ### The format of the entries is: ### file-name-pattern = propname[=value][;propname[=value]...] ### The file-name-pattern can contain wildcards (such as '*' and ### '?'). All entries which match will be applied to the file. ### Note that auto-props functionality must be enabled, which ### is typically done by setting the 'enable-auto-props' option. *.c = svn:eol-style=native *.cpp = svn:eol-style=native *.h = svn:eol-style=native *.dsp = svn:eol-style=CRLF *.dsw = svn:eol-style=CRLF *.sh = svn:eol-style=native;svn:executable *.txt = svn:eol-style=native *.png = svn:mime-type=image/png *.jpg = svn:mime-type=image/jpeg Makefile = svn:eol-style=native *.java = svn:eol-style=native;svn:keywords=Rev Date *.xml = svn:eol-style=native;svn:keywords=Rev Date *.xsd = svn:eol-style=native;svn:keywords=Rev Date *.html = svn:eol-style=native;svn:keywords=Rev Date *.properties = svn:eol-style=native;svn:keywords=Rev Date *.jelly = svn:eol-style=native;svn:keywords=Rev Date *.ipr = svn:eol-style=native *.iml = svn:eol-style=native 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. SettingupyourDevelopmentEnvironment"> Setting up your Development EnvironmentBuild tree structureThe 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 |-- tools SCA Tools (Eclipse plugins, wsdl2java, java2wsdl, etc) |-- tutorial SCA Tutorial 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/tuscany/branches/sca-java-1.x Building the SCA source code is simple cd sca-java-1.x/sca mvn It should work even if you start with an empty Maven local repository, and it should always work, however when you are building for Tuscany for the first time there are a lot of dependencies which must be downloaded so the first build can take a long time and it may fail with problems retrieving the dependencies. 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. The trunk code sometimes has SNAPSHOT dependencies which can get out of date in your local repository so if you see odd build failures try updating the SNAPSHOT jars with: mvn -U 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 The SCA build consumes a good amount of memory, in case you are seeing issues during the build, set a MAVEN_OPTS environment variable to allocate more memory for the build process. Windows : SET MAVEN_OPTS=-Xmx512m The "trunk" is always in very active development, and sometimes you might experience issues trying to build some modules, in that case you can tell maven to continue building other modules mvn -fae clean install or either skip all unit tests mvn -fae -Dmaven.skip.test=true clean install or run tests, but do not stop building if one of the tests fails mvn -fn clean install Buildingthebinaryandsourcedistributions"> Building the binary and source distributionsThe binary and source distribution release artifacts are created by running maven in the distribution folder, for example: cd java/sca/distribution mvn clean install -o The distribution artifacts can then be found in the folder named "target" within the distribution folder. ImportingSCAmodulesintoyourDevelopmentIDE">Importing SCA modules into your Development IDEUsing EclipseIf 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-repo 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. There are some Tuscany Eclipse code templates available: UnderstandingSCAcodepath"> Understanding SCA code pathHere is a walk through of [key methods/functions] which help you get started with SCA Java development. CodingGuidelines"> Coding GuidelinesThere are a few simple guidelines when developing for JAVA SCA:
Some other useful suggestions: Clean Code
Unit/Integration Tests
Formatting
While Tuscany does not yet have an official style or template, here are some templates that folks have been using and have been checked into the build which are stored at https://svn.apache.org/repos/asf/tuscany/java/etc/ Naming conventions to increase consistencyFolder Names: Please use all lowercases and dashes in folder names (like in the jar names)
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.* Testing"> TestingTuscany 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. MavenBuildStructure"> Maven Build StructureWe use the term Module to refer to the leaf of maven tree.
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. Reportingissuesandprovidingpatches"> Reporting issues and providing patchesError formatting macro: include: java.lang.IllegalArgumentException: No link could be created for 'TUSCANYxDOCx2x:Found a Bug Section'.
Unknown macro: {HTMLcomment}
Development HintsGeneratingEclipseWTPWebProjectsforWebappsamples"> Generating Eclipse WTP Web Projects for Webapp samplesIf you're using Eclipse WTP and want to get WTP Web Projects generated The magic -Dwtpversion=1.5 option will add the WTP Web project nature to h3: Generating Dependencies for Ant in Samples Figuring out the package dependency to include in Ant build.xml can be a pain. Here is a quick jar tvf sample-feed-aggregator-webapp.war | grep .jar | awk '{ printf "%s\n", $8 }' | sed -e "s/WEB-INF\/lib\///" | awk '{ printf "<include name=\"%s\"/>\n", $1 }' | grep -v tuscany HowtodoareleaseofTuscany?"> How to do a release of Tuscany?Here is the Checklist for doing a Tuscany SCA Java release . |