• Najnowsze pytania
  • Bez odpowiedzi
  • Zadaj pytanie
  • Kategorie
  • Tagi
  • Zdobyte punkty
  • Ekipa ninja
  • IRC
  • FAQ
  • Regulamin
  • Książki warte uwagi

Java Spring - testowanie kontrolera z niewłaściwymi danymi

VPS Starter Arubacloud
0 głosów
875 wizyt
pytanie zadane 13 marca 2019 w Java przez niezalogowany
edycja 13 marca 2019

Hej. Mam kontroler:

 

@GetMapping("/{category}")
  public String getProductsByCategory(Model model, @PathVariable("category") String productCategory) {
    List<Product> productsByCategory = productRepository.findByCategory(productCategory);
    if (productsByCategory == null || productsByCategory.isEmpty()) {
      throw new NoProductsFoundUnderCategoryException();
    }
    model.addAttribute("products", productsByCategory);
    return "allProducts";
  }

I mam test:

 

@Test(expected = NoProductsFoundUnderCategoryException.class)
  public void shouldThrowExceptionWhenCategoryNull() throws Exception {
    List<Product> emptyList = new ArrayList<>();
    when(mockRepository.findByCategory("phone")).thenReturn(emptyList);
    mockMvc.perform(get("/products/phone"));
    verify(mockRepository, times(1)).findByCategory("phone");
  }

Jednak test nie przechodzi. W teście widzę to tak: mockuję repozytorium, żeby w razie wywołania metody findByCategory("phone") zwracało pustą listę.

Jeżeli findByCategory("phone") zwraca pustą listę, to kontroler powinien wywalić wyjątek NoProductsFoundUnderCategoryException. 
Następnie w teście wywołuję żądanie get na ścieżce "/products/phone" (klasa ma @RequestMapping ustawiony na "/products") i upewniam się, że metoda  findByCategory("phone") została wywołana raz.

Nie umiem znaleźć błędu w tym teście. Może powinienem dodać jakieś .andExpect? Po dodaniu 

.andExpect(status().is4xxClientError());

test nadal nie przechodzi.

Klasa NoProductsFound...

@ResponseStatus(value = HttpStatus.NOT_FOUND, reason = "Brak produktów we wskazanej kategorii")
public class NoProductsFoundUnderCategoryException extends RuntimeException {

  private static final long serialVersionUID = 3935230281455340039L;
}

 

komentarz 13 marca 2019 przez mbabane Szeryf (79,280 p.)
Podaj komunikat, ktory zostal zwrocony.
komentarz 13 marca 2019 przez niezalogowany

Konsola wyświetla:
 

java.lang.AssertionError: Expected exception: com.packt.webstore.exception.NoProductsFoundUnderCategoryException

 

3 odpowiedzi

+1 głos
odpowiedź 13 marca 2019 przez Arkadiusz Fajdek Dyskutant (9,450 p.)
wybrane 13 marca 2019
 
Najlepsza

Odpowiedź kolejna żeby nie zniknęła w gąszczu komentarzy. Problem nie jest taki trywialny jak myślałem ;) Człowiek uczy się całe życie.

Dobra, sprawa ma się tak i dokładnie ten konkretny problem jest opisany tutaj: https://github.com/spring-projects/spring-boot/issues/7321

Najważniejsze zdanie "MockMvc tests simply aren't enough to test error responses generated through Spring Boot.". 

I ma to baardzo duży sens, nie ogarnąłem że to robisz to Unit test, a nie test integracyjny. Musisz podnieść w teście integracyjnym cały kontekst springa i wtedy zrobić ten test. Good luck.

komentarz 13 marca 2019 przez niezalogowany
Dziękuję. Jeszcze nie poznałem tematu testów integracyjnych, więc zaznaczam Twoją odpowiedź w ciemno.

Możesz napisać, jak znalazłeś odpowiedź? Szukałem google z 2h i nie wpadłem na to, co Ty :]
komentarz 14 marca 2019 przez Arkadiusz Fajdek Dyskutant (9,450 p.)
Wiesz, kwestia doświadczenia trochę, w zawodowe siędzę w Javie jakieś 7 lat, wiem czego szukać mniej więcej w googlach żeby mnie dobrze pokirwoało :)

Czasem człowiek mierzy się z mega dziwnymi problemami, ale zazwyczaj na stackoverflow // github ktoś już walczył z tym tematem i da się znaleźć jakieś informacje na konkretny temat :)

Nie pamiętam co dokładnie w google wpisałem (sorka), ale pewnie komunikat błędu + to czego się spodziewałem że być powinno.
0 głosów
odpowiedź 13 marca 2019 przez Arkadiusz Fajdek Dyskutant (9,450 p.)
when(mockRepository.findByCategory("phone")).thenReturn(emptyList);

Tu jest problem, zamiast "phone" daj 

Mockito.anyString()
komentarz 13 marca 2019 przez niezalogowany

Niestety nie działa nadal. Stosuję podejście TDD. Najpierw test:

 

@Test
  public void shouldReturnProductsByCategory() throws Exception {

    when(mockRepository.findByCategory("phone")).thenReturn(expectedProducts);
    mockMvc.perform(get("/products/phone"))
        .andExpect(status().isOk())
        .andExpect(view().name("allProducts"))
        .andExpect(model().attributeExists("products"))
        .andExpect(model().attribute("products", mockRepository.findByCategory("phone")));
    verify(mockRepository, times(2)).findByCategory("phone");
  }

Potem odpowiednia klasa:

 

@GetMapping("/{category}")
  public String getProductsByCategory(Model model, @PathVariable("category") String productCategory) {
    List<Product> productsByCategory = productRepository.findByCategory(productCategory);
    model.addAttribute("products", productsByCategory);
    return "allProducts";
  }

I potem dodałem test z pierwszego postu, który przechodzi, kiedy usunę z adnotacji 

(expected = NoProductsFoundUnderCategoryException.class)

Nowa wersja testu:

 

 @Test(expected = NoProductsFoundUnderCategoryException.class)
  public void shouldThrowExceptionWhenCategoryNull() throws Exception {
    List<Product> emptyList = new ArrayList<>();
    when(mockRepository.findByCategory(Mockito.anyString())).thenReturn(emptyList);
    mockMvc.perform(get("/products/phone"));
    verify(mockRepository, times(1)).findByCategory("phone");
  }

 

