Übung Meteo Service Unit Test Spring Boot
Diese Übung zeigt die meisten verwendeten Unit Test Varianten von Spring Boot. So testen wir durch diese Variantenstudie den gleichen Use Case teilweise doppelt. In der Praxis wählt man die richtige Variante nach den aktuellen Gegebenheiten und Anforderungen.
Programmieren Sie mindestens einen der nachfolgend beschriebenen Unit Tests. Wir empfehlen Ihnen mit dem Test Setup Daten fix zu definieren und zu laden ohne die Daten aus der Datei data.sql zu verwenden. Erstellen Sie hierzu die Datei application-unittest.properties und schalten Sie das Laden der data.sql aus. Das folgende Listing zeigt eine mögliche unittest Profile Properties Datei application-unittest.properties:
spring.sql.init.mode=never
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driver-class-name=org.h2.Driver
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.H2Dialect
spring.jpa.database-platform=org.hibernate.dialect.H2DialectEinige Tests arbeiten mit Mock Daten und beziehen keine Daten aus der Datenbank. Die anderen Tests arbeiten mit Daten aus der H2 Datenbank.
Das folgende Beispiel zeigt eine mögliche Setup Klasse für die Bereitstellung der Testdaten. Die nachfolgenden Vorlagen für die Unit Tests arbeiten mit dieser Klasse:
package ch.std.meteo.test.setup;
import java.util.Arrays;
import java.util.stream.Collectors;
import java.util.stream.DoubleStream;
import javax.persistence.EntityManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import ch.std.meteo.jpa.MeteoData;
import ch.std.meteo.repositories.MeteoDataRepository;
@Component
public class MeteoDataTestSetup {
public static Double MIN = 4.5;
public static Double MAX = 16.1;
public static Double[] TEMPERATURES = { MIN, 6.2, 10.3, 14.2, MAX, 13.3, 9.8, 7.2 };
public static Double MED = 0.0;
static {
MED = Arrays.stream(TEMPERATURES).collect(Collectors.averagingDouble(x -> x));
}
private MeteoDataRepository meteoDataRepository;
private EntityManager entityManager;
@Autowired
public MeteoDataTestSetup(MeteoDataRepository meteoDataRepository, EntityManager entityManager) {
this.meteoDataRepository = meteoDataRepository;
this.entityManager = entityManager;
}
public void setup() {
for (Double t : TEMPERATURES) {
MeteoData meteoData = new MeteoData(t);
this.meteoDataRepository.save(meteoData);
}
this.entityManager.clear();
}
public void teardown() {
this.meteoDataRepository.deleteAllInBatch();
}
}JPA Repository Unit Test (@DataJpaTest)
Das folgende Listing zeigt einen möglichen @DataJpaTest:
package ch.std.meteo.test.repositories;
...
@ExtendWith(SpringExtension.class)
@DataJpaTest
@ComponentScan(basePackages = {"ch.std.meteo.test"})
@ActiveProfiles("unittest")
public class MeteoDataRepositoryJPATest {
@Autowired
private MeteoDataRepository meteoDataRepository;
@Autowired
private MeteoDataTestSetup meteoDataTestSetup;
@BeforeEach
public void setup() {
this.meteoDataTestSetup.setup();
}
@AfterEach
public void teardown() {
this.meteoDataTestSetup.teardown();
}
@Test
public void testMeteoDataFindAll() {
// TODO
}
}DTO Mapping Unit Test
Bei diesem reinen Java Unit Test testen wir das korrekte Mapping zwischen Instanzen der Klasse ch.std.meteo.jpa.MeteoData -> ch.std.meteo.dto.MeteoDataDTO.
Meteo Service Unit Test
Bei diesem Test testen wir die ch.std.meteo.service.MeteoService Klasse. Wir arbeiten mit dem Kontext der H2 Datenbank und verwenden damit die @DataJpaTest Umgebung:
package ch.std.meteo.test.service;
...
@ExtendWith(SpringExtension.class)
@DataJpaTest
@ComponentScan(basePackages = {"ch.std.meteo.test"}, basePackageClasses = {MeteoService.class})
@ActiveProfiles("unittest")
public class MeteoServiceTest {
@Autowired
private MeteoDataTestSetup meteoDataTestSetup;
@Autowired
private MeteoService meteoService;
@BeforeEach
public void setup() {
this.meteoDataTestSetup.setup();
}
@AfterEach
public void teardown() {
this.meteoDataTestSetup.teardown();
}
@Test
public void test_getMeteoDaten() {
// TODO
}
@Test
public void test_getMeteoMetrics() {
// TODO
}
}Meteo Service Unit Test using Repository MockBean
Bei diesem Test testen wir die ch.std.meteo.service.MeteoService Klasse. Wir arbeiten aber alternativ mit einer Mock Umgebung anstelle der H2 Datenbank:
package ch.std.meteo.test.service;
...
@ExtendWith(SpringExtension.class)
@DataJpaTest
@ComponentScan(basePackages = {"ch.std.meteo.test"}, basePackageClasses = {MeteoService.class})
@ActiveProfiles("unittest")
public class MeteoServiceTestUsingMockBean {
@MockBean
private MeteoDataRepository meteoDataRepository;
@Autowired
private MeteoService meteoService;
@BeforeEach
public void setup() {
when(meteoDataRepository.findAll()).thenReturn(Arrays.stream(MeteoDataTestSetup.TEMPERATURES).map(t -> new MeteoData(t)).collect(Collectors.toList()));
}
@Test
public void test_getMeteoDaten() {
// TODO
}
@Test
public void test_getMeteoMetrics() {
MeteoMetrics meteoMetrics = this.meteoService.getMeteoMetrics();
// TODO
}
}Meteo Service Integration Unit Test (@SpringBootTest)
Bei diesem Integratoinstest testen wir den REST Endpoint der Klasse ch.std.meteo.rest.MeteoController. Wir verwenden die @SpringBootTest Annotation mit dem Random Port. Als Test Client arbeitet die Vorlage mit der TestRestTemplate-Klasse:
package ch.std.meteo.test.integration;
...
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@ComponentScan(basePackages = {"ch.std.meteo"})
@ActiveProfiles("unittest")
public class MeteoServiceIntegrationTest {
@Autowired
private TestRestTemplate restTemplate;
@Autowired
private MeteoDataTestSetup meteoDataTestSetup;
@BeforeEach
public void setup() {
this.meteoDataTestSetup.setup();
}
@AfterEach
public void teardown() {
this.meteoDataTestSetup.teardown();
}
@Test
public void test_MeteoController_getMeteoDaten() throws Exception {
// TODO
}
@Test
public void test_MeteoController_getMeteoMetrics() {
// TODO
}
}Meteo Service WebMvc Unit Test (@WebMvc)
Abschliessen testen wir den REST Endpoint MeteoController mit der gemockten Umgebung @WebMvc, und damit wird nur der Controller geladen aber keine weiteren Beans oder Components. Die ch.std.meteo.service.MeteoService Klassen mocken wir, siehe Vorlage:
package ch.std.meteo.test.webmvc;
...
@ExtendWith(SpringExtension.class)
@WebMvcTest(MeteoController.class)
public class MeteoServiceWebLayerTest {
@Autowired
private MockMvc mvc;
@MockBean
private MeteoService meteoService;
@BeforeEach
public void setup() {
List meteoDataList = Arrays.stream(MeteoDataTestSetup.TEMPERATURES).map(t -> new MeteoData(t)).collect(Collectors.toList());
when(meteoService.getMeteoDaten()).thenReturn(meteoDataList);
MeteoMetrics meteoMetrics = new MeteoMetrics(meteoDataList);
when(meteoService.getMeteoMetrics()).thenReturn(meteoMetrics);
}
@Test
public void test_MeteoController_getMeteoDaten() throws Exception {
// TODO
}
@Test
public void test_getMeteoMetrics() throws Exception {
// TODO
}
} Lösung
Eine mögliche Lösung finden Sie hier