My Profile Photo

Mehmet Cem Yücel


En yalın haliyle paylaşım platformu
Java Cloud Mikroservis Spring Boot NoSQL Kafka Dağıtık Sistemler Big Data ve Blockchain hakkında karalamalarım


Spring Boot Rest Servis Entegrasyon Testi

Hepimiz Rest servisleri uygulamalarımızda yoğun olarak kullanıyoruz. Peki, bu servislerin entegrasyon testlerini yazarken sıklıkla yapılan o hataya siz de düşüyor olabilir misiniz? Bugün bir Spring Boot uygulamasında Rest servislere 2 farklı test yazımını inceleyeceğiz. Birisi gerçekten bir integration testi, diğeri de tüm Spring Context’ini ayağa kaldırarak yapılan uçtan uca testi örnekleyecek.

Test Piramidi

Test piramidinin en tabanında birim testler(unit tests) bulunur. Sonrasında entegrasyon testleri(integration tests), kontrat testleri(contract tests), arayüz testleri(UI tests) diye devam eder. Bu testler ile ilgili Martin Fowler’ın yazısını okumanızı tavsiye ederim.

Martin Fowler Test Pyramidhttps://martinfowler.com/articles/practical-test-pyramid/testPyramid.png

Bu piramidin en güçlü olması gereken yeri tabii ki tabanıdır. Taban katmanının gücü üzerine üzerine diğer katmanlar yerleşir. Bu sebeple en geniş kapsamlı testleri birim testlerde kodlarız. Bu testlerimizin adetlerinin çok olmasından dolayı hızlı çalışmaları lazımdır. Örneğin bir CI/CD pipeline’ında kodunuz build edilirken bu testleriniz çalıştırılacaktır. Bir mikroservis mimaride ancak 3 dakikada deploy olabilen kod sahibi olmak bir çok problemi doğuracaktır. Bu sebeple özellikle birim testleri hiçbir bağımlılık olmadan çalışabilmelidir. Entegrasyon testlerinin de doğru mock, fake, spy veya stub yöntemleri ile izolasyonu mutlaka sağlanmalıdır.

REST Entegrasyon Testi

Buradan itibaren kodumuza dönelim. Bir RestController’ımız, bir de onun kullandığı başka bir Spring Bean sınıfımız olsun.

Post metod açan bu sınıfımızın testini nasıl yazmalıyız? Google’da “spring boot rest test” anahtar kelimeleri ile aramamızı yaptığımızda çıkan 5 site aşağıdaki gibi. Bunlardan ikisi de Spring’in kendi sitesi :)

Google Search

Bu 5 sitedeki yöntemler aşağı yukarı aynı. Autowire edilmiş bir MockMvc ile ya tüm Spring Application Context ayağa kaldırılıyor, ya da sadece Web Context ve bu context’e bağımlı beanler ayağa kaldırılıyor. Ben tüm application context yerine daha hızlı olan sadece web contexti ve bunlara bağlı beanleri ayağa kaldıracak şekilde aşağıdaki test sınıfını yazdım.

Bu test sınıfındaki kodu 5 farklı kez çalıştırdım ve ortalama sonlanma süresi olarak 2.186 ms süresine ulaştım. Bir entegrasyon testi için uzun bir süre. Bu süreyi kısaltmak için neler yapılabilir? Gerçekten de tüm web contexti ayağa kaldırmak zorunda mıyız?

MockMvc Standalone Builder

Önerdiğim yeni yöntemimizde yapacağımız değişiklikler şunlar olacak;

  1. Tüm web contexti ayağa kaldırmaktan vazgeç, sadece RestController’ımı kaldır
  2. Controller’ımın bağımlı olduğu bean’leri ayağa kaldırma, yerine ben onları mocklayacağım.

Bu değişikliklerle kodumuz aşağıdaki gibi oldu:

Bu kodu 5 kez çalıştırdığımda da ortalama çalışma süresi olarak 556 ms olarak ölçtüm. Neredeyse 4’te biri sürede kodumun çalışırlığını test edebilmiş oldum. Kodlara aşağıdaki adresten erişebilirsiniz.

https://github.com/mehmetcemyucel/springboot-rest-int-test

Yazıyı bitirmeden yine de şunları not etmekte fayda var. Bu yazıda kıyasladığım örnekler her bir servis için ayrı ayrı context ayağa kaldırma ile standalone yapılandırma arasındaki farkı içeriyor. Test edeceğiniz servis sayısı ile bağlantılı olmak üzere başka alternatifler de mevcut, örneğin 30 servis için tek context ayağa kaldırıp tüm testleri tek bir context ile tamamladığınızda her defasında mock üretme maliyetine girmediğinizden dolayı total süre daha düşük çıkabilir. Özetle, tek bir doğru yok, senaryoya göre doğru tercih veya tercihler var.

Sonuç olarak testlerimizin hızlı olarak sonuçlanabilmesi için maksimum izolasyon ve minimum bağımlılığı aklımızdan çıkartmamalıyız. Bu ihtiyaçlarınız için kullanabileceğiniz birkaç test frameworkünü de yazarak yazımı sonlandırıyorum.

Junit: Defacto standart (spring-boot-starter-test’in bir parçası)

Spring Test: Boot uygulamaları için utilityler (spring-boot-starter-test’in bir parçası)

Mockito: Dependency’leri mocklamak için (spring-boot-starter-test’in bir parçası)

AssertJ: Akıcı bir dille test yazabilmek için (spring-boot-starter-test’in bir parçası)

Wiremock: Harici bir servisi stublamak için kütüphane

Hamcrast: Matcher objeler için test kütüphanesi (spring-boot-starter-test’in bir parçası)

Pact: Consumer Drivent Contract testleri için kütüphane

JsonAssert: JSON için assertion kütüphanesi (spring-boot-starter-test’in bir parçası)

Selenium: UI üzerinden end to end testler yazmak için kütüphane

Rest-assured: Rest apiler üzerinden end to end testler yazmak için kütüphane

Sonraki yazılarda görüşmek üzere

En yalın haliyle

Mehmet Cem Yücel


Bu yazılar ilgilinizi çekebilir:

Bir Yazılımcının Bilmesi Gereken 15 Madde

Spring Boot Devtools ile Docker Üzerindeki Kodu Debug Etme ve Değiştirme

Spring Boot Property’lerini Jasypt ile Şifrelemek

Blockchain teknolojisi ile ilgileniyor iseniz bunlar da hoşunuza gidebilir:

BlockchainTurk.net yazıları

comments powered by Disqus