komentarz 13 marca 2019 przez Arkadiusz Fajdek Dyskutant (9,450 p.)
No ale czekaj, bo czegoś tu nie rozumiem. Masz @GetMapping("/{category}"), rozumiem że Controller ma "/products/phone",  ale w mokMvc robisz mockMvc.perform(get("/products/phone") bez /category. Jesteś pewien że wchodzi Ci do odpowiedniej metody controlera?

Weź się zapnij w tej metodzie debbugerem podczas uruchamiania testu i wszystko bedzie jasne.
komentarz 13 marca 2019 przez niezalogowany

Kontroler ma ustawione mapowanie na "/products", a testowana metoda na "/{category}", gdzie category jest (jako String productCategory) przypisane do zmiennej szablonu URI.

Jeżeli w teście wywołam żądanie GET do zasobu /products/phone, to "phone" z metody 

getProductsByCategory

zostanie przypisane do String productCategory i na podstawie tego Stringa odpowiednia metoda odpowiedniej klasy ma wyszukać produkty z danej kategorii. Jeżeli nic nie znajdzie, ma rzucić wyjątkiem 

NoProductsFoundUnderCategoryException

W teście na sztywno przypisałem zmiennej "category" wartość phone i na zmockowanym repozytorium na sztywno ustawiłem wynik wywołania metody 

findByCategory

jako pusta lista, a pusta lista powinna spowodować rzucenie wyjątkiem.

Wydaje się, że wszystko powinno grać.
Czytam ciągle, może coś wymyślę.
Wynik debugu:
 

15:23:47.596 [main] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - 5 mappings in <unknown>
15:23:47.941 [main] DEBUG org.jboss.logging - Logging Provider: org.jboss.logging.Log4j2LoggerProvider
15:23:47.941 [main] INFO org.hibernate.validator.internal.util.Version - HV000001: Hibernate Validator 6.0.14.Final
15:23:47.941 [main] DEBUG org.hibernate.validator.internal.engine.resolver.TraversableResolvers - Found javax.persistence.Persistence on classpath containing 'getPersistenceUtil'. Assuming JPA 2 environment. Trying to instantiate JPA aware TraversableResolver
15:23:47.956 [main] DEBUG org.hibernate.validator.internal.engine.resolver.TraversableResolvers - Instantiated JPA aware TraversableResolver of type org.hibernate.validator.internal.engine.resolver.JPATraversableResolver.
15:23:47.973 [main] DEBUG org.hibernate.validator.messageinterpolation.ResourceBundleMessageInterpolator - Loaded expression factory via original TCCL
15:23:47.974 [main] DEBUG org.hibernate.validator.internal.engine.ConfigurationImpl - Setting custom MessageInterpolator of type org.springframework.validation.beanvalidation.LocaleContextMessageInterpolator
15:23:47.974 [main] DEBUG org.hibernate.validator.internal.engine.ConfigurationImpl - Setting custom ParameterNameProvider of type org.springframework.validation.beanvalidation.LocalValidatorFactoryBean$1
15:23:47.979 [main] DEBUG org.hibernate.validator.internal.xml.config.ValidationXmlParser - Trying to load META-INF/validation.xml for XML based Validator configuration.
15:23:47.980 [main] DEBUG org.hibernate.validator.internal.xml.config.ResourceLoaderHelper - Trying to load META-INF/validation.xml via TCCL
15:23:47.980 [main] DEBUG org.hibernate.validator.internal.xml.config.ResourceLoaderHelper - Trying to load META-INF/validation.xml via Hibernate Validator's class loader
15:23:47.981 [main] DEBUG org.hibernate.validator.internal.xml.config.ValidationXmlParser - No META-INF/validation.xml found. Using annotation based configuration only.
15:23:48.097 [main] DEBUG org.hibernate.validator.internal.engine.ValidatorFactoryImpl - HV000234: Using org.springframework.validation.beanvalidation.LocaleContextMessageInterpolator as ValidatorFactory-scoped message interpolator.
15:23:48.097 [main] DEBUG org.hibernate.validator.internal.engine.ValidatorFactoryImpl - HV000234: Using org.hibernate.validator.internal.engine.resolver.JPATraversableResolver as ValidatorFactory-scoped traversable resolver.
15:23:48.097 [main] DEBUG org.hibernate.validator.internal.engine.ValidatorFactoryImpl - HV000234: Using org.hibernate.validator.internal.util.ExecutableParameterNameProvider as ValidatorFactory-scoped parameter name provider.
15:23:48.097 [main] DEBUG org.hibernate.validator.internal.engine.ValidatorFactoryImpl - HV000234: Using org.hibernate.validator.internal.engine.DefaultClockProvider as ValidatorFactory-scoped clock provider.
15:23:48.097 [main] DEBUG org.hibernate.validator.internal.engine.ValidatorFactoryImpl - HV000234: Using org.hibernate.validator.internal.engine.scripting.DefaultScriptEvaluatorFactory as ValidatorFactory-scoped script evaluator factory.
15:23:48.149 [main] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter - ControllerAdvice beans: 0 @ModelAttribute, 0 @InitBinder, 1 RequestBodyAdvice, 1 ResponseBodyAdvice
15:23:48.183 [main] DEBUG org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver - ControllerAdvice beans: 0 @ExceptionHandler, 1 ResponseBodyAdvice
15:23:48.199 [main] INFO org.springframework.mock.web.MockServletContext - Initializing Spring TestDispatcherServlet ''
15:23:48.199 [main] INFO org.springframework.test.web.servlet.TestDispatcherServlet - Initializing Servlet ''
15:23:48.199 [main] DEBUG org.springframework.test.web.servlet.TestDispatcherServlet - Detected AcceptHeaderLocaleResolver
15:23:48.199 [main] DEBUG org.springframework.test.web.servlet.TestDispatcherServlet - Detected FixedThemeResolver
15:23:48.199 [main] DEBUG org.springframework.test.web.servlet.TestDispatcherServlet - Detected org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator@38fc5554
15:23:48.199 [main] DEBUG org.springframework.test.web.servlet.TestDispatcherServlet - Detected org.springframework.web.servlet.support.SessionFlashMapManager@5e8cda75
15:23:48.199 [main] DEBUG org.springframework.test.web.servlet.TestDispatcherServlet - enableLoggingRequestDetails='false': request parameters and headers will be masked to prevent unsafe logging of potentially sensitive data
15:23:48.199 [main] INFO org.springframework.test.web.servlet.TestDispatcherServlet - Completed initialization in 0 ms
15:23:48.263 [main] DEBUG org.springframework.test.web.servlet.TestDispatcherServlet - GET "/products/phone", parameters={}
15:23:48.271 [main] DEBUG org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping - Mapped to public java.lang.String com.packt.webstore.controller.ProductController.getProductsByCategory(org.springframework.ui.Model,java.lang.String)
15:23:48.294 [main] DEBUG org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver - Resolved [com.packt.webstore.exception.NoProductsFoundUnderCategoryException]
15:23:48.294 [main] DEBUG org.springframework.test.web.servlet.TestDispatcherServlet - Completed 404 NOT_FOUND



 

komentarz 13 marca 2019 przez Arkadiusz Fajdek Dyskutant (9,450 p.)
Racja :) słuchaj to na 100% jest coś mega trywialnego, wrzuć repo na githuba, albo na jakieś inne repozytorium żebym mógł zobacyć cały kod i powiem Ci dokładnie czemu nie działa :)
komentarz 13 marca 2019 przez niezalogowany
komentarz 13 marca 2019 przez niezalogowany

