如何在 SpecFlow 中使用 Nlog 进行登录？

Question

SpecFlow writes its output into Console like this:

Given the "TestOperator" user is logged in
-> done: WebUserSteps.GivenTheUserIsLoggedIn("TestOperator", "") (9.5s)

How can we make it use NLog to configure where it should write?

With this:

public class CustomListener : ITraceListener
{
    private Logger Log = LogManager.GetLogger("SPECFLOW");

    public void WriteTestOutput(string message)
    {
        Log.Trace(message);
    }

    public void WriteToolOutput(string message)
    {
        Log.Trace(message);
    }
}

And

[Binding]
public class ScenarioContextInitializer 
{
    private readonly IObjectContainer _container;

    public ScenarioContextInitializer(ScenarioContext scenarioContext)
    {
        _container = (scenarioContext ?? throw new ArgumentNullException(nameof(scenarioContext))).ScenarioContainer;
    }

    [Before]
    protected void Load()
    {
        _container.RegisterTypeAs<CustomListener, ITraceListener>();
    }
}

It didn't work. I know there is ability to add plugins but that seems too much overhead.

Also we use ObjectivityLtd Test.Automation extensions.

It works via xunit tests generated by SpecFlow.xUnit

Answer 1

The issue is probably that NLog cannot find it's config.

When running unit tests, the dlls are moved and not the nlog.config

There are multiple solutions:

Load the config from a fixed path, eg

LogManager.Configuration = new XmlLoggingConfiguration("c:/mydir/nlog.config");

Or setup from code instead of config, eg:

var config = new LoggingConfiguration();
config.AddRuleForAllLevels(new FileTarget()
{
    FileName = "c:/temp/logfile.log"
});
LogManager.Configuration = config; //apply config

See wiki

If that is still an issue, check the internal log

Answer 2

I've done similar thing in my framework with this workaround:

• Add hook [AfterStep], that calls Console.WriteLine() [or your logger] with the name of the step + if passed or not (if test error != null, that means failed, ow passed)
  Please note that this works perfect in parallel execution. (the correct output goes to each test)

Here is the example: https://github.com/LirazShay/SpecFlowDemo/blob/master/src/SpecFlowDemo/Hooks.cs

Something like this:

 [AfterStep]
 public void LogStepResult()
        {
          string stepText = StepContext.StepInfo.StepDefinitionType + " " + StepContext.StepInfo.Text;
          Console.WriteLine(stepText);
          var stepTable = StepContext.StepInfo.Table;
          if (stepTable != null && stepTable.ToString() != "") Console.WriteLine(stepTable);
          var error = ScenarioContext.TestError;
          Console.WriteLine(error != null ? "-> error: " + error.Message : "-> done.");
        }