Shai Raiten's Blog : Visual Studio 2010, TFS API, TECH

TFS API Part 42 – Getting Started With Lab Management API

shair — Thu, 22 Dec 2011 17:12:00 GMT

I did some cool things lately with TFS Lab Management API, from connecting it to TFS Web Access and allow REST access to the lab (if you want to ask why – The customer is always right ).

So this part of TFS API will deal with Lab Management API, although Lab Management API is not public I’ll show some cool things you can do but this will be under your own risk.

Again, this is just the beginning of the Lab Management API, so let’s get started

Download Demo Project

Step 1: Located “Microsoft.TeamFoundation.Lab.Client.dll”

This dll cannot be found under Public, Private or ReferenceAssemblies it can only be found under GAC, so navigate here - C:\Windows\assembly\GAC_MSIL\Microsoft.TeamFoundation.Lab.Client\10.0.0.0__b03f5f7f11d50a3a\
Microsoft.TeamFoundation.Lab.Client.dll

Add this dll as reference to your project.

Step 2: Connect TFS and Obtain LabService

After connecting to TFS you need to obtain the Lab Service at the same way we did for all other services under TFS.

If created a combo box with all team project for later use.

private void BtnConnectClick(object sender, RoutedEventArgs e)
{
   var tpp = new TeamProjectPicker(TeamProjectPickerMode.NoProject,false);
   tpp.ShowDialog();
 
   if (tpp.SelectedTeamProjectCollection == null) return;
   _tfs = tpp.SelectedTeamProjectCollection;
   _lab = (LabService)_tfs.GetService(typeof(LabService));
  
   var store = (WorkItemStore)_tfs.GetService<WorkItemStore>();
   listProjects.ItemsSource = store.Projects;
}

Step 3: Get Collection Hosts and Library Share

Before we start dealing with Team Projects and their Lab Vm’s and templates the below code will show how to pull the Lab Management Hosts and Library Share from the TFS Collection.

Using the Lab Service and a QuerySpec object (we’ll use those a lot), we need to call QueryTeamProjectCollectionHostGroups method (right now we don’t need to add anything to the Query).

//public class TeamProjectCollectionHostGroupQuerySpec
//{
//  public TeamProjectCollectionHostGroupQuerySpec();
//  public Uri Location { get; set; }
//  public string Name { get; set; }
//}
listHostGroups.ItemsSource = _lab.QueryTeamProjectCollectionHostGroups(
    new TeamProjectCollectionHostGroupQuerySpec());
 
//public class TeamProjectCollectionLibraryShareQuerySpec
//{
//  public TeamProjectCollectionLibraryShareQuerySpec();
//  public Uri Location { get; set; }
//  public string Name { get; set; }
//}
listLibraryShares.ItemsSource = _lab.
          QueryTeamProjectCollectionLibraryShares(
     new TeamProjectCollectionLibraryShareQuerySpec());

Step 4: Get Lab Management Details For Team Project

Now, when you choose a Team Project we’ll call the GetProjectLabDetails method to extract all relevant lab information on that project.

But first we’ll use the LabService.IsLabConfigured method to see if this project has any lab configurations, if it does then using the QuerySpec we can pull all Environments and Templates for that team project.

void GetProjectLabDetails(string projectName)
{
    //Does this Team Project has Lab configure?
    if (!_lab.IsLabConfigured(projectName)) return;
 
    //Creating Query for lab environments under a specific project name.
    var labQuerySpec = new LabEnvironmentQuerySpec{Project = projectName};
    //public class LabEnvironmentQuerySpec
    //{
    //  public LabEnvironmentQuerySpec();
    //  public LabEnvironmentDisposition Disposition { get; set; }
    //  public Uri Location { get; set; }
    //  public string Project { get; set; }
    //}
 
    listEnvironments.ItemsSource =_lab.QueryLabEnvironments(labQuerySpec);
    listTemplates.ItemsSource = _lab.QueryLabTemplates(new 
    LabTemplateQuerySpec() { Project = projectName });
}

Download Demo Project

Enjoy.

TFS API Part 41–Manage Groups and Members

shair — Wed, 07 Dec 2011 21:11:00 GMT

In the past I’ve showed some examples on how to work with TFS IGroupSecurityService for getting users list, but you can do much more, Create new Group, Add or Remove users from group etc…

Download Demo Project

Step 1: Connect To TFS and Get All Users and Projects

As always we need to start with connecting to TFS, but here we’ll also obtain 2 important services for our demo IGroupSecurityService and ICommonStructureService.

Using ICommonStructureService we’ll be able to extract all Team Projects under the collection you choose, this is not the only way to do that.

Using IGroupSecurityService will allow us to get all users under the “Project Collection Valid Users” category.

private void BtnConnectClick(object sender, RoutedEventArgs e)
{
  var tpp = new TeamProjectPicker(TeamProjectPickerMode.NoProject, false);
  tpp.ShowDialog();
  if (tpp.SelectedTeamProjectCollection == null) return;
  
_tfs= tpp.SelectedTeamProjectCollection;
_css= (ICommonStructureService)_tfs.GetService<ICommonStructureService>();
_gss= (IGroupSecurityService)_tfs.GetService<IGroupSecurityService>();
 
  var allSids = _gss.ReadIdentity(SearchFactor.AccountName, 
        "Project Collection Valid Users", QueryMembership.Expanded);
 
  listAllUsers.ItemsSource = _gss.ReadIdentities(SearchFactor.Sid,
  allSids.Members, QueryMembership.None).Where(a=>a.Type == 
  IdentityType.WindowsUser || a.Type == IdentityType.WindowsGroup);
 
  listProjects.ItemsSource = _css.ListAllProjects();
}

