我有以下记录器记录器类,我想知道最好对其进行单元测试。
一些观察结果:
我能够通过使用MemoryString实现IFileWrapper来对FileWrapper.WriteLog方法进行单元测试,但是如果我想测试方法中的预期行为,我就不能(例如:抛出异常,不正确)路径和文件名等。)
/// <summary>
/// Creates an instance of type <see cref="FileLogger"/>
/// </summary>
/// <remarks>Implements the Singleton Pattern</remarks>
private FileLogger()
{
FileName = string.Format("\\{0: MMM dd, yy}.log", DateTime.Now);
Path = Environment.CurrentDirectory;
FileWrapper = ContainerBuilderFactory.Container.Resolve<IFileWrapper>();
}
/// <summary>
/// Log the <paramref name="Message"/> in the <paramref name="Path"/> specified.
/// The <paramref name="UserName"/>, <paramref name="Host"/> must be supplied
/// </summary>
/// <example>
/// <code>
/// var handler = new LoggerHandlerFactory();
/// var logger = handler.GetHandler<FileLogger>();
/// logger.Log("Hello CSharpLogger");
/// </code>
/// </example>
/// <exception cref="ArgumentNullException"></exception>
/// <exception cref="ArgumentException"></exception>
/// <exception cref="NotSupportedException"></exception>
/// <exception cref="FileNotFoundException"></exception>
/// <exception cref="IOException"></exception>
/// <exception cref="SecurityException"></exception>
/// <exception cref="DirectoryNotFoundException"></exception>
/// <exception cref="UnauthorizedAccessException"></exception>
/// <exception cref="PathTooLongException"></exception>
/// <exception cref="ArgumentOutOfRangeException"></exception>
/// <exception cref="FormatException"></exception>
public void Log(string message, LogLevel level = LogLevel.INFO)
{
lock (_current)
{
var configLevel = CSharpLoggerConfiguration.Configuration.GetLogLevel();
if (configLevel != LogLevel.OFF & level != LogLevel.OFF && configLevel >= level)
{
try
{
FileWrapper.WriteLog(string.Concat(Path, FileName), message, level);
}
catch (CSharpLoggerException)
{
throw;
}
}
}
}
所以,我使用Moq创建了以下UnitTesting:
//arrange
CSharpLoggerConfiguration.Configuration.SetLogLevel(LogLevel.DEBUG);
var mock = new Mock<IFileWrapper>();
mock.Setup(x => x.WriteLog(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<LogLevel>()));
logger.FileWrapper = mock.Object;
//act
logger.Log("Hello CSharpLogger", LogLevel.DEBUG);
logger.Log("Hello CSharpLogger", LogLevel.WARN);
//assert
mock.Verify(x => x.WriteLog(It.IsAny<string>(), It.IsAny<string>(), It.IsAny<LogLevel>()), Times.Exactly(2));
到目前为止一切顺利。我不舒服的是这一行:logger.FileWrapper = mock.Object;我想保持FileWrapper的私密性。
欢迎任何建议。
如果您需要更多详细信息,我将发布代码http://csharplogger.codeplex.com/。
答案 0 :(得分:3)
使用constructor injection。简而言之;而不是通过设置属性来提供服务(在本例中为文件包装器),使记录器具有一个公共构造函数,该构造函数接受IFileWrapper
参数。
public class Logger
{
public Logger(IFileWrapper fileWrapper)
{
FileWrapper = fileWrapper;
}
public IFileWrapper FileWrapper { get; }
}
// in your test:
var logger = new Logger(mock.Object);
要回答有关单个文件包装器更彻底的问题,这里是应用程序(非测试)代码的代码示例:
public static class FileWrapperFactory
{
private static IFileWrapper _fileWrapper;
public static IFileWrapper GetInstance()
{
return _fileWrapper ?? (_fileWrapper = CreateInstance());
}
private static IFileWrapper CreateInstance()
{
// do all the necessary setup here
return new FileWrapper();
}
}
public class StuffDoer
{
public void DoStuff()
{
var logger = new FileLogger(FileWrapperFactory.GetInstance());
logger.WriteLog("Starting to do stuff...");
// do stuff
logger.WriteLog("Stuff was done.");
}
}
由于FileWrapperFactory
维护文件包装器的静态实例,因此您永远不会有多个。但是,您可以创建这样的多个记录器,并且他们不必关心。如果您将来决定使用多个文件包装器,则无需更改记录器代码。
在实际应用程序中,我建议您选择某种DI框架来处理所有这些簿记;大多数人都对单例实例有很好的支持,基本上做的是上面的FileWrapperFactory
(但通常是以更复杂和健壮的方式。FileWrapperFactory
不是'线程安全的,例如......)。
答案 1 :(得分:0)
由于您的代码注释显示您的记录器是单例,因此您需要一种除构造函数注入之外的方法来设置依赖项。在他的关于遗产代码的书中,Mike Feathers为这样的目的建议了一个功能,这个功能已被充分命名,如
public void SetInstanceForTesting(IFileWrapper fileWrapper) {...}
现在这个功能不会用于不同的目的......