Manage TFS Test Cases C# Code

• Download full source code

Introduction

To use TFS Test Cases via code, you should first create TFS Collection and Team Test Project. You can find more information in my previous post: “How to: Connect to TFS Team Project C# Code“.

Next you need to connect to a specific test plan. You can read more in the article: “Manage TFS Test Plans C# Code“.

In MS Test Manager, you can edit, create, delete test cases. Here I am going to show you how to do these actions via C# code.

Get All TFS Test Cases

Our first job is to create a wrapper class for the TFS Test Case (ITestCase). It will contain only the most important properties of the base core TFS Test Case object and will be serializable because the standard Microsoft objects are not. This means that you cannot use them in web services or put them into the clipboard.

[Serializable]
public class TestCase : BaseNotifyPropertyChanged
{
    [NonSerialized]
    private TeamFoundationIdentityName teamFoundationIdentityName;
    private int id;
    private string title;
    private string area;
    private string createdBy;
    private DateTime dateCreated;
    private DateTime dateModified;
    private Priority priority;
    protected bool isInitialized;

    public string OwnerDisplayName { get; set; }

    public Guid TeamFoundationId { get; set; }

    public int Id
    {
        get
        {
            return this.id;
        }

        set
        {
            this.id = value;
        }
    }

    public string Title
    {
        get
        {
            return this.title;
        }

        set
        {
            if (this.isInitialized)
            {
                UndoRedoManager.Instance().Push(t => this.Title = t, this.title, "Change the test case title");
            }
            this.title = value;
            this.NotifyPropertyChanged();
        }
    }

    public DateTime DateCreated
    {
        get
        {
            return this.dateCreated;
        }

        set
        {
            this.dateCreated = value;
            this.NotifyPropertyChanged();
        }
    }

    public string CreatedBy
    {
        get
        {
            return this.createdBy;
        }

        set
        {
            this.createdBy = value;
            this.NotifyPropertyChanged();
        }
    }

    public DateTime DateModified
    {
        get
        {
            return this.dateModified;
        }

        set
        {
            this.dateModified = value;
            this.NotifyPropertyChanged();
        }
    }

    public string Area
    {
        get
        {
            return this.area;
        }

        set
        {
            if (this.isInitialized)
            {
                UndoRedoManager.Instance().Push(a => this.Area = a, this.area, "Change the test case area");
            }
            this.area = value;
            this.NotifyPropertyChanged();
        }
    }

    public TeamFoundationIdentityName TeamFoundationIdentityName
    {
        get
        {
            return this.teamFoundationIdentityName;
        }

        set
        {
            if (this.isInitialized)
            {
                UndoRedoManager.Instance().Push(t => this.TeamFoundationIdentityName = t, this.teamFoundationIdentityName, "Change the test case owner");
            }
            this.teamFoundationIdentityName = value;
            this.NotifyPropertyChanged();
        }
    }

    public Priority Priority
    {
        get
        {
            return this.priority;
        }

        set
        {
            if (this.isInitialized)
            {
                UndoRedoManager.Instance().Push(p => this.Priority = p, this.priority, "Change the test case priority");
            }
            this.priority = value;
            this.NotifyPropertyChanged();
        }
    }
}

If you want to get all test cases in the current Team Project, you can use the following method.

public static List<TestCase> GetAllTestCasesInTestPlan(ITestManagementTeamProject testManagementTeamProject, ITestPlan testPlan, bool initializeTestCaseStatus = true)
{
    testPlan.Refresh();
    List<TestCase> testCasesList;
    testCasesList = new List<TestCase>();
    string fullQuery =
        String.Format("SELECT [System.Id], [System.Title] FROM WorkItems WHERE [System.WorkItemType] = 'Test Case' AND [Team Project] = '{0}'", testManagementTeamProject.TeamProjectName);
    IEnumerable<ITestCase> allTestCases = testManagementTeamProject.TestCases.Query(fullQuery);
    foreach (var currentTestCase in allTestCases)
    {
        TestCase testCaseToAdd = new TestCase(currentTestCase, currentTestCase.TestSuiteEntry.ParentTestSuite, testPlan, initializeTestCaseStatus);
        if (!testCasesList.Contains(testCaseToAdd))
        {
            testCasesList.Add(testCaseToAdd);
        }
    }

    return testCasesList;
}

If you want to get the test cases from specific test suite, you can use a slightly modified method. The test plan and the current suite are refreshed in order to obtain the latest added test cases. Otherwise, the TFS will return you the cached snapshot of the query.

public static List<TestCase> GetAllTestCaseFromSuite(ITestPlan testPlan, int suiteId, bool includeExecutionStatus = true)
{
    List<TestCase> testCases = new List<TestCase>();
    testPlan.Refresh();
    ITestSuiteBase currentSuite = testPlan.Project.TestSuites.Find(suiteId);
    currentSuite.Refresh();
    foreach (var currentTestCase in currentSuite.TestCases)
    {
        TestCase testCaseToAdd = new TestCase(currentTestCase.TestCase, currentSuite, testPlan, includeExecutionStatus);
        if (!testCases.Contains(testCaseToAdd))
        {
            testCases.Add(testCaseToAdd);
        }
    }
    log.InfoFormat("Load all test cases in the suite with Title= \"{0}\" id = \"{1}\"", currentSuite.Title, currentSuite.Id);
    return testCases;
}

Delete TFS Test Case

public static TestCase Save(this TestCase sourceTestCase, ITestManagementTeamProject testManagementTeamProject, ITestPlan testPlan, bool createNew, int? suiteId)
{
    TestCase currentTestCase = sourceTestCase;
    if (createNew)
    {
        ITestCase testCaseCore = testManagementTeamProject.TestCases.Create();
        currentTestCase = new TestCase(testCaseCore, sourceTestCase.ITestSuiteBase, testPlan);
    }
    currentTestCase.ITestCase.Area = sourceTestCase.Area;
    currentTestCase.ITestCase.Title = sourceTestCase.Title;
    currentTestCase.ITestCase.Priority = (int)sourceTestCase.Priority;
    currentTestCase.ITestCase.Actions.Clear();
    currentTestCase.ITestCase.Owner = testManagementTeamProject.TfsIdentityStore.FindByTeamFoundationId(sourceTestCase.TeamFoundationId);

    if (suiteId != null)
    {
        var newSuite = TestSuiteManager.GetTestSuiteById(testManagementTeamProject, testPlan, (int)suiteId);
        sourceTestCase.ITestSuiteBase = newSuite;
    }
    currentTestCase.ITestCase.Flush();
    currentTestCase.ITestCase.Save();
    if (suiteId != null)
    {
        SetTestCaseSuite(testManagementTeamProject, testPlan, (int)suiteId, currentTestCase);
    }

    currentTestCase.ITestCase.Flush();
    currentTestCase.ITestCase.Save();

    return currentTestCase;
}