Step 2: Get All Application Groups Under a Team Project

Once you choose a project we’ll use Project Uri and ListApplicationGroups method under IGroupSecurityService to get all Groups under that project.

private void ListProjectsSelectionChanged(object sender,
 SelectionChangedEventArgs e)
{
    if (listProjects.SelectedItem == null) return;
    var project = listProjects.SelectedItem as ProjectInfo;
    listGroups.ItemsSource = _gss.ListApplicationGroups(project.Uri);
}

Step 3: Get Users From Specific Group

When you select a specific group we’ll use the group SID to get all members under that group.

Make sure to change the SearchFactor to SID instead on AccountName, this will prevent getting users from another Project where the Group Name is not unique.

private void ListGroupsSelectionChanged(object sender, 
SelectionChangedEventArgs e)
{
    if (listGroups.SelectedItem == null) return;
 
    var group = listGroups.SelectedItem as Identity;
 
    var sids = _gss.ReadIdentity(SearchFactor.Sid, group.Sid, 
               QueryMembership.Expanded);
    if (sids == null || sids.Members.Length == 0)
    {
        listUsers.ItemsSource = null;
        return;
    }
 
    listUsers.ItemsSource = _gss.ReadIdentities(SearchFactor.Sid, 
                                 sids.Members, QueryMembership.None);
}

Step 4: Add New Application Group

This part is very simple, you just need to obtain the Project Uri and call CreateApplicationGroup under IGroupSecurityService with the Project Uri and the new Group Name.

