MSTest - 단위 테스트에 static/instance 유형의 private 멤버 접근 방법
예를 들어, 다음과 같은 식의 코드가 있다고 가정할 때,
using System;
using System.Diagnostics;
namespace ClassLibrary1
{
public class Class1
{
int _waitTime = 5000;
Stopwatch _st;
public void Start()
{
_st = new Stopwatch();
_st.Start();
}
public bool IsTooSlow()
{
long elapsed = _st.ElapsedMilliseconds;
if (elapsed > _waitTime)
{
return true;
}
return false;
}
}
}
단위 테스트를 이런 식으로 작성하게 될 텐데요,
using ClassLibrary1;
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Threading;
namespace ClassLibrary1.Tests
{
[TestClass()]
public class Class1Tests
{
Class1 _cl = new Class1();
[TestMethod()]
[DataRow(false, 3000)]
[DataRow(true, 5016)]
public void IsTooSlowTest(bool expected, int sleepTime)
{
_cl.Start();
Thread.Sleep(sleepTime);
Assert.AreEqual(expected, _cl.IsTooSlow());
}
}
}
그런데, 매번 저걸 테스트할 때마다 8초씩 기다려야 하는 걸까요? 물론, Class1의 _waitTime이 꼭 5000이어야 한다면 할 수 없지만, 단위 테스트에 한해 저 값을 바꿔도 무방한 코드라면 유연함을 발휘하는 것이 좋습니다.
이런 경우 선택할 수 있는 방법이 해당 필드를 internal 접근 유형으로 바꾸고,
InternalsVisibleTo를 이용해 단위 테스트 프로젝트를 등록하면 됩니다.
using System;
using System.Diagnostics;
using System.Runtime.CompilerServices;
[assembly: InternalsVisibleTo("ClassLibrary1Tests")]
namespace ClassLibrary1
{
public class Class1
{
internal int _waitTime = 5000;
// ...[생략]...
}
}
그럼 단위 테스트 프로젝트에서 이렇게 internal 필드를 접근할 수 있어,
[TestMethod()]
[DataRow(false, 16)]
[DataRow(true, 46)]
public void IsTooSlowTest(bool expected, int sleepTime)
{
_cl._waitTime = 30;
_cl.Start();
Thread.Sleep(sleepTime);
Assert.AreEqual(expected, _cl.IsTooSlow());
}
단위 테스트 시간을 절약할 수 있습니다.
하지만, 경우에 따라서는 매번 private 필드를 internal로 바꾸는 것이 타당하지 않을 수 있습니다. 그렇다고 단위 테스트를 위해 SetWaitTime internal 메서드를 두는 것도 부담스럽다면, 마지막으로 적용할 수 있는 방법이 바로 private 필드를 Reflection으로 접근해 보는 것입니다.
사실, .NET Framework 환경에서는 마이크로소프트가 이런 경우를 위해
PrivateObject/
PrivateType을 제공하고 있었습니다. 그래서 위의 예제라면 다음과 같은 식으로 사용할 수 있습니다.
using Microsoft.VisualStudio.TestTools.UnitTesting;
using System.Threading;
namespace ClassLibrary1.Tests
{
[TestClass()]
public class Class1Tests
{
Class1 _cl;
PrivateObject _prvObj; // instance private 접근
PrivateType _prvType; // static private 접근
[TestInitialize]
public void TestInitialize()
{
_cl = new Class1();
_prvObj = new PrivateObject(_cl);
_prvType = new PrivateType(typeof(Class1));
}
[TestMethod()]
[DataRow(false, 16)]
[DataRow(true, 46)]
public void IsTooSlowTest(bool expected, int sleepTime)
{
_prvObj.SetField("_waitTime", 30);
// 만약 정적 필드라면,
// _prvType.SetStaticField("_waitTime", 30);
_cl.Start();
Thread.Sleep(sleepTime);
Assert.AreEqual(expected, _cl.IsTooSlow());
}
}
}
아쉽게도 PrivateObject/PrivateType은 .NET Core/5+ 환경의 단위 테스트 프로젝트에서는 더 이상 제공하지 않고 있습니다.
PrivateObject and PrivateType are not available for a project targeting netcorapp2.0 #366
; https://github.com/Microsoft/testfx/issues/366
어쩔 수 없습니다. 직접 만들든가 해야 하는데, 그래도 위의 덧글을 보면 마이크로소프트 측의 구현 코드 위치와 함께,
testfx/src/TestFramework/Extension.Desktop/
; https://github.com/microsoft/testfx/tree/664ac7c2ac9dbfbee9d2a0ef560cfd72449dfe34/src/TestFramework/Extension.Desktop
아예 zip 파일로 제공해 주고 있습니다. ^^ (첨부 파일의 프로젝트에도 PrivateObjectPrivateType.cs 파일을 포함하고 있습니다.)
PrivateObjectPrivateType.zip
; https://github.com/microsoft/testfx/files/4132970/PrivateObjectPrivateType.zip
따라서, PrivateObjectPrivateType.cs을 그대로 .NET Core/5+ 단위 테스트 프로젝트에 복사해 주고 이전 PrivateObject/PrivateType 사용 코드를 그대로 활용할 수 있습니다.
참고로, 다음의 편의성 메서드도 있으니 참고하시고.
[PrivateObject]
GetArrayElement
GetField
GetFieldOrProperty
GetProperty
Invoke
SetArrayElement
SetField
SetFieldOrProperty
SetProperty
[PrivateType]
GetStaticArrayElement
GetStaticField
GetStaticProperty
InvokeStatic
SetStaticArrayElement
SetStaticField
SetStaticProperty
그 외 자잘한 거 2개 정도 더 정리해 볼까요? ^^
해당 메서드에서 예외가 발생할 수 있다면 이렇게
ExpectedException 특성을 지정할 수 있습니다.
[TestMethod]
[ExpectedException(typeof(FileNotFoundException))]
public void TestException()
{
File.ReadAllText("test.dat");
}
그럼, FileNotFoundException 예외가 발생해도 기대했던 동작이기 때문에 위의 단위 테스트는 실패로 평가되지 않습니다.
마지막으로, 자신만의 메타데이터를
TestProperty를 이용해 설정하는 것이 가능합니다.
[TestMethod]
[TestProperty("Author", "kevin")]
public void ExampleTest()
{
// Test logic
}
위와 같은 경우, "Test Explorer" 창에서 "Author [kevin]"이라는 별도의 출력 항목을 "Traits" 칼럼에서 확인할 수 있습니다.
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]