Как протестировать отправленные сервером события с помощью Spring?

Я реализовал контроллер с методом, возвращающим SseEmitter, и теперь я хочу его протестировать. Единственный способ, который я смог найти до сих пор, заключается в следующем:

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = {SsePaymentReceivedController.class, AutomatBackendContextInitializer.class, EventBusImpl.class})
@WebAppConfiguration
public class SsePaymentReceivedControllerIntegrationTest {

@Inject
WebApplicationContext context;
@Inject
SsePaymentReceivedController sseCoinController;
@Inject
EventBusImpl eventBus;

MockMvc mockMvc;

@Before
public void setUpMockMvc() {
    this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context).build();
}

@Test
public void subscriptionToSseChannelIsFine() throws Exception {
    MvcResult result = mockMvc.perform(get("/sse/payment"))
            .andExpect(status().isOk())
            .andReturn();
    eventBus.fireNotification(new PaymentReceivedNotification("50", Currency.EURO));
    LinkedHashSet<ResponseBodyEmitter.DataWithMediaType> emitters =
            (LinkedHashSet<ResponseBodyEmitter.DataWithMediaType>)Whitebox.getInternalState(((SseEmitter)result.getModelAndView().getModel().get("sseEmitter")), "earlySendAttempts");
    final Iterator<ResponseBodyEmitter.DataWithMediaType> iterator = emitters.iterator();

    ResponseBodyEmitter.DataWithMediaType dataField = iterator.next();
    assertEquals("data:", dataField.getData());

    ResponseBodyEmitter.DataWithMediaType valueField = iterator.next();
    assertEquals("{\"remainingAmount\":\"50\",\"currency\":\"EURO\"}", valueField.getData());

    ResponseBodyEmitter.DataWithMediaType lastField = iterator.next();
    assertEquals("\n\n", lastField.getData());
}
}

Должен быть подход лучше, чем проверка внутренностей возвращенной модели, и я ищу его - есть идеи?


spring server-sent-events mockmvc
person Andras Hatvani    schedule 19.02.2016    source источник

Ответы (3)


arrow_upward
0
arrow_downward

Хорошей идеей может быть использование клиента SSE. Для этого вы можете использовать JAX WS RS Client с Jersey EventSource.

С javax.ws.rs-api 2.0.1 и jersey-media-sse 2.25.1, вот как открыть соединение SSE:

Client client = ClientBuilder
        .newBuilder()
        .register(SseFeature.class)
        .build();

EventSource eventSource = EventSource
        .target(client.target("http://localhost:8080/feed/123456"))
        .reconnectingEvery(1, TimeUnit.SECONDS)
        .build();

EventListener listener = inboundEvent -> {

    log.info("Event received: id -> {}, name -> {}, data -> {}", inboundEvent.getId(),
             inboundEvent.getName(), inboundEvent.readData(String.class));

    // Process events ...
};
eventSource.register(listener);
eventSource.open();

Итак, если вы хотите создать инструменты для тестирования, вы можете написать небольшой вспомогательный класс, подобный этому:

package org.demo.service.sse;

import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;

import org.glassfish.jersey.media.sse.EventListener;
import org.glassfish.jersey.media.sse.EventSource;
import org.glassfish.jersey.media.sse.InboundEvent;
import org.glassfish.jersey.media.sse.SseFeature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SseTestClient {

    private static final Logger log = LoggerFactory.getLogger(SseTestClient.class);

    private final String targetUrl;
    private final List<InboundEvent> receivedEvents = new ArrayList<>();

    private String clientName = "SSE client";
    private EventSource eventSource;
    private int currentEventPos = 0;

    public SseTestClient( String targetUrl ) {

        this.targetUrl = targetUrl;
    }

    public SseTestClient setClientName( String clientName ) {

        this.clientName = clientName;
        return this;
    }

    public SseTestClient connectFeed() {

        log.info("[{}] Initializing EventSource...", clientName);

        // Create SSE client and server

        Client client = ClientBuilder
                .newBuilder()
                .register(SseFeature.class)
                .build();

        eventSource = EventSource
                .target(client.target(targetUrl))
                .reconnectingEvery(300, TimeUnit.SECONDS) // Large number so that any disconnection will break tests
                .build();

        EventListener listener = inboundEvent -> {

            log.info("[{}] Event received: name -> {}, data -> {}",
                     clientName, inboundEvent.getName(), inboundEvent.readData(String.class));

            receivedEvents.add(inboundEvent);
        };
        eventSource.register(listener);
        eventSource.open();

        log.info("[{}] EventSource connection opened", clientName);

        return this;
    }

    public int getTotalEventCount() {

        return receivedEvents.size();
    }

    public int getNewEventCount() {

        return receivedEvents.size() - currentEventPos;
    }

    public boolean hasNewEvent() {

        return currentEventPos < receivedEvents.size();
    }

    public InboundEvent getNextEvent() {

        if (currentEventPos >= receivedEvents.size()) {
            return null;
        }
        InboundEvent currentEvent = receivedEvents.get(currentEventPos);
        ++currentEventPos;
        return currentEvent;
    }

    public SseTestClient closeFeed() {

        if (eventSource != null) {
            eventSource.close();
        }
        return this;
    }
}

Что значительно упрощает написание тестов:

SseTestClient sseClient = new SseTestClient("http://localhost:8080/feed/123456").connectFeed();

Thread.sleep(1000);

assertTrue(sseClient.hasNewEvent());
assertEquals(2, sseClient.getNewEventCount());
// ...

Надеюсь, поможет!

person Hadrien Beaufils    schedule 27.09.2018

arrow_upward
0
arrow_downward

Вы можете использовать WebTestClient в Spring Framework 5.0 или более поздней версии.

person Rossen Stoyanchev    schedule 11.03.2019
comment
Может использоваться только в реактивном веб-стеке ( Spring WebFlux) - person da-sha1; 17.04.2019

arrow_upward
0
arrow_downward

Лучший вариант, который я нашел, — это получить содержимое ответа:

String str1 = result.getResponse().getContentAsString()
// remove data: and \n\n
String str2 = str1.substring(5, str1.length() - 2);
new JsonPathExpectationsHelper("$.remainingAmount").assertValue(str2, "50");
new JsonPathExpectationsHelper("$.currency").assertValue(str2, "EURO");
person Bax    schedule 18.03.2016