2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.mycroft.internal.api;
15 import static org.junit.jupiter.api.Assertions.assertEquals;
17 import java.io.IOException;
18 import java.io.UnsupportedEncodingException;
19 import java.net.InetSocketAddress;
21 import org.eclipse.jdt.annotation.NonNullByDefault;
22 import org.eclipse.jetty.websocket.api.Session;
23 import org.eclipse.jetty.websocket.client.WebSocketClient;
24 import org.junit.jupiter.api.Test;
25 import org.junit.jupiter.api.extension.ExtendWith;
26 import org.mockito.ArgumentCaptor;
27 import org.mockito.ArgumentMatchers;
28 import org.mockito.Mock;
29 import org.mockito.Mockito;
30 import org.mockito.junit.jupiter.MockitoExtension;
31 import org.mockito.junit.jupiter.MockitoSettings;
32 import org.mockito.quality.Strictness;
33 import org.openhab.binding.mycroft.internal.api.dto.BaseMessage;
34 import org.openhab.binding.mycroft.internal.api.dto.MessageSpeak;
37 * This class provides tests for mycroft binding
39 * @author Gwendal Roulleau - Initial contribution
41 @ExtendWith(MockitoExtension.class)
42 @MockitoSettings(strictness = Strictness.LENIENT)
44 public class MycroftConnectionTest {
46 private @Mock @NonNullByDefault({}) MycroftConnectionListener mycroftConnectionListener;
47 private @Mock @NonNullByDefault({}) Session sessionMock;
50 public void testConnectionOK() throws IOException {
52 MycroftConnection mycroftConnection = new MycroftConnection(mycroftConnectionListener, new WebSocketClient());
53 Mockito.when(sessionMock.getRemoteAddress()).thenReturn(new InetSocketAddress(1234));
54 mycroftConnection.onConnect(sessionMock);
56 Mockito.verify(mycroftConnectionListener, Mockito.times(1)).connectionEstablished();
60 public void testAnyListener() throws UnsupportedEncodingException, IOException {
61 MycroftConnection mycroftConnection = new MycroftConnection(mycroftConnectionListener, new WebSocketClient());
63 Mockito.when(sessionMock.getRemoteAddress()).thenReturn(new InetSocketAddress(1234));
64 mycroftConnection.onConnect(sessionMock);
66 @SuppressWarnings("unchecked")
67 MycroftMessageListener<MessageSpeak> mockListener = Mockito.mock(MycroftMessageListener.class);
68 ArgumentCaptor<BaseMessage> argCaptorMessage = ArgumentCaptor.forClass(BaseMessage.class);
70 // given we register any listener
71 mycroftConnection.registerListener(MessageType.any, mockListener);
73 // when we send speak message
74 @SuppressWarnings("null")
75 String speakMessageJson = new String(
76 MycroftConnectionTest.class.getResourceAsStream("speak.json").readAllBytes(), "UTF-8");
77 mycroftConnection.onMessage(sessionMock, speakMessageJson);
79 // then message is correctly received by listener
80 Mockito.verify(mockListener, Mockito.times(1)).baseMessageReceived(ArgumentMatchers.any());
81 Mockito.verify(mockListener).baseMessageReceived(argCaptorMessage.capture());
83 assertEquals(argCaptorMessage.getValue().message, speakMessageJson);
87 public void testSpeakListener() throws IOException {
89 MycroftConnection mycroftConnection = new MycroftConnection(mycroftConnectionListener, new WebSocketClient());
91 Mockito.when(sessionMock.getRemoteAddress()).thenReturn(new InetSocketAddress(1234));
92 mycroftConnection.onConnect(sessionMock);
94 @SuppressWarnings("unchecked")
95 MycroftMessageListener<MessageSpeak> mockListener = Mockito.mock(MycroftMessageListener.class);
96 ArgumentCaptor<MessageSpeak> argCaptorMessage = ArgumentCaptor.forClass(MessageSpeak.class);
98 // given we register speak listener
99 mycroftConnection.registerListener(MessageType.speak, mockListener);
101 // when we send speak message
102 @SuppressWarnings("null")
103 String speakMessageJson = new String(
104 MycroftConnectionTest.class.getResourceAsStream("speak.json").readAllBytes(), "UTF-8");
105 mycroftConnection.onMessage(sessionMock, speakMessageJson);
107 // then message is correctly received by listener
108 Mockito.verify(mockListener).baseMessageReceived(argCaptorMessage.capture());
110 assertEquals(argCaptorMessage.getValue().data.utterance, "coucou");