Skip to content

Latest commit

 

History

History
131 lines (84 loc) · 8.89 KB

README.md

File metadata and controls

131 lines (84 loc) · 8.89 KB
Raw

Introduction

The RISCOSS project will offer novel risk identification, management and mitigation tools and methods for community-based and industry-supported OSS development.

RISCOSS will deliver a decision-making management platform integrated in a business-oriented decision-making framework, which together support placing technical OSS adoption decisions into organizational, business strategy and broader OSS community context.

This is the main repository for the RISCOSS Platform code.

Project structure

The project structure reflects the structure of the RISCOSS Platform architecture:

  • riscoss-platform-dm contains the code of the Domain Manager (DM)
  • riscoss-platform-rdr contains the code for the Risk Data Repository (RDR)
  • riscoss-platform-analyser is the engine which calculates risk based on data-points stored in the RDR.
  • riscoss-platform-jsmile is a wrapper around the proprietary jSmile project which is used by the riscoss-platform-analyser.

Please refer to the RISCOSS White Paper for a more detailed description.

Building

Prerequisites

In order to build the RISCOSS Platform you need to:

  • Install Java JDK7
  • Install Maven 3.0.5
  • Set the environment variable MAVEN_OPTS to the value -Xmx1024m -XX:MaxPermSize=256m
  • Put the file settings.xml in your local Maven directory (usually located under .m2 in your home directory). The settings.xml file is available in the etc directory of this repository.
  • Donwload and copy the Smile binary library to riscoss-platform-jsmile/src/main/resources/. The library to copy depends on your operating system. For Linux/X86_64 it's called libjsmile.so

How to build

To build the RISCOSS Platform just run the command mvn install from the root directory.

Depending on your connection speed, and the number of artifacts to download, it will take between 5 and 20 minutes to build the whole platform.

Deploying the RISCOSS Platform (single domain)

After having built the RISCOSS Platform you will need the following artifacts in order to deploy it:

  • The RISCOSS Platform Domain Manager WEB application, located in riscoss-platform/riscoss-platform-dm/riscoss-platform-dm-war/target
  • The RISCOSS Platform Domain Manager XAR application, located in riscoss-platform/riscoss-platform-dm/riscoss-platform-dm-distribution/riscoss-platform-dm-ui-wiki-all/target
  • The RISCOSS Platform Risk Data Repository WEB application, located in riscoss-platform/riscoss-platform-rdr/riscoss-platform-rdr-war/target
  • A servlet container
  • A database driver

In this document we will deploy the RISCOSS Platform using Tomcat 7.0 and the HSQLDB database.

Installing Tomcat

Please refer to http://tomcat.apache.org for installation instruction.

Unpacking RISCOSS Platform WEB applications

  • Create a directory riscoss in the webapps directory of your Tomcat installation.
  • Unpack the RISCOSS Platform Domain Manager WEB application in this directory using the command jar xvf riscoss-platform-dm-war-VERSION.war
  • Create a directory rdr in the webapps directory of your Tomcat installation.
  • Unpack RISCOSS Platform Risk Data Repository WEB application in this directory using the command jar xvf riscoss-platform-rdr-war-VERSION.war

Installing the database driver

  • Download the HSQLDB database driver from http://search.maven.org/remotecontent?filepath=hsqldb/hsqldb/1.8.0.10/hsqldb-1.8.0.10.jar
  • Copy it under webapps/riscoss/WEB-INF/lib of your Tomcat installation