private void BtnAddGroupClick(object sender, RoutedEventArgs e)
{
    if (string.IsNullOrEmpty(txtGroupName.Text) || 
               listProjects.SelectedItem == null) return;
            
    var project = listProjects.SelectedItem as ProjectInfo;
    var groupname = txtGroupName.Text;
    try
    {
        var result = _gss.CreateApplicationGroup(project.Uri, groupname,
                      "Your Group Description");
        ListProjectsSelectionChanged(sender, null);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

Step 5: Remove Application Group

This part is also very simple, you need to call DeleteApplicationGroup method under IGroupSecurityService with the Group sid you want to delete.

private void BtnRemoveGroupClick(object sender, RoutedEventArgs e)
{
    if (listGroups.SelectedItem == null) return;
 
    var result = MessageBox.Show("You are about to remove application 
    group from TFS, press yes to continue",
    "Remove Group", MessageBoxButton.YesNo, MessageBoxImage.Question);            


    
    if (result == MessageBoxResult.No) return;
 
    var group = listGroups.SelectedItem as Identity;
    _gss.DeleteApplicationGroup(group.Sid);
    ListProjectsSelectionChanged(sender, null);
}

Step 6: Add User To Application Group

For this you need to obtain the User sid and Group sid and again using the IGroupSecurityService add call AddMemberToApplicationGroup method passing those values.

If the User already exists in that Group you will receive a soap exception.

private void BtnAddUserToGroupClick(object sender, RoutedEventArgs e)
{
    if (listAllUsers.SelectedItem == null 
     || listGroups.SelectedItem == null) return;
 
    var group = listGroups.SelectedItem as Identity;
    var user = listAllUsers.SelectedItem as Identity;
 
    try
    {
        _gss.AddMemberToApplicationGroup(group.Sid, user.Sid);
        ListGroupsSelectionChanged(sender, null);
    }
    catch (Exception ex)
    {//TF50235: The group Test Group already has a member Administrators.
        MessageBox.Show(ex.Message);
    }
}

Step 7: Remove User From Application Group

It’s the same as Adding a user to a group, just call RemoveMemberFromApplicationGroup method.

private void BtnRemoveUserFromGroupClick(object sender, RoutedEventArgs e)
{
    if (listUsers.SelectedItem == null || 
       listGroups.SelectedItem == null) return;
 
    var group = listGroups.SelectedItem as Identity;
    var user = listUsers.SelectedItem as Identity;
 
    _gss.RemoveMemberFromApplicationGroup(group.Sid,user.Sid);
    ListGroupsSelectionChanged(sender, null);
}

Download Demo Project

Enjoy.

My Lecture at Munich ALM Days 2011

shair — Mon, 28 Nov 2011 23:42:00 GMT

TFS API Part 40–Build Service Host

shair — Mon, 14 Nov 2011 19:15:00 GMT

First, what is the Build Service Host or IBuildServiceHost?

The BuildServiceHost object represent the physical location of the Controller and/or Agent objects. The name property is usually the machine name that the Controller or Agent lives on. In earlier versions, this was simply the Machine Name property on the Agent.

Now, I’m working with a customer works with Lab Manager and after upgrading the SCVVM and perform some port changes we faced an issue – The Build Service Host stuck in your server with no way to remove it. (there is no UI for Build Hosts)

Now when trying to register the Lab environments we received an error the Host with the same name already exists, so I’ve built a small tool to help me managing the Build Service Hosts.

Download

Step 1: Connect To TFS and Obtain IBuildServer

As any TFS API article we first need to connect TFS and from the TFS Object Model to obtain the IBuildServer object.

private void BtnConnectClick(object sender, RoutedEventArgs e)
{
  var tpp = new TeamProjectPicker(TeamProjectPickerMode.NoProject, false);
  tpp.ShowDialog();
 
  if (tpp.SelectedTeamProjectCollection != null && 
      (tpp.SelectedTeamProjectCollection == null && 
      !tpp.SelectedTeamProjectCollection.HasAuthenticated)) return;
 
  _tfs = tpp.SelectedTeamProjectCollection;
  _buildSrv = _tfs.GetService<IBuildServer>();
 
  ShowList();
}

Showing the current Hosts in the TFS:

private void ShowList()
{
    buildList.ItemsSource = _buildSrv.QueryBuildServiceHosts("*");
}

The IBuildServer is running Team Foundation Build and has control on everything related to Builds.

Step 2: Delete, Create and Rename

After we obtain all Build Service Hosts we will use the IBuildServer to Create, Delete and Rename the hosts on our TFS.

private void DeleteHost(string hostName)
{
    IBuildServer buildServer = _tfs.GetService<IBuildServer>();
    IBuildServiceHost bsh = buildServer.GetBuildServiceHost(hostName);
    bsh.Delete();
}
 
private void Create(string hostName)
{
  IBuildServer buildServer = _tfs.GetService<IBuildServer>();
  IBuildServiceHost hostsrv = buildServer.CreateBuildServiceHost(hostName,
      "http", hostName, 8181);
  hostsrv.Save();
}
 
private void Rename(string currentHostName, string newHostName)
{
  IBuildServer buildServer = _tfs.GetService<IBuildServer>();
  IBuildServiceHost hostsrv = buildServer.GetBuildServiceHost
 (currentHostName);
  hostsrv.Name = newHostName;
  UriBuilder uriBuilder = new UriBuilder(hostsrv.BaseUrl);
  uriBuilder.Host = newHostName;
  hostsrv.BaseUrl = uriBuilder.Uri;
  hostsrv.Save();
}

Download

Visual Studio ALM Video & Two Updates for TFS/VS You Should Install

shair — Tue, 28 Jun 2011 15:31:00 GMT

Some news for Visual Studio 2010, I’ll start from several updates you should to apply on you TFS and Visual Studio.

KB - TFS 2010 SP1 Cumulative Update 1 – KB2536929

This is the first Update from Microsoft since SP1, and the new concept from Microsoft is to release hot fixes for critical bugs, every once in a while when the development team feels they have critical mass of fixes they will publish new Update includes all hot fixes. – So make sure your Visual Studio and TFS are up to date.

This update should be installed on TFS application tiers and build servers. It need not be installed elsewhere (clients or proxies).
*IMPORTANT UPDATE* - Don't install this patch on a TFS proxy!

KB - Rollup Update - Testing Tools in Visual Studio 2010 SP1 – Read KB

The above update solves several issues in Coded UI Testing:

Attempted to access an unloaded AppDomain. (Exception from HRESULT: 0x80131014)
"Search may have failed at '<name>' <control type> as it may have virtualized children. If the control being searched is descendant of '<name>' <control type> then including it as the parent container may solve the problem."
And More - Read KB

Visual Studio ALM + Team Foundation Server Blog

Esther Fan has released a great list of videos from MSDN about Visual Studio ALM, you will find videos for Testing, Development, Visualization, Modeling, and Architecture, Team Foundation Server and Lab Management.

Article - http://blogs.msdn.com/b/vstsue/archive/2011/06/15/videos-about-visual-studio-alm-team-foundation-server-2010-on-msdn.aspx

A Glimpse:

Testing

Lab Management

TFS API Part 38 – Create Label

shair — Tue, 14 Jun 2011 15:16:00 GMT

In my last post on TFS API I summarize in Index Page include 37 parts -http://blogs.microsoft.co.il/blogs/shair/archive/2011/05/18/tfs-api-index-parts-1-to-37.aspx

And I coming back with more about TFS API, and Today about how to create Label using TFS API.

Download Demo Project

Step 1: Create Project and Add Reference

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

First add reference for

Microsoft.TeamFoundation.dll
Microsoft.TeamFoundation.Build.Client
Microsoft.TeamFoundation.Build.Common.dll
Microsoft.TeamFoundation.dll

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

Step 2: Connect Team Foundation Server

for creating Label the only object we need to obtain is VersionControlServer, everything we need is there.

private void BtnConnectClick(object sender, RoutedEventArgs e)
{     var dp = new TeamProjectPicker(TeamProjectPickerMode.NoProject, false);     dp.ShowDialog(); //Display DomainProjectPicker     if (dp.SelectedTeamProjectCollection != null)     {         tfs = dp.SelectedTeamProjectCollection;         //Create VersionControlServer object from TFS         sourceControl = (VersionControlServer)tfs.GetService(typeof(VersionControlServer));         bg.RunWorkerAsync();     }
}

Step 3: Map Source Control

I’ve already talked about this in the past, so please check this post - TFS API Part 16: Mapping Source Control Using VersionControlServer

(Also in the Demo Project)

Step 4: Create Label

And for the important part, when we draw the source control tree we assigned the Server Path ($/Project/Folder etc) as Tag – and this is very important because this is our Label Scope.

We will start with creating VersionControlLabel contains the VersionControlServer object, Label Name, Owner and Comments.

Then we need to define the ItemSpec for the label – Which Files, Folder we want to Label.

And Finally using VersionControlLabel.CreateLabel with our settings.

private void btnCreateLabel_Click(object sender, RoutedEventArgs e)
{     if (SourceTree.SelectedItem == null || string.IsNullOrEmpty(txtLabelName.Text) ||

   comboLabelChildOption.SelectedItem == null || comboRecursion.SelectedItem == null) return;

    //get the full path from the selected file\folder   
    var path = ((TreeViewItem)SourceTree.SelectedItem).Tag.ToString();

    //Represents a version control label.   
    var versionControlLabel = new VersionControlLabel(sourceControl, txtLabelName.Text, sourceControl.AuthorizedUser,path, txtComments.Text);

    //Represents one or more files or folders on the local machine or in the repository.
    var itemSpec = new ItemSpec(path, (RecursionType)comboRecursion.SelectedItem);

    // What items should this label apply to? 
    var labelItemSpec = new LabelItemSpec[1];

    labelItemSpec[0] = new LabelItemSpec(itemSpec, VersionSpec.Latest, false);

    //*** LabelChildOption ***   
    //If you use Replace, any item that you specify in your request that's already in the label will be  
    //replaced by what you have specified. Anything that's not in the label already will be added to   
    //the label, and existing items that aren't modified by your request will remain as they were.    
    //Use Merge to leave unmodified items that are in your request but that already exist in the label. 
    //Any item in your request that's not already in the label will be added to the label, and existing
    //items in the label that aren't specified in your label will remain unchanged. Explaining the Fail    
    //option is not easy. Labels have the notion of a scope. The Fail option says that the call to create     
    //or update the label should fail if there is at least one label by the same name that exists at a      
    //scope that would be below the scope of the new label.

    var lb = sourceControl.CreateLabel(versionControlLabel, labelItemSpec, (LabelChildOption)comboLabelChildOption.SelectedItem);

    MessageBox.Show(lb[0].Status.ToString());
}

Download Demo Project

Enjoy.

TFS API Index Parts 1 To 37

shair — Wed, 18 May 2011 16:03:16 GMT

Since 2009 I ‘m writing about TFS API and several people asked to get an index page with all parts related to TFS API, so here is it:

Basic

Source Control

Testing

Work Items – Definitions and Queries

Areas and Iterations

Builds

TFS API Part 37 – Create Builds

shair — Wed, 18 May 2011 13:26:22 GMT

This is the last of series of 3 about manipulating Build Controllers (TFS API Part 35 – Create Build Controllers), Agents and Definitions (TFS API Part 36 – Create Build Definitions) and now I’ll complete the series with a demonstration on how to create a new Build and set the Result using TFS API.

This can assist you in building Fake definition in order to publish tests or setting a test environment much more easily.

Download Demo Project

As you can see from the picture above you can define the Build Name and Status and the result will appear under the Build Definition in TFS.

Step 1: Define “Update Build Information” Permissions

Before you can do any manipulation on the Build item you need to have the proper permissions, in Team Explorer under the desire Team Project go to the Builds node and Right Click –> Security

There make sure you user or group have the “Update build Information” box checked.

Step 2: Create New Build

The BuildDefinition item has CreateManualBuild method that will serve us for creating new Build.

private void BtnAddBuildClick(object sender, RoutedEventArgs e)
{

  if (listAddDefinitionBuildDefinitions.SelectedItem == null) return;   
  
 if(string.IsNullOrEmpty(txtBuildName.Text) || string.IsNullOrEmpty(txtLocalPath.Text) ||
    string.IsNullOrEmpty(txtServerPath.Text) || comboBuildStatus.SelectedItem == null)    
   {        
           MessageBox.Show("Please make sure the following fields has valid value:\n1.Build Name\n2.Local Path\n3.Server Path\n4.Status",  
           "Missing Values", MessageBoxButton.OK, MessageBoxImage.Information); 
         return; 
   } 
 try   
  {    
     var buildDefinition = (IBuildDefinition)listAddDefinitionBuildDefinitions.SelectedItem;    
     IBuildDetail buildDetail = buildDefinition.CreateManualBuild(txtBuildName.Text); 
     IBuildProjectNode buildProjectNode = buildDetail.Information.AddBuildProjectNode(   
     DateTime.Now.AddSeconds(10),            // Finish Time = The time at which the project finished building.  
     comboFlavor.SelectedValue.ToString(),   //Flavor = The flavor (configuration) the project was built for.  
     txtLocalPath.Text,                      //Local Path = The local path of the project file.            
     comboPlatform.SelectedValue.ToString(), //Platform = The platform the project was built for.           
     txtServerPath.Text,                     // Server Path = The server path of the project file.            
     DateTime.Now,                           //Start Time = The time at which the project was built.          
    "default");                             //Target Name = The targets for which the project was built.    
     buildProjectNode.Save();        
     buildDetail.FinalizeStatus((BuildStatus)comboBuildStatus.SelectedItem); 
     ClearAddBuildForm();    
 }     
 catch (AccessDeniedException accessDeniedException)    
 {        
        MessageBox.Show(accessDeniedException.Message, "Access Denied Exception", MessageBoxButton.OK, MessageBoxImage.Error);   
 }     
catch (BuildNumberAlreadyExistsException buildNumberAlreadyExistsException)   
  {        
        MessageBox.Show(buildNumberAlreadyExistsException.Message, "Build Number Already Exists Exception", MessageBoxButton.OK, MessageBoxImage.Error);   
  }    
catch (InvalidFinalStatusException invalidFinalStatusException)    
  {       
  MessageBox.Show(invalidFinalStatusException.Message, "Invalid Final Status Exception", MessageBoxButton.OK, MessageBoxImage.Error); 
  }    
 finally  
  {         
        listBuilds.ItemsSource = ((IBuildDefinition)listAddDefinitionBuildDefinitions.SelectedItem).QueryBuilds();   
  }
}

Step 3: Query Builds from Build Definition

Using the QueryBuilds method in IBuildDefinition will bring back all Build under that specific Build Definition.

private void ListAddDefinitionBuildDefinitionsSelectionChanged(object sender, SelectionChangedEventArgs e)
{    
   if(listAddDefinitionBuildDefinitions.SelectedItem == null) return;  
   
   listBuilds.ItemsSource = ((IBuildDefinition) listAddDefinitionBuildDefinitions.SelectedItem).QueryBuilds();
}

Step 4: Remove Build

IBuildServer allow you to call the DeleteBuilds method with the Builds you want to delete.

private void BtnRemoveBuildClick(object sender, RoutedEventArgs e)
{     
    if (listBuilds.SelectedItem == null) return;   
  
    _buildServer.DeleteBuilds(new IBuildDetail[] { (IBuildDetail)listBuilds.SelectedItem });
    listBuilds.ItemsSource = ((IBuildDefinition)listAddDefinitionBuildDefinitions.SelectedItem).QueryBuilds();
}

Download Demo Project

TFS API Part 36 – Create Build Definitions

shair — Mon, 16 May 2011 11:45:04 GMT

In my last post TFS API Part 35 – Create Build Controllers I showed how to create Build Controllers using TFS API, this can help create a Fake Build and publish test results outside TFS.

This post continue the coding from me previous post, and shows how to create or delete Build Definitions under a specific Team Project.

Download Demo Project

Step 1: Obtain Build Process Templates and Existing Definition from Team Project

private void ListDefinitionsTeamProjectSelectionChanged(object sender, SelectionChangedEventArgs e)
{     
     if (listDefinitionsTeamProject.SelectedItem == null) return; 
     comboProcessTemplates.ItemsSource = _buildServer.QueryProcessTemplates(
                                             ((Project)listDefinitionsTeamProject.SelectedItem).Name);     
        listAddDefinitionBuildDefinitions.ItemsSource = _buildServer.QueryBuildDefinitions( 
         ((Project)listDefinitionsTeamProject.SelectedItem).Name);
}

Step 2: Add New Build Definition

private void BtnAddDefinitionClick(object sender, RoutedEventArgs e)
{     
    if (listDefinitionsTeamProject.SelectedItem != null && listTfsControllers.SelectedItem != null)  
   {        
        if (string.IsNullOrEmpty(txtDefinitionName.Text) || string.IsNullOrEmpty(txtDropLocation.Text) || 
            comboProcessTemplates.SelectedItem == null)        
          {             
            MessageBox.Show(
                 "Please make sure the following fields has value:\n1.Definiton Name\n2.Drop Location\n3.Process Template",
  "Missing Values", MessageBoxButton.OK, MessageBoxImage.Error);             
            return;       
   }        
        try     
     {      
        var proj = (Project)listDefinitionsTeamProject.SelectedItem; 
            var controller = (IBuildController)listTfsControllers.SelectedItem;  
            //Create new instance of build definition under the Team Project.     
         var definition = _buildServer.CreateBuildDefinition(proj.Name);          
    definition.Name = txtDefinitionName.Text;            
            //Define Build Definition Trigger - // All, Batch , Gated, Individual, None, Schedule, ScheduleForced   
           definition.ContinuousIntegrationType = (ContinuousIntegrationType)comboContinuousIntegrationTypes.SelectedItem;      
        //Define Build Controller            
            definition.BuildController = controller;           
   definition.DefaultDropLocation = txtDropLocation.Text; 
            definition.Description = txtDescription.Text;     
         definition.Enabled = (bool)chxIsEnabled.IsChecked ? true : false;         
     //Create a fake workspace folder          
    definition.Workspace.AddMapping("$/", "c:\\someFakeFolder", WorkspaceMappingType.Map);  
            //Assign the Process Template for the new build definition            
            definition.Process = (IProcessTemplate)comboProcessTemplates.SelectedItem;         
     definition.Save();             
            //Refresh the Build Definitions List         
     listAddDefinitionBuildDefinitions.ItemsSource = _buildServer.QueryBuildDefinitions(((Project)listDefinitionsTeamProject.SelectedItem).Name); 
         }         
      catch (BuildServerException ex)   
       {             
            MessageBox.Show(ex.Message, "Opps", MessageBoxButton.OK, MessageBoxImage.Error);   
       }  
    }
}

Step 3: Remove Build Definition

private void BtnRemoveDefinitionClick(object sender, RoutedEventArgs e)
{    
  if (listAddDefinitionBuildDefinitions.SelectedItem == null) return;
     
    _buildServer.DeleteBuildDefinitions(new IBuildDefinition[] { (IBuildDefinition)listAddDefinitionBuildDefinitions.SelectedItem }); 








  listAddDefinitionBuildDefinitions.ItemsSource = _buildServer.QueryBuildDefinitions(((Project)listDefinitionsTeamProject.SelectedItem).Name);
}

Download Demo Project

Test Case Migrator Between Projects – WPF Metro

shair — Sun, 20 Mar 2011 18:08:57 GMT

Test Case Migrator Between Projects – WPF Metro

This is a common question I keep hearing from customers:

Question: How can we copy Test Cases \ Shared Steps from one Team Project to another?

Answer: You can manually duplicate item after item in visual studio but this isn’t a good solution if you have lots of Test Cases to copy.

So, to solve this problem I built a tiny little tool to help you accomplish this task.

This tool contains 4 steps:

Getting Started:

1. Connection

Connect to TFS, pick Source and Target Team Project.

Define a configuration file (all the data will be saved there).

2. Fields

Here you will see if there any missing fields , areas and iterations between the Source and Target Team Project.

I didn't make any special feature to create those, so you will have to complete the missing fields,area and iterations before continue.

4. Query

Using TFS Queries, just pick the Test Cases you want to migrate.

4. Start

I think you understand this part...... :-)

4.1 – See Migration Results

4.2 - The tool will not recreate existing Test Cases (Already migrate using this tool - everything is saved in the configuratiionFile.)

And the Result:

if you want to try this tool please contact me directly.

Thanks

TFS API Part 34– Build Basic Actions

shair — Mon, 24 Jan 2011 13:18:43 GMT

TFS API Part 34– Build Basic Actions

In my previous post on on TFS API– Get Build Definitions and Build Details I’ve showed how to obtain Builds Definitions and Builds using TFS API.
In this post I' used the same project but I’ve added more functionality to the UI that will allow you to perform more actions on the Build item (Stop, Delete etc).

Download Demo Project

Step 1: Create Project and Add Reference

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

First add reference for

Microsoft.TeamFoundation.dll
Microsoft.TeamFoundation.Build.Client
Microsoft.TeamFoundation.Build.Common.dll
Microsoft.TeamFoundation.dll

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

Step 2: Connect to Team Foundation Server

(TFS API Part 20: Bye TeamFoundationServer and Welcome TfsTeamProjectCollection)

private TfsTeamProjectCollection server;
private IBuildServer buildServer;
private void btn_connect_Click(object sender, RoutedEventArgs e)
{
    TeamProjectPicker tpp = new TeamProjectPicker(TeamProjectPickerMode.SingleProject, false);
    tpp.ShowDialog();
 
    if (tpp.SelectedTeamProjectCollection != null)
    {
        server = tpp.SelectedTeamProjectCollection;
        server.EnsureAuthenticated();
        buildServer = (IBuildServer)server.GetService(typeof(IBuildServer));
 
        //QueryBuildDefinitions(String)	Gets the build definitions for the specified team project.
        //QueryBuildDefinitions(IBuildDefinitionSpec)	Gets a single build definition query result for a specified build definition specification.
        //QueryBuildDefinitions(IBuildDefinitionSpec[])	Gets the build definition query results for a specified array of build definition specifications.
        //QueryBuildDefinitions(String, QueryOptions)	Gets the build definitions for the specified team project. The specified query options determine the amount of data that is retrieved in the query.
        // IBuildDefinition Interface -> http://msdn.microsoft.com/en-us/library/microsoft.teamfoundation.build.client.ibuilddefinition.aspx
        BuildDefinitions.ItemsSource = buildServer.QueryBuildDefinitions(tpp.SelectedProjects[0].Name);
    }
}

Step 3: Build Actions

Here is the list of some basic methods you can use for BuildDetail.

IBuildDetail build = Builds.SelectedItem as IBuildDetail;
//Delete the build and only the specified information.
//None          No delete options selected.
//DropLocation	Delete drop location.
//TestResults	Delete test results.
//Label          Delete the label.
//Details      Delete details.
//Symbols      Delete symbols.
//All          Delete all.
build.Delete(DeleteOptions.All);

//Stops the build.
build.Stop();

//Starts polling by using the default interval of five seconds and no synchronization object.
//When events are handled by a visual Windows Forms component, the other overload should be used for this
//method and that component should be passed in as the synchronizingObject so that the event handlers 
//are called on the same thread on which the component was created.
build.Connect();

//Stops polling the server.
build.Disconnect();

//Notifies the server that the build is complete and sets the status accordingly.
BuildStatus item = (BuildStatus)combo_status.SelectedItem;
build.FinalizeStatus(item);

//Blocks additional builds until this build is finished.
build.Wait();

//Retrieves the latest build data from the server with all details.
build.RefreshAllDetails();

Enjoy

Download Demo Project

TFS API Part 33– Get Build Definitions and Build Details

shair — Tue, 11 Jan 2011 20:15:14 GMT

TFS API Part 33– Get Build Definitions and Build Details

Doing some major projects in WF under Team Build 2010 I decide it’s the right time to start writing about Build API in TFS 2010.

This part is very very basic and in later posts I’ll show some cool stuff in Build 2010 API.

Download Demo Project

Step 1: Create Project and Add Reference

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

First add reference for

Microsoft.TeamFoundation.dll
Microsoft.TeamFoundation.Build.Client
Microsoft.TeamFoundation.Build.Common.dll
Microsoft.TeamFoundation.dll

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

Step 2: Connect to Team Foundation Server

(TFS API Part 20: Bye TeamFoundationServer and Welcome TfsTeamProjectCollection)

private TfsTeamProjectCollection server;
private IBuildServer buildServer;
private void btn_connect_Click(object sender, RoutedEventArgs e)
{
    TeamProjectPicker tpp = new TeamProjectPicker(TeamProjectPickerMode.SingleProject, false);
    tpp.ShowDialog();
 
    if (tpp.SelectedTeamProjectCollection != null)
    {
        server = tpp.SelectedTeamProjectCollection;
        server.EnsureAuthenticated();
        buildServer = (IBuildServer)server.GetService(typeof(IBuildServer));
 
        //QueryBuildDefinitions(String)	Gets the build definitions for the specified team project.
        //QueryBuildDefinitions(IBuildDefinitionSpec)	Gets a single build definition query result for a specified build definition specification.
        //QueryBuildDefinitions(IBuildDefinitionSpec[])	Gets the build definition query results for a specified array of build definition specifications.
        //QueryBuildDefinitions(String, QueryOptions)	Gets the build definitions for the specified team project. The specified query options determine the amount of data that is retrieved in the query.
        // IBuildDefinition Interface -> http://msdn.microsoft.com/en-us/library/microsoft.teamfoundation.build.client.ibuilddefinition.aspx
        BuildDefinitions.ItemsSource = buildServer.QueryBuildDefinitions(tpp.SelectedProjects[0].Name);
    }
}

Step 3: Get Builds From Build Definition

private void BuildDefinitions_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
    if (BuildDefinitions.SelectedItem != null)
    {
        IBuildDefinition def = BuildDefinitions.SelectedItem as IBuildDefinition;
        //IBuildDetail Interface -> http://msdn.microsoft.com/en-us/library/microsoft.teamfoundation.build.client.ibuilddetail.aspx
        Builds.ItemsSource = def.QueryBuilds();
    }
}

