Question

最近，我不得不重新考虑大量测试，以便根据报告结果为所有测试标记特定的 TestCategory 属性。如果测试在报告中列出，则应使用“好类别”标记，否则应该在“坏类别”中。这些类别将用于过滤哪些测试将作为我们的门控构建的一部分运行。

以下是一些如何完成的例子。

Answer 1

该过程的第一步是加载解决方案

var wkps = MSBuildWorkspace.Create();
var sln = wkps.OpenSolutionAsync(slnPath).Result;

现在我们有了一个解决方案参考，我们可以迭代每个项目并获得它的SyntaxTrees。然后我们可以在每个SyntaxTree上调用GetRoot并将其转换为CompilationUnitSyntax。从这一点开始，我们搜索所有符合我们的定义TestMethod属性的方法的DecsendantNodes。

以下是它们的所有内容

foreach (var proj in sln.Projects)
{
    var comp = proj.GetCompilationAsync().Result;
    foreach (var method in root.DescendantNodes().OfType<MethodDeclarationSyntax>().Where(m => HasAttribute(m, TEST_METHOD)))
    {
        //do something with this test method
    }
}

上面有一个名为HasAttribute的辅助方法，它只查找名为“TestMethod”的方法上的任何属性。这是看起来像什么

bool HasAttribute(MethodDeclarationSyntax method, string attributeName)
{
    return method.AttributeLists
        .Any(al => al.Attributes
            .Any(a => a.Name is IdentifierNameSyntax && (((IdentifierNameSyntax)a.Name).Identifier.Text == attributeName)));
}

现在我们已经有了迭代所有TestMethod方法的方法，我们需要为它们分配TestCategory属性。这是上面循环的“做某事”部分。

此处有两个步骤。首先是编辑我们的SyntaxTree，以便我们添加和/或删除我们想要的类别。其次是将SyntaxTree写回源文件。

我们需要做的第一件事是根据输入列表检查方法的名称。假设我们有一个方法名称词典，它可能看起来像这样

var methodName = method.Identifier.ValueText;
var testIsOnList = testDictionary.ContainsKey(methodFullName);

然而，这个测试假设在整个解决方案中，测试名称是全球唯一的。不幸的是，在我的情况下，这不是真的。为了解决这个问题，我们将输入列表设为“完全合格的测试名称”，就像它出现在MSTest测试运行器中一样。这将是：

命名空间
- 类层次结构
  - 方法名称

离。 My.Long.NameSpace.ParentClass.ChildClass.Method

这是一个litte辅助方法，它将根据MethodDeclarationSyntax

创建FQTN

string BuildFullTestName(MethodDeclarationSyntax method)
{
    StringBuilder sb = new StringBuilder();
    sb.Append(method.Identifier.ValueText);
    SyntaxNode node = method;
    while(node.Parent is ClassDeclarationSyntax)
    {
        node = node.Parent;
        sb.Insert(0, ".");
        sb.Insert(0, ((ClassDeclarationSyntax)node).Identifier.ValueText);
    }
    if(node.Parent is NamespaceDeclarationSyntax)
    {
        node = node.Parent;
        sb.Insert(0, ".");
        sb.Insert(0, ((NamespaceDeclarationSyntax)node).Name.ToString());
    }
    else
    {
        throw new Exception("method \{method.Identifier.ValueText} has wierd parents.");
    }

    return sb.ToString();
}

所以我们已经完成了比较，我们想用我们好的或坏的TestCategory属性标记一个测试。下面是另一个辅助方法，它将接受MethodDeclarationSyntax，属性名称（在我们的例子中为TestCateogry），以及属性的参数（在我们的例子中为cateogry的名称）。它将返回包含我们更改的新MethodDeclarationSyntax。

MethodDeclarationSyntax AddMethodProperty(MethodDeclarationSyntax method, string propertyName, string argumentName)
{
    return method.AddAttributeLists(
            SyntaxFactory.AttributeList(
                SyntaxFactory.SingletonSeparatedList(
                    SyntaxFactory.Attribute(
                        SyntaxFactory.IdentifierName(propertyName),
                        SyntaxFactory.AttributeArgumentList(
                            SyntaxFactory.SingletonSeparatedList(
                                SyntaxFactory.AttributeArgument(
                                    SyntaxFactory.LiteralExpression(
                                        SyntaxKind.StringLiteralExpression,
                                        SyntaxFactory.Token(
                                            default(SyntaxTriviaList),
                                            SyntaxKind.StringLiteralToken,
                                            argumentName,
                                            argumentName,
                                            default(SyntaxTriviaList))
                                        ))))))));
}

因为所有语法节点都是不可变的，所以我们无法就地更新方法。所以现在我们已经有了新的MethodDeclarationSyntax，我们需要创建一个新的SyntaxTree，我们用新的方法替换旧的方法。

SyntaxTree newTree = SyntaxFactory.SyntaxTree(
    Formatter.Format(syntaxRoot.ReplaceNode(method, newMethod), wkps))
        .WithFilePath(method.SyntaxTree.FilePath);

注意：。需要.WithFilePath，以便新的SyntaxTree保留其映射到哪个源文件的上下文。

现在我们可以将新的SyntaxTree写入磁盘。标准的东西在这里。

using (StreamWriter file = File.CreateText(method.SyntaxTree.FilePath))
{
    file.Write(newTree.ToString());
    file.Flush();
}

循环使用您的方法时，有一个主要问题需要记住。每次创建新的SyntaxTree时，必须将其根CompilationUnitSyntax传递给循环的未来迭代。另外，我们对上面的syntaxRoot.ReplaceNode的调用仅在被替换的方法实际来自该SyntaxTree时才有效。换句话说，在新创建的SyntaxTree中找不到我们的大嵌套foreach的下一次迭代中的MethodDeclarationSyntax引用。为了解决这个问题，我创建了另一个辅助方法，它将在新的SyntaxTree中找到旧的方法中的MethodDeclarationSyntax。

MethodDeclarationSyntax GetMethodFromSyntaxRoot(CompilationUnitSyntax root, string nameSpaceName, string className, MethodDeclarationSyntax method)
{
    var result = root.Members.OfType<NamespaceDeclarationSyntax>().Single(ns => ns.Name.ToString() == nameSpaceName)
       .DescendantNodes(d => true).OfType<ClassDeclarationSyntax>().Single(c => c.Identifier.ValueText == className)
           .Members.OfType<MethodDeclarationSyntax>().SingleOrDefault(m => m.Identifier.ValueText == method.Identifier.ValueText && m.ParameterList.ToString() == method.ParameterList.ToString());
}

使用Roslyn重构TestCategory属性

1 个答案: