TestDirector Version Control Add-in Installation Guide

Transcription

1 TestDirector Version Control Add-in Installation Guide

2 Borland Software Corporation 100 Enterprise Way Scotts Valley, California Borland Software Corporation may have patents and/or pending patent applications covering subject matter in this document. Please refer to the product CD or the About dialog box for the list of applicable patents. The furnishing of this document does not give you any license to these patents. COPYRIGHT Borland Software Corporation. All rights reserved. All Borland brand and product names are trademarks or registered trademarks of Borland Software Corporation in the United States and other countries. All other marks are the property of their respective owners. For third-party conditions and disclaimers, see the Release Notes on your product CD. Printed in the U.S.A.

3 Contents Chapter 1 Preface 1 Contacting Borland Support Documentation Conventions Chapter 2 Using the Add-In 3 Installing the StarTeam TestDirector Version Control Add-in Creating a TestDirector Project Running the StarTeam Add-in Setup Using Version Control with TestDirector Tips on Using the StarTeam Add-in Known Issues: TestDirector Index 7 i

4 ii

5 Chapter 1 Chapter1Preface Important Installing the StarTeam TestDirector Version Control Add-in enables you to use StarTeam as a version control system for Mercury s TestDirector or Quality Center. By implementing version control, a team of people can work on tests without overwriting each other s changes. When a team member checks out a test under version control, it can be locked, which prevents others from changing it. A revised test can be checked back into the StarTeam repository and unlocked, so that it is available to the team. This guide explains: How to install the TestDirector Version Control Add-in How to set up the TestDirector Version Control Add-in to use a StarTeam project The differences between the instructions for the TestDirector Version Control Add-in and the directions in Mercury s TestDirector Version Control Add-in Guide. A shortcut to this guide is created when you install the TestDirector Version Control Add-in. Please check the Borland web site for periodic updates to both the Add-in and its documentation. The installation program for the Add-in copies an online version of this guide to the installation folder. The online manual is in Adobe s Portable Document Format (.PDF) and requires version 4.0 or higher of the Adobe Acrobat Reader to display. The free Reader is available from the Adobe web site at: Chapter 1: Preface 1

6 Contacting Borland Support Contacting Borland Support Borland Software Corporation is committed to providing world-class services in the area of consulting and technical support. We have over 15 years of experience in supporting developers and enterprise customers. Our qualified technical support engineers are prepared to handle your support needs on a case-by-case basis or in an ongoing partnership. Borland provides support worldwide, delivering timely, reliable service to ensure every customer s business success. For more information about Borland s support services, please see our web site at From the Web site, you can also access many newsgroups where users exchange information, tips, and techniques. See for the latest list of free product newsgroups. Also, available on the Internet is the Borland Developer Network site at This Borland Community provides access to product specific information, articles, code examples, and news. When contacting support, be prepared to provide complete information about your environment, the version of the product you are using, and a detailed description of the problem. For support on third-party tools or documentation, contact the vendor of the tool. Documentation Conventions The documentation uses the following conventions. Choose File > Exit Fixed-Space Font italics Indicates a menu selection followed by a submenu selection. The greater-than symbol (>) separates the commands to be selected from subsequent menus. For example, Choose the File > Exit command means to choose File from the menu bar and then choose Exit from the drop-down menu. Text appearing in Courier font represents information that you need to enter and messages from the system. Syntax appearing in italics represents information that you replace with the names of your files, child folders, etc. Italics are also used for the names of dialogs and books and for emphasis. Bold Syntax appearing in bold represents information that you must use exactly as shown (if you use it). [ ] Square brackets surround optional syntax. A vertical bar separates mutually exclusive choices in syntax. Note Tip Important Caution Identifies supplemental information. Identifies information on alternative procedures or other helpful but nonessential information. Identifies information that is essential to the completion of a task. Identifies actions that may result in loss of data, or procedures that must be followed to ensure that data is not lost. 2 TestDirector Version Control Add-in Installation Guide

