پس از بررسی مباحث و نکات پایه‌ای کار با کتابخانه‌ی Moq، در این قسمت تعدادی از نکات تکمیلی آنرا بررسی خواهیم کرد.
حالت‌های عملکرد کتابخانه‌ی Moq
کتابخانه‌ی Moq، دو حالت عملکرد را دارد: Strict Mode و Loose mode. زمانیکه یک Mock object را نمونه سازی میکنیم، به صورت پیش‌فرض کتابخانه‌ی Moq، یک Loose mock را ایجاد میکند. در این حالت این شیء، مقادیر پیش‌فرض خواص و اشیاء را بازگشت می‌دهد و استثنائی را صادر نمی‌کند. اگر این موارد مدنظر نیستند، میتوان به حالت Strict آن رجوع کرد که روش تنظیم آن به صورت زیر است:
var mockIdentityVerifier = new Mock<IIdentityVerifier>(MockBehavior.Strict);
در این حالت اگر متد آزمون واحد را اجرا کنیم، با پیام زیر، با شکست مواجه خواهد شد:
Test method Loans.Tests.LoanApplicationProcessorShould.Accept threw exception:
Moq.MockException: IIdentityVerifier.Initialize() invocation failed with mock behavior Strict.
All invocations on the mock must have a corresponding setup.
در حالت Strict، تمام فراخوانی‌های شیء Mock شده باید دارای Setup باشند (نیازی به Setup تمام موارد نیست؛ فقط مواردی که در فراخوانی‌های آزمون واحد، مورد استفاده قرار می‌گیرند، حتما باید تنظیم شوند). برای نمونه در اینجا عنوان کرده‌است که در این آزمایش، تنظیمات متد Initialize انجام نشده‌است که با تعریف سطر زیر، این مشکل برطرف می‌شود:
mockIdentityVerifier.Setup(x => x.Initialize());
بنابراین هرچند کارکردن با حالت پیش‌فرض کتابخانه‌ی Moq ساده‌است، اما تنظیم حالت Strict سبب می‌شود تا تنظیمی را فراموش نکنیم و در نتیجه کیفیت آزمون واحد تهیه شده افزایش می‌یابد.
صدور استثناءها از طریق Mock objects
اگر در سیستم در حال آزمایش، قسمتی به بررسی خطاها اختصاص دارد، میتوان توسط Mock objects استثناءهایی را تولید و به این ترتیب منطق بررسی خطاها را آزمایش کرد.
برای نمونه در متد Process کلاس LoanApplicationProcessor، یک try/catch را به قسمت CalculateScore اضافه میکنیم:
try
{
_creditScorer.CalculateScore(application.Applicant.Name, application.Applicant.Address);
}
catch
{
return application.IsAccepted;
}
زمانیکه کار فراخوانی متد CalculateScore صورت می‌گیرد، برای تنظیم آزمون واحد آن میتوان از متد Throws، برای صدور یک استثناء استفاده کرد:
mockCreditScorer.Setup(x =>
x.CalculateScore(It.IsAny<string>(), It.IsAny<string>()))
.Throws(new InvalidOperationException("Test Exception"));
صدور این استثناء سبب خواهد شد تا درخواست شخص، رد شود. بنابراین در آزمایش آن میتوان این مساله را بررسی کرد و از رسیدن به این قسمت (رد شدن درخواست) اطمینان حاصل نمود:
Assert.IsFalse(application.IsAccepted);
صدور رخدادها از طریق Mock objects
فرض کنید یک EventArgs سفارشی را به صورت زیر تعریف:
using System;
namespace Loans.Models
{
public class CreditScoreResultArgs : EventArgs
{
public int Score { get; set; }
}
}
و سپس رخدادی را به نحو زیر به ICreditScorer اضافه کرده‌ایم:
public interface ICreditScorer
{
event EventHandler<CreditScoreResultArgs> ResultAvailable;
برای اینکه یک Mock object سبب بروز رخداد ResultAvailable شود (به صورت دستی و دقیقا در سطری که مشخص میکنیم)، میتوان به صورت زیر عمل کرد:
mockCreditScorer.Raise(x => x.ResultAvailable += null, new CreditScoreResultArgs());
ابتدا توسط متد Raise، رخداد مدنظر را ذکر میکنیم و سپس یک نمونه‌ی EventArgs را به آن ارسال خواهیم کرد.
روش دیگر انجام اینکار به صورت زیر است:
mockCreditScorer.Setup(x =>
x.CalculateScore(It.IsAny<string>(), It.IsAny<string>()))
.Raises(x => x.ResultAvailable += null, new CreditScoreResultArgs());
در این حالت با فراخوانی متد CalculateScore، رخداد ResultAvailable به صورت خودکار صادر می‌شود.
معرفی Partial Mocks
در اغلب آزمون‌های واحدی که تا اینجا بررسی شدند، ابتدا یک Mock object را ایجاد و سپس وهله‌ای از سرویس مدنظر را توسط آن تهیه میکنیم. در ادامه تعدادی از متدهای این سرویس را مانند متد Process کلاس LoanApplicationProcessor، فراخوانی میکنیم. اینکار سبب اجرای فعالیتی در این سیستم شده و به همراه آن تعاملی با اشیاء Mock شده نیز صورت می‌گیرد. در نهایت حالت و یا نتیجه‌ای را دریافت میکنیم و آنرا با حالت یا نتیجه‌ای که انتظار داریم، مقایسه خواهیم کرد. در این روش پس از پایان اجرای سیستم در حال اجرا، حالت و نتیجه‌ی نهایی حاصل از عملکرد آن، مورد بررسی قرار می‌گیرد. این بررسی‌ها را نیز بر روی اینترفیس‌ها انجام دادیم. اگر بجای اینترفیس‌ها از یک class استفاده شود، به آن partial mock گفته می‌شود. عموما مواردی را که آزمایش آنها سخت است، با Partial mocks پیاده سازی میکنند؛ مانند کار با فایل سیستم، کار با قطعه کدهای نامعین مانند DateTime.Now، اعداد اتفاقی و یا Guidها.
در مثال زیر، شبیه به متد آزمون واحد Accept که تاکنون آنرا بررسی کردیم، از اشیاء Mock شده استفاده شده‌است؛ با یک تفاوت: بجای اینترفیس IIdentityVerifier، از کلاس پیاده سازی کننده‌ی آن که در اینجا IdentityVerifierServiceGateway است، استفاده شده:
namespace Loans.Tests
{
[TestClass]
public class LoanApplicationProcessorShould
{
[TestMethod]
public void AcceptUsingPartialMock()
{
var product = new LoanProduct {Id = 99, ProductName = "Loan", InterestRate = 5.25m};
var amount = new LoanAmount {CurrencyCode = "Rial", Principal = 2_000_000_0};
var applicant =
new Applicant {Id = 1, Name = "User 1", Age = 25, Address = "This place", Salary = 1_500_000_0};
var application = new LoanApplication {Id = 42, Product = product, Amount = amount, Applicant = applicant};
var mockIdentityVerifier = new Mock<IdentityVerifierServiceGateway>();
mockIdentityVerifier.Setup(x => x.CallService(applicant.Name, applicant.Age, applicant.Address))
.Returns(true);
var mockCreditScorer = new Mock<ICreditScorer>();
mockCreditScorer.Setup(x => x.ScoreResult.ScoreValue.Score).Returns(110_000);
var sut = new LoanApplicationProcessor(mockIdentityVerifier.Object, mockCreditScorer.Object);
sut.Process(application);
Assert.IsTrue(application.IsAccepted);
}
}
}
در اینجا برای اینکه بتوانیم متد CallService را که private بوده، بررسی و تنظیم کنیم، آنرا به public virtual تبدیل کرده‌ایم تا توسط Moq قابل دسترسی و همچنین قابل بازنویسی شود:
public virtual bool CallService(string applicantName, int applicantAge, string applicantAddress)
تبدیل DateTime.Now به یک مقدار ثابت قابل آزمایش توسط Partial Mocks
در کلاس IdentityVerifierServiceGateway، یک چنین کدی را داریم که از DateTime.Now نامشخص استفاده میکند و آزمون واحد نوشتن برای آن مشکل است؛ چون DateTime.Now در هربار که آزمایش اجرا می‌شود، تغییر میکند:
public bool Validate(string applicantName, int applicantAge, string applicantAddress)
{
Connect();
var isValidIdentity = CallService(applicantName, applicantAge, applicantAddress);
LastCheckTime = DateTime.Now;
Disconnect();
return isValidIdentity;
}
برای بالابردن قابلیت آزمون نویسی این کلاس، آنرا به صورت زیر Refactor میکنیم تا DateTime.Now را به صورت یک متد public virtual دریافت کند:
public bool Validate(string applicantName, int applicantAge, string applicantAddress)
{
Connect();
var isValidIdentity = CallService(applicantName, applicantAge, applicantAddress);
LastCheckTime = GetCurrentTime();
Disconnect();
return isValidIdentity;
}
public virtual DateTime GetCurrentTime()
{
return DateTime.Now;
}
اکنون آزمون واحد نویسی برای این کلاس توسط Mock objects بسیار ساده‌است:
var expectedTime = new DateTime(2000, 1, 1);
mockIdentityVerifier.Setup(x => x.GetCurrentTime())
.Returns(expectedTime);
// ...
Assert.AreEqual(expectedTime, mockIdentityVerifier.Object.LastCheckTime);
در اینجا خروجی متد GetCurrentTime بر روی Mock object تهیه شده، به یک مقدار ثابت تنظیم شده‌است که با هر بار اجرای آزمایش در زمان‌های مختلف، تغییری نمی‌کند و وابسته‌ی به DateTime.Now نامشخص، نیست.
استفاده از متدهای protected بجای استفاده از متدهای public virtual در Partial Mocks
همانطور که مشاهده کردید، برای کار با Partial Mocks نیاز است متدهای معرفی شده، از نوع public virtual باشند. برای نمونه حتی مجبور شدیم یک متد private را نیز public کنیم. اگر علاقمند به این نوع تغییرات نیستید، میتوان بجای public کردن متدهای private، آنها را protected تعریف کرد. به همین جهت دو متدی را که تاکنون public virtual تعریف کردیم، تبدیل به protected virtual میکنیم.
پس از آن در کلاسی که آزمون‌های واحد را تهیه کردیم، ابتدا using Moq.Protected را ذکر میکنیم تا بتوانیم به قابلیت‌های ویژه‌ی کار با متدهای Protected دسترسی پیدا کنیم.
سپس روش تنظیم این نوع متدهای protected، چون دسترسی مستقیمی به آنها وجود ندارد، به صورت زیر، با ذکر نام رشته‌ای آنها تغییر میکند:
mockIdentityVerifier.Protected().Setup<bool>(
"CallService",applicant.Name, applicant.Age, applicant.Address)
.Returns(true);
var expectedTime = new DateTime(2000, 1, 1);
mockIdentityVerifier.Protected().Setup<DateTime>("GetCurrentTime")
.Returns(expectedTime);
ابتدا متد Protected شیء Mock شده ذکر می‌شود و پس از آن متد Setup باید دقیقا نوع بازگشتی متد در حال تنظیم را ذکر کند؛ چون دیگر دسترسی strongly typed ای به آن نداریم. پس از آن، لیست پارامترهای متد، ذکر می‌شوند.
روش دیگری نیز برای تعریف متدهای protected وجود دارد که اینبار strongly typed است. بالای متد آزمون واحد، اینترفیس private زیر را تعریف میکنیم:
interface IIdentityVerifierServiceGatewayProtectedMembers
{
DateTime GetCurrentTime();
bool CallService(string applicantName, int applicantAge, string applicantAddress);
}
که در آن متدهای تعریف شده، با متدهای protected در حال بررسی، امضای یکسانی دارند (و همواره با هر تغییری در برنامه نیز باید این وضعیت حفظ شود). در ادامه تعاریف تنظیمات این متدها به صورت strongly typed زیر قابل انجام است:
mockIdentityVerifier.Protected()
.As<IIdentityVerifierServiceGatewayProtectedMembers>()
.Setup(x => x.CallService(It.IsAny<string>(),
It.IsAny<int>(),
It.IsAny<string>()))
.Returns(true);
var expectedTime = new DateTime(2000, 1, 1);
mockIdentityVerifier.Protected()
.As<IIdentityVerifierServiceGatewayProtectedMembers>()
.Setup(x => x.GetCurrentTime())
.Returns(expectedTime); معرفی روش دیگری بجای استفاده از متدهای protected
اگر در کدهای خود نیاز به استفاده‌ی بیش از حد از متدهای protected را مشاهده کردید، این مورد میتوان نشانه‌ی امکان Refactoring این قسمت از کدها به سرویس‌هایی مجزا باشند. برای مثال میتوان یک اینترفیس INowProvider را به صورت زیر تعریف کرد:
using System;
namespace Loans.Services.Contracts
{
public interface INowProvider
{
DateTime GetNow();
}
}
و سپس آنرا به سازنده‌ی کلاس IdentityVerifierServiceGateway تزریق کرد:
public class IdentityVerifierServiceGateway : IIdentityVerifier
{
private readonly INowProvider _nowProvider;
public DateTime LastCheckTime { get; private set; }
public IdentityVerifierServiceGateway(INowProvider nowProvider)
{
_nowProvider = nowProvider;
}
و متد GetCurrentTime را حذف و آنرا با متد GetNow این سرویس جایگزین نمود:
public bool Validate(string applicantName, int applicantAge, string applicantAddress)
{
Connect();
var isValidIdentity = CallService(applicantName, applicantAge, applicantAddress);
LastCheckTime = _nowProvider.GetNow();
// ...
به این ترتیب نیاز به تنظیم متد protected بازگشت زمان، حذف شده و میتوان از این سرویس جدید استفاده کرد:
var mockNowProvider = new Mock<INowProvider>();
mockNowProvider.Setup(x => x.GetNow()).Returns(expectedTime);
var mockIdentityVerifier = new Mock<IdentityVerifierServiceGateway>(mockNowProvider.Object);
کدهای کامل این سری را از اینجا می‌توانید دریافت کنید: MoqSeries-05.zip 
