Unity 에서의 NSubstitute 사용 - soo:bak
작성일 :
관련 글 : NSubstitute : .Net Mocking Framework - soo:bak
NSubstitute 를 유니티에서 사용하기
NSubstitute 는 유니티 프로젝트에서 단위 테스트를 수행하고 종속성을 격리하는 좋은 도구로 활용될 수 있다.
예제 시나리오 가정
만약, 유니티 게임 프로젝트에서 플레이어(Player) 와 적(Enemy) 사이의 상호 작용을 테스트 하려고 하고,
이를 위해 IEnemy 인터페이스와 Player 클래스가 다음과 같이 정의되어 있다고 가정하자 :
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// IEnemy 인터페이스 정의
public interface IEnemy {
void TakeDamage(int amount);
void AttackPlayer();
}
// Player 클래스
public class Player {
private IEnemy enemy;
public Player(IEnemy enemy) {
this.enemy = enemy;
}
public void AttackEnemy() {
// 적 공격 로직
enemy.TakeDamage(10);
}
}
NSubstitute 를 사용한 단위 테스트
1. 가짜 객체 생성
먼저, IEnemy 인터페이스의 가짜 객체를 생성한다.
이 객체는 테스트 중에 적(Enemy) 역할을 대신할 것이다.
1
IEnemy = fakeEnemy = Substitute.For<IEnemy>();
2. 의존성 주입
가짜 객체를 생성한 후, 이를 이용해 Player 클래스의 인스턴스를 생성한다.
이렇게 하면 Player 클래스가 실제 적(Enemy)이 아닌 가짜 객체와 상호 작용 할 수 있게 된다.
1
Player player = new Player(fakeEnemy);
3. 메서드 호출 검증
이제 Player 클래스의 AttackEnemy() 메서드를 호출하고, 특정 동작이 예상되로 수행되었는지 검증한다.
에를 들어, AttackEnemy() 메서드가 내부에서 enemy.TakeDamage(10) 을 호출하는지를 확인하려면 다음과 같이 검증할 수 있다 :
1
2
3
4
5
// Act : 플레이어가 적을 공격함
player.AttackEnemy();
// Assert : 적(가짜 객체)이 TakeDamage 메서드를 10의 인수로 호출했는지 검증
fakeEnemy.Received().TakeDamage(10);
4. 동작 설명
가짜 객체의 메서드 호출 동작을 설정하려면, When 과 Do 메서드를 사용한다.
예를 들어, 적이 AttackPlayer() 메서드를 호출했을 때 어떤 동작을 수행하도록 설정하려면 다음과 같이 한다 :
1
fakeEnemy.When(e => e.AttackPlayer()).Do(e => { /* 동작 설정 */ });
완성된 테스트 코드
위에서 설명한 내용을 종합하여 완성된 테스트 코드는 다음과 같다 :
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
using NSubstitute;
using NUnit.Framework;
[TestFixture]
public class PlayerTests {
[Test]
public void Player_AttackEnemy_DamagesEnemy() {
// Arrange
IEnemy fakeEnemy = Substitute.For<IEnemy>();
Player player = new Player(fakeEnemy);
// Act
player.AttackEnemy();
// Assert
fakeEnemy.Received(1).TakeDamage(10);
}
}
이 테스트는 Player 가 AttackEnemy() 메서드를 호출할 때, IEnemy 의 TakeDamage(10) 메서드가 한 번 호출되는지 검증한다.
결론
유니티 프로젝트에서 NSubstitute 를 사용하여 단위 테스트를 작성하는 것은 코드의 견고성을 높이고, 버그를 줄이는 데 큰 도움이 된다.
단위 테스트를 통해 유니티 프로젝트를 더 품질 높게 개발할 수 있도록 NSubstitute 를 적극적으로 활용해보자.
다양한 예시
예시 1. 메서드 호출 검증
TakeDamage() 메서드 호출 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[Test]
public void Player_AttackEnemy_DamagesEnemy() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격함
player.AttackEnemy();
// Assert : 적(가짜 객체)이 TakeDamage 메서드를 10의 인수로 호출했는지 검증
fakeEnemy.Received().TakeDamage(10);
}
예시 2. 메서드 호출 순서 검증
AttackPlayer() 와 TakeDamage() 메서드 호출 순서 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[Test]
public void Player_AttackEnemy_CorrectMethodCallOrder() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격함
player.AttackEnemy();
// Assert : 적(가짜 객체)이 TakeDamage 메서드를 10의 인수로 호출했는지 검증
Received.InOrder(() => {
fakeEnemy.AttackPlayer();
fakeEnemy.TakeDamge(10);
});
}
예시 3. 예외 던지기
TakeDamage() 메서드가 예외를 던지는 경우를 검증
1
2
3
4
5
6
7
8
9
10
11
12
[Test]
public void Player_AttackEnemy_ThrowsException() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
fakeEnemy.When(e => e.TakeDamage(Arg.Any<int>()))
.Do(e => { throw new Exception("Damage failed!"); });
Player player = new Player(fakeEnemy);
// Act & Assert : 특정 동작이 예외를 던지는지 검증
Assert.Throws<Exception>(() => player.AttackEnemy());
}
예시 4. 메서드 반환값 설정
TakeDamage() 메서드의 반환값을 설정하고 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[Test]
public void Player_AttackEnemy_ReturnsValue() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
fakeEnemy.TakeDamage(Arg.Any<int>()).Returns(5);
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격함
int damageDealt = player.AttackEnemy();
// Assert : 반환값 검증
Assert.AreEqual(5, damageDealt);
}
예시 5. 메서드가 특정 횟수 호출되는지 검증
TakeDamage() 메서드가 두 번 호출되는지 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[Test]
public void Player_AttackEnemy_CallsMethodMultipleTimes() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
Player player = new Player(fakeEnemy);
// Act : 플레이어가 두 번 적을 공격함
player.AttackEnemy();
player.AttackEnemy();
// Assert : 메서드 호출 횟수 검증
fakeEnemy.Received(2).TakeDamage(10);
}
예시 6. 메서드가 특정 조건에 따라 다르게 동작하는지 검증
TakeDamage() 메서드가 특정 인수에 따라 다른 값을 반환하는지 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[Test]
public void Player_TakeDamage_ReturnsDifferentValuesBasedOnInput() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
fakeEnemy.TakeDamage(5).Returns(10); // 5 입력 시 반환값 10 설정
fakeEnemy.TakeDamage(10).Returns(20); // 10 입력 시 반환값 20 설정
Player player = new Player(fakeEnemy);
// Act & Assert
int damage1 = player.TakeDamage(5);
int damage2 = player.TakeDamage(10);
// 다른 입력에 따른 반환값 검증
Assert.AreEqual(10, damage1);
Assert.AreEqual(20, damage2);
}
예시 7. 메서드 호출 시 인수 검증
TakeDamage() 메서드가 특정한 인수 값으로 호출되었는지 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
[Test]
public void Player_AttackEnemy_CallsMethodWithSpecificArgument() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격함
player.AttackEnemy();
// Assert : 메서드 호출 시 특정 인자값 검증
fakeEnemy.Received().TakeDamage(Arg.Is<int>(x => x == 10));
}
예시 8. 가짜 객체의 프로퍼티 설정
적(Enemy)의 체력을 설정하고 반환하는 상황을 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[Test]
public void Player_AttackEnemy_ReturnsEnemyHealth() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
fakeEnemy.Health.Returns(100); // 체력 프로퍼티 설정
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격함
int enemyHealth = player.GetEnemyHealth();
// Assert : 프로퍼티 반환 값 검증
Assert.AreEqual(100, enemyHealth);
}
예시 9. 가짜 객체의 이벤트 시뮬레이션
가짜 객체에서 이벤트를 발생시키고, 특정 이벤트 핸들러가 호출되는지 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
[Test]
public void Player_AttackEnemy_RaisesEvent() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
bool eventRaised = false;
// 이벤트 핸들러 설정
fakeEnemy.Died += (sender, args) => eventRaised = true;
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격하고 적의 사망 이벤트 발생
player.AttackEnemy();
fakeEnemy.Died += Raise.Event();
// Assert : 이벤트가 발생하고 핸들러가 호출되는지 검증
Assert.IsTrue(eventRaised);
}
예시 10. 가짜 객체의 메서드 호출 동작 설정
가짜 객체의 메서드 호출 시 특정 동작을 수행하도록 설정하는 예시,
예를 들어, 메서드가 호출될 때 값을 변경하는 동작을 설정하여 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
[Test]
public void Player_AttackEnemy_ModifiesValue() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
int health = 100;
// 메서드 호출 시 동작 설정
fakeEnemy.TakeDamage(Arg.Any<int>()).Returns(x =>
{
health -= x.ArgAt<int>(0); // 인수를 받아서 값을 변경
return x.ArgAt<int>(0); // 변경된 값을 반환
});
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격함
int damageDealt = player.AttackEnemy();
// Assert : 메서드 호출 후 값이 변경되었는지 검증
Assert.AreEqual(90, health); // 100 - 10
Assert.AreEqual(10, damageDealt);
}
예시 11. 메서드가 특정 조건에 따라 예외 던지기
메서드 호출 시 특정 조건을 만족하지 않으면 예외를 던지도록 설정 후 검증
1
2
3
4
5
6
7
8
9
10
11
[Test]
public void Player_AttackEnemy_ThrowsExceptionBasedOnCondition() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
fakeEnemy.When(e => e.TakeDamage(Arg.Is<int>(x => x < 0))).Do(e => throw new ArgumentException("Negative damage is not allowed!"));
Player player = new Player(fakeEnemy);
// Act & Assert : 특정 조건에 따라 예외를 던지는지 검증
Assert.Throws<ArgumentException>(() => player.AttackEnemy(-5));
}
예시 12. 메서드 호출 횟수 범위 검증
메서드가 특정 횟수 범위 내에서 호출되는지 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[Test]
public void Player_AttackEnemy_CallsMethodMultipleTimesInRange() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
Player player = new Player(fakeEnemy);
// Act : 플레이어가 임의 횟수만큼 적을 공격함
player.AttackEnemy();
player.AttackEnemy();
player.AttackEnemy();
// Assert : 메서드 호출 횟수 범위 검증 (1부터 5회 사이)
fakeEnemy.Received(1, 5).TakeDamage(10);
}
예시 13. 가짜 객체의 메서드 반환값 동적 설정 검증
가짜 객체의 메서드 호출 시 동적으로 반환값을 설정 후 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[Test]
public void Player_AttackEnemy_ReturnsDynamicValue() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
fakeEnemy.TakeDamage(Arg.Any<int>()).Returns(x => x.ArgAt<int>(0) * 2); // 인자에 따라 반환값 동적 설정
Player player = new Player(fakeEnemy);
// Act & Assert : 메서드 호출 시 동적으로 반환값이 설정되는지 검증
int damage1 = player.AttackEnemy(5); // 5 * 2 = 10
int damage2 = player.AttackEnemy(8); // 8 * 2 = 16
Assert.AreEqual(10, damage1);
Assert.AreEqual(16, damage2);
}
예시 14. 가짜 객체의 메서드 호출 동작 지연 검증
메서드 호출 동작을 지연시키는 예시,
메서드 호출 후 일정 시간이 지난 후 동작이 수행되도록 설정 후 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
[Test]
public void Player_AttackEnemy_DelayedMethodCall() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
fakeEnemy.TakeDamage(Arg.Any<int>()).Returns(Task.Delay(1000).ContinueWith(_ => 10)); // 1초 후에 반환값 반환
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격하고 1초 동안 대기
var damageTask = player.AttackEnemyAsync();
await Task.Delay(1000); // 1초 대기
// Assert : 메서드 호출 동작이 지연되어 반환값을 올바르게 반환하는지 검증
int damage = await damageTask;
Assert.AreEqual(10, damage);
}
예시 15. 가짜 객체의 메서드 호출 횟수 조건 검증
메서드 호출 횟수에 대한 조건을 설정하여 검증하는 예시입니다. 메소드가 특정 횟수 이상 호출되는지 검증
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
[Test]
public void Player_AttackEnemy_CallsMethodMultipleTimes() {
// Arrange : 가짜 적(Enemy) 객체 생성
IEnemy fakeEnemy = Substitute.For<IEnemy>();
Player player = new Player(fakeEnemy);
// Act : 플레이어가 적을 공격함 여러 번
player.AttackEnemy();
player.AttackEnemy();
player.AttackEnemy();
// Assert : 메소드 호출 횟수 조건 검증 (최소 2회 이상)
fakeEnemy.ReceivedWithAnyArgs(2).TakeDamage(Arg.Any<int>());
}