7 Chapter 2 2Using the Add-In Chapter The TestDirector Version Control Add-in enables you to place current and prior versions of TestDirector test plans under version control in the StarTeam repository. It supports both the StarTeam Windows Server and StarTeam for Solaris Server. Before TestDirector test plans can be stored in StarTeam, the following tasks must be completed: 1 On a computer with an Internet Information Server (IIS), install the following software: a b c TestDirector 7.6 or 8.0. The Add-in also works with Quality Center 8.2 for Windows and Quality Center 8.2 for Solaris. TestDirector Version Control Add-in. Installing this add-in also installs a shortcut to the Mercury TestDirector Version Control Add-in Guide, which explains how to use version control in TestDirector. StarTeam TestDirector Version Control Add-in 2 Do one of the following: a b c d e Create a new TestDirector project for test plans that will be placed under StarTeam version control. Create the TestDirector project, but do not activate it. See Creating a TestDirector Project on page 4. Run the StarTeam Add-in Setup to select a StarTeam project to store the files. See Running the StarTeam Add-in Setup on page 5. From Site Administrator, enable version control for the TestDirector project. For details, see the TestDirector Version Control Add-in Guide. From Site Administrator, activate the TestDirector project. For details, see the TestDirector Version Control Add-in Guide. Place an existing TestDirector project under StarTeam version control. From Site Administrator, deactivate the TestDirector project. For details, see the TestDirector Version Control Add-in Guide. Run the StarTeam Add-in Setup to select a StarTeam project to store the files. See Running the StarTeam Add-in Setup on page 5. Chapter 2: Using the Add-In 3

8 Installing the StarTeam TestDirector Version Control Add-in Note f g From Site Administrator, enable version control for the TestDirector project. For details, see the TestDirector Version Control Add-in Guide. From Site Administrator, reactivate the TestDirector project. For details, see the TestDirector Version Control Add-in Guide. 3 After the TestDirector project is activated under source control and the StarTeam folder for storing test plans has been selected, you can check files in and out, as explained in the TestDirector Version Control Add-in Guide. TestDirector creates a number of folders in StarTeam. TestDirector stores a variety of files for each test. All of the files will have the file status Missing in the StarTeam client unless you provide an alternate working folder that is the pathtotestdirectorproject\ checkouts\username. TestDirector checks the files for each test in and out using this predefined location. TestDirector stores tests in folders using internal identifiers. You should not attempt to modify the location of the folders or tests from within StarTeam. Installing the StarTeam TestDirector Version Control Add-in The StarTeam Add-in must be downloaded from a Borland web site, and then installed on a machine that is running the required software. See page 3 for details. To install the StarTeam Add-in: 1 Go to the following web site: 2 Click on the appropriate link and download the TestDirector Version Control Add-in file. 3 On a machine that is running the IIS Server and TestDirector, run the file to start installing the StarTeam Add-in. 4 Follow the instructions in the installation program dialogs. Creating a TestDirector Project If you create a TestDirector project to use with StarTeam, you should not activate the TestDirector project as part of its creation. Except for this restriction, you should follow the instructions for creating a project in the TestDirector Version Control Add-in Guide. A shortcut to this guide is created when you install the TestDirector Version Control Add-in. To create a TestDirector project to use with StarTeam: 1 In the Site Administrator, select the Projects tab. 2 Click Create. 3 In the resulting Create Project dialog box. a b c d In the Project Name text box, enter a name for the TestDirector project. In the Domain text box, select a TestDirector virtual domain. For the Database Type, select one of the available types. Click Next. 4 On the resulting page: a b Clear the Activate Project check box. Clear the Create A Version Control Database check box. 4 TestDirector Version Control Add-in Installation Guide

