Unit Test günümüz yazılım dünyasında artık olmazsa olmaz bir kural olarak bütün projelerde yazılması zorunlu hale gelmekte. DevOps açısından düşündüğümüzde Continuous Integration ve Continuous Deployment tool'ları yazmış olduğumuz kodları build edip deploy etmeden önce ilk olarak test metotlarını çalıştırır ve metotlardan herhangi biri fail verdiğinde deploy'u durdurabilir. Böylelikle unit test yazmak artık yazılım geliştirme dünyasında Nice to Have olmaktan çıkıp Is Must haline gelmektedir.
Bu yazımızda Unit Test nedir, nasıl yazılır gibi sorulara cevap arıyor olacağız.
Unit Test Nedir ?
Unit test geliştirmiş olduğunuz kodu test etmek için yazdığınız kod bloğudur ve esas olarak kodun veya fonksiyonun belirli bir biriminin davranışını kontrol eder ve geliştirdiğiniz kod dizinindeki akışa dayalı olarak acceptance criteria'ları cover ediyor mu etmiyor mu ölçebilmek adına da büyük öneme sahiptir.
Hiçbir kod ilelebet el değmeden yaşamayacaktır, her zaman için sizden sonra gelen bir developer extra feature'lar ekleyip commit edecektir yada o kodları kullanacak başka ekiplerde olacaktır. Unit test aynı zamanda kodlarınızı kullanacak diğer developer'lar tarafından okunduğunda onların kodları nasıl kullanması gerektiğini anlatması açısından da önemli bir göreve sahiptir. Nasıl çalıştığını öğrenmek için testleri çalıştırıp okuyabilirler. Yada daha önce yazılmış bir kod bloğuna küçük bir özellik eklemek istiyorsunuz ama bu mevcut kullanıcıları/sistemi bozar mı bozmaz mı diye sorgulamak yerine eğer o kod bloğunun daha önceden yazılmış ve her bir satırını cover eden unit-test metotları var ise tek yapmanız gereken o testleri run edip geçip geçmediğini görmek. Eğer o sonradan yaptığınız geliştirme mevcut'u bozmuyorsa test'ler zaten green statüsünde passed olacaktır.
Unit yazabilmek için nuget üzerinden de install edebildiğimiz bir çok kütüphane bulunmakta.
Bazı Unit Test Frameworkleri
- MSTest
- NUnit
- xUnit
- MBunit
Herhangi birini seçip kendi sitelerinde yayınlamış oldukları sample projeler üzerinden kendi unit test projenizi oluşturabilirsiniz.
Örnek Proje
Şimdi küçük bir unit test örneği yapalım. Eft işlemi yapan bir modül için bir Console Application ve bu modülü basitçe test etmek için bir unit test projesi oluşturalım.
İlk olarak VS da EftSample adında bir console projesi oluşturalım ve sonrasında solution'a sağ tıklayıp yeni bir proje ekle diyerek ismi EftSample.Test adında bir UnitTest projesi oluşturalım.
Eft işleminde kullanılacak olan TransferRequest ve TransferResponse adında class'larını console uygulamamıza aşağıdaki gibi oluşturalım.
public class TransferRequest
{
public decimal Amount { get; set; }
public string SenderIBAN { get; set; }
public string ReceiverIBAN { get; set; }
}
public class TransferResponse
{
public bool IsSuccess { get; set; }
public string Message { get; set; }
}
Daha sonra transfer işlemini yapacak olan metodu Transfer adında bir class içerisine TransferMoney adında bir metot aşağıdaki gibi tanımlayalım.
Transfer.cs
public class Transfer
{
public TransferResponse MoneyTransfer(TransferRequest request)
{
var response = new TransferResponse();
//Aşağıdaki validasyonlar için farklı yöntemler, frameworkler kullanılması daha doğrudur ancak açık görünmesi açısından bu şekilde yapalım
if (request.Amount < 1)
{
response.IsSuccess = false;
response.Message = "Amount must be greater Then 1";
return response;
}
if (string.IsNullOrEmpty(request.SenderIBAN))
{
response.IsSuccess = false;
response.Message = "Sender Account IBAN must not be null or empty.";
return response;
}
if (string.IsNullOrEmpty(request.ReceiverIBAN))
{
response.IsSuccess = false;
response.Message = "Receiver Account IBAN must not be null or empty.";
return response;
}
//TODO do process
response.IsSuccess = true;
response.Message = "Transfer operation is successful.";
return response;
}
}
Şimdi sıra test metotlarını yazmaya geldi. EftSample.Test adında ki test projemize gidip EftSample projemizi referans olarak ekleyelim. Sonrasında TransferMoneyTest.cs adında test metotlarımızı yazacağımız class'ı oluşturalım.
Not - 1: Unit test yazarken naming oldukça önemli bir konudur. Ortak kabul görmüş bir standart olan MethodName_StateUnderTest_ExpectedBehavior şeklinde bir isimlendirme önerilir ancak her yiğidin yoğurt yiyişi farklıdır tezinden yola çıkarak developer anlaşılır yazdığı sürece isimlendirmeyi istediği gibide yapabilmektedir.
Not - 2: Test metotlarını yazdığımız class'ların başında [TestClass] adında bir attribute tanımlaması yapılması zorunludur. Bu attribute ile sistem o class'ın bir test class'ı olduğunu anlamakta.
Not - 3: Yazılmış olan test metotlarının başında [TestMethod] attribute'ü yazılması gerekir. Bu attribute o metodun bir test metodu olduğunu işaret etmekte.
1- Amount Less Then One Test
İlk test metodumuz Amount = 0 olarak eft işlemi yapmaya çalıştığımızda ki case'i test ediyor olsun.
[TestMethod]
public void TransferMoney_With_Zero_Amount_Then_Transfer_Failed_Test()
{
var expected = new TransferResponse
{
IsSuccess = false,
Message = "Amount must be greater Then 1"
};
var transfer = new Transfer();
var transferRequest = new TransferRequest
{
Amount = 0,
ReceiverIBAN = "TR806541651616516416541",
SenderIBAN = "TR13216498468465416"
};
var actual = transfer.MoneyTransfer(transferRequest);
Assert.AreEqual(expected.IsSuccess, actual.IsSuccess);
Assert.AreEqual(expected.Message, actual.Message);
}
2- Sender IBAN Empty Test
İkinci test metodu ise sender iban alanı boş bırakıldığında ki case'i test ediyor olsun.
[TestMethod]
public void TransferMoney_With_Empty_Sender_IBAN_Then_Transfer_Failed_Test()
{
var expected = new TransferResponse
{
IsSuccess = false,
Message = "Sender Account IBAN must not be null or empty."
};
var transfer = new Transfer();
var transferRequest = new TransferRequest
{
Amount = 60,
SenderIBAN = string.Empty,
ReceiverIBAN = "TR13216498468465416"
};
var actual = transfer.MoneyTransfer(transferRequest);
Assert.AreEqual(expected.IsSuccess, actual.IsSuccess);
Assert.AreEqual(expected.Message, actual.Message);
}
3- All Pramters Are Ok Test
Son metodumuz da doğru bilgilerle transfer işlemi yapılmaya çalışıldığında ki case'i test ediyor olsun.
[TestMethod]
public void TransferMoney_With_Correct_Request_Parameter_Then_Transfer_OK_Test()
{
var expected = new TransferResponse
{
IsSuccess = true,
Message = "Transfer operation is successful."
};
var transfer = new Transfer();
var transferRequest = new TransferRequest
{
Amount = 60,
ReceiverIBAN = "TR806541651616516416541",
SenderIBAN = "TR13216498468465416"
};
var actual = transfer.MoneyTransfer(transferRequest);
Assert.AreEqual(expected.IsSuccess, actual.IsSuccess);
Assert.AreEqual(expected.Message, actual.Message);
}
Test metotlarımızı yazdıktan sonra aşağıdaki görselde olduğu gibi VS'da bulunan Test > Run > All Tests dedikten sonra Test Explorer açılır ve solution da bulunan test metotları çalıştırılıp success ve fail durumlarını görebiliriz.
TransferMoneyTest.cs içerisi son olarak aşağıdaki gibidir.
[TestClass]
public class TransferMoneyTest
{
[TestMethod]
public void TransferMoney_With_Zero_Amount_Then_Transfer_Failed_Test()
{
var expected = new TransferResponse
{
IsSuccess = false,
Message = "Amount must be greater Then 1"
};
var transfer = new Transfer();
var transferRequest = new TransferRequest
{
Amount = 0,
ReceiverIBAN = "TR806541651616516416541",
SenderIBAN = "TR13216498468465416"
};
var actual = transfer.MoneyTransfer(transferRequest);
Assert.AreEqual(expected.IsSuccess, actual.IsSuccess);
Assert.AreEqual(expected.Message, actual.Message);
}
[TestMethod]
public void TransferMoney_With_Empty_Sender_IBAN_Then_Transfer_Failed_Test()
{
var expected = new TransferResponse
{
IsSuccess = false,
Message = "Sender Account IBAN must not be null or empty."
};
var transfer = new Transfer();
var transferRequest = new TransferRequest
{
Amount = 60,
SenderIBAN = string.Empty,
ReceiverIBAN = "TR13216498468465416"
};
var actual = transfer.MoneyTransfer(transferRequest);
Assert.AreEqual(expected.IsSuccess, actual.IsSuccess);
Assert.AreEqual(expected.Message, actual.Message);
}
[TestMethod]
public void TransferMoney_With_Correct_Request_Parameter_Then_Transfer_OK_Test()
{
var expected = new TransferResponse
{
IsSuccess = true,
Message = "Transfer operation is successful."
};
var transfer = new Transfer();
var transferRequest = new TransferRequest
{
Amount = 60,
ReceiverIBAN = "TR806541651616516416541",
SenderIBAN = "TR13216498468465416"
};
var actual = transfer.MoneyTransfer(transferRequest);
Assert.AreEqual(expected.IsSuccess, actual.IsSuccess);
Assert.AreEqual(expected.Message, actual.Message);
}
}
Yazının başında da belirttiğimiz üzre unit-test yazmak ilk başlarda maliyet olarak görünsede aslında oldukça önemli ve hayat kurtarıcı yanları da olabilmekte. Çeşitli framework'ler kullanarak çok farklı test yapıları oluşturabilirsiniz. Yaptığımız örnekte basitçe unit test nasıl yazılır göstermeye çalıştık. Unit test ile ilgili daha fazla bilgiyi ms'in burada bulunan adresinden de bulabilirsiniz.