Download Demo Project

TFS API Part 32 – Add and Remove Users From Application Groups

shair — Thu, 25 Nov 2010 02:45:17 GMT

TFS API Part 32 – Add and Remove Users From Application Groups

Download Demo Project

Step 1: Create Project and Add Reference

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

First add reference for

Microsoft.TeamFoundation.dll
Microsoft.TeamFoundation.Client.dll
Microsoft.TeamFoundation.Common.dll

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

Step 2: Connect to Team Foundation Server

(TFS API Part 20: Bye TeamFoundationServer and Welcome TfsTeamProjectCollection)

IGroupSecurityService gss;
private void button1_Click(object sender, RoutedEventArgs e)
{
    TeamProjectPicker tpp = new TeamProjectPicker(TeamProjectPickerMode.SingleProject, false);
    tpp.ShowDialog();
 
    if (tpp.SelectedProjects.Length > 0)
    {
        TFS = tpp.SelectedTeamProjectCollection;
        Project = tpp.SelectedProjects[0];
        gss = (IGroupSecurityService)TFS.GetService(typeof(IGroupSecurityService));
    }
}

Step 3: Get All Users and Groups by Project

First create listbox called “list_users” to contain the users list and a combobox called “combo_groups” to contain the Project Groups

void GetUsers()
{
    //Perfom search based on "Project Collection Valid Users" this valid only for TFS 2010 in order to user the same functionality on TFS 2008
    //You need to user Team Foundation Valid Users"
    Identity SIDS = gss.ReadIdentity(SearchFactor.AccountName, "Project Collection Valid Users", QueryMembership.Expanded);
    Identity[] UserIds = gss.ReadIdentities(SearchFactor.Sid, SIDS.Members, QueryMembership.None);
 
    var query = from user in UserIds
                where user.Type == IdentityType.WindowsUser
                select user;
 
    list_users.ItemsSource = query;
}
 
