Contents
Welcome to CB2SVN, this guide quickly runs through a typical installation. For more detailed instructions, please refer to the other documentation included with this product. For a Linux installation, simply replace all references to c:\Program Files with /opt (or /usr/local if you prefer) and use a terminal window where it refers to 'DOS' below.
Prerequisites
Before you start make sure you have the following setup and available:
a CodeBeamer Server that you can administer
a Subversion Server with authentication enabled
- at least one Client machine
a machine to run the CB2SVN Server (if desired, you can use the CodeBeamer Server machine).
Request a License
Unpack the zip file on the machine that you are planning to use as the CB2SVN Server and run the Clearvision\tools\get_license_info program in a DOS command window. Send the information requested to sales@clearvision-cm.com to apply for a license.
Linux prerequisites
The client executable uses GTK+ on linux, so you might need to install this, for example on CentOS 5 or RHEL 5:
yum install gtk+
(If you see an error with libgmodule.so missing while trying to run the client, then gtk+ is not installed on your system)
Setup CodeBeamer
Create a Report
Create a report to get the list of tracker items that a typical CB2SVN user would be interested in. For example, all outstanding bugs or features for the 'Current User'. Make sure that this report is usable by everyone who will use CB2SVN. Write down the id of the report: a number like '1010'. You can find it at the end of the URL after creating a new report, or when you view a report (look in your browser's location bar and scroll right as far as you can go).
Install & Configure CB2SVN Server
On your CB2SVN Server machine:
unpack the zip file into C:\Program Files.
edit Clearvision\cb2svn\server\cb2svn_server.cfg using Wordpad (not Notepad) and configure the following parameters with values according to your setup, eg for a report id of 1010 and a CodeBeamer server accessible at http://issues.mycompany.com:8080/ (
![/!\](img/alert.png "/!\")
note that the http:// part is not included in the config file):
[CB] report_id=10010 cb_server=http://issues.mycompany.com:8080 [License] company_name=Your Company Plc licence_email=admin@yourcompany.com expiry_date=2008-12-31 users=999 license_key=PLEASE_ADD_YOUR_LICENCE_key_HERE license_certificate=PLEASE_ADD_YOUR_LICENCE_certificate_HERE [Server] server_ip=192.168.1.2 server_port=54325
- open a DOS command window, go to the server directory, then start the server (make it executable first on Linux), eg:
cd c:\Program Files\Clearvision\cb2svn\server cb2svn_server.exe
check the CB2SVN.log file in the server directory for any errors (an empty file indicates no errors).
Install & Configure CB2SVN Clients
On each of the machines that CB2SVN users will be working:
unpack the zip file into C:\Program Files.
edit Clearvision\cb2svn\client\cb2svn_client.cfg and configure the following parameters with values according to your setup:
[CB] cb_uid=joe_bloggs cb_password=my_secret_password [Server] server_ip=192.168.1.2 server_port=54325
if your login id is different to your Subversion user id, also set svn_uid, eg:
[Options] svn_uid=joe_bloggs
open a DOS command window in the client directory and start the client (make it executable first on Linux), eg:
cd c:\Program Files\Clearvision\cb2svn\client cb2svn_client.exe
check the CB2SVN.log file in the client directory for any errors.
Install & Configure Subversion Hooks
On your Subversion Server machine:
unpack the zip file into C:\Program Files.
copy all of the files from Clearvision\cb2svn\subversion_hooks into the hooks directory of your Subversion server.
- on Linux, make all of the hook scripts executable (ie everything except the config file)
edit the config file (cb2svn_hook.cfg) that is in your Subversion hooks directory and configure the following parameters with values according to your setup, for example, if your CB2SVN Server is at IP address 192.168.1.2 and is licensed for port 54325:
[Server] server_ip=192.168.1.2 server_port=54325
Test it!
Now that you have:
configured CodeBeamer for CB2SVN
- started a CB2SVN Server
- are running at least one CB2SVN Client
- and have installed all of the CB2SVN hook programs into your Subversion repository
you are ready to test the system by committing a change to Subversion. On the machine that is running the CB2SVN Client:
- check out a working copy from your repository
- make a change to a file
- commit that change as the user id you configured for this client (eg joe_bloggs above), eg
svn commit myfile.txt --username joe_bloggs
You should see the CB2SVN client GUI pop-up to allow you to select the list of issues that were resolved by this change. Select one and select OK to close the pop-up window.
Verify Results
To check that CB2SVN worked fully, go to the SCM Repository tab for your project in CodeBeamer, find your commit in the table below and check that the tracker item you selected appears in the Tasks column.
Then, check the link back to CodeBeamer in Subversion by looking at the 'clearvision:change_id' revprop with this command:
svn proplist -rHEAD --verbose --revprop .
Copyright (c) 2009 Clearvision CM All Rights Reserved Registered in England No. 5643578 VAT Registration No. UK881364801 Registered Address Laurel Farm, Winters Hill, Durley Southampton, SO32 2AH