@Arkadiusz Fajdek, Jak coś to teraz ściągnij, bo zapomniałem pushnąć zmian :]

komentarz 13 marca 2019 przez Arkadiusz Fajdek Dyskutant (9,450 p.)

@YourDoom na dzień dobry w repo nie ma klasy 

ProductService

Widze ze tez pozmieniałeś kod, nie ma tego exceptiona o którym pisałeś... tak to Ci kolego nie pomogę ;) Zawijam sie do domu, jak ogarniesz to repo to wieczorem sprawdze i napisze co jest nie tak. Tylko proszę, żebym kolejny raz nie ściągał repo na darmo ;)

komentarz 13 marca 2019 przez niezalogowany
Sorry. Chyba ściągnąłeś zanim pushnąłem zmiany :(
0 głosów
odpowiedź 13 marca 2019 przez mbabane Szeryf (79,280 p.)
edycja 14 marca 2019 przez mbabane

Jeśli chcesz to przetestować jednostkowo to robisz to zwyczajnie jak to w Javie:

@Test(expected = NoProductsFoundUnderCategoryException.class)
  public void shouldThrowExceptionWhenCategoryNull() throws Exception {
    List<Product> emptyList = new ArrayList<>();
    when(mockRepository.findByCategory("phone")).thenReturn(emptyList);

    productController.getProductsByCategory("phone" ...);

    verify(mockRepository, times(1)).findByCategory("phone");
  }

Natomiast tak jak wspomniał  Arkadiusz Fajdek, bardziej integracyjne taki test nie ma trochę sensu, bo robiąc zapytanie HTTP nie ma możliwości aby klient dostał Javowy wyjątek. Musiał by on być z serializowany np. do JSON i sprawdzany po stronie klienta. Co prawda jest to domyślnie jakoś robione bo w Twoim przypadku body w momencie wyrzucenia wyjątku będzie podobne do:

{
    "timestamp": "2019-03-13T20:30:14.941+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "No message available",
    "path": "/products/adasd"
}

 Domyślna sygnalizacja wyjątków dla klientów HTTP to zdaje się zwrócenie błędu HTTP 500 Internal Server Error

Do łapania wyjątków w Springu jest coś takiego:

https://docs.spring.io/spring/docs/5.1.5.RELEASE/spring-framework-reference/web.html#mvc-ann-exceptionhandler

Jednak to jest bardziej pod REST API tak mi się wydaje. Ty zdaje się robisz bardziej tradycyjną aplikację MVC. I w tym wypadku takie rzucanie wyjątku jest chyba nadmiarowe.  Po prostu wsadź tę listę do modelu tak jak jest i sprawdzenie zrób po stronie widoku:

@GetMapping("/{category}")
  public String getProductsByCategory(Model model, @PathVariable("category") String productCategory) {
    List<Product> productsByCategory = productRepository.findByCategory(productCategory);
 
    model.addAttribute("products", productsByCategory);
    return "allProducts";
  }

Dodam jeszcze, że w przypadku, kiedy coś jest szukane względem czegoś i to zwraca listę/tablicę to gdy tego czegoś nie będzie to dobrą praktyką jest zwracanie pustej listy/tablicy, a nie nulla (Wspominam o tym bo masz tam sprawdzenie czy lista jest nullem).

komentarz 14 marca 2019 przez niezalogowany
Ok, dzięki za rady.

Napisałeś "Po prostu wsadź tę listę do modelu tak jak jest i sprawdzenie zrób po stronie widoku", czyli jeżeli lista nie jest pusta, to widok ją pokaże, a jeżeli jest pusta, to nie pokaże?
Czy jest to dobre rozwiązanie? A jeżeli ktoś ręcznie wpisze w przeglądarce www.webstore.com/nieistniejącakategoria
to nie spowoduje to jakichś nieprzewidzianych błędów, jeżeli nie zabezpieczymy się przed tym, dodając wyjątek i odpowiednią stronę do wyświetlenia komunikatu, że nie istnieje taka kategoria?
komentarz 14 marca 2019 przez mbabane Szeryf (79,280 p.)

... czyli jeżeli lista nie jest pusta, to widok ją pokaże, a jeżeli jest pusta, to nie pokaże?

Tak dokladnie.

Czy jest to dobre rozwiązanie? A jeżeli ktoś ręcznie wpisze w przeglądarce www.webstore.com/nieistniejącakategoria

Nawet jeśli tak zrobi to i tak przejdzie do widoku, ktory zwracasz returnem czyli w tym wypadku "allProducts.html". A w widoku będzie wyświetlone "Dla kategorii "nieistniejacakategoria" nie znaleziono produktów".

Odrębną rzeczą jest zrobienie walidacji na to pole. Czyli Twój kontroler musi przed wejściem do właściwego szukania, sprawdzać czy pole category zawiera dozwolone znaki.

Podobne pytania

0 głosów
1 odpowiedź 154 wizyt
pytanie zadane 18 sierpnia 2017 w Java przez Jonki Dyskutant (8,180 p.)
0 głosów
1 odpowiedź 140 wizyt
pytanie zadane 3 sierpnia 2018 w Java przez kamil159 Nowicjusz (180 p.)
0 głosów
1 odpowiedź 232 wizyt
pytanie zadane 20 lipca 2018 w Java przez Kondzio Mądrala (5,230 p.)

92,452 zapytań

141,262 odpowiedzi

319,077 komentarzy

61,854 pasjonatów

Motyw:

Akcja Pajacyk

Pajacyk od wielu lat dożywia dzieci. Pomóż klikając w zielony brzuszek na stronie. Dziękujemy! ♡

Oto polecana książka warta uwagi.
Pełną listę książek znajdziesz tutaj.

Akademia Sekuraka

Akademia Sekuraka 2024 zapewnia dostęp do minimum 15 szkoleń online z bezpieczeństwa IT oraz dostęp także do materiałów z edycji Sekurak Academy z roku 2023!

Przy zakupie możecie skorzystać z kodu: pasja-akademia - użyjcie go w koszyku, a uzyskacie rabat -30% na bilety w wersji "Standard"! Więcej informacji na temat akademii 2024 znajdziecie tutaj. Dziękujemy ekipie Sekuraka za taką fajną zniżkę dla wszystkich Pasjonatów!

Akademia Sekuraka

Niedawno wystartował dodruk tej świetnej, rozchwytywanej książki (około 940 stron). Mamy dla Was kod: pasja (wpiszcie go w koszyku), dzięki któremu otrzymujemy 10% zniżki - dziękujemy zaprzyjaźnionej ekipie Sekuraka za taki bonus dla Pasjonatów! Książka to pierwszy tom z serii o ITsec, który łagodnie wprowadzi w świat bezpieczeństwa IT każdą osobę - warto, polecamy!

...