void GetGroups()
{
    Identity SIDS = gss.ReadIdentity(SearchFactor.EveryoneApplicationGroup, "", QueryMembership.Expanded);
    Identity[] groups = gss.ReadIdentities(SearchFactor.Sid, SIDS.Members, QueryMembership.None);
 
    var query = from _group in groups
                where _group.Type == IdentityType.ApplicationGroup
                select _group;
 
    combo_groups.ItemsSource = gss.ListApplicationGroups(Project.Uri);
}

Step 4: Get User List by Group

After you select a group from the combobox this method will obtain all Users from that application group.

void DefineGroupUsers()
{
    if (combo_groups.SelectedItem != null)
    {
        Identity group = combo_groups.SelectedItem as Identity;
 
        //Perform new search based on Sid and from the selected Group.
        Identity SIDS = gss.ReadIdentity(SearchFactor.Sid, group.Sid, QueryMembership.Expanded);
        //Read the users related to that group.
        if (SIDS.Members.Length > 0)
        {
            Identity[] UserIds = gss.ReadIdentities(SearchFactor.Sid, SIDS.Members, QueryMembership.None);
            list_group_users.ItemsSource = UserIds;
        }
        else
            list_group_users.ItemsSource = null;
    }
}

Step 5: Add and Remove User From Application Group

