Cách tốt để ghi đè DateTime.Now trong quá trình thử nghiệm là gì?

Tôi có một số mã (C #) dựa vào ngày hôm nay để tính toán chính xác mọi thứ trong tương lai. Nếu tôi sử dụng ngày hôm nay trong bài kiểm tra, tôi phải lặp lại phép tính trong bài kiểm tra, điều này cảm thấy không ổn. Cách tốt nhất để đặt ngày thành một giá trị đã biết trong bài kiểm tra để tôi có thể kiểm tra xem kết quả có phải là giá trị đã biết không?

Sở thích của tôi là có các lớp sử dụng thời gian thực sự dựa trên một giao diện, chẳng hạn như

interface IClock
{
    DateTime Now { get; } 
}

Với một triển khai cụ thể

class SystemClock: IClock
{
     DateTime Now { get { return DateTime.Now; } }
}

Sau đó, nếu muốn, bạn có thể cung cấp bất kỳ loại đồng hồ nào khác mà bạn muốn để thử nghiệm, chẳng hạn như

class StaticClock: IClock
{
     DateTime Now { get { return new DateTime(2008, 09, 3, 9, 6, 13); } }
}

Có thể có một số chi phí trong việc cung cấp đồng hồ cho lớp dựa vào nó, nhưng điều đó có thể được xử lý bằng bất kỳ giải pháp chèn phụ thuộc nào (sử dụng Inversion of Control container, phương thức khởi tạo / bộ định tuyến cũ đơn giản hoặc thậm chí là một Mẫu cổng tĩnh ).

Các cơ chế khác của việc cung cấp một đối tượng hoặc phương thức cung cấp thời gian mong muốn cũng hoạt động, nhưng tôi nghĩ điều quan trọng là tránh đặt lại đồng hồ hệ thống, vì điều đó sẽ chỉ giới thiệu nỗi đau ở các cấp độ khác.

Ngoài ra, việc sử dụng DateTime.Nowvà đưa nó vào các tính toán của bạn không chỉ là không ổn - nó còn cướp đi của bạn khả năng kiểm tra các thời điểm cụ thể, chẳng hạn như nếu bạn phát hiện ra một lỗi chỉ xảy ra gần ranh giới nửa đêm hoặc vào các ngày Thứ Ba. Sử dụng thời gian hiện tại sẽ không cho phép bạn kiểm tra các tình huống đó. Hoặc ít nhất là không phải bất cứ khi nào bạn muốn.

Ayende Rahien sử dụng một phương thức tĩnh khá đơn giản ...

public static class SystemTime
{
    public static Func<DateTime> Now = () => DateTime.Now;
}

Tôi nghĩ rằng việc tạo một lớp đồng hồ riêng cho một thứ đơn giản như lấy ngày hiện tại là hơi quá mức cần thiết.

Bạn có thể chuyển ngày hôm nay làm tham số để có thể nhập một ngày khác trong bài kiểm tra. Điều này có thêm lợi ích là làm cho mã của bạn linh hoạt hơn.

Sử dụng Microsoft Fakes để tạo miếng đệm là một cách thực sự dễ dàng để thực hiện việc này. Giả sử tôi có lớp sau:

public class MyClass
{
    public string WhatsTheTime()
    {
        return DateTime.Now.ToString();
    }

}

Trong Visual Studio 2012, bạn có thể thêm một lắp ráp Giả mạo vào dự án thử nghiệm của mình bằng cách nhấp chuột phải vào hợp ngữ bạn muốn tạo Giả mạo / Shims và chọn "Add Fakes Assembly"

Cuối cùng, đây là lớp thử nghiệm sẽ trông như thế nào:

using System;
using ConsoleApplication11;
using Microsoft.QualityTools.Testing.Fakes;
using Microsoft.VisualStudio.TestTools.UnitTesting;

namespace DateTimeTest
{
[TestClass]
public class UnitTest1
{
    [TestMethod]
    public void TestWhatsTheTime()
    {

        using(ShimsContext.Create()){

            //Arrange
            System.Fakes.ShimDateTime.NowGet =
            () =>
            { return new DateTime(2010, 1, 1); };

            var myClass = new MyClass();

            //Act
            var timeString = myClass.WhatsTheTime();

            //Assert
            Assert.AreEqual("1/1/2010 12:00:00 AM",timeString);

        }
    }
}
}

Chìa khóa để thử nghiệm đơn vị thành công là tách . Bạn phải tách mã thú vị của mình khỏi các phần phụ thuộc bên ngoài của nó, để nó có thể được kiểm tra một cách riêng biệt. (May mắn thay, Phát triển theo hướng thử nghiệm tạo ra mã tách rời.)

Trong trường hợp này, bên ngoài của bạn là DateTime hiện tại.

Lời khuyên của tôi ở đây là trích xuất logic giao dịch với DateTime sang một phương thức hoặc lớp mới hoặc bất kỳ điều gì có ý nghĩa trong trường hợp của bạn và chuyển DateTime vào. Bây giờ, bài kiểm tra đơn vị của bạn có thể vượt qua DateTime tùy ý, để tạo ra kết quả có thể dự đoán được.

Một cái khác sử dụng Microsoft Moles ( Isolation framework cho .NET ).

MDateTime.NowGet = () => new DateTime(2000, 1, 1);

Các nốt ruồi cho phép thay thế bất kỳ phương thức .NET nào bằng một đại biểu. Nốt ruồi hỗ trợ các phương pháp tĩnh hoặc không ảo. Nốt ruồi phụ thuộc vào hồ sơ từ Pex.

Tôi khuyên bạn nên sử dụng mẫu IDisposable:

[Test] 
public void CreateName_AddsCurrentTimeAtEnd() 
{
    using (Clock.NowIs(new DateTime(2010, 12, 31, 23, 59, 00)))
    {
        string name = new ReportNameService().CreateName(...);
        Assert.AreEqual("name 2010-12-31 23:59:00", name);
    } 
}

Được mô tả chi tiết tại đây: http://www.lesnikowski.com/blog/index.php/testing-datetime-now/

Câu trả lời đơn giản: ditch System.DateTime :) Thay vào đó, hãy sử dụng NodaTime và thư viện thử nghiệm của nó: NodaTime.Testing .

