|
|
| (3 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | = Setting up an Environment for the OSLC Workshop =
| + | '''This documentation has moved to its new site under the [https://oslc.github.io/developing-oslc-applications/tutorials.html OSLC Developer Guide].''' |
| − | | + | |
| − | == OSLC Workshop ==
| + | |
| − | | + | |
| − | The OSLC Workshop was originally designed to go along with a VMWare image which had all of the prerequisites installed and the projects pre-loaded in the Eclipse IDE. These instructions are intended to help you run the workshop outside of VMWare in your own Eclipse IDE.
| + | |
| − | | + | |
| − | == Bugzilla ==
| + | |
| − | | + | |
| − | The workshop takes you through a scenario where you build an OSLC Adapter for the Bugzilla open source bug tracking tool. You must have access to a Bugzilla 4.0.x or higher server. By default, the workshop Lab projects are configured to use a public Bugzilla server on the internet called [https://landfill.bugzilla.org/bugzilla-4.0-branch/ landfill]. If you want to use landfill, you will need to [https://landfill.bugzilla.org/bugzilla-4.0-branch/createaccount.cgi create a new account].
| + | |
| − | | + | |
| − | Alternatively, you can install your own Bugzilla server from the [http://www.bugzilla.org/releases/4.0.5/ Bugzilla project home]. You will need to ensure that Bugzilla's XML-RPC support is working. The SOAP::Lite and Test::Taint Perl modules must be installed for XML-RPC to work. See the Bugzilla installation and configuration [http://www.bugzilla.org/docs/4.0/en/html/installing-bugzilla.html documentation] for details.
| + | |
| − | | + | |
| − | == Rational Jazz tools ==
| + | |
| − | | + | |
| − | An optional Lab in the workshop works through connecting the Bugzilla OSLC adapter to a Rational Jazz tool supporting OSLC such as Rational Team Concert. If you wish to run this Lab, you will need administrative access to an RTC server of your own. If you wish to install your own server with a trial license, it can be found [https://jazz.net/downloads/rational-team-concert/releases/4.0 here].
| + | |
| − | | + | |
| − | == Eclipse IDE Prerequisites ==
| + | |
| − | * [http://eclipse.org/downloads Eclipse 3.6 or higher IDE]
| + | |
| − | * [http://eclipse.org/egit/download/ EGit] team provider.
| + | |
| − | * [http://www.eclipse.org/m2e/download/ m2eclipse] for Maven support in the Eclipse IDE
| + | |
| − | | + | |
| − | == Clone the Lyo Git repositories ==
| + | |
| − | | + | |
| − | You will need to clone three Lyo Git repositories to get all of the code needed for the workshop.
| + | |
| − | | + | |
| − | # org.eclipse.lyo.core.git: Lyo OSLC4J
| + | |
| − | # org.eclipse.lyo.server.git: Lyo OAuth provider
| + | |
| − | # org.eclipse.lyo.docs.git: Lyo OSLC Workshop source code and documentation
| + | |
| − | | + | |
| − | | + | |
| − | * Open the Git Repositories view in Eclipse and click the Clone Git Repository icon
| + | |
| − | * Use git://git.eclipse.org/gitroot/lyo/org.eclipse.lyo.core.git as the URI. User/Password are not required.
| + | |
| − | [[Image:Lyo-core-git-repo.png]]
| + | |
| − | * On the Branch Selection page, select the master branch
| + | |
| − | * On the Local Destination page, specify a location or accept the default and click Finish
| + | |
| − | | + | |
| − | Repeat the above steps for '''org.eclipse.lyo.server.git''' and '''org.eclipse.lyo.docs.git.'''
| + | |
| − | | + | |
| − | The repositories should now show up in your Git Repositories view. Next step is to import the projects.
| + | |
| − | | + | |
| − | == Import Eclipse projects from the git repository ==
| + | |
| − | # Import projects for OSLC4J
| + | |
| − | #* In the Git Repositories view, right click org.eclipse.lyo.core and select Import Projects
| + | |
| − | #* Select the Import Existing Projects wizard and click next
| + | |
| − | #* Import the projects you want. At a minimum, you must import
| + | |
| − | #** OSLC4J
| + | |
| − | #** OSLC4JJenaProvider
| + | |
| − | #** OSLC4JJson4JProvider
| + | |
| − | #** OSLC4JWink
| + | |
| − | # Import projects for the Lyo OAuth provider
| + | |
| − | #* In the Git Repositories view, right click org.eclipse.lyo.server and select Import Projects
| + | |
| − | #* Select the Import Existing Projects wizard and click next
| + | |
| − | #* Import the projects you want. At a minimum, you must import
| + | |
| − | #** org.eclipse.lyo.server.oauth.consumerstore
| + | |
| − | #** org.eclipse.lyo.server.oauth.core
| + | |
| − | #** org.eclipse.lyo.server.oauth.webapp
| + | |
| − | # Import projects with the Workshop documentation
| + | |
| − | #* In the Git Repositories view, right click org.eclipse.lyo.docs and select Import Projects
| + | |
| − | #* Select the Import Existing Projects wizard and click next
| + | |
| − | #* Import the projects you want. At a minimum, you must import
| + | |
| − | #** Lab1 - Lab6
| + | |
| − | #** ninacrm
| + | |
| − | #** LabMiscellaneous
| + | |
| − | | + | |
| − | Along with the Lab projects there is a project called OSLC4JBugzilla. This is the completed OSLC Bugzilla adapter.
| + | |
| − | | + | |
| − | = Getting started with the Workshop =
| + | |
| − | The Lab 1 content includes a PDF with the workshop documentation. The documentation currently includes references to the VMWare image users and passwords and URLs which will only work if the hostname you are working on is "oslc". To have these URLs work on your system, give your systems loopback address (127.0.0.1) an additional hostname of oslc:
| + | |
| − | * On a Linux, Mac or other Unix system, edit /etc/hosts. On Windows, edit \Windows\system32\drivers\etc\hosts
| + | |
| − | * Add oslc as a hostname for 127.0.0.1. Example: 127.0.0.1 localhost oslc
| + | |
| − | | + | |
| − | == Configuring the Bugzilla server and user ==
| + | |
| − | Instead of bugs@localhost.here as the user, you will need to use a login for your Bugzilla server, whether that is on landfill or on your own Bugzilla server. To configure the adapter with your Bugzilla server location and user:
| + | |
| − | | + | |
| − | * Each Lab project as a file called '''bugz.properties''' in the '''src/main/resources''' folder. Edit this file
| + | |
| − | * set the value of '''bugzilla_uri''' to the base URI of your Bugzilla server (default is landfill)
| + | |
| − | * set the value of '''admin''' to your Bugzilla user (e-mail address)
| + | |
