如何使用 SpecFlow 设置个人跟踪/日志记录

Question

对于我的 SpecFlow 测试，我想在测试执行期间设置单独的记录/跟踪测试进度。例如。我想写

• 所有通过/失败的步骤
• 开始/结束的场景
• 开始/结束的功能

到windows事件日志（为了与其他系统组件在测试期间生成的事件日志消息同步）。

我尝试使用 [BeforeFeature]、[BeforeScenario]、[BeforeStep] Hooks 来执行此操作，但结果证明我没有此 hooks 中的所有必需信息。例如。我不知道如何获取当前步骤执行的当前文本行（包括行信息等）或当前步骤的结果（失败/通过）。

有没有办法在这些钩子中或在测试执行期间以任何其他方式获取这些信息？

如果不是： 有没有办法以任何其他方式自定义 Specflow 创建的跟踪输出？

Answer 1

最后，经过一番调查，我发现您可以通过实现接口 ITraceListener 来用自己的实现替换 DefaultTraceListener：

public class foo:  TechTalk.SpecFlow.Tracing.ITraceListener
{
    public void WriteTestOutput(string message)
    {
        EventLog.WriteEntry("mysource", "output: " + message);
    }

    public void WriteToolOutput(string message)
    {
        EventLog.WriteEntry("mysource", "specflow: " + message);
    }
}

并通过将其添加到“specflow”部分来修改您的 App.config 配置：

<trace traceSuccessfulSteps="true"
       traceTimings="false"
       minTracedDuration="0:0:0.1"
       listener="MyNamespace.foo, MyAssemblyName"/>

但是，这对我来说更像是一种“解决方法”，因为我没有输入信息（例如 StepInstance 类的信息），我必须依赖或修改 SpecFlow 的输出格式。

我更愿意以某种方式用我自己的替换 TestTracer (ITestTracer) 实现，但我没有找到一种方法来做到这一点。有人现在怎么做吗？

Answer 2

为了提供 ITestTracer 的自定义实现，您应该为 SpecFlow 创建一个插件。

创建一个名为 CustomTracer.SpecflowPlugin 的类库项目。 CustomTracer 是您选择的插件名称。

然后将以下代码放入你的新程序集

[assembly: RuntimePlugin(typeof(CustomTracer.SpecflowPlugin.CustomTracerPlugin))]

namespace CustomTracer.SpecflowPlugin
{
    public class CustomTracerPlugin : IRuntimePlugin
    {
        public void RegisterDependencies(ObjectContainer container)
        {

        }

        public void RegisterCustomizations(ObjectContainer container, RuntimeConfiguration runtimeConfiguration)
        {
            container.RegisterTypeAs<CustomTracer, ITestTracer>();
        }

        public void RegisterConfigurationDefaults(RuntimeConfiguration runtimeConfiguration)
        {

        }
    }

    public class CustomTracer : ITestTracer
    {
        // Your implementation here
    }
}

编译程序集并放入您的规范所在的项目文件夹（.csprog 文件所在的位置）。

编辑 app.config，specFlow 部分以包括：

<plugins>
  <add name="CustomTracer" path="." type="Runtime"/>
</plugins>

就是这样。您的插件应该加载并且您的自定义 ITracer 实现应该在场景执行期间被调用。如果你在调试下运行场景，你甚至可以调试它。

Answer 3

在 Specflow 2.1 中有点不同。

代替：

public class CustomTracerPlugin : IRuntimePlugin
{
    public void RegisterDependencies(ObjectContainer container)
    {

    }

    public void RegisterCustomizations(ObjectContainer container, RuntimeConfiguration runtimeConfiguration)
    {
        container.RegisterTypeAs<CustomTracer, ITestTracer>();
    }

    public void RegisterConfigurationDefaults(RuntimeConfiguration runtimeConfiguration)
    {

    }
}

这样做：

public class CustomTracerPlugin : IRuntimePlugin
{
    public void Initialize(RuntimePluginEvents runtimePluginEvents, RuntimePluginParameters runtimePluginParameters)
    {
        runtimePluginEvents.CustomizeTestThreadDependencies += (sender, args) => { args.ObjectContainer.RegisterTypeAs<CustomTracer, ITestTracer>(); };
    }
}

其他一切都与 Vladimir Perevalovs 的回答相同。

Answer 4

在 SpecFlow 3.x 中注册自定义 ITestTracer：

[assembly: RuntimePlugin(typeof(CustomTracerPlugin))]

public class CustomTracerPlugin : IRuntimePlugin
{
    public void Initialize(
        RuntimePluginEvents runtimePluginEvents,
        RuntimePluginParameters runtimePluginParameters,
        UnitTestProviderConfiguration unitTestProviderConfiguration)
    {
        runtimePluginEvents.CustomizeGlobalDependencies +=
            (s, ea) => ea.ObjectContainer.RegisterTypeAs<CustomTracer, ITestTracer>();
    }
}

public class CustomTracer : ITestTracer
{
    ...
}