Now we getting to the important part – Adding and Removing Users from Groups.

User IGroupSecurityService object this is very easy task – just call RemoveMemberFromApplicationGroup method to remove user from group with the group Sid and User Sid, same goes for Adding a User.

private void btn_remove_Click(object sender, RoutedEventArgs e)
{
    if (list_group_users.SelectedItem != null && combo_groups.SelectedItem != null)
    {
        Identity user = list_group_users.SelectedItem as Identity;
        Identity group = combo_groups.SelectedItem as Identity;
        //Remove User to Specific Application Group
        gss.RemoveMemberFromApplicationGroup(group.Sid, user.Sid);
        //Refresh Users List
        DefineGroupUsers();
    }
}
 
private void btn_add_Click(object sender, RoutedEventArgs e)
{
    if (combo_groups.SelectedItem != null && list_users.SelectedItem != null)
    {
        Identity user = list_users.SelectedItem as Identity;
        Identity group = combo_groups.SelectedItem as Identity;
        //Add User to Specific Application Group
        gss.AddMemberToApplicationGroup(group.Sid, user.Sid);
        //Refresh Users List
        DefineGroupUsers();
    }
}

Download Demo Project

Enjoy

ALM Summit Here We Come

shair — Fri, 29 Oct 2010 13:25:28 GMT

