2016/05/28 - Apache Tuscany has been retired.

How to get involved in development of C++ RDB DAS?

This document is the development guideline for C++ RDB DAS project.

• General Guide
• Getting Source code
• Setting up your development environment
• Importing DAS code and samples into your Development IDE
• Testing
• Reporting Issues and Providing patches

General Guide

Welcome to the Tuscany RDB DAS C++ 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.

• C++ RDB DAS sub-project aims to provide enterprise-grade Data Access Service to help SOA applications using SDO have data updates with Database Data Source at backend.
• C++ RDB DAS provides feedback to Tuscany SDO and Spec as it evolves.
• The C++ RDB DAS provides flexibility in accessing data with explicit CRUD as well as using SDO DataObjects.
• The C++ RDB DAS infrastructure is very modularized and is designed to be highly extensible so users can customize it to fit their needs.

Getting Source code

The C++ RDB DAS project Subversion repository is located at https://svn.apache.org/repos/asf/incubator/tuscany/cpp/das .
The repository can also be viewed online at http://svn.apache.org/viewvc/incubator/tuscany/cpp/das
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/cpp/das

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.

Build tree structure

The build tree is designed to facilitate modular development and releases. Maven modules are grouped by how they are released under a hierarchy. C++ RDB DAS currently have the below module hierarchy :

-cpp
 |-- das
     |-- runtime               DAS Source         |-- source             DAS Core Source Code         |-- test                 DAS Test Cases Source Code
     |-- samples              DAS Sample Applications     |-- VSExpress            DAS Visual Studio Express Project Files

Building the RDB DAS source code is simple

Prerequisites

        - Apache Ant with CppTasks and Ant-Contrib
        - Tuscany SDO latest version
        - Visual Studio Express (optional)
 

cd cpp/das
ant

More details about downloading and installing DAS can be found at http://svn.apache.org/repos/asf/incubator/tuscany/cpp/das/GettingStarted.html

Developing RDB DAS using Visual Studio Express IDE

There is a VS solution file under cpp/das/VSExpress/tuscany_das/ that contains all configuration necessary to start developing DAS C++ with your Visual Studio Express.

Testing

All commits are expected to be accompanied by test cases execution. Test cases should verify specific behavior relating to a single class or small set of related classes; integration tests verify code paths across subsystems. Test cases 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. Test cases source code can be found at cpp/das/runtime/test/src/.

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.