Click here to Skip to main content
13,634,702 members
Click here to Skip to main content
Add your own
alternative version

Tagged as


2 bookmarked
Posted 30 Jul 2010
Licenced Ms-PL

TFS API Part 27 – Test Plans, Test Suites, Test Cases Mapping

, 30 Jul 2010
Rate this:
Please Sign up or sign in to vote.
In this post, I’ll show how to get all Test Suites hierarchy Test Cases and more.

In my last post TFS API Part 26 – Add/Remove Test Plans, I showed how to Add remove Test Plan using MTM API.


Picture - A

Now when we know how to use work with Test Plan, let's deep dive to all items under each Test Plan. In this post, I'll show how to get all Test Suites hierarchy Test Cases and more.

As a QA manager, it will be awesome to get a view of all Team Projects and all Test Plans under one window.

Step 1: Create Project and Add Reference

Create an WPF/WinForm application and add the following references:

  • Microsoft.TeamFoundation.WorkItemTracking.Client.dll
  • Microsoft.TeamFoundation.Client.dll
  • Microsoft.TeamFoundation.dll
  • Microsoft.TeamFoundation.TestManagement.Client

All files are located under - c:\Program Files (x86)\Microsoft Visual Studio 10.0\Common7\IDE\ReferenceAssemblies\v2.0\

Step 2: Connect to Team Foundation Server

private TfsTeamProjectCollection _tfs;
private ITestManagementTeamProject _testproject;
TeamProjectPicker tpp = new TeamProjectPicker(TeamProjectPickerMode.SingleProject, false);
if (tpp.SelectedTeamProjectCollection != null)
    this._tfs = tpp.SelectedTeamProjectCollection;
    ITestManagementService test_service = 
    this._testproject = test_service.GetTeamProject(tpp.SelectedProjects[0].Name);
    btn_add.IsEnabled = true;
    btn_remove_plan.IsEnabled = true;

Step 3: Get Test Plans

void GetTestPlans(ITestManagementTeamProject testproject)
        ITestPlanCollection plans = testproject.TestPlans.Query("Select * From TestPlan");
        TreeViewItem root = null;
        root = new TreeViewItem();
        root.Header = ImageHelpers.CreateHeader
			(testproject.WitProject.Name, ItemTypes.TeamProject);
        foreach (ITestPlan plan in plans)
            TreeViewItem plan_tree = new TreeViewItem();
            plan_tree.Header = ImageHelpers.CreateHeader(plan.Name, ItemTypes.TestPlan);
            if (plan.RootSuite != null && plan.RootSuite.Entries.Count > 0)
                GetPlanSuites(plan.RootSuite.Entries, plan_tree);

Step 4: Get Test Suites

void GetPlanSuites(ITestSuiteEntryCollection suites, TreeViewItem tree_item)
    foreach (ITestSuiteEntry suite_entry in suites)
        IStaticTestSuite suite = suite_entry.TestSuite as IStaticTestSuite;
        if (suite != null)
            TreeViewItem suite_tree = new TreeViewItem();
            suite_tree.Header = ImageHelpers.CreateHeader
				(suite.Title, ItemTypes.TestSuite);
            GetTestCases(suite, suite_tree);
            if (suite.Entries.Count > 0)
                GetPlanSuites(suite.Entries, suite_tree); 

Step 5: Get Test Cases

void GetTestCases(IStaticTestSuite suite, TreeViewItem tree_item)
    //AllTestCases - Will show all the Test Cases under that Suite even in sub suites.
    //ITestCaseCollection testcases = suite.AllTestCases; – See Picture B
    //Will bring only the Test Case under a specific Test Suite. – See Picture A
    ITestSuiteEntryCollection suiteentrys = suite.TestCases;
    foreach (ITestSuiteEntry testcase in suiteentrys)
        TreeViewItem test = new TreeViewItem();
        test.Header = ImageHelpers.CreateHeader(testcase.Title, ItemTypes.TestCase);


Picture - B


This article, along with any associated source code and files, is licensed under The Microsoft Public License (Ms-PL)


About the Author

Shai Raiten
Architect Sela
Israel Israel
Shai Raiten is VS ALM MVP, currently working for Sela Group as a ALM senior consultant and trainer specializes in Microsoft technologies especially Team System and .NET technology. He is currently consulting in various enterprises in Israel, planning and analysis Load and performance problems using Team System, building Team System customizations and adjusts ALM processes for enterprises. Shai is known as one of the top Team System experts in Israel. He conducts lectures and workshops for developers\QA and enterprises who want to specialize in Team System.

My Blog:

You may also be interested in...


Comments and Discussions

QuestionHelps alot :) Pin
roneytyc15-Oct-17 16:42
memberroneytyc15-Oct-17 16:42 
QuestionRegarding add testcase to Requirement test suite. Pin
shamshaTest16-Jan-13 18:28
membershamshaTest16-Jan-13 18:28 
Please help me in how to add test cases to Requirement test suite using TFS API.
AnswerRe: Regarding add testcase to Requirement test suite. Pin
Shai Raiten20-Jan-13 1:45
mvpShai Raiten20-Jan-13 1:45 
QuestionError on plan.RootSuite.Entries.Count Pin
SainathAdhiraj26-Nov-12 20:53
memberSainathAdhiraj26-Nov-12 20:53 
GeneralIs there a way to get the child suites in the same order that they are displayed in MTM? Pin
Todd Andrew9-May-11 11:29
memberTodd Andrew9-May-11 11:29 
GeneralRe: Is there a way to get the child suites in the same order that they are displayed in MTM? Pin
Shai Raiten9-May-11 20:17
memberShai Raiten9-May-11 20:17 
GeneralRe: Is there a way to get the child suites in the same order that they are displayed in MTM? Pin
Todd Andrew10-May-11 4:21
memberTodd Andrew10-May-11 4:21 
GeneralLooks good... Pin
Sandeep Mewara30-Jul-10 22:09
mentorSandeep Mewara30-Jul-10 22:09 
GeneralRe: Looks good... Pin
Shai Raiten30-Jul-10 22:17
memberShai Raiten30-Jul-10 22:17 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

Permalink | Advertise | Privacy | Cookies | Terms of Use | Mobile
Web03 | 2.8.180712.1 | Last Updated 31 Jul 2010
Article Copyright 2010 by Shai Raiten
Everything else Copyright © CodeProject, 1999-2018
Layout: fixed | fluid