Binding Test Projects to Source Control (Legacy)

Applies to TestComplete 15.68, last modified on October 16, 2024
This topic describes functionality of the SCC API Providers plugin, which is obsolete and is left for backward compatibility only. To learn about supported source control integrations, see Integration With Source Control Systems.

TestComplete source control services let you add your project, project suite and project item files to a source control system directly from TestComplete.

To add a project
  • Save your project if it or any of its items have unsaved changes.

  • Switch to the Project Explorer panel and select the project node or any of its child nodes (project items or child elements of project items).

  • Select File | Source Control | Add Project from the TestComplete main menu. This will call the Select SCC Provider dialog that lists source control systems installed on your computer. TestComplete generates this list automatically.

  • Select the desired source control system in the dialog and press OK.

  • Once you press OK in the Select SCC Provider dialog, TestComplete will connect to the selected source control system. Then, it will show the source control system’s dialog where you need to specify the source control’s project to which you would like to add your project.

Note: To work with TestComplete source control services, you can also use the Source Control submenu of the Project Explorer’s context menu or the Source Control toolbar (see Integration With Source Control Systems via SCC API Providers (Legacy)). This submenu and toolbar holds the same items as the File | Source Control menu. So, to add a project to source code control you can also right-click the project node in the Project Explorer and choose Source Control | Add Project from the context menu.

Besides adding projects, you can add the whole project suite to a source control system

To add a project suite
  • Save all changes by selecting File | Save All from the TestComplete main menu.

  • Switch to the Project Explorer panel and select the project suite node.

  • Select File | Source Control | Add Project Suite from the TestComplete main menu or right-click the project suite node in the Project Explorer and choose Source Control | Add Project Suite from the context menu. This will call the Select SCC Provider dialog that lists source control systems installed on your computer. TestComplete generates this list automatically.

  • Select the desired source control system in the dialog and press OK.

  • Once you press OK in the Select SCC Provider dialog, TestComplete will connect to the selected source control system. Then, it will show the source control system’s dialog in which you need to specify the source control’s project to which you would like to add your project suite.

When you add your project or project suite to a source code control, TestComplete also adds all the files that belong to this project (project suites), that is, TestComplete also adds files of project items and their child elements. The structure of files and folders in a source code control system corresponds to the structure of files and folders on your hard disk. For a full list of project suite, project and project item files that are added, see List of Files Added to Source Code Control.

After you have added the project, you can check in and check out files or project items, compare files, view their properties, and so on. All these actions will be performed with the source control system, to which you added the project. For information on how to unbind your project from the source control system, see Unbinding Projects and Project Suites From Source Code Control. For information on how to change the source control system or project (or project suite) location in it, see Changing Source Control System or File Location in It.

If you add a project item or a child element of a project to your project after the project has been added to a source control system, you should add this project item (element) manually.

Note: After you have bound a project suite or one of its projects to a source code control, the Project Explorer panel displays small images within the items’ icons to indicate the source control status of the items. For information on the images, see the panel description.
To add a project item or child element to a source control system
  • Select the desired element in the Project Explorer panel and choose File | Source Control | Add to Source Control from the main menu of TestComplete or Source Control | Add to Source Control from the Project Explorer’s context menu, or click Add to Source Control on the Source Control toolbar.

Remarks
  • The project item files are added to the same source control system database, to which the project holding this item belongs. You cannot have a project stored in one source control system database and project items stored to another database.

  • Project items’ files must be located in subfolders of the project’s folder. This limitation is caused by certain specifics of the Microsoft Source Code Control API. So, if the project item file is not located in a subfolder of the project’s folder, TestComplete is unable to add this project item to the source control system.

  • If the Bind new items to SCC automatically option is enabled, TestComplete automatically binds new projects or project items and their child elements to the source code system to which the project or project suite is bound.

  • If the Bind Visualizer frames to SCC option is enabled when you add script units and keyword tests to the source control, TestComplete automatically adds Visualizer files associated with these units and tests.

    Keeping a large number of Test Visualizer images in source control can cause slow performance of the check in and check out operations on the test project. To avoid performance issues, disable the Bind Visualizer frames to SCC option or minimize the number of source control-bound Visualizer images. For more information, see the Visualizer Data and Source Control Systems section of the Sharing Visualizer Frames topic.

See Also

Legacy Integration With Source Control Systems - Common Tasks
Adding New Elements to a Bound Project Suite (Legacy)
Select SCC Provider Dialog
Changing Source Control System or File Location in It (Legacy)
Unbinding Projects and Project Suites From Source Code Control (Legacy)
List of Files Added to Source Code Control
Integration With Source Control Systems via SCC API Providers (Legacy)

Highlight search results