博客园_Ruiz

How TFS Build Get Associated Changesets/Workitems and Update Workitems

2010-07-28T16:54:00Z

When we queue a build in TFS, if it failed, TFSBuild will create a bug workitem. If it successes, TFSBuild will update associated workitems.

1 How TFSBuild gets associated changesets
private void AnalyzeChangesets(Item[] lastItems, Item[] currentItems);
Declaring Type:
Microsoft.TeamFoundation.Build.Tasks.GenCheckinNotesUpdateWorkItems
Assembly:
Microsoft.TeamFoundation.Build.Tasks.VersionControl, Version=9.0.0.0

As we know, When we queue a build in TFS, TFSBuild will Label the source code, if the Build successes, TFS will record the Label in Database as the LastGoodBuildLabel of the current Build Definition.And the next time we queue the same build definition, TFSBuild can get LastGoodBuildLabel and CurrentLabel.

The task GenCheckinNotesUpdateWorkItems will get lastItems[] in  LastGoodBuildLabel  and currentItems[] in CurrentLabel.

A If lastItems[i]’s ItemID matches a item in currentItems, like currentItems[j]

Get all changesets between lastItems[i]’s changesetID and currentItems[j]’s changesetID that include this item.

Notice, not all changeset between them include this item

B If lastItems[i]’s ItemID does not match any item in currentItems and does not exist in Latest version

This means that the Item may be deleted in a changeset.Get all changesets between lastItems[i]’s changesetID and VersionSpec.Latest that include this item.

C If currentItems[i]’s ItemID does not match any item in lastItems

Get all changesets between ChangesetVersionSpec(1) and currentItems[i]’s changesetID that include this item.

2 How TFSBuild get associated WorkItems

Each changesets contains a prroperty WorkItems. In the step1 we can get all associated changesets, and then we can get all WorkItems.

3 How associate a WorkItem to changeset

A In Team Explorer, when you check-in a changeset, you can associate workitems to it.

B in Team Explorer, you can edit a changeset and associate workitems to it.

4 How TFSBuild Update WorkItems
TFSBuild will set item["Microsoft.VSTS.Build.IntegrationBuild"] = this.BuildNumber for all associated workitem which have this field.

本文链接

How to set SMTP Port in TFS2010

2010-07-01T06:24:00Z

In TFS2010 Administration Console, you can only set SMTP Server and Email From Address.

And in the TFS Config command line

TFSConfig ConfigureMail /FromEmailAddress:emailAddress /SmtpHost:SMTPHostName

You can not set port. Smtphost:port is not a valid format even though the command could accept it successfully.

In TFS2010, TFSJobAgent is used to send notification. You can edit the TFSJobAgent.exe.config to set the mail port.

Add following script to C:\Program Files\Microsoft Team Foundation Server 2010\Application Tier\TFSJobAgent\TfsJobAgent.exe.config

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

<system.net>
<mailSettings>
    <smtp >
      <network host="smtpserver" port="26" >
    </smtp>
</mailSettings>
</system.net>

</configuration>

The host will be ignored but port will be used.

本文链接

Create work item in code editor

2010-06-01T03:45:00Z

Some developers or testers may find that it will be more convenient that they could create a bug in code editor. Select a method, right click and create a work item.

Following steps and sample codes is for VS2010 and .NET4.0.

1 Create a VS Add-in project

2 Add new entry to the context menu of code editor.

The add-in class Connect will implement interface IDTExtensibility2

   1: namespace Extensibility   2: {   3:     [Guid("B65AD801-ABAF-11D0-BB8B-00A0C90F2744")]   4:     [TypeLibType(4160)]   5:     public interface IDTExtensibility2   6:     {   7:         [DispId(3)]   8:         void OnAddInsUpdate(ref Array custom);   9:         [DispId(5)]  10:         void OnBeginShutdown(ref Array custom);  11:         [DispId(1)]  12:         void OnConnection(object Application, ext_ConnectMode ConnectMode, object AddInInst, ref Array custom);  13:         [DispId(2)]  14:         void OnDisconnection(ext_DisconnectMode RemoveMode, ref Array custom);  15:         [DispId(4)]  16:         void OnStartupComplete(ref Array custom);  17:     }  18: }