Starting the server and installing the RISCOSS Platform Domain Manager XAR application

  • Open the file webapps/riscoss/WEB-INF/xwiki.cfg and uncomment the line xwiki.superadminpassword=system
  • Start the Tomcat server using the script bin/startup.sh in your Tomcat installation.
  • Open a browser and go to the following URL: http://localhost:8080/riscoss/bin/login/XWiki/XWikiLogin
  • Login as superadmin with password system
  • In the top Wiki: xwiki menu choose Administration
  • Click on the button Choose a file and select on your filesystem the file riscoss-platform-dm-ui-wiki-all.xar located in riscoss-platform/riscoss-platform-dm/riscoss-platform-dm-distribution/riscoss-platform-dm-ui-wiki-all/target of the source code repository
  • Click on the link riscoss-platform-dm-ui-wiki-all.xar in the availabe packages section. A list of documents should appear on the right half of the page.
  • Go down this list and click on the Import button
  • Once finished click on the Log-out button on the top right
  • You can now re-login using the Admin user name, and admin as a password.

The RISCOSS Platform Domain Manager is built on top of the XWiki Platform. For more information you can also look at http://platform.xwiki.org/xwiki/bin/view/Main/Documentation

How to contribute

In this section we will describe how to contribute to the RISCOSS platform.

Let's say that you want to contribute to the riscoss-platform repository. The first thing that you will do is to create a clone of the repository on Gitorious:

  • Go to the repository home page: http://gitorious.ow2.org/riscoss/riscoss-platform
  • Click on the "Clone repository" button.
  • Give a name for the cloned repository. Gitorious will propose you a name consisting of your user name followed by the original repository name. You can keep it and click directly on the "Clone repository" button.

Once the clone is completed you will be redirected to the home page of your cloned repository that resides under your account.

Now you can clone the private repository on your computer by using git. Select and copy the SSH clone URI from the Gitorious page, and paste it on the git command line: git clone SSH_CLONE_URI_FOR_YOUR_PRIVATE_REPOSITORY

Setup the upstream remote for pulling changes from the original repository. Go to the original project repository (i.e., http://gitorious.ow2.org/riscoss/riscoss-platform) and select and copy the GIT clone URI from the Gitorious page, and paste it on the git command line: git remote add upstream GIT_URI_OF_THE_ORIGINAL_REPOSITORY

What we did here? We added a remote for retrieving changes form the original repository (see later).

If you type git remote -v you should see something like this:

origin	[email protected]:~fmancinelli/riscoss/fmancinellis-riscoss-platform-dev.git (fetch)
origin	[email protected]:~fmancinelli/riscoss/fmancinellis-riscoss-platform-dev.git (push)
upstream	git://gitorious.ow2.org/riscoss/riscoss-platform-dev.git (fetch)
upstream	git://gitorious.ow2.org/riscoss/riscoss-platform-dev.git (push)

For the upstream repository we used the GIT clone URI because it is read-only. This would prevent us to mistakenly commit to the original repository.

At this point you have a working copy of the RISCOSS platform on your computer. You must do these steps only ONCE, the first time you clone a repository.

Before you start to write anything, create a branch by giving it a meaningful name about what you will be coding. You can do it with this command: git checkout -b BRANCHNAME

You can always check on which branch you are by using the git branch command. The current branch is the one with a * next to it.

Now you can really start to code. Write your code and commit it periodically as you advance.

Since in the meanwhile the master branch could have had some changes, you must periodically merge these changes to your branch in order to always have an up-to-date version of the code base. You can do it with the following command: git pull upstream master

This will retrieve all the latest commit from the master branch of the upstream remote (i.e., from the original repository) and merge them to your local branch.

When you're satified with the state of the code and want to make it become part of the RISCOSS Platform you will have to create a merge request:

  • Push your local branch to Gitorious: git push origin BRANCHNAME
  • Go to the Gitorious page of your private repository and click on the Request merge button.
  • Fill the forms with useful information about your work.
  • Select the target repository where you want the changes to be merged, in this case riscoss-platform
  • Select the target branch where you want the changes to be merged, in this case master
  • Select the source branch from where to take the changes, in this case BRANCHNAME (i.e., the name you gave to the branch that you pushed)
  • Select the commit that represet the state of the code that you want to merge
  • Click on "Create merge request"

At this point you're done. A new merge request will be added to the original repository so that it can be code-reviewed and, if everything is fine, it can be finally merge into the master branch of the riscoss-platform becoming part of it.