単体テスト：DateTime.Now
「現在の時刻」がDateTime.Nowと異なることを期待する単体テストがありますが、コンピューターの時刻を変更したくないのは明らかです。
これを達成するための最良の戦略は何ですか？
best戦略は、 現在の時間を抽象化でラップし、その抽象化をコンシューマに注入する です。
あるいは、時間の抽象化をAmbient Contextとして定義することもできます：
public abstract class TimeProvider
{
private static TimeProvider current =
DefaultTimeProvider.Instance;
public static TimeProvider Current
{
get { return TimeProvider.current; }
set
{
if (value == null)
{
throw new ArgumentNullException("value");
}
TimeProvider.current = value;
}
}
public abstract DateTime UtcNow { get; }
public static void ResetToDefault()
{
TimeProvider.current = DefaultTimeProvider.Instance;
}
}
これにより、次のように使用できます。
var now = TimeProvider.Current.UtcNow;
単体テストでは、TimeProvider.CurrentをTest Double/Mockオブジェクトに置き換えることができます。 Moqを使用した例：
var timeMock = new Mock<TimeProvider>();
timeMock.SetupGet(tp => tp.UtcNow).Returns(new DateTime(2010, 3, 11));
TimeProvider.Current = timeMock.Object;
ただし、静的状態で単体テストを行う場合は、TimeProvider.ResetToDefault()を呼び出して、常にフィクスチャを分解することを忘れないでください。
これらはすべて良い答えです、これは私が別のプロジェクトでやったことです：
使用法：
今日の実際の日付時刻を取得
var today = SystemTime.Now().Date;
DateTime.Nowを使用する代わりに、SystemTime.Now()...を使用する必要があります。難しい変更ではありませんが、このソリューションはすべてのプロジェクトに理想的ではない場合があります。
タイムトラベリング（将来5年になります）
SystemTime.SetDateTime(today.AddYears(5));
「今日」の偽物を取得する（「今日」から5年になる）
var fakeToday = SystemTime.Now().Date;
日付のリセット
SystemTime.ResetDateTime();
/// <summary>
/// Used for getting DateTime.Now(), time is changeable for unit testing
/// </summary>
public static class SystemTime
{
/// <summary> Normally this is a pass-through to DateTime.Now, but it can be overridden with SetDateTime( .. ) for testing or debugging.
/// </summary>
public static Func<DateTime> Now = () => DateTime.Now;
/// <summary> Set time to return when SystemTime.Now() is called.
/// </summary>
public static void SetDateTime(DateTime dateTimeNow)
{
Now = () => dateTimeNow;
}
/// <summary> Resets SystemTime.Now() to return DateTime.Now.
/// </summary>
public static void ResetDateTime()
{
Now = () => DateTime.Now;
}
}
モル：
[Test]
public void TestOfDateTime()
{
var firstValue = DateTime.Now;
MDateTime.NowGet = () => new DateTime(2000,1,1);
var secondValue = DateTime.Now;
Assert(firstValue > secondValue); // would be false if 'moleing' failed
}
免責事項-私はモルに取り組んでいます
あなたはそれを行うためのいくつかのオプションがあります：
モックフレームワークを使用し、DateTimeServiceを使用します（小さなラッパークラスを実装し、運用コードに注入します）。ラッパーの実装はDateTimeにアクセスし、テストではラッパークラスをモックできます。
Typemock Isolator を使用すると、 偽のDateTime.Now が可能になり、テスト対象のコードを変更する必要がなくなります。
Moles を使用します。 DateTime.Now を使用することもでき、本番コードの変更は不要です。
いくつかの例：
Moqを使用したラッパークラス：
[Test]
public void TestOfDateTime()
{
var mock = new Mock<IDateTime>();
mock.Setup(fake => fake.Now)
.Returns(new DateTime(2000, 1, 1));
var result = new UnderTest(mock.Object).CalculateSomethingBasedOnDate();
}
public class DateTimeWrapper : IDateTime
{
public DateTime Now { get { return DateTime.Now; } }
}
アイソレーターを使用してDateTimeを直接偽装する：
[Test]
public void TestOfDateTime()
{
Isolate.WhenCalled(() => DateTime.Now).WillReturn(new DateTime(2000, 1, 1));
var result = new UnderTest().CalculateSomethingBasedOnDate();
}
免責事項-私はTypemockで働いています
システム用の偽のアセンブリを追加します（[システム参照] => [偽のアセンブリを追加]を右クリックします）。
そして、テストメソッドに書き込みます：
using (ShimsContext.Create())
{
System.Fakes.ShimDateTime.NowGet = () => new DateTime(2014, 3, 10);
MethodThatUsesDateTimeNow();
}
@crabcrusherclamcollectorの回答に関して、EFクエリでそのアプローチを使用すると問題が発生します（System.NotSupportedException：LINQ式ノードタイプ「Invoke」はLINQ to Entitiesでサポートされていません）。それに実装を変更しました：
public static class SystemTime
{
private static Func<DateTime> UtcNowFunc = () => DateTime.UtcNow;
public static void SetDateTime(DateTime dateTimeNow)
{
UtcNowFunc = () => dateTimeNow;
}
public static void ResetDateTime()
{
UtcNowFunc = () => DateTime.UtcNow;
}
public static DateTime UtcNow
{
get
{
DateTime now = UtcNowFunc.Invoke();
return now;
}
}
}
スレッドセーフSystemClockを使用してThreadLocal<T>を使用するとうまく機能します。
ThreadLocal<T>は、.Net Framework v4.0以降で使用できます。
/// <summary>
/// Provides access to system time while allowing it to be set to a fixed <see cref="DateTime"/> value.
/// </summary>
/// <remarks>
/// This class is thread safe.
/// </remarks>
public static class SystemClock
{
private static readonly ThreadLocal<Func<DateTime>> _getTime =
new ThreadLocal<Func<DateTime>>(() => () => DateTime.Now);
/// <inheritdoc cref="DateTime.Today"/>
public static DateTime Today
{
get { return _getTime.Value().Date; }
}
/// <inheritdoc cref="DateTime.Now"/>
public static DateTime Now
{
get { return _getTime.Value(); }
}
/// <inheritdoc cref="DateTime.UtcNow"/>
public static DateTime UtcNow
{
get { return _getTime.Value().ToUniversalTime(); }
}
/// <summary>
/// Sets a fixed (deterministic) time for the current thread to return by <see cref="SystemClock"/>.
/// </summary>
public static void Set(DateTime time)
{
if (time.Kind != DateTimeKind.Local)
time = time.ToLocalTime();
_getTime.Value = () => time;
}
/// <summary>
/// Resets <see cref="SystemClock"/> to return the current <see cref="DateTime.Now"/>.
/// </summary>
public static void Reset()
{
_getTime.Value = () => DateTime.Now;
}
}
使用例：
[TestMethod]
public void Today()
{
SystemClock.Set(new DateTime(2015, 4, 3));
DateTime expectedDay = new DateTime(2015, 4, 2);
DateTime yesterday = SystemClock.Today.AddDays(-1D);
Assert.AreEqual(expectedDay, yesterday);
SystemClock.Reset();
}
System.DateTimeに依存するコードをテストするには、system.dllをモック化する必要があります。
これを行うことがわかっているフレームワークは2つあります。 Microsoftの偽物 および スモック 。
Microsoftの偽物には、Visual Studio 2012の最終通告が必要であり、コンプトンからそのまま動作します。
スモックはオープンソースであり、非常に使いやすいです。 NuGetを使用してダウンロードできます。
以下は、System.DateTimeのモックを示しています。
Smock.Run(context =>
{
context.Setup(() => DateTime.Now).Returns(new DateTime(2000, 1, 1));
// Outputs "2000"
Console.WriteLine(DateTime.Now.Year);
});
この同じ問題に遭遇しましたが、この問題を解決するマイクロソフトの調査プロジェクトを見つけました。
http://research.Microsoft.com/en-us/projects/moles/
Molesは、デリゲートに基づいた.NETのテストスタブおよび迂回用の軽量フレームワークです。モールは、シール型の非仮想/静的メソッドを含む、あらゆる.NETメソッドを迂回するために使用できます。
// Let's detour DateTime.Now
MDateTime.NowGet = () => new DateTime(2000,1, 1);
if (DateTime.Now == new DateTime(2000, 1, 1);
{
throw new Exception("Wahoo we did it!");
}
サンプルコードは元のコードから変更されました。
私は他の人が提案したことを行い、DateTimeをプロバイダーに抽象化しました。それはただ間違っていると感じただけで、テストだけでは多すぎると感じました。今晩、これを私の個人的なプロジェクトに実装します。
DateTime.Nowを TypeMock でモックする際の特別な注意事項...
これを適切にモックするには、DateTime.Nowの値を変数に配置する必要があります。例えば：
これは動作しません：
if ((DateTime.Now - message.TimeOpened.Value) > new TimeSpan(1, 0, 0))
ただし、これは：
var currentDateTime = DateTime.Now;
if ((currentDateTime - message.TimeOpened.Value) > new TimeSpan(1, 0, 0))
モックオブジェクト。
テストに適したNowを返す模擬DateTime。
誰も最も明確な方法を提案していないことに驚いています：
public class TimeDependentClass
{
public void TimeDependentMethod(DateTime someTime)
{
if (GetCurrentTime() > someTime) DoSomething();
}
protected virtual DateTime GetCurrentTime()
{
return DateTime.Now; // or UtcNow
}
}
その後、テストダブルでこのメソッドをオーバーライドできます。
場合によってはTimeProviderクラスを挿入することも好きですが、他の場合はこれで十分です。ただし、複数のクラスでこれを再利用する必要がある場合は、おそらくTimeProviderバージョンをお勧めします。
編集：興味のある人にとっては、これはクラスに「シーム」を追加することと呼ばれ、クラスのコードを実際に変更せずに（テスト目的などで）変更する動作にフックできるポイントです。
DateTimeProviderがIDisposableを実装する場合は、良い習慣です。
public class DateTimeProvider : IDisposable
{
[ThreadStatic]
private static DateTime? _injectedDateTime;
private DateTimeProvider()
{
}
/// <summary>
/// Gets DateTime now.
/// </summary>
/// <value>
/// The DateTime now.
/// </value>
public static DateTime Now
{
get
{
return _injectedDateTime ?? DateTime.Now;
}
}
/// <summary>
/// Injects the actual date time.
/// </summary>
/// <param name="actualDateTime">The actual date time.</param>
public static IDisposable InjectActualDateTime(DateTime actualDateTime)
{
_injectedDateTime = actualDateTime;
return new DateTimeProvider();
}
public void Dispose()
{
_injectedDateTime = null;
}
}
次に、単体テスト用に偽のDateTimeを注入できます
using (var date = DateTimeProvider.InjectActualDateTime(expectedDateTime))
{
var bankAccount = new BankAccount();
bankAccount.DepositMoney(600);
var lastTransaction = bankAccount.Transactions.Last();
Assert.IsTrue(expectedDateTime.Equals(bankAccount.Transactions[0].TransactionDate));
}
例を参照してください DateTimeProviderの例
これを行うための1つのクリーンな方法は、VirtualTimeを注入することです。時間を制御できます。最初にVirtualTimeをインストールします
Install-Package VirtualTime
これにより、たとえば、DateTime.NowまたはUtcNowへのすべての呼び出しで5倍速く移動する時間を作成できます。
var DateTime = DateTime.Now.ToVirtualTime(5);
時間を遅くするために、例えば5倍遅くする
var DateTime = DateTime.Now.ToVirtualTime(0.5);
時間を静止させるには
var DateTime = DateTime.Now.ToVirtualTime(0);
時間をさかのぼることはまだテストされていません
サンプルテストは次のとおりです。
[TestMethod]
public void it_should_make_time_move_faster()
{
int speedOfTimePerMs = 1000;
int timeToPassMs = 3000;
int expectedElapsedVirtualTime = speedOfTimePerMs * timeToPassMs;
DateTime whenTimeStarts = DateTime.Now;
ITime time = whenTimeStarts.ToVirtualTime(speedOfTimePerMs);
Thread.Sleep(timeToPassMs);
DateTime expectedTime = DateTime.Now.AddMilliseconds(expectedElapsedVirtualTime - timeToPassMs);
DateTime virtualTime = time.Now;
Assert.IsTrue(TestHelper.AreEqualWithinMarginOfError(expectedTime, virtualTime, MarginOfErrorMs));
}
ここでさらにテストを確認できます。
DateTime.Now.ToVirtualTime拡張機能が提供するのは、ITimeに依存するメソッド/クラスに渡すITimeのインスタンスです。選択したDIコンテナにDateTime.Now.ToVirtualTimeが設定されます
これは、クラス委託者に注入する別の例です
public class AlarmClock
{
private ITime DateTime;
public AlarmClock(ITime dateTime, int numberOfHours)
{
DateTime = dateTime;
SetTime = DateTime.UtcNow.AddHours(numberOfHours);
Task.Run(() =>
{
while (!IsAlarmOn)
{
IsAlarmOn = (SetTime - DateTime.UtcNow).TotalMilliseconds < 0;
}
});
}
public DateTime SetTime { get; set; }
public bool IsAlarmOn { get; set; }
}
[TestMethod]
public void it_can_be_injected_as_a_dependency()
{
//virtual time has to be 1000*3.75 faster to get to an hour
//in 1000 ms real time
var dateTime = DateTime.Now.ToVirtualTime(1000 * 3.75);
var numberOfHoursBeforeAlarmSounds = 1;
var alarmClock = new AlarmClock(dateTime, numberOfHoursBeforeAlarmSounds);
Assert.IsFalse(alarmClock.IsAlarmOn);
System.Threading.Thread.Sleep(1000);
Assert.IsTrue(alarmClock.IsAlarmOn);
}
言及されていない代替オプションは、依存メソッドに現在時刻を注入することです。
public class DateTimeNowDependencyClass
{
...
public void ImplicitTimeDependencyMethod(Obj arg0)
{
this.TimeDependencyMethod(DateTime.Now, arg0);
}
internal void TimeDependencyMethod(DateTime now, Obj arg1)
{
...
}
...
}
内部のバリエーションは、並列または非並列の単体テストに開放されています。
これは、ImplicitTimeDependencyMethodが「壊れやすい」という原則に基づいています（参照： http://junit.sourceforge.net/doc/faq/faq.htm#best_ ）単体テストのカバレッジに含める必要はありません。とにかく統合テストで触れなければなりませんが。
クラスの目的によっては、これらのメソッドを両方とも公開することが望ましい場合があります。
私は同じ問題を抱えていましたが、同じクラスで設定された日時のものを使用すべきではないと考えていました。いつかは誤用につながる可能性があるためです。だから私は次のようなプロバイダーを使用しました
public class DateTimeProvider
{
protected static DateTime? DateTimeNow;
protected static DateTime? DateTimeUtcNow;
public DateTime Now
{
get
{
return DateTimeNow ?? System.DateTime.Now;
}
}
public DateTime UtcNow
{
get
{
return DateTimeUtcNow ?? System.DateTime.UtcNow;
}
}
public static DateTimeProvider DateTime
{
get
{
return new DateTimeProvider();
}
}
protected DateTimeProvider()
{
}
}
テストについては、テストプロジェクトで、設定されたものを処理するヘルパーを作成しました。
public class MockDateTimeProvider : DateTimeProvider
{
public static void SetNow(DateTime now)
{
DateTimeNow = now;
}
public static void SetUtcNow(DateTime utc)
{
DateTimeUtcNow = utc;
}
public static void RestoreAsDefault()
{
DateTimeNow = null;
DateTimeUtcNow = null;
}
}
コード上
var dateTimeNow = DateTimeProvider.DateTime.Now //not DateTime.Now
var dateTimeUtcNow = DateTimeProvider.DateTime.UtcNow //not DateTime.UtcNow
そしてテスト中
[Test]
public void Mocked_Now()
{
DateTime now = DateTime.Now;
MockDateTimeProvider.SetNow(now); //set to mock
Assert.AreEqual(now, DateTimeProvider.DateTime.Now);
Assert.AreNotEqual(now, DateTimeProvider.DateTime.UtcNow);
}
[Test]
public void Mocked_UtcNow()
{
DateTime utcNow = DateTime.UtcNow;
MockDateTimeProvider.SetUtcNow(utcNow); //set to mock
Assert.AreEqual(utcNow, DateTimeProvider.DateTime.UtcNow);
Assert.AreNotEqual(utcNow, DateTimeProvider.DateTime.Now);
}
ただし、1つ覚えておく必要があります。実際のDateTimeとプロバイダーのDateTimeが同じように動作しない場合があります
[Test]
public void Now()
{
Assert.AreEqual(DateTime.Now.Kind, DateTimeProvider.DateTime.Now.Kind);
Assert.LessOrEqual(DateTime.Now, DateTimeProvider.DateTime.Now);
Assert.LessOrEqual(DateTimeProvider.DateTime.Now - DateTime.Now, TimeSpan.FromMilliseconds(1));
}
遅延は最大TimeSpan.FromMilliseconds（0.00002）になると想定しました。しかし、ほとんどの場合それはさらに少ないです
MockSamples でサンプルを見つけます
ITimeProviderを使用して、他のプロジェクトから参照する必要があるspecial shared commonプロジェクトにそれを強制的に追加しました。しかし、これは 依存関係の制御を複雑化 。
.NETフレームワークでITimeProviderを検索しました。 NuGetパッケージを検索した結果、 one がDateTimeOffsetで機能しません。
そこで、標準ライブラリのタイプのみに依存する独自のソリューションを考え出しました。 Func<DateTimeOffset>のインスタンスを使用しています。
使い方
public class ThingThatNeedsTimeProvider
{
private readonly Func<DateTimeOffset> now;
private int nextId;
public ThingThatNeedsTimeProvider(Func<DateTimeOffset> now)
{
this.now = now;
this.nextId = 1;
}
public (int Id, DateTimeOffset CreatedAt) MakeIllustratingTuple()
{
return (nextId++, now());
}
}
登録方法
Autofac
builder.RegisterInstance<Func<DateTimeOffset>>(() => DateTimeOffset.Now);
（将来の編集者の場合：ここにケースを追加します）。
単体テストの方法
public void MakeIllustratingTuple_WhenCalled_FillsCreatedAt()
{
DateTimeOffset expected = CreateRandomDateTimeOffset();
DateTimeOffset StubNow() => expected;
var thing = new ThingThatNeedsTimeProvider(StubNow);
var (_, actual) = thing.MakeIllustratingTuple();
Assert.AreEqual(expected, actual);
}
これがこの質問に対する私の答えです。 「Ambient Context」パターンとIDisposableを組み合わせます。そのため、通常のプログラムコードでDateTimeProvider.Currentを使用し、テストではusingステートメントでスコープをオーバーライドできます。
using System;
using System.Collections.Immutable;
namespace ambientcontext {
public abstract class DateTimeProvider : IDisposable
{
private static ImmutableStack<DateTimeProvider> stack = ImmutableStack<DateTimeProvider>.Empty.Push(new DefaultDateTimeProvider());
protected DateTimeProvider()
{
if (this.GetType() != typeof(DefaultDateTimeProvider))
stack = stack.Push(this);
}
public static DateTimeProvider Current => stack.Peek();
public abstract DateTime Today { get; }
public abstract DateTime Now {get; }
public void Dispose()
{
if (this.GetType() != typeof(DefaultDateTimeProvider))
stack = stack.Pop();
}
// Not visible Default Implementation
private class DefaultDateTimeProvider : DateTimeProvider {
public override DateTime Today => DateTime.Today;
public override DateTime Now => DateTime.Now;
}
}
}
ユニットテスト内で上記のDateTimeProviderを使用する方法を次に示します。
using System;
using Xunit;
namespace ambientcontext
{
public class TestDateTimeProvider
{
[Fact]
public void TestDateTime()
{
var actual = DateTimeProvider.Current.Today;
var expected = DateTime.Today;
Assert.Equal<DateTime>(expected, actual);
using (new MyDateTimeProvider(new DateTime(2012,12,21)))
{
Assert.Equal(2012, DateTimeProvider.Current.Today.Year);
using (new MyDateTimeProvider(new DateTime(1984,4,4)))
{
Assert.Equal(1984, DateTimeProvider.Current.Today.Year);
}
Assert.Equal(2012, DateTimeProvider.Current.Today.Year);
}
// Fall-Back to Default DateTimeProvider
Assert.Equal<int>(expected.Year, DateTimeProvider.Current.Today.Year);
}
private class MyDateTimeProvider : DateTimeProvider
{
private readonly DateTime dateTime;
public MyDateTimeProvider(DateTime dateTime):base()
{
this.dateTime = dateTime;
}
public override DateTime Today => this.dateTime.Date;
public override DateTime Now => this.dateTime;
}
}
}
静的SystemTimeオブジェクトを使用していましたが、並列ユニットテストの実行で問題が発生しました。 Henk van Boeijenのソリューションを使用しようとしましたが、生成された非同期スレッド間で問題が発生し、最終的には次のような方法でAsyncLocalを使用することになりました。
public static class Clock
{
private static Func<DateTime> _utcNow = () => DateTime.UtcNow;
static AsyncLocal<Func<DateTime>> _override = new AsyncLocal<Func<DateTime>>();
public static DateTime UtcNow => (_override.Value ?? _utcNow)();
public static void Set(Func<DateTime> func)
{
_override.Value = func;
}
public static void Reset()
{
_override.Value = null;
}
}
ソース： https://Gist.github.com/CraftyFella/42f459f7687b0b8b268fc311e6b4af08
プロフェッショナルではないかもしれませんが、より簡単な解決策は、コンシューマメソッドでDateTimeパラメータを作成することです。たとえば、SampleMethodのようなmakeメソッドの代わりに、SampleMethod1をパラメータで作成します。
public void SampleMethod()
{
DateTime anotherDateTime = DateTime.Today.AddDays(-10);
if ((DateTime.Now-anotherDateTime).TotalDays>10)
{
}
}
public void SampleMethod1(DateTime dateTimeNow)
{
DateTime anotherDateTime = DateTime.Today.AddDays(-10);
if ((dateTimeNow - anotherDateTime).TotalDays > 10)
{
}
}