ALM Summit Here We Come

Application Lifecycle Management for the Microsoft platform will take place as November 16-18, 2010 - Microsoft Redmond.

If you are an ALM practitioner, lead, or manager who is passionate about mastering your craft, this is an event you don’t want to miss, and Sela Collage as ALM leader in Israel will be there as a gold sponsor.

Sela is going to announce of two tools for TFS and Visual Studio 2010:

Scrat – Quality Center 2 TFS 2010 Migration Tool – Home Page
Wimbi – More details after the summit

Here is the agenda:

Day 1: Agile Acceleration Day

Scrum: The Third Decade - Ken Schwaber
ALM Adoption and Futures - Dave West
Heterogeneous ALM Environments - Jamie Cool
IT for the Future - Moving into the Cloud - Tony Scott
Achieving true 'ALM' through analytics - Stuart McGill
Using Failure to Pave the Path for Success - John Szurek
Scenario-Focused Engineering - Austina De Bonte
Agile transformation during acquisition - Chris Kinsman
Agile transformation of a Microsoft product team - Cameron Skinner

Day 2: Collaborative Development

From Individual to Team to Organization - Brian Harry
Making Continuous Delivery a Reality from Product Backlog to Virtual Lab - Amit Chopra
Successful software project management styles - Stephanie Cuthbertson
Increasing Revenue Opportunities with Automated Development Tools - Karel Deman
Extending the ALM Platform - Mario Cardinal
Connecting ALM to Developer Workflow: the Task-Focused Interface - David Green (Tasktop)
Synchronizing and migrating ALM environments - Grant Holliday
The Future of Collaborative Development - Mary Czerwinski