Đọc thêm:

• Kiểm tra đơn vị với Noda Time
• Tiêm phụ thuộc: Tiêm phụ thuộc của bạn, khoảng thời gian!

Bạn có thể đưa vào lớp (tốt hơn: phương thức / ủy nhiệm ) mà bạn sử dụng cho DateTime.Nowlớp đang được kiểm tra. CóDateTime.Now một giá trị mặc định và chỉ đặt nó trong thử nghiệm thành một phương thức giả trả về một giá trị không đổi.

CHỈNH SỬA: Blair Conrad đã nói gì (anh ấy có một số mã để xem xét). Ngoại trừ, tôi có xu hướng thích đại biểu cho điều này hơn, vì chúng không làm lộn xộn thứ bậc lớp của bạn với những thứ như IClock...

Tôi đã đối mặt với tình huống này thường xuyên, đến mức tôi đã tạo một nuget đơn giản để hiển thị thuộc tính Hiện hành thông qua giao diện.

public interface IDateTimeTools
{
    DateTime Now { get; }
}

Việc triển khai tất nhiên là rất đơn giản

public class DateTimeTools : IDateTimeTools
{
    public DateTime Now => DateTime.Now;
}

Vì vậy, sau khi thêm nuget vào dự án của mình, tôi có thể sử dụng nó trong các bài kiểm tra đơn vị

Bạn có thể cài đặt mô-đun ngay từ Trình quản lý gói GUI Nuget hoặc bằng cách sử dụng lệnh:

Install-Package -Id DateTimePT -ProjectName Project

Và mã cho Nuget ở đây .

Có thể tìm thấy ví dụ về cách sử dụng Autofac tại đây .

Bạn đã xem xét sử dụng biên dịch có điều kiện để kiểm soát những gì xảy ra trong quá trình gỡ lỗi / triển khai chưa?

ví dụ

DateTime date;
#if DEBUG
  date = new DateTime(2008, 09, 04);
#else
  date = DateTime.Now;
#endif

Không thành công, bạn muốn để lộ tài sản để bạn có thể thao túng nó, tất cả đây là một phần của thử thách viết mã có thể kiểm tra , đó là điều mà tôi hiện đang tự đấu tranh: D

Biên tập

Phần lớn tôi thích cách tiếp cận của Blair hơn . Điều này cho phép bạn "cắm nóng" các phần của mã để hỗ trợ thử nghiệm. Tất cả tuân theo nguyên tắc thiết kế gói gọn những gì khác nhau mã kiểm tra không khác gì mã sản xuất, chỉ là không ai nhìn thấy nó bên ngoài.

Tuy nhiên, việc tạo và giao diện có vẻ như rất nhiều công việc đối với ví dụ này (đó là lý do tại sao tôi chọn biên dịch có điều kiện).