Associate Test Case Automation using TFS API

-
Hello,

 I have been observing most of users reported that associating automation to test case one by one from Visual Studio Team Explorer is tedious job rather time consuming. I was thinking what if we could achieve this using TFS object model. My idea was fetch test case one by one and associate automation to test case and save test case work item.

 Resolution:
Here is code which can use to associate automation in bulk - 

Add below references - 
Microsoft.TeamFoundation
Microsoft.TeamFoundation.Client 
Microsoft.TeamFoundation.WorkItemTracking.Client
Microsoft.TeamFoundation.WorkItemTracking
teamprojectCollection = TfsTeamProjectCollectionFactory.GetTeamProjectCollection(collectionUri);

workItemStore = projectCollection.GetService<WorkItemStore>();

//You can either specify work item query to fetch test cases
WorkItemCollection workItemCollection = workItemStore.Query(
     " SELECT * FROM WorkItems " +
     " WHERE [System.TeamProject] = '" + teamProject.Name;

//Or
//Pass test case Id to get test case
WorkItem workItem = workItemStore.GetWorkItem(555);

//Parameter details -
//ITestCase testCase = The test case artifact to which to associate automation
//String automationTestName = The automation test name. It should be fully qualified of format "Namespace.ClassName.TestMethodName
//String automationTestType = The automation test type like "CodedUITest"
//String automationStorageName = The assembly name containing the above est method without path like MyTestProject.dll.

//Get automation guid
    SHA1CryptoServiceProvider crypto = new SHA1CryptoServiceProvider();
    byte[] bytes = new byte[16];
    Array.Copy(crypto.ComputeHash(Encoding.Unicode.GetBytes(automationTestName)), bytes, bytes.Length);
    Guid automationGuid = new Guid(bytes);

// Create the associated automation.
   testCase.Implementation = testCase.Project.CreateTmiTestImplementation(
            automationTestName, automationTestType,
            automationStorageName, automationGuid);

    // Save the test. If you are doing this for lots of test, you can consider
    // bulk saving too (outside of this method) for performance reason.
    testCase.Save();


This is just sample code but I am planning to create small tool and will share here soon.
Thanks,
Vivek

Comments

  1. UnknownOctober 30, 2013 at 2:14 PM

    Hi Vivek Bansod,

    How I catch the testCase?

    Thank's

    ReplyDelete
  2. Vivek BansodDecember 5, 2013 at 5:22 AM

    Hi,
    You can use below line of code to get the test case object -
    WorkItemStore wis = teamProjectCollection.GetService();
    ITestManagementTeamProject project = teamProjectCollection.GetService().GetTeamProject(prInfo.Name);
    ITestCase testcase = project.TestCases.Find();

    then call above associate automation method by passing this test case object. Hope this helps you.

    ReplyDelete
  3. UnknownDecember 19, 2013 at 12:33 AM

    Hi Vivek,

    May I know for the generation of the Automation Guid, does it has to strictly follows the sample code that you provided or I could just do a Guid.NewGuid()?

    I previously asked in the forum, and they told me I can't simply generate the automation id
    http://social.msdn.microsoft.com/Forums/vstudio/en-US/d5df2b42-660d-4281-8d00-68f04bbf7134/associating-automation-via-excel-query-and-publish-can-automated-test-id-be-generated-using?forum=tfsgeneral#ce278509-ecab-41ef-98a4-4f9d87fa7056

    ReplyDelete
  4. UnknownDecember 19, 2013 at 12:50 AM

    Hi again,

    I just tried out the code

    SHA1CryptoServiceProvider crypto = new SHA1CryptoServiceProvider();
    byte[] bytes = new byte[16];
    Array.Copy(crypto.ComputeHash(Encoding.Unicode.GetBytes(automationTestName)), bytes, bytes.Length);
    Guid automationGuid = new Guid(bytes);

    and it seems to be the same as the one generated by TFS :)

    Just curious, how did you know it was using that algorithm?

    ReplyDelete
  5. Vivek BansodDecember 19, 2013 at 1:57 AM

    Hi, Thanks for feedback,

    Actually I was facing similar issue then I tried above code at my end and it just worked fine like real. So thought of sharing with all through my blog. My understanding is, TFS uses same algorithm and hence same results. I found this snippet at MSDN ALM blogs.

    Glad it helped you.

    ReplyDelete

Post a Comment

Popular posts from this blog

How To: Bulk upload Test Case results to Microsoft Test Manager

-
Problem Definition: Most TFS or Microsoft Test Manager users find it difficult to update test execution result to MTM. Assume that you are done with 100+ test case execution manually and now you want to upload results (Pass/Fail/Block) for all those test cases and also link bugs, test cases to result as needed. Doing this manually is very time consuming. At this time there is no way to support this ask in MTM versions but yes, we can achieve this by writing our own code using TFS SDK APIs. Resolution: I came along with this issue some time back and created a tool using TFS APIs which upload results to MTM very smoothly. Here is how my tool works:   1. Run tool exe  2. Connect to team foundation server you want to  3.  Select test plan -> Test Suite  4. Click Get Test Case button  5. This will create excel with test cases from selected test suite.  6. There is filter if you want to upload results specifically for manual or automated or all test cases  7.  Open created excel and
Read more

TFS API: Get Work Item History Revisions for parituclar Field

-
Image
Hello, I observed many of us struggling to view history for any work item. History is visible but it is hard to visualize changes made like who made changes, to which field and when etc. For this matter, one has to scroll through entire history tab and find it tedious job. I was thinking what if we could view work item history for selected field with other details like who changed it and when. Here is solution - I have created a tool which show work item history for selected field. Also shows how may times selected field changed. You can view history by selecting single work item and also export entire work item query history to excel. I find this tool useful so thought of sharing with others. How it works - 1. Run EXE 2. Prompt you select/add team project server details 3. Populates your My Queries to Treeview 4. Double Click query from tree and it will show work items in right grid 5. Select Work item field from top drop down for which you want to see history 6. Doubl
Read more

Add attachment to Test Case Result using TFS API

-
We can add attachment to test case result using TFS APIs. Here is small code snippet I have created. ITestRun testRun = _plan . CreateTestRun ( false ); ITestCaseResultCollection results = testRun . QueryResults (); ITestIterationResult iterationResult ;   foreach ( ITestCaseResult result in results ) {      result . Attachments . Add ( new Attachment ( "FileName" , "Comments if any" )); }   results . Save ( true ); testRun . Save (); testRun . Refresh ();
Read more