Software Testing: Microsoft Test Manager – Test Case Migrator Plus Tool

Microsoft Team Foundation Server Logo

Having trouble uploading requirements, test cases, or bugs into Microsoft Team Foundation Server (TFS)?

We often provide ways to help our clients improve processes and maximize the benefit of their tools. Today we will discuss migrating existing requirements, test cases, or bugs into TFS for use in Visual Studio, Visual Studio Online and Microsoft Test Manager (MTM). The Test Case Migrator Plus tool allows test related artifacts, present in Excel and MHT/Word formats, to be imported into TFS. This tool works with Visual Studio 2010, 2012 and 2015 as well as MTM and Visual Studio On-line.


1.1 Excel Based Workflow

The capabilities listed below allow you to reap all the benefits associated with test case management (requirements traceability, test coverage, requirements coverage, test execution, test result analysis etc.) present in TFS post migration.


• Migrates test cases (along with test steps) from Excel into TFS – This is a ONE way migration only

• Migrates requirements/user stories and bugs from Excel into TFS – This is a ONE way migration only

• Supports multi-pass migration process – i.e., each work item type has to be migrated in a different invocation/session of the tool

• Maintains links between work item types (parent/child, related, tested by, tests etc.) across multiple passes

• Provides the ability to create the test suite where the test cases will be uploaded


The Test Case Migrator Plus Tool is an open source tool that can be downloaded here:


1.2 Prerequisites

The Test Case Migrator Plus Tool requires certain programs, without which, the tool will not function. Visual Studio 2012 or 2015 and the programs listed below are prerequisites for the tool.


• Microsoft Visual Studio 2012 or 2015 bits

• Microsoft Visual Studio 2012 Ultimate (Web Install) (OR)

• Microsoft Visual Studio 2012 Premium (Web Install) (OR)

• Microsoft Visual Studio 2012 Test Professional (Web Install)

• Version of Microsoft Office 2003 or beyond

• TFS Installation


1.3 Installation

Download the “Test Case Migrator Plus Tool” zip file, extract it to a folder, and start the “TestCaseMigratorPlus.exe” application. Along with the binaries package, the “Readme” document is helpful, it links the internal documents and sample packages (one for Excel & one for MHT). The sample packages contain corresponding setting files that can be used to jump-start the migration process.

2 Test Case Migrator Plus Excel Workflow


2.1 Welcome Dialog

Provides an overview of the options when using the Test Case Migrator Plus Wizard.

Test Migrator Screenshot 1


2.2 Source Dialog

The figure below shows the two different options for the data source type.


• “Excel workbook” option to migrate data (test cases, requirements/user stories and bugs) from Excel

• “VS 2005/2008 Manual Test Case Format (MHT/Word)” option to migrate test cases from mht/word into TFS

Test Migrator Screenshot 2


2.3 Destination Dialog

Allows you to specify the TFS Server/Project Collection, Project, and the Work Item template where data will be migrated.

Test Migrator Screenshot 3


2.4 Settings Dialog

Allows you to either load the settings from a “setting/mapping file”, or to create a new mapping file. Setting files (when saved) contain the configuration choices made (for field mapping, data mapping, links mapping, miscellaneous mapping) that show up in subsequent wizard dialogs.


A “sample settings file” for each work item type is also released.  This file corresponds to the sample excel files that are being released.  The sample excel files have settings defined that work across both Agile and CMMI project templates (that ship out-of-the-box with TFS). You can use these to jump-start your migration process.

Test Migrator Screenshot 4


2.5 Field Mapping Dialog

Allows you to specify the field mapping between the Excel workbook columns and TFS work item fields. For each field (column) in the Source field, you need to map the corresponding TFS work item field. Data will be migrated only for those fields/columns that have a defined destination column mapping.


Fields with “<Ignore>” will be ignored during the migration process. Mandatory fields are marked as “*” in the drop down list. Fields which are auto-generated by the TFS server are marked as “+” in the drop down list. This dialog also allows you to specify the Test Suites a particular test case belongs to by specifying the field/column mapping. If qbvalue is specified, then Test Suites are auto created using the hierarchy specified in the column value.


After specifying the field mapping for the excel workflow, clicking on “Next” starts the parsing process for the records present in the selected excel file.


When there is a large number of rows in the excel worksheet, a “Parsing Progress” window appears to show the progress of the parsing. You can cancel the parsing at any time. To restart the parsing, click the “Next” button again.

Test Migrator Screenshot 5


2.6 Data mapping Dialog

If certain fields in your source excel worksheet contain data that is mismatched with the “allowed values” specified for the corresponding TFS work item field, you use this dialog to specify the data mappings so the migration process will not error out for the rows.


By default, the wizard auto-calculates such field values from the excel worksheet and shows them in this dialog. You can add additional rows by clicking ‘add’. This allows you to define the data mappings once and then reuse it across multiple excel workbooks.

Test Migrator Screenshot 6


2.7 Links mapping Dialog

Allows you to specify the different links within a particular work item type (ex: Requirement::Requirement -Parent/Child) or links between work item types (ex: Requirement::Test Case – Tested By). Since the migration of different work item types can only be done in multiple invocations/sessions of the tool, the linking metadata information is persistent across different invocations/sessions for a TFS Server/Project combination.

Test Migrator Screenshot 7


2.8 Miscellaneous Settings Dialog

Allows you to specify miscellaneous settings related to Test Steps (in case of Test Case work item) and to save the mappings file and the output log files.

Test Migrator Screenshot 8


2.9 Confirm Dialog

Allows you to preview the choices made in the wizard along with the ability to “Save and exit” the wizard without actually doing the migration OR “Save and migrate” which will initiate the migration process.

Test Migrator Screenshot 9


2.10 Progress Dialog

Shows you the progress of the migration process. It also allows you to stop the migration before it has fully completed. Note, if the migration is stopped before it has fully completed, the rows which have already been migrated will *NOT* be reverted back. When the migration is stopped before completion, the tool will still process all the links for the already migrated work items and will generate the respective output reports.


After the completion of the migration process, if “create link mappings” was checked, you are able to review the Output log files and the consolidated Linking report. This dialog also provides a summary of the migration for the current invocation at the top of the dialog.

Test Migrator Screenshot 10


2.11 Session Output Log File

Shows you the current session’s output during the migration process, including the new Work Item IDs created in TFS.

Test Migrator Screenshot 11



Olenick has experience using this utility to import requirements/user stories, test case and bug work items for use within TFS, Visual Studio, Visual Studio Online and Microsoft Test Manager (MTM). This utility is easy to use and it saves time and effort when importing artifacts into TFS.


Authors and Researchers:

Sathish Subramanian, Lead Senior Consultant – Olenick, Chicago

Stephen Black, Software Test/Lead Test Consultant – Olenick, Belfast

Related Content: Data Migration and ETL Testing, Requirements Management, Test Management, Test Tool Management Strategy