JUnit5 ile Parameterized Test

By Cem Dırman Last updated Oca 26, 2024

Bu yazımızda unit testlerimizi daha efektif hale getirmeye çalışacağız. Peki neden? Çünkü testlerimizi yazarken muhtemelen fark ettiğiniz bir problem var.

Bazı durumlarda test methodumuzun işlevi aynı kalmasını istiyoruz ama farklı değerler çalışmasını istiyoruz. Bu sorunu test methodlarımızı çoklayarak da yapabiliriz.

Fakat neden kod tekrarı yapalım ki? Ayrıca proje kodlarına değer verdiğimiz kadar test kodlarımıza da değer vermeliyiz. Unutmamalıyız ki test methodlarımız ayrıca bizler için

dokümantasyon da sağlar. Bilmediğimiz bir methodun nasıl davrandığını test methodlarından çok daha iyi anlayabiliriz.

Parameterized Tests

Parametreli testler, bir testi farklı argümanlarla birden çok kez çalıştırmanızı sağlar. @Test metodları gibi tanımlanan ancak @ParameterizedTest annotasyonu kullanılan bir JUnit özelliğidir. Ayrıca, her çağrı için argümanları sağlayacak en az bir parametre kaynağı(source) belirtmeniz ve test metodunda bu argümanları kullanmanız gerekir. Aksi halde parametreli test zaten olmaz.

Aşağıdaki örnek, @ValueSource annotasyonunu kullanarak bir dizi String’i argüman olarak belirleyen parametreli bir testi göstermektedir.



@ParameterizedTest
@ValueSource(strings = { "racecar", "radar", "able was I ere I saw elba" })
void palindromes(String candidate) {
    assertTrue(StringUtils.isPalindrome(candidate));
}

@ParameterizedTest

@ValueSource(strings = { "racecar", "radar", "able was I ere I saw elba" })

void palindromes(String candidate) {

assertTrue(StringUtils.isPalindrome(candidate));

}



palindromes(String) ✔
├─ [1] candidate=racecar ✔
├─ [2] candidate=radar ✔
└─ [3] candidate=able was I ere I saw elba ✔

palindromes(String) ✔

├─ [1] candidate=racecar ✔

├─ [2] candidate=radar ✔

└─ [3] candidate=able was I ere I saw elba ✔

@ValueSource

Aşağıdaki tipler parametreli testler için parametre olarak verilebilir.

short
byte
int
long
float
double
char
boolean
java.lang.String
java.lang.Class



@ParameterizedTest
@ValueSource(ints = { 1, 2, 3 })
void testWithValueSource(int argument) {
    assertTrue(argument > 0 && argument < 4);
}

@ParameterizedTest

@ValueSource(ints = { 1, 2, 3 })

void testWithValueSource(int argument) {

assertTrue(argument > 0 && argument < 4);

}

@NullSource & @EmptySource



    @ParameterizedTest
    @EmptySource
    void shouldEqualsEmptyValue(String value) {
        assertThat(StringUtils.EMPTY).isEqualTo(value);
    }

    @ParameterizedTest
    @NullSource
    void shouldEqualsNullValue(String value) {
        assertNull(value);
    }

@ParameterizedTest

@EmptySource

void shouldEqualsEmptyValue(String value) {

assertThat(StringUtils.EMPTY).isEqualTo(value);

}

@ParameterizedTest

@NullSource

void shouldEqualsNullValue(String value) {

assertNull(value);

}

@EnumSource

Enum değerlerini parametre vermek için kullanılır.

Örnek bir method üzerinden inceleyelim. Amacımız sadece test yazabilmek olduğu için methodumuz uydurma 🙂



@Service
@RequiredArgsConstructor
@Slf4j
public class AdvertService {

	private final RabbitMqService rabbitMqService;

	private final AdvertRepository advertRepository;

	public void getAdvertsWithoutAdvertisement(UserType type) {

		if (Set.of(UserType.INDIVIDUAL, UserType.STUDENT).contains(type)) {
			log.error("{} type is not valid", type);
			throw new RuntimeException("user type is not valid");
		}

		rabbitMqService.sendMessage(new EmailMessage("email@bilisim.io"));

		advertRepository.findAll();

	}

}