Implement method OnConnection with following code

   1: public void OnConnection(object application, ext_ConnectMode connectMode, object addInInst, ref Array custom)   2:         {   3:             _applicationObject = (DTE2)application;   4:             _addInInstance = (AddIn)addInInst;   5:             if(connectMode == ext_ConnectMode.ext_cm_UISetup)   6:             {   7:                 object []contextGUIDS = new object[] { };   8:                 Commands2 commands = (Commands2)_applicationObject.Commands;   9:                 string toolsMenuName = "Code Window";  10:    11:               12:                 //Place the command on the tools menu.  13:                 //Find the MenuBar command bar, which is the top-level command bar holding all the main menu items:  14:                 Microsoft.VisualStudio.CommandBars.CommandBar menuBarCommandBar = ((Microsoft.VisualStudio.CommandBars.CommandBars)_applicationObject.CommandBars)["Editor Context Menus"];  15:    16:                 //Find the Tools command bar on the MenuBar command bar:  17:                 CommandBarControl toolsControl = menuBarCommandBar.Controls[toolsMenuName];  18:                 CommandBarPopup toolsPopup = (CommandBarPopup)toolsControl;  19:    20:                 //This try/catch block can be duplicated if you wish to add multiple commands to be handled by your Add-in,  21:                 //  just make sure you also update the QueryStatus/Exec method to include the new command names.  22:                 try  23:                 {  24:                     //Add a command to the Commands collection:  25:                     Command command = commands.AddNamedCommand2(_addInInstance, "CreateWorkItem", "CreateWorkItem", "Executes the command for CreateWorkItem", true, 59, ref contextGUIDS, (int)vsCommandStatus.vsCommandStatusSupported + (int)vsCommandStatus.vsCommandStatusEnabled, (int)vsCommandStyle.vsCommandStylePictAndText, vsCommandControlType.vsCommandControlTypeButton);  26:    27:                     //Add a control for the command to the tools menu:  28:                     if((command != null) && (toolsPopup != null))  29:                     {  30:                         command.AddControl(toolsPopup.CommandBar, 1);  31:    32:                     }  33:                 }  34:                 catch(System.ArgumentException)  35:                 {  36:                     //If we are here, then the exception is probably because a command with that name  37:                     //  already exists. If so there is no need to recreate the command and we can   38:                     //  safely ignore the exception.  39:                 }  40:             }  41:         }

3 Handle the command when the menu is clicked

The add-in class Connect will implement interface IDTCommandTarget

   1: public interface IDTCommandTarget   2:    {   3:        [DispId(2)]   4:        void Exec(string CmdName, vsCommandExecOption ExecuteOption, ref object VariantIn, ref object VariantOut, ref bool Handled);   5:        [DispId(1)]   6:        void QueryStatus(string CmdName, vsCommandStatusTextWanted NeededText, ref vsCommandStatus StatusOption, ref object CommandText);   7:    }

When the menu is click, the method Exec is called.

In the Exec command, show a dialog to choose work item type.

   1: public void Exec(string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled)   2:         {   3:             handled = false;   4:             if(executeOption == vsCommandExecOption.vsCommandExecOptionDoDefault)   5:             {   6:                 if (commandName == "CreateWorkItem.Connect.CreateWorkItem")   7:                 {                                         8:                     Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt tfsExt   9:                        = (Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt)_applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt");  10:    11:                     //Confirm that TFS is connected  12:                     if ((tfsExt == null)   13:                         || (tfsExt.ActiveProjectContext == null)   14:                         || (tfsExt.ActiveProjectContext.DomainUri == null)   15:                         || (tfsExt.ActiveProjectContext.ProjectUri == null))  16:                     {  17:                         MessageBox.Show("Please Connect to TFS first and select a Team Project");  18:                     }  19:    20:                     WorkItemTypeSelect witselect = new WorkItemTypeSelect();  21:                     witselect._applicationObject = _applicationObject;  22:                     witselect.ShowDialog();  23:    24:                     handled = true;  25:                     return;  26:                 }  27:             }  28:         }

The UI of the dialog is like

The codes are

   1: using System;   2: using System.Collections.Generic;   3: using System.ComponentModel;   4: using System.Data;   5: using System.Drawing;   6: using System.Linq;   7: using System.Text;   8: using System.Windows.Forms;   9: using EnvDTE80;  10: using Microsoft.TeamFoundation.Client;  11: using Microsoft.VisualStudio.TeamFoundation.WorkItemTracking;  12: using Microsoft.TeamFoundation.WorkItemTracking.Client;  13:    14: namespace CreateWorkItem  15: {  16:     public partial class WorkItemTypeSelect : Form  17:     {  18:         public DTE2 _applicationObject { get; set; }  19:         Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt tfsExt;  20:         DocumentService witDocumentService;  21:         TfsTeamProjectCollection tfsProjectCollection;  22:         WorkItemStore wiStore;  23:    24:         public WorkItemTypeSelect()  25:         {  26:             InitializeComponent();  27:         }  28:    29:         private void button1_Click(object sender, EventArgs e)  30:         {  31:    32:             WorkItem wi = new WorkItem(wiStore.Projects[tfsExt.ActiveProjectContext.ProjectName].WorkItemTypes[listBox1.SelectedItem.ToString()]);  33:    34:             wi.Title = listBox1.SelectedItem.ToString();  35:    36:             dynamic selection = _applicationObject.ActiveDocument.Selection;  37:             wi.Description = selection.Text;  38:    39:             IWorkItemDocument widoc = null;  40:             widoc = witDocumentService.CreateWorkItem(wi,  41:                 new object());  42:             try  43:             {  44:                 witDocumentService.ShowWorkItem(widoc);  45:             }  46:             finally  47:             {  48:                 widoc.Release(this);  49:             }  50:             this.Close();  51:         }  52:    53:         private void WorkItemTypeSelect_Load(object sender, EventArgs e)  54:         {  55:             tfsExt = (Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt)_applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt");  56:    57:             witDocumentService = (DocumentService)_applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.WorkItemTracking.DocumentService");  58:    59:             tfsProjectCollection = TfsTeamProjectCollectionFactory.GetTeamProjectCollection(new Uri(tfsExt.ActiveProjectContext.DomainUri));  60:    61:             wiStore = tfsProjectCollection.GetService<WorkItemStore>();  62:    63:             listBox1.Items.Clear();  64:             foreach (WorkItemType wit in wiStore.Projects[tfsExt.ActiveProjectContext.ProjectName].WorkItemTypes)  65:             {  66:                 listBox1.Items.Add(wit.Name);  67:             }  68:    69:               70:         }  71:     }  72: }

Note that in MSF for Agile 5, description is not displayed in Bug work item, you can

set the field Microsoft.VSTS.TCM.ReproSteps.

The final result is

本文链接

Listen the Getting event of Version Control

2010-03-05T03:11:00Z

This behavior can be done in many ways, Hongye supplied a solution in http://social.msdn.microsoft.com/Forums/en-US/tfsgeneral/thread/c6a4dc3c-39f9-4e37-9de0-93319273b8bc.

Another way is to use the Getting event of VersionControlServer.

1 Create a Visual Studio Add-in project ListenGetStatus

Add following references

EnvDTE

EnvDTE80

EnvDTE90

Microsoft.TeamFoundation

Microsoft.TeamFoundation.Client

Microsoft.TeamFoundation.VersionControl.Client

Microsoft.VisualStudio.TeamFoundation

Microsoft.VisualStudio.TeamFoundation .Client

Microsoft.VisualStudio.TeamFoundation.VersionControl

2 Implement OnStartupComplete

TeamFoundationServerExt tfsExt;
        VersionControlExt vsExt;
        public void OnStartupComplete(ref Array custom)
        {
            tfsExt = _applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.TeamFoundationServerExt") as TeamFoundationServerExt;
            if (tfsExt.ActiveProjectContext.DomainUri == null)
            {
                MessageBox.Show("Error");
                return;
            }


            vsExt = _applicationObject.GetObject("Microsoft.VisualStudio.TeamFoundation.VersionControl.VersionControlExt") as VersionControlExt;

            vsExt.Explorer.Workspace.VersionControlServer.Getting += new GettingEventHandler(VersionControlServer_Getting);
            

        }


        static object locker = new object();
        void VersionControlServer_Getting(object sender, GettingEventArgs e)
        {
            lock (locker)
            {
                FileStream fs = null;
                StreamWriter writer=null;

                try
                {
                    fs = File.Open("C:\\GettingLog.txt", FileMode.Append);

                    writer = new StreamWriter(fs);
                    writer.WriteLine(string.Empty);
                    writer.WriteLine(DateTime.Now.ToString());
                    writer.WriteLine(String.Format("ServerItem={0}", e.ServerItem));
                    writer.WriteLine(String.Format("SourceLocalItem={0}", e.SourceLocalItem));
                    writer.WriteLine(String.Format("ChangeType={0}", e.ChangeType));
                    writer.WriteLine(String.Format("DeletionId={0}", e.DeletionId));
                    writer.WriteLine(String.Format("DiskUpdateAttempted={0}", e.DiskUpdateAttempted));
                    writer.WriteLine(String.Format("IsDelete={0}", e.IsDelete));
                    writer.WriteLine(String.Format("IsLatest={0}", e.IsLatest));
                    writer.WriteLine(String.Format("ItemId={0}", e.ItemId));
                    writer.WriteLine(String.Format("ItemType={0}", e.ItemType));

                    writer.WriteLine(String.Format("Status={0}", e.Status));
                    writer.WriteLine(String.Format("TargetLocalItem={0}", e.TargetLocalItem));
                    writer.WriteLine(String.Format("Version={0}", e.Version));
                    writer.WriteLine(String.Format("Workspace={0}", e.Workspace.DisplayName));

                }
                catch
                {

                }

                finally
                {
                    if (writer != null)
                    {
                        writer.Flush();
                        writer.Close();
                    }
                    if (fs != null)
                    {
                        fs.Flush();
                        fs.Close();
                    }
                }
                

            }

        }

3 In the above code

if (!e.IsDelete && e.IsLatest), so that the item is a new file and latest.

4 Copy the assembly under bin folder and ListenGetStatus.AddIn to My Documents\Visual Studio 2008\Addins

5 Notice that this needs TeamFoundationServer is available OnStartupComplete, you can use a Timer to check it timely if TeamFoundation is not available.

本文链接

How to Enable TFS Email Alert

2010-03-03T03:27:00Z

MSDN has an article about

How to: Configure SMTP Server and E-mail Notification Settings in the Services Web.Config File

1 TFS will use the service account(TFSService) to connect to SmtpServer, so TFSService must be a valid member of your SmtpServer, or your SmtpServer allow anonymous senders to send e-mail.
2 Edit the C:\Program Files\Microsoft Visual Studio 2008 Team Foundation Server\Web Services\Services\Web.config

<appSettings>
    <add key="ConnectionString" value="Data Source=[Server];Initial Catalog=TfsIntegration;Integrated Security=True;Persist Security Info=False;Application Name=TeamFoundation" />
    <add key="eventingEnabled" value="true" />
    <add key="DetailedExceptions" value="false" />
    <add key="emailNotificationFromAddress" value="****@*****.***" />
    <add key="smtpServer" value="[smtpHost]" />
    <add key="enableEmails" value="true" />
  </appSettings>

3 Reset IIS

本文链接

How custom wit control Open another work item in Team Explorer

2009-12-10T09:02:00Z

For the steps how to create and apply custom control, please refer to How to:Create a Custom WI Control Now we want to a feature to make custom wit control open another work item, like the behavior o...

How to Keep build number / assembly version the same and auto-increment

2009-12-08T05:44:00Z

First, Thanks for Richard’s blog http://richardsbraindump.blogspot.com/2007/07/versioning-builds-with-tfs-and-msbuild.html A simple way to keep the build number manually is to store last build number ...

How TO Subscribe TFS Event Using Web Service

2009-11-26T02:03:00Z

Team Foundation Eventing Service delivers notification of events by e-mail or through Web services. If we subscribe TFS Event using Web Service, we can do much more then E-mail. 1 Create a Asp.NET We...

Create TFS Report Step by Step

2009-11-19T09:28:00Z

After installation of SQL Server Business Intelligence Development Studio(2008), you can create TFS Reports yourself. 1 Using VS to create a Report Server Project “My Reports” 2 Right click Shared Dat...

How to exclude file types in TFS source control

2009-11-10T05:15:00Z

The exclude file types are defined in HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\9.0\TeamFoundation\SourceControl\AddOptions\ExcludeMasks, the default value like Debug;Release;*.pdb;*.obj;*.dll...