VSTS 2008 - 自定义签入代码审查策略

最近正在微软VSTS Workshop项目中，忙了一个月了，今天将其中一个场景实现写在这里，供大家参考。

实现步骤

建立自定义策略项目

1. 打开VS2008:
   
2. 选择"文件"下的"新建"菜单中的"项目":
   
3. 在新项目中选择"Visual C#">"Windows">"类库":
   
4. 输入项目名为"CopyrightCheckinPolicy":
   
5. 选择确定按钮保存.
6. 重命名"Clase1"为"CopyrightPolicy.cs":
   
7. 右击项目选择"添加引用":
   
8. 在".NET"选项卡选择"System.Windows.Forms"选择"确定":
   
9. 再右击项目, 选择"添加引用"选择"浏览"选项卡, 找到下面路径的文件:
   C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE \PrivateAssemblies\Microsoft.TeamFoundation.VersionControl.Client.dll
   并添加:
   
10. 在类中输入下面代码:

Code
using System.Windows.Forms; 

using Microsoft.TeamFoundation.VersionControl.Client; 

using System.Collections; 

using System.IO; 

using System; 

using System.Collections.Generic; 

using System.Text; 

namespace CopyrightCheckinPolicy 

{ 

[Serializable] 

public class CopyrightPolicy : PolicyBase 

{ 

public override string Description 

{ 

get { return Strings.policyDescription; } 

} 

public override bool Edit(IPolicyEditArgs policyEditArgs) 

{ 

return false; 

} 

public override PolicyFailure[] Evaluate() 

{ 

if (this.Disposed) 

{ 

throw new ObjectDisposedException(Strings.policyType, Strings.policyDisposedMessage); 

} 

ArrayList changes = new ArrayList(); 

PendingChange[] checkedFiles = this.PendingCheckin.PendingChanges.CheckedPendingChanges; 

foreach (PendingChange change in checkedFiles) 

{ 

if (Path.GetExtension(change.LocalItem) == ".cs") 

{ 

if (change.ChangeType.ToString().Contains(ChangeType.Edit.ToString()) || change.ChangeType.ToString().Contains(ChangeType.Add.ToString())) 

{ 

if (IsFileMissingCopyrightNotice(change.LocalItem)) 

{ 

PolicyFailure failure = new PolicyFailure(Strings.activateMessage + " : " + change.LocalItem, this); 

changes.Add(failure); 

} 

} 

} 

} 

return (PolicyFailure[])changes.ToArray(typeof(PolicyFailure)); 

} 

public override string Type 

{ 

get { return Strings.policyType; } 

} 

public override string TypeDescription 

{ 

get { return Strings.policyTypeDescription; } 

} 

public override bool CanEdit 

{ 

get 

{ 

return false; 

} 

} 

public override void DisplayHelp(PolicyFailure failure) 

{ 

MessageBox.Show(Strings.policyHelp); 

} 

public override string InstallationInstructions 

{ 

get 

{ 

return Strings.policyInstallationInstructions; 

} 

set 

{ 

Strings.policyInstallationInstructions = value; 

} 

} 

public override void Activate(PolicyFailure failure) 

{ 

MessageBox.Show(Strings.activateMessage); 

} 

protected override void OnPolicyStateChanged(PolicyFailure[] failures) 

{ 

base.OnPolicyStateChanged(failures); 

} 

public override void Initialize(IPendingCheckin pendingCheckin) 

{ 

base.Initialize(pendingCheckin); 

pendingCheckin.PendingChanges.CheckedPendingChangesChanged += new EventHandler(pendingCheckin_CheckedPendingChangesChanged); 

} 

public override void Dispose() 

{ 

PendingCheckin.PendingChanges.CheckedPendingChangesChanged -= new EventHandler(pendingCheckin_CheckedPendingChangesChanged); 

base.Dispose(); 

} 

private void pendingCheckin_CheckedPendingChangesChanged(Object sender, EventArgs e) 

{ 

OnPolicyStateChanged(Evaluate()); 

} 

private bool IsFileMissingCopyrightNotice(string fullFileName) 

{ 

try 

{ 

StreamReader sr = new StreamReader(fullFileName, true); 

string sourceCode = sr.ReadToEnd(); 

bool result = !sourceCode.Contains("Copyright"); 

sr.Close(); 

return result; 

} 

catch (Exception) 

{ 

return false; 

} 

} 

} 

internal class Strings 

{ 

public static string policyType = "Copyright Notice Policy"; 

public static string policyDescription = "This policy ensures that all C# Source Files include a Copyright Notice."; 

public static string policyInstallationInstructions = "Sorry, No instructions are available at this time"; 

public static string policyTypeDescription = policyType + " Description"; 

public static string policyDisposedMessage = policyType + " Object has been disposed."; 

public static string policyHelp = "Sorry, help for " + policyType + " is not available at this time."; 

public static string activateMessage = "Copyright Notice not found in this source file."; 

} 

11. 编译成功后保存.

注册策略

1. 中键入"Regedit"来运行注册表编辑器, 并找到下面注册表键:
   HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\9.0\TeamFoundation\
   SourceControl\Checkin Policies:
   
2. 添加一个字符串类型的值, 然后将名字命名为刚才建立项目生成的DLL的名字"CopyrightCheckinPolicy":
   
3. 双击选择在值中写入该DLL的完整路径, 如下(视具体情况而定):
   C:\HOL\Dev\Module 05 - Lab 01 - Setting Up Custom Checkin Policies\Begin\CopyrightCheckinPolicy\CopyrightCheckinPolicy\bin\Debug\CopyrightCheckinPolicy.dll:
   
4. 保存后即可.

测试策略

1. 打开VS2008, 右击项目选择其属性:
   
2. 选择"调试"页:
   
3. 选择"启动外部程序"单选按钮, 然后设置其值为"C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\devenv.exe":
   
4. 保存.
5. 调试该程序, 这时一个新的VS2008被打开:
   
6. 选择团队项目, 在其中选择"团队项目设置"菜单中的"源代码管理":
   
7. 选择"签入策略"选项卡, 点击"添加"按钮:
   
8. 这时我们看到刚才定义的策略已经在其中了, 选择它并点击"确定":
   
9. 新建一个项目, 将其加入到该团队项目中:
   
   
10. 继续后将" // Copyright ( c ) MyCompany"加入Class1中:
    
11. 再新建一个类:
    
12. 然后"签入"所有代码:
    
13. 这时可以看到提示未加入版权的信息:
    

 

希望本文对大家有帮助，谢谢！