@Service

@RequiredArgsConstructor

@Slf4j

public class AdvertService {

private final RabbitMqService rabbitMqService;

private final AdvertRepository advertRepository;

public void getAdvertsWithoutAdvertisement(UserType type) {

if (Set.of(UserType.INDIVIDUAL, UserType.STUDENT).contains(type)) {

log.error("{} type is not valid", type);

throw new RuntimeException("user type is not valid");

}

rabbitMqService.sendMessage(new EmailMessage("[email protected]"));

advertRepository.findAll();

}

UserType göre görevini yapan bir methodumuz var ve UserType.INDIVIDUAL, UserType.STUDENT enum değerlerine göre hata fırlatmasını bekliyoruz ve “PREMIUM”, “CORPORATE” değerleri geldiğinde ise görevini başarılı bir şekilde gerçekleştirmesini bekliyoruz.



@ExtendWith(MockitoExtension.class)
class AdvertServiceTest {
    @InjectMocks
    private AdvertService advertService;
    @Mock
    private RabbitMqService rabbitMqService;
    @Mock
    private AdvertRepository advertRepository;

    @ParameterizedTest
    @EnumSource(value = UserType.class, names = {"STUDENT", "INDIVIDUAL"})
    void shouldThrowException_whenUserTypeIndividualOrStudent(UserType userType) {
        RuntimeException exception = assertThrows(RuntimeException.class, () -> advertService.getAdvertsWithoutAdvertisement(userType));
        assertThat("user type is not valid").isEqualTo(exception.getMessage());
        Mockito.verifyNoInteractions(advertRepository);
        Mockito.verifyNoInteractions(rabbitMqService);
    }

    @ParameterizedTest
    @EnumSource(value = UserType.class, names = {"PREMIUM", "CORPORATE"})
    void shouldGetAdverts_whenUserTypeIndividualOrStudent(UserType userType) {
        advertService.getAdvertsWithoutAdvertisement(userType);
        Mockito.verify(rabbitMqService).sendMessage(Mockito.any(EmailMessage.class));
        Mockito.verify(advertRepository).findAll();
    }
}

@ExtendWith(MockitoExtension.class)

class AdvertServiceTest {

@InjectMocks

private AdvertService advertService;

@Mock

private RabbitMqService rabbitMqService;

@Mock

private AdvertRepository advertRepository;

@ParameterizedTest

@EnumSource(value = UserType.class, names = {"STUDENT", "INDIVIDUAL"})

void shouldThrowException_whenUserTypeIndividualOrStudent(UserType userType) {

RuntimeException exception = assertThrows(RuntimeException.class, () -> advertService.getAdvertsWithoutAdvertisement(userType));

assertThat("user type is not valid").isEqualTo(exception.getMessage());

Mockito.verifyNoInteractions(advertRepository);

Mockito.verifyNoInteractions(rabbitMqService);

}

@ParameterizedTest

@EnumSource(value = UserType.class, names = {"PREMIUM", "CORPORATE"})

void shouldGetAdverts_whenUserTypeIndividualOrStudent(UserType userType) {

advertService.getAdvertsWithoutAdvertisement(userType);

Mockito.verify(rabbitMqService).sendMessage(Mockito.any(EmailMessage.class));

Mockito.verify(advertRepository).findAll();

}

@EnumSource ile value ve names değerlerini vermemiz gerekiyor. names alanı girmediğinizde enum içerisinde tanımlı bütün değerler ile testi çalıştırmaya çalışacaktır.

Fakat biz sadece belirlediğimiz değerlere göre çalışmasını istediğimiz için names ile değerlerimizi vermemiz gerekiyor.

@MethodSource

Parametreli testlere veri sağlamak için kullanılan bir annotation.



@ParameterizedTest
@MethodSource("stringProvider")
void testWithExplicitLocalMethodSource(String argument) {
    assertNotNull(argument);
}

static Stream<String> stringProvider() {
    return Stream.of("apple", "banana");
}

@ParameterizedTest

@MethodSource("stringProvider")

void testWithExplicitLocalMethodSource(String argument) {

assertNotNull(argument);

}

static Stream<String> stringProvider() {

return Stream.of("apple", "banana");

}

Başka bir class içinden test methodlarımıza aşağıdaki gibi parametre geçebiliriz.



class ExternalMethodSourceDemo {

