Test Guide for Source Control Plug-ins

Applies to: Visual Studio Visual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

This section provides guidance for testing your source control plug-in with Visual Studio. An extensive overview of the most common testing areas, as well as some of the more intricate areas that may be problematic is provided. This overview is not meant to be an exhaustive list of test cases.

Note

Some bug fixes and improvements to the latest Visual Studio IDE may uncover problems with existing source control plug-ins that were previously not encountered while using previous versions of Visual Studio. It is strongly recommended that you test your existing source control plug-in for the areas enumerated in this section, even if no changes have been made to the plug-in since the previous version of Visual Studio.

Common Preparation

A machine with Visual Studio and the target source control plug-in installed, is required. A second machine similarly configured can be used for some of the Open from Source Control tests.

Definition of Terms

For the purpose of this test guide, use the following term definitions:

Client project Any project type available in Visual Studio that supports source control integration (for example, Visual Basic, Visual C#, or Visual C++).

Web project There are four types of Web projects: File System, Local IIS, Remote Sites, and FTP.

• File System projects are created on a local path, but they do not require the Internet Information Services (IIS) to be installed as they are accessed internally via a UNC path, and can be placed under source control from inside the IDE, much like client projects.

• Local IIS projects work with IIS that is installed on the same machine and are accessed with a URL pointing to the local machine.

• Remote Sites projects are also created under an IIS Services, but they are placed under source control on the IIS server machine and not from inside the Visual Studio IDE.

• FTP projects are accessed through a remote FTP server but they cannot be placed under source control.

  Enlistment Another term for the solution or project under source control.

  Version Store The source control database that is being accessed through the Source Control Plug-in API.

Test Areas Covered in This Section

• Test Area 1: Add To/Open From Source Control

  • Case 1a: Add Solution to Source Control

  • Case 1b: Open Solution from Source Control

  • Case 1c: Add Solution from Source Control

• Test Area 2: Get From Source Control

• Test Area 3: Check Out/Undo Checkout

  • Case 3: Check Out/Undo Checkout

  • Case 3a: Check Out

  • Case 3b: Disconnected Checkout

  • Case 3c: Query Edit/Query Save (QEQS)

  • Case 3d: Silent Checkout

  • Case 3e: Undo Checkout

• Test Area 4: Check In

  • Case 4a: Modified items

  • Case 4b: Adding files

  • Case 4c: Adding projects

• Test Area 5: Change Source Control

  • Case 5a: Bind

  • Case 5b: Unbind

  • Case 5c: Rebind

• Test Area 6: Delete

• Test Area 7: Share

• Test Area 8: Plug-in Switching

  • Case 8a: Automatic Change

  • Case 8b: Solution-based Change

See also

• Source Control Plug-ins