November 11, 2015

Setting Up the New Team Foundation Server Integration with TestTrack

Helix ALM
We’ve recently expanded our third-party integration support in TestTrack 2015.1.2, which introduces one-way integration with Microsoft Team Foundation Server (TFS) so users can attach TFS source files and changesets to TestTrack items at check in. Keep reading to learn more about setting up  this new source control integration.

Setting up the integration

An administrative user needs to perform the following tasks to set up the TFS integration.

1. Install the TestTrack source control provider CGI on the TestTrack web server.

This CGI (ttextpro.exe) is used to communicate between the TestTrack Server and the plug-in you will install on the Team Foundation Server. If you need to install it or configure the web server, see the TestTrack installation help for information.

2. Add the TFS source control provider to the TestTrack project.

When you add the source control provider in TestTrack, the provider key required to exchange attachment information between TFS and TestTrack is automatically generated. Choose Tools > Administration > Source Control Providers and then click Add in the Source Control Providers dialog box. Enter a provider Name and select Team Foundation Server as the Type. If you want to include hyperlinks with TFS changesets and files on the Source Files tab in TestTrack items, configure the Changeset and FileURLs. (If you do not want to include hyperlinks, you can leave either or both fields empty.) Copy the TFS Web Access URL, which is available from the Application Tier Summary in the TFS Administration Console, to each field and append the following to it:
  • Changeset URL (TFS 2012 or later)—/web/cs.aspx?pcguid=<pcguid>&cs=<cs>
  • Changeset URL (TFS 2010)—/cs.aspx?pcguid=<pcguid>&cs=<cs>
  • File URL (TFS 2012 or later)—/web/view.aspx?pcguid=<pcguid>&path=<path>&cs=<cs>
  • File URL (TFS 2010)—/view.aspx?pcguid=<pcguid>&path=<path>&cs=<cs>
ttSourceControlProvidersTFS Copy the Provider key to a text file or send it to your TFS administrator. You will need this key when configuring the TFS plug-in. Make sure Active is selected and click OK to save the provider.

3. Download the TestTrack TFS plug-in.

Be sure to download the plug-in for your TFS version.

4. Install and configure the TestTrack plug-in on the Team Foundation Server.

To install the plug-in, unzip the downloaded file and copy its contents to the Application Tier\Web Services\bin\Plugins directory in the TFS application directory (e.g., C:\Program Files\Microsoft Team Foundation Server 2010\Application Tier\Web Services\bin\Plugins). Open TTTFSPluginServer.dll.config in a text editor and update the following values in the file:
  • ProviderKey—Provider key from the TestTrack Source Control Providers dialog box.
  • TTExtProCGIURL—URL to the TestTrack source control provider CGI (e.g., http://localhost/scripts/ttextpro.exe).
  • IssueTag, TestCaseTag, and RequirementTag – TestTrack item abbreviations that identify item types in check in comments. The default tags are IS for issues, TC for test cases, and RQ for requirements. You can use different tags, but you must provide users with the tags to include in check in comments when attaching files to TestTrack.
  • AllowCheckinIfErrors—True allows changes to be checked in to TFS even if an error that prevented attaching files to the TestTrack item occurred. To prevent TFS check ins when errors occur, change the value to false. If TFS project templates are configured to automatically check in files when new projects are created, setting the value to false could cause errors that prevent users from creating new projects. To allow check in of new projects created from these templates, set the value to true.
  • RequiredAttachmentFileExtensions—Extensions of file types that must be attached to TestTrack items when checked in. Only applies if AllowCheckinIfErrors is set to false. Use an asterisk to separate extensions (e.g., "*.cpp, *.h").
Save the configuration file. Be sure to provide users with the items tags from the configuration file, especially if you changed them from their default values, so they can include the correct tags in check in comments to attach files to TestTrack.

5. Make sure external source control provider access is enabled in the TestTrack Registry Utility.

External source control provider access must be enabled for users to attach source files to TestTrack items from TFS. You can also configure additional security options to disable access after a specific number of failed attempts and then restore access after a specific number of minutes. These options help prevent hackers from decrypting the provider key used to access TestTrack data. See the TestTrack Registry Utility help for information.