    @ParameterizedTest
    @MethodSource("example.StringsProviders#tinyStrings")
    void testWithExternalMethodSource(String tinyString) {
        // test with tiny string
    }
}

class StringsProviders {

    static Stream<String> tinyStrings() {
        return Stream.of(".", "oo", "OOO");
    }
}

class ExternalMethodSourceDemo {

@ParameterizedTest

@MethodSource("example.StringsProviders#tinyStrings")

void testWithExternalMethodSource(String tinyString) {

// test with tiny string

}

class StringsProviders {

static Stream<String> tinyStrings() {

return Stream.of(".", "oo", "OOO");

}

@CsvSource

Diğer source annotation gibi testlerimize veri sağlamak için kullanılıyor. Adından da anlayabileceğimiz gibi csv dosyası formatında veriyi sağlayabilirisiniz.

Verileri virgüller ile ayırarak aşağıdaki gibi bir kullanım sağlanabilir.



@ParameterizedTest
@CsvSource({
    "apple,         1",
    "banana,        2",
    "'lemon, lime', 0xF1",
    "strawberry,    700_000"
})
void testWithCsvSource(String fruit, int rank) {
    assertNotNull(fruit);
    assertNotEquals(0, rank);
}

@ParameterizedTest

@CsvSource({

"apple, 1",

"banana, 2",

"'lemon, lime', 0xF1",

"strawberry, 700_000"

})

void testWithCsvSource(String fruit, int rank) {

assertNotNull(fruit);

assertNotEquals(0, rank);

}

@CsvFileSource

İlk olarak, test verilerimizi içeren bir CSV dosyası oluşturmalı ve bu dosyayı classpath’e koymalıyız. Oluşturulan CSV dosyasına test verilerini eklerken şu kurallara uymamız gerekiyor:

Bir satır, bir metod çağrısının tüm argümanlarını içermelidir.
Farklı argüman değerlerini virgülle ayırmalısınız.
Her satırdaki argüman değerlerinin sırasının, test metodunun parametreleriyle aynı olmasını sağlamalısınız.



ParameterizedTest
@CsvFileSource(resources = "/two-column.csv", numLinesToSkip = 1)
void testWithCsvFileSourceFromClasspath(String country, int reference) {
    assertNotNull(country);
    assertNotEquals(0, reference);
}

@ParameterizedTest
@CsvFileSource(files = "src/test/resources/two-column.csv", numLinesToSkip = 1)
void testWithCsvFileSourceFromFile(String country, int reference) {
    assertNotNull(country);
    assertNotEquals(0, reference);
}

@ParameterizedTest(name = "[{index}] {arguments}")
@CsvFileSource(resources = "/two-column.csv", useHeadersInDisplayName = true)
void testWithCsvFileSourceAndHeaders(String country, int reference) {
    assertNotNull(country);
    assertNotEquals(0, reference);
}

ParameterizedTest

@CsvFileSource(resources = "/two-column.csv", numLinesToSkip = 1)

void testWithCsvFileSourceFromClasspath(String country, int reference) {

assertNotNull(country);

assertNotEquals(0, reference);

}

@ParameterizedTest

@CsvFileSource(files = "src/test/resources/two-column.csv", numLinesToSkip = 1)

void testWithCsvFileSourceFromFile(String country, int reference) {

assertNotNull(country);

assertNotEquals(0, reference);

}

@ParameterizedTest(name = "[{index}] {arguments}")

@CsvFileSource(resources = "/two-column.csv", useHeadersInDisplayName = true)

void testWithCsvFileSourceAndHeaders(String country, int reference) {

assertNotNull(country);

assertNotEquals(0, reference);

}

Kaynak

https://junit.org/junit5/docs/current/user-guide/

Önceki test yazıları için aşağıdaki linklerden ulaşabilirsiniz.

Faydalı olması dileğiyle.