FusionForge

Import Export Plugin

From FusionForge Wiki
Revision as of 18:32, 28 May 2014 by Nioniosfr (talk | contribs) (Added web featuresdecisions for the interface. More to be added.)

Jump to: navigation, search
Name
Project Import/Export Plugin
Description
The import/export plugin aims to ease the migration of project data between forges. Goal is to allow interoperability between projects hosted on different forges. As data in these forges are usually locked, which means that its quite easy to start a new project but it is not as easy if the project is already mature and the developers decide to migrate to a different forge system.This project will try to solve the following use cases:
  • Export a project from FusionForge, along with all its information (issues, trackers, etc.).
  • Import a project to FusionForge that has been exported from another forge.
  • Ideally define a common standard to represent the data in such way to be easily consumable by other services.

The project will make use of the OSLC format as it was defined by the COCLICO project. More details can be found in the specification; also take a look at ForgePlucker (and the coclico fork).

Directory
/plugins/project_import-export
Plugin Changelog
Plugin Changelog for project_import-export
Maintainer(s)
Status
in development
Compatibility
Matrix by Fusionforge Version and by Linux Distribution
distribution\version 4.8.x 5.0.x 5.1.x 5.2.x 5.3.x 6.0.x master
Debian undefined undefined undefined undefined undefined undefined undefined
CentOS undefined undefined undefined undefined undefined undefined undefined



Related tasks

  • import/export for Mediawiki_Plugin, including for private projets (currently: daily XML export for public projects only)
  • import/export for Mailman users and configuration
  • mass import/export for Mailman archives (currently: only per-month archive mbox with e-mail obfuscation)

Useful links and resources


Building blocks

The import export plugin will have to support different formats as exported from the different types of platforms.


GitHub


GitHub provides an API for developers to access the public or private repositories of its users, as well as all their metadata.

Access to the API is via HTTP GET requests and the user authentication can be realised via basic authentication (username, password) or OAuth2 authentication.

The format of the response can be returned in JSON among other. More information about media types.

An example cURL request to retrieve all the issues of the project redcarpet of user vmg.

$ curl -i "https://api.github.com/repos/vmg/redcarpet/issues"


MediaWiki


As stated in the related tasks section, mediawiki pages should also be available for export.

The current method of exportation is defined in the mediawiki plugin page


Google Code


Currently there are many different types of plugins available for extracting the project metadata from Google Code web-site.

A few of these project can be found with a simple search (GitHub project, forgeplucker on gitorious).

There is also an API provided by Google for the issue trackers, but as stated on the official documentation it has been declared as deprecated.


Relevant links


Web Interface Features

The user interface for the import/export plugin will focus on having a clear design. The main access point to the plugin will be a tab under the project's navigation bar, similar to SCM tab for instance. All users will have access to the plugin and it's functionality since it is aimed to promote interoperability.

Since each project can define private and public data, the project's user restrictions will also apply to the import/export plugin's exposed data. Non project members will still have access to the public data and will be able to export those (considering there are public data available).

Design and linking

Design and linking are necessary tasks for the future development of import/export. The user interface will comply with the rest of the FusionForge design principles.

Below are the task that are under implementation.

Import


Select the source to import from

When a user will use the import/export plugin will have the choice to select among different project platforms and select the one he wants to import project data from (Google code, SourceForge, etc.)

Select the objects within FusionForge to import to

At least during the first releases, the plugin will require the user to specify for which objects/categories of FusionForge data are going to be imported. This most likely will change in the future but as of time of writing it is considered as a feature of the web interface.

Select a file to import from

Users will also given the posibility to upload a file from where data can be imported in FusionForge.

Export


Select the format to use for exportation

The export feature will be compliant with different types of formats The user will have the option to select whether the export file will be a comma seperated value of a JSON file for example.

Select the categories of project data to export

Since not all project data will be accessible by everyone, the user will be given the option to reviw which parts should be extracted. This can be considered either as a table with a checkbox next to each category, or a multi-select element where again the user can select multiple entries.

This approach aims to eleiminate the confusion between what data are publicly accessible (for non project members), as well as an overview of which data the user is willing to export (issues, mailing lists, files, etc.).

Web Interface development

The development for the web interface will happen in parallel to the added functionality in the plugin's source code. There will be an effort to always contribute finalized tasks with their equivelant web interface (whenever applicable).