9 Running the StarTeam Add-in Setup c Click Create. The new project will be added to the list of TestDirector projects, but it has not yet been placed under version control or activated. Running the StarTeam Add-in Setup Note To help you set up the StarTeam Add-in, a special program deposits a file named STServer.properties in your TestDirector project directory. This file contains information about the StarTeam project, view, and folder in which you will store TestDirector test plans. To set up the StarTeam Add-in: 1 From the Windows Start menu, select Programs > StarTeam > StarTeam TestDirector Version Control Add-in > Setup. 2 On the Welcome page of the resulting dialog box, click Next. 3 On the resulting page, specify the Project Directory for this project, and click Next. The resulting page shows the available StarTeam servers. 4 If the StarTeam Server you want to access is not listed in this dialog box, click Add Server. The StarTeam Server dialog box appears. a b c d e In the Server Description text box, enter a unique descriptive name for the server configuration. The name is not case sensitive and cannot contain colons (:). In the Server Address text box, enter or browse for the server s computer name or IP address. In the Endpoint text box, enter the port number associated with the TCP/IP communications protocol. Select an encryption type check box to encrypt data transferred between your workstation and the server. Encryption protects files and other project information from being read by unauthorized parties over unsecured network lines. The encryption types are ordered (top to bottom) based on speed. Each encryption type is slower, but safer, than the type that precedes it. If you want to use data compression, select the Compress Transferred Data check box. 5 Double-click the name of the StarTeam server to be accessed. 6 In the resulting Log On dialog box, enter your name and password for StarTeam Server, and click OK. 7 Expand the tree for this StarTeam server, and select the StarTeam project, view, and folder that will be used to store the files from TestDirector. 8 Click Next. The Review Settings page appears. 9 Review the settings to make sure they are correct. If the settings are correct, click Finish. If the settings are not correct, click Back until you reach the page on which you can change the setting, and then click Next until you reach this page again. 10 In the confirmation dialog indicating that setup is complete, click OK. To use the StarTeam TestDirector Version Control Add-in, you do not need to complete a log on dialog box. Chapter 2: Using the Add-In 5

10 Using Version Control with TestDirector Using Version Control with TestDirector For information about working with version control in TestDirector, review the latest version of the TestDirector Version Control Add-in Guide. A shortcut to this guide is created when you install the TestDirector Version Control Add-in.The information provided in the guide explains how to create tests under version control, check out tests, check in tests, undo checkouts, view previous versions, and more. Tips on Using the StarTeam Add-in Viewing a modified test. Assume that two users are viewing the same test, but only one user has it checked out. That user makes a modification in the test, and checks it back in again. The second user will not see the changes after checking out the test until he or she changes tabs or items or clicks Refresh. Performing Concurrent Operations. When two users perform concurrent operations (for example, Get Latest), one user may see a message about the test being locked, even though the lock is in place only briefly. Checking out the tip revision. If you have checked out a historical revision of a test in TestDirector, but decide that you want to check out the tip revision, you must first perform an Undo Checkout, then a Get Latest Version operation, then Check Out the file. Checking out prior revisions. To check out an older revision of a test plan, you must have the latest revision of the file in your StarTeam working folder. If you check out an early version of a test that has been renamed, the historical revision retains the original file name. Using process rules. Process rules are enforced at the StarTeam client level. Therefore, when you use the StarTeam Add-in, you can check files in and out regardless of the process rules that have been set. Adding comments. Although you can enter a Comment on the Check Out dialog boxabout why you are checking out files, this feature is not currently supported, so the comment will not be retained or used by StarTeam. Using Undo Checkout. When you modify a test, decide not to keep the changes, and select Undo Checkout, you will not see a warning that your changes will be lost. Instead, a standard confirmation message displays. Setting the StarTeam Server timeout. Connections to the StarTeam Server are not automatically released when the TestDirector connection times out. Borland recommends setting the StarTeam Server timeout in Server Administration to approximately the same number of minutes as the timeout used by TestDirector/IIS. Known Issues: TestDirector When version control is enabled and more than one user performs the same operation (such as a check out or add) at the same time, the operation fails if TestDirector is using an Access database. If you use the TestDirector Site Administrator to disable the StarTeam Add-in when tests have been checked out (locked), you cannot re-enable the Add-in. In this situation, you must go to the StarTeam client and unlock the tests before the Add-in can be restarted. 6 TestDirector Version Control Add-in Installation Guide

11 Index B bold convention 2 brackets convention 2 C conventions bold 2 brackets 2 fixed-space type 2 italics 2 menu selections 2 vertical bars 2 creating a TestDirector project 4 D developer support 2 F fixed-space type convention 2 I installing the StarTeam TestDirector Version Control Add-in 4 italics convention 2 M menu selections convention 2 P product support 2 projects creating in TestDirector 4 selecting in StarTeam 5 S Setup program 5 square brackets convention 2 StarTeam TestDirector Version Control Add-in 3 support 2 T technical support 2 V vertical bars convention 2 Index 7

12 8 StarTeam TestDirector Version Control Add-in Installation Guide