Development

Developing sw360

The sw360 is Java-based application consisting of two main parts:

1. A Liferay/based front end application that allows users to work with sw360
2. A Java-based servlet infrastructure Thrift interfaces that allows the Liferay part and other applications to manage and store data
3. In the backend, couchdb is used for storing project, component, release and license information as well as attachments.

Submitting Issues

Please report issues to the issue tracker, but please keep also in mind that someone else has to read them! Issues should include:

• What you intended to do?
• What did you observe?
• Why do you think it is wrong?
• Screenshots of what you have observed presumably gone wrong or link to pages were another person can follow
• Version where you have observed this.
• Common written English and use of line breaks!!! Use the preview function!

Please refer to the following pages for writing issues:

• https://issues.apache.org/bugwritinghelp.html
• https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
• https://www.joelonsoftware.com/2000/11/08/painless-bug-tracking/

Contribution Workflow

As basic introduction, the dev ops works as following:

1. We are issue-based, please do not hesitate to create issues - also for questions (and set the issue tag)
2. The issues are organised by milestones which do not represent releases anymore. Milestone are meant to be useful packages of work done
3. Contributions are made through pull requests
4. We do conversations directly on issues and pull requests

More topics regarding “how” to develop:

1. Definition of done and code style
2. Creating a sw360 release
3. Brief notes on the jgiven testing
4. For help with problems, you might want to check that

Architecture

sw360 is a server application using Java servlets. It did some faint steps towards micro services (ie. one maintaining licenses, another for vulnerabilities), the front end is a portlet applications using good old JSPs.

1. Introduction and Scope
2. High Level View
3. Architecture Topics

General

1. How to write a new portlet
2. Adding a new backend service
3. Changing the data model
4. REST API overview
5. Migrating to Javascript modules

Special

1. Filtering in portlets
2. The FOSSology integration
3. How moderation requests work
4. Roles and access rights
5. Attachment Types Description
6. Our ideas of Google-Summer-of-Code 2019
7. How Friendly URLs work with the Liferay Portlets

Testing sw360

Generally, all modules have unit tests and these are executed (including deployment of couchdb) at CI times. In addtion, to test the front end, there are defined integration test cases for a manual check, if the sw360 is working properly in general:

1. Test Cases: Components Functionality
2. Test Cases: Licenses Functionality
3. Test Cases: Moderations Functionality
4. Test Cases: Projects Functionality