“仅在满足条件时运行方法”模式

Question

我有办法

using Microsoft.VisualStudio.TestTools.UnitTesting; // using visual studio's test framework

[TestMethod]
public void ATestMethod()
{
    // stuff
}

来自public class ATestClass。这个测试类运行两种类型的测试：

• 需要在运行测试的机器上安装特定软件的测试
• 可以免费运行的测试

为了处理这个问题，我添加了一个public class BaseTestClass，我从中派生了ATestClass，并在ATestClass 中添加了一个：

public bool isTheSoftwareInstalledOnTheMachine()
{
    // stuff
}

我从ATestClass“装饰”了所有内部测试范围，如下所示：

[TestMethod]
public void ATestMethod()
{
    if (isTheSoftwareInstalledOnTheMachine())
    {
        // stuff
    }
}

我觉得这太可怕了。我宁愿能够写出类似的东西：

[TestMethod]
[RunIfTheSoftwareInstalledOnTheMachine]
public void ATestMethod()
{
    // stuff
}

但我不知道是否允许定义“自定义”[characterizer]'s。 （我什至不知道他们的正确词。）如果是，那会是最好的设计吗？ （我听说过装饰器模式，但我不知道是否可以在我的上下文中使其足够通用，因为我可能需要将条件用于许多其他测试类。）无论如何，我将如何继续使用 @987654332 @的？

Answer 1

我知道你正在使用 VS 测试框架，但如果你可以更改为 NUnit，你就可以完成你想要的。

测试用例：

using NUnit.Framework;

[TestFixture]
public class MyAppTests
{
    [Test]
    [RunIfTheSoftwareInstalledOnTheMachine]
    public void ATestMethod()
    {
        // Executes if custom attribute is true, otherwise test case is ignored
    }
}

自定义属性：

using NUnit.Framework;
using NUnit.Framework.Interfaces;

public class TestHelper
{
    public static bool IsTheSoftwareInstalledOnTheMachine()
    {
        // Return state of software
        return true;
    }
}

public class RunIfTheSoftwareInstalledOnTheMachineAttribute : Attribute, ITestAction
{
    public ActionTargets Targets { get; private set; }

    public void AfterTest(ITest test) {}

    public void BeforeTest(ITest test)
    {
        if (!TestHelper.IsTheSoftwareInstalledOnTheMachine())
        {
            Assert.Ignore("Omitting {0}. Software is not installed on machine.", test.Name);
        }
    }
}

Answer 2

如果你定义了你自己的属性，你肯定必须自己检查它的存在。您不能指望您的框架猜测该属性的用途。

但我想您甚至不需要属性来执行此操作。您可以通过将逻辑放在测试方法中来简单地忽略测试：

[Test]
public void MyTest()
{
    if(!RunIfTheSoftwareInstalledOnTheMachine)
        Assert.Ignore("Test not run because no software was installed");
    // your actual test-code
}

另一种方法是使用 NUnit 提供的CategoryAttribute，您可以使用它仅运行那些属于您提供的类别的测试：

[Test]
[Category("SoftwareInstalled")]
public void MyTest() { /* ... */ }

编辑：您还可以将TestCaseAttribute 与特定方法一起使用，该方法在满足条件时返回TestCase：

[TestCaseSource("ProvideTestcases")]
public void MyTest() { /* ... */ }

private static IEnumerable<TestCaseData> ProvideTestcases()
{
    if(RunIfTheSoftwareInstalledOnTheMachine)
        yield return new TestCaseData();
}

如果不满足条件，则根本不会生成测试用例。

Answer 3

如果机器上安装的软件是任何测试通过的要求，并且任何一个测试失败意味着整个套件失败，那么如果安装了软件，为什么还要检查多个测试?只需编写一个 single 测试以在未安装软件时失败并抛出有用的异常。比如：

[Test]
public void EnsureImportantSoftwareIsInstalled()
{
    if(!importantSoftwareIsInstalled)
    {
         Assert.Fail($"Software X must be installed for the tests in {nameof(MyTestClass)} to run, please install it");
    }
}

Answer 4

对于 Nunit 2.6，HimBromBeere 的答案略有不同，对我来说效果很好。测试用例显示为忽略。

[TestCaseSource("ProvideTestcases")]
public void MyTest() { /* ... */ }

private static IEnumerable<TestCaseData> ProvideTestcases()
{
    if(RunIfTheSoftwareInstalledOnTheMachine)
        yield return new TestCaseData().Ignore();
}