Day 3: Engaging the Whole Team

The Agile Consensus - Sam Guckenheimer
Introducing Agility into the Enterprise at Nordstrom - JB Brown
Testing Tools in an Agile World - Vinod Malhotra
Transcending Dogma: How are they different, really? - Eric Willeke
Shared Values - The Why of ALM - Jim Newkirk
Exploratory Testing - Jon Bach
Professional Scrum Developer Practices - Richard Hundehausen
Quality is the Soul of Agile - Peter Provost

ALM Summit Home Page

Brian Harry will also be at the Summit as a presenter. (Brian on the Summit)

I hope to see you there!

TFS API Part 29 – TFS Impersonation

shair — Mon, 23 Aug 2010 23:00:10 GMT

TFS API Part 29 – TFS Impersonation

What is TFS Impersonation?

TFS Impersonation is a feature that was introduced in TFS 2010 in order to allow a process running as User A to make web service calls to TFS in such a way that TFS thinks the actions are being performed by User B.

A long time ago I wrote about Access Token With C#, a method that will allow you to perform actions with a different user.

Why? when writing Tools and services for customers one of the most important features is to perform the action with the right user. Let’s say I want to run a service that for each Work Item Save action you want to add value to a field – this action is very simple but the history will show two actions from two different users, the user who run the service did the action instead of the user who saved the work item.

And I can find couple more actions the Impersonation can help us with.

Download Example

Step 1: Create Project and Add Reference

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

using Microsoft.TeamFoundation.Client;
using Microsoft.TeamFoundation.Framework.Client;
using Microsoft.TeamFoundation.Framework.Common;
using Microsoft.TeamFoundation.Server;

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

Step 2: Connect to Team Foundation Server

(TFS API Part 20: Bye TeamFoundationServer and Welcome TfsTeamProjectCollection)

TfsTeamProjectCollection tfs;
TeamProjectPicker tpp = new TeamProjectPicker(TeamProjectPickerMode.NoProject, false);
tpp.ShowDialog();
 
if (tpp.SelectedTeamProjectCollection != null)
{
    tfs = tpp.SelectedTeamProjectCollection;
    ims = tfs.GetService<IIdentityManagementService>();
 
    GetUsers();
    GetAuthenticatedIdentity(tfs);
}

Step 3: GetUsers & GetAuthenticatedIdentity

I’ve created the following methods to make things easier, GetUsers will allow you to pick the user to Impersonate from the List instead of writing Account Names etc… and GetAuthenticatedIdentity will display the user running the TfsTeamProjectCollection object.

/// <summary>
/// Gets all window users from the "Project Collection Valid Users" group
/// </summary>
void GetUsers()
{
    IGroupSecurityService gss = (IGroupSecurityService)tfs.GetService(typeof(IGroupSecurityService));
    Identity SIDS = gss.ReadIdentity(SearchFactor.AccountName, "Project Collection Valid Users", QueryMembership.Expanded);
    Identity[] UserId = gss.ReadIdentities(SearchFactor.Sid, SIDS.Members,QueryMembership.Expanded);
 
    var query = from s in UserId
                where s.Type == IdentityType.WindowsUser
                select s;
 
    UsersList.ItemsSource = query;
}

/// <summary>
/// Gets the Authorized Identity from the current TFS connection object
/// </summary>
/// <param name="current_tfs">latest tfs connection object</param>
void GetAuthenticatedIdentity(TfsTeamProjectCollection current_tfs)
{
    try
    {
        txt_current_user.Text = current_tfs.AuthorizedIdentity.DisplayName;
    }
    catch (AccessCheckException ex)
    {
        //By default, the Administrators group does not have the 
        //“Make requests on behalf of others” permission
        throw new AccessCheckException(ex.Message);
    }
}

Step 4: Impersonate

/// <summary>
/// Impersonation - Creates new instance of TfsTeamProjectCollection object using a different user;
/// </summary>
/// <param name="serverUri">Tfs server uri you want to connect using Impersonation</param>
/// <param name="userToImpersonate">Account name of the user you want to Impersonate</param>
public void Impersonation(Uri serverUri,string userToImpersonate)
{
    // Read out the identity of the user we want to impersonate
    TeamFoundationIdentity identity = ims.ReadIdentity(IdentitySearchFactor.AccountName, 
        userToImpersonate,
        MembershipQuery.None, 
        ReadIdentityOptions.None);
 
    tfs_impersonated = new TfsTeamProjectCollection(serverUri, identity.Descriptor);
 
    GetAuthenticatedIdentity(tfs_impersonated);
}

Step 5: Enable “Make requests on behalf of others”

If you run the code right now – it will fail!

By default, the Administrators group does not have the “Make requests on behalf of others” permission.

To Enable Impersonate run the following command:
tfssecurity.exe /collection:http://localhost:8080/tfs/DefaultCollection /a+ Server FrameworkGlobalSecurity Impersonate adm: ALLOW

After running the command you should see “Make requests on behalf of others” enabled.

To Disable Impersonate run the following command:

tfssecurity.exe /collection:http://localhost:8080/tfs/DefaultCollection /a- Server FrameworkGlobalSecurity Impersonate adm: ALLOW

Now, after enabling Impersonation you can use this tool:

Tfs object is now running using “Local Service”

Download Example

Enjoy