Spring Boot Test Assertions mit Objekten

[Raphael_]

Hi, ich habe einen Spring Boot Test, der folgendermaßen aussieht:

 @Test
    void buyStock_WhenBotOptionalIsPresent_ThenSaveEditedBotAndNewStockAndReturnStock() {
        //arrange
        Bot givenBot = Bot.builder()
                .id(1L)
                .algorithms(List.of(Algorithms.MACD))
                .name("Test")
                .moneyLeftToInvest(BigDecimal.valueOf(1000))
                .build();

        Stock boughtStock = Stock.builder()
                .stockType(StockType.BTCUSDT)
                .amount(BigDecimal.valueOf(100))
                .build();

        Bot expectedBot = Bot.builder()
                .id(1L)
                .algorithms(List.of(Algorithms.MACD))
                .name("Test")
                .moneyLeftToInvest(BigDecimal.valueOf(100))
                .stocks(List.of(boughtStock))
                .build();

        BotBuyingRequest botBuyingRequest = new BotBuyingRequest();
        botBuyingRequest.setStockType(boughtStock.getStockType());
        botBuyingRequest.setAmount(boughtStock.getAmount());

        Mockito.when(botRepository.findById(anyLong())).thenReturn(Optional.of(givenBot));

        //act
        ResponseEntity<Optional<Bot>> result = botService.buyStock(1L, botBuyingRequest);

        //assert
        Assertions.assertEquals(HttpStatus.OK, result.getStatusCode());
        Assertions.assertEquals(expectedBot, result.getBody().get());
    }

Ich möchte bei meinen Assertions sicherstellen, dass der expectedBot mit dem result body übereinstimmt. Mein Problem ist, dass ich folgenden Fehler erhalte:

org.opentest4j.AssertionFailedError:
Expected :Optional[com.forecast.nlm.entity.bot.Bot@24facb47]
Actual   :Optional[com.forecast.nlm.entity.bot.Bot@6020cd42]

Die Werte in expectedBot und result body stimmen überein, allerdings sieht das für mich so aus, als ob jedes Optional eine id hat, welche dann nicht übereinstimmt, weil es ja nicht genau das selbe Optional ist. Ich könnte jetzt natürlich auf alle Werte einzeln zugreifen und somit überprüfen, ob diese übereinstimmen, aber das ist halt nicht so schön, wie ich finde. Gibt es eine Möglichkeit besser zu lösen?

 

[KonradN]

Also die Meldung interpretiere ich schon so, dass da zwei unterschiedliche Bot Instanzen sind. Da geht es nicht um zwei Optional Instanzen, die unterschiedlich sind. Du hast halt einmal den Bot com.forecast.nlm.entity.bot.Bot@24facb47 und einmal com.forecast.nlm.entity.bot.Bot@6020cd42

Und an welcher Stelle kommt der AssertionFailedError? Das scheint ja nicht Assertions.assertEquals(expectedBot, result.getBody().get()); zu sein, denn expectedBot ist kein Optional<Bot> sondern ein Bot. Da scheint also etwas generell an den bereitgestellten Daten nicht zu stimmen - so ich mich jetzt nicht auf die Schnelle komplett irre. Daher wäre wirklich zu prüfen, was da wo angemeckert wird.

Und zusätzlich:
Was man nicht sieht ist, wie Du botRepository und botService erstellst. Hast Du evtl. ein Problem bei der Initialisierung?
Falls Du da nicht vor jedem Test neue Mocks erstellst, hast Du evtl. ein Problem mit mehreren when(..).thenReturn(...) Anweisungen die sich beeinträchtigen? Aber das ist nur ein wildes gerate auf Grund von fehlenden Informationen.

 

[Raphael_]

Also die Meldung interpretiere ich schon so, dass da zwei unterschiedliche Bot Instanzen sind. Da geht es nicht um zwei Optional Instanzen, die unterschiedlich sind. Du hast halt einmal den Bot com.forecast.nlm.entity.bot.Bot@24facb47 und einmal com.forecast.nlm.entity.bot.Bot@6020cd42

Und an welcher Stelle kommt der AssertionFailedError? Das scheint ja nicht Assertions.assertEquals(expectedBot, result.getBody().get()); zu sein, denn expectedBot ist kein Optional<Bot> sondern ein Bot. Da scheint also etwas generell an den bereitgestellten Daten nicht zu stimmen - so ich mich jetzt nicht auf die Schnelle komplett irre. Daher wäre wirklich zu prüfen, was da wo angemeckert wird.

Und zusätzlich:
Was man nicht sieht ist, wie Du botRepository und botService erstellst. Hast Du evtl. ein Problem bei der Initialisierung?
Falls Du da nicht vor jedem Test neue Mocks erstellst, hast Du evtl. ein Problem mit mehreren when(..).thenReturn(...) Anweisungen die sich beeinträchtigen? Aber das ist nur ein wildes gerate auf Grund von fehlenden Informationen.

Ja, du hast recht. Sorry die Fehlermeldung und der Test haben gerade nicht übereingestimmt. Die Assertion sieht eigentlich so aus:

Assertions.assertEquals(HttpStatus.OK, result.getStatusCode());
Assertions.assertEquals(Optional.of(expectedBot), result.getBody());

 

[KonradN]

Ok, das passt zu der Ausgabe und ist auch ok - Optional überschreibt equals und prüft auch (u.a.) die eingeschlossenen Objekte.

Und damit ist der Test wirklich fehlgeschlagen und wir kommen zu der ursprünglichen Fragestellung, wie Du die benutzten Instanzen initialisiert hast.
Zusätzlich ist die Frage, was buyStock macht. Dein Test impliziert, dass Du dort die Bot Instanz zurück bekommst, die Du im repository gemockt hast. Macht die Methode das wirklich?

Derzeit sehe ich zwei Möglichkeiten:
a) Deine Methode machst Du nicht, was Du prüfst. Dann ist es richtig, dass der Test fehl schlägt und Du solltest klären, was die Methode machen soll um dann zu klären: Was ist falsch? Der Test? Die Implementierung im Service? Beides?
b) Du hast ein Problem mit der Initialisierung.

 

[Raphael_]

Ok, das passt zu der Ausgabe und ist auch ok - Optional überschreibt equals und prüft auch (u.a.) die eingeschlossenen Objekte.

Und damit ist der Test wirklich fehlgeschlagen und wir kommen zu der ursprünglichen Fragestellung, wie Du die benutzten Instanzen initialisiert hast.
Zusätzlich ist die Frage, was buyStock macht. Dein Test impliziert, dass Du dort die Bot Instanz zurück bekommst, die Du im repository gemockt hast. Macht die Methode das wirklich?

Derzeit sehe ich zwei Möglichkeiten:
a) Deine Methode machst Du nicht, was Du prüfst. Dann ist es richtig, dass der Test fehl schlägt und Du solltest klären, was die Methode machen soll um dann zu klären: Was ist falsch? Der Test? Die Implementierung im Service? Beides?
b) Du hast ein Problem mit der Initialisierung.

Die Methode buyStock sieht so aus:

 @Transactional
    public ResponseEntity<Optional<Bot>> buyStock(Long id, BotBuyingRequest request) {

        Optional<Bot> botOptional = botRepository.findById(id);

        if (botOptional.isPresent()) {
            Bot bot = botOptional.get();
            bot.setMoneyLeftToInvest(bot.getMoneyLeftToInvest().subtract(request.getAmount()));

            Stock stock = Stock.builder()
                    .stockType(request.getStockType())
                    .amount(request.getAmount())
                    .bot(bot)
                    .build();

            botRepository.save(bot);
            stockRepository.save(stock);

            return ResponseEntity.ok(Optional.of(bot));
        }
        return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
    }

Es wird ein Stock Objekt erstellt, wo die Informationen, die reinkommen gespeichert werden. Dann wird der Bot, der stockBuy aufruft abgefragt und aus dem Repository geholt, um moneyLeftToInvest neu zu berechnen. Da ich eine Beziehung zwischen Stock und Bot habe stehen dann im Feld Stocks vom Bot die jeweiligen Stocks drinnen. Dann soll sowohl Bot, als auch Stock gespeichert werden und der neu upgedatete Bot returnt werden.

Wie gesagt stimmen die Werte, die zurückkommen mit dem überein, was ich erwarte und wenn ich die werte auch einzeln abfrage dann läuft mein Test auch, allerdings nicht, wenn ich ein komplettes Bot Objekt in ein Optional packe und zurückgebe und das dann vergleiche. Kann auch gut sein, dass das ein komplett normales Verhalten ist, weil ich ja unterschiedliche Instanzen aufrufe. Deshalb war meine Frage ja, wie ich das am besten mache, dass ich nicht alle Felder einzeln überprüfen muss.

 

[KonradN]

Bleibt noch die Frage:

zu der ursprünglichen Fragestellung, wie Du die benutzten Instanzen initialisiert hast.

Du hast da ja jetzt die Methode buyStock auf, aber wie hast Du die Instanz von der Klasse bekommen? Wie hast Du sicher gestellt, dass die Klasse dein Mock von BotRepository nutzt?

Und bei dem Test der Methode wäre doch deutlich mehr zu prüfen:

• Der Bot muss richtig verändert worden sein. (Hier wäre ein Mock eines Bots besser, der prüft, ob setMoneyLeftToInvest korrekt aufgerufen wurde. Die Methode wirst Du ja selbst nicht testen wollen in diesem Unit Test)
• Die save Methode von dem veränderten bot muss aufgerufen werden.
• Die save Methode mit dem erzeugten Stock muss aufgerufen werden - das muss also auch gemockt werden.

Das wäre zumindest mein Ansatz, um diese Methode zu testen.

 

[Raphael_]

Bleibt noch die Frage:

Du hast da ja jetzt die Methode buyStock auf, aber wie hast Du die Instanz von der Klasse bekommen? Wie hast Du sicher gestellt, dass die Klasse dein Mock von BotRepository nutzt?

Und bei dem Test der Methode wäre doch deutlich mehr zu prüfen:

• Der Bot muss richtig verändert worden sein. (Hier wäre ein Mock eines Bots besser, der prüft, ob setMoneyLeftToInvest korrekt aufgerufen wurde. Die Methode wirst Du ja selbst nicht testen wollen in diesem Unit Test)
• Die save Methode von dem veränderten bot muss aufgerufen werden.
• Die save Methode mit dem erzeugten Stock muss aufgerufen werden - das muss also auch gemockt werden.

Das wäre zumindest mein Ansatz, um diese Methode zu testen.

Also so sieht der Methodenkopf meiner Testklasse aus:

@SpringBootTest
@ExtendWith(MockitoExtension.class)
class BotServiceTest {

    @Autowired
    private BotService botService;
    @Mock
    private StockRepository stockRepository;
    @Mock
    private BotRepository botRepository;

Und im BotService ist die buyStock Methode enthalten.



Und zu den Dingen, die du gesagt hast, die auch getestet werden müssen hab ich Integrationtests geschrieben, wo ich eine h2 in memory db für nutze und dort dann überprüfe ob die Berechnungen stimmen und ob die richtigen Stocks und Bots auch wirklich im Repository liegen. Ich kann hier mal einen rein posten. Dabei habe ich übrigens genau das selbe Problem. Ich überprüfe am Ende bei den Tests immer auf die einzelnen Werte, weil ich dort sonst denselben Fehler bekomme.

Das wäre bspw einer:

@Test
   @Transactional
   void buyNewStock_WhenNewStockHasBeenBought_ThenMakeSureBotHasCorrectlyUpdated() {
        List<Stock> stock = new ArrayList<>();
       //arrange
       Stock boughtStock = Stock.builder()
               .stockType(StockType.BTCUSDT)
               .amount(BigDecimal.valueOf(200))
               .build();

       Bot givenBot = Bot.builder()
               .id(1L)
               .name("Test")
               .moneyLeftToInvest(BigDecimal.valueOf(1000))
               .stocks(stock)
               .build();

       botRepository.save(givenBot);


       Bot botThatShouldBeInRepository = Bot.builder()
               .id(givenBot.getId())
               .name("Test")
               .moneyLeftToInvest(BigDecimal.valueOf(100))
               .stocks(List.of(boughtStock))
               .build();

       StockBuyingRequest stockBuyingRequest = new StockBuyingRequest();
       stockBuyingRequest.setStockType(StockType.BTCUSDT);
       stockBuyingRequest.setAmount(BigDecimal.valueOf(900));

       //act
       ResponseEntity<Optional<Bot>> result = botInteractionController.buyNewStock(givenBot.getId(), stockBuyingRequest);

       Long stockId = botRepository.findAll().get(0).getId();
       Stock stockThatShouldBeInRepository = Stock.builder()
               .id(stockId)
               .bot(givenBot)
               .stockType(StockType.BTCUSDT)
               .amount(BigDecimal.valueOf(900))
               .build();

       //assert
       Assertions.assertEquals(HttpStatus.OK, result.getStatusCode());
       Assertions.assertTrue(Objects.requireNonNull(result.getBody()).isPresent());
       Assertions.assertEquals(BigDecimal.valueOf(100), result.getBody().get().getMoneyLeftToInvest());

       //Make sure bot is also updated in botRepository and new stock has been saved
       //Stock
       Optional<Stock> stockInRepository = stockRepository.findById(stockId);
       Assertions.assertTrue(stockInRepository.isPresent());

       Assertions.assertEquals(stockThatShouldBeInRepository.getId(), stockInRepository.get().getId());
       Assertions.assertEquals(stockThatShouldBeInRepository.getBot().getId(), stockInRepository.get().getBot().getId());
       Assertions.assertEquals(stockThatShouldBeInRepository.getStockType(), stockInRepository.get().getStockType());
       Assertions.assertEquals(stockThatShouldBeInRepository.getAmount(), stockInRepository.get().getAmount());

       //Bot
       Optional<Bot> botInRepository = botRepository.findById(givenBot.getId());
       Assertions.assertTrue(botInRepository.isPresent());

       Assertions.assertEquals(botThatShouldBeInRepository.getMoneyLeftToInvest(), botInRepository.get().getMoneyLeftToInvest());
   }

Wie du sehen kannst habe ich auch hier ganz viele Assertions, weil das mit dem vergleichen der Objekte nicht geklappt hat. Das würde ich ja gerne lösen.