untaggedNodes = nodeDAO.deleteTag(tagData);
+ untaggedNodes.forEach(n -> webSocketHandler.sendMessage(new SaveAndRestoreWebSocketMessage(MessageType.NODE_UPDATED, n)));
+ return untaggedNodes;
}
}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocket.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocket.java
new file mode 100644
index 0000000000..4d1458aaf0
--- /dev/null
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocket.java
@@ -0,0 +1,173 @@
+/*******************************************************************************
+ * Copyright (c) 2019-2022 UT-Battelle, LLC.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the LICENSE
+ * which accompanies this distribution
+ ******************************************************************************/
+package org.phoebus.service.saveandrestore.websocket;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.springframework.web.socket.TextMessage;
+import org.springframework.web.socket.WebSocketSession;
+
+import java.util.concurrent.ArrayBlockingQueue;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Utility class for handling web socket messages. In the context of the save-and-restore service,
+ * only messages from server are expected. Client messages are logged, but do not invoke any behavior.
+ */
+@SuppressWarnings("nls")
+public class WebSocket {
+
+ /**
+ * Is the queue full?
+ */
+ private final AtomicBoolean stuffed = new AtomicBoolean();
+
+ /**
+ * Queue of messages for the client.
+ *
+ * Multiple threads concurrently writing to the socket results in
+ * IllegalStateException "remote endpoint was in state [TEXT_FULL_WRITING]"
+ * All writes are thus performed by just one thread off this queue.
+ */
+ private final ArrayBlockingQueue writeQueue = new ArrayBlockingQueue<>(2048);
+
+ private static final String EXIT_MESSAGE = "EXIT";
+
+ private final WebSocketSession session;
+ private final String id;
+
+ private final Logger logger = Logger.getLogger(WebSocket.class.getName());
+
+ private final ObjectMapper objectMapper;
+
+ /**
+ * Constructor
+ */
+ public WebSocket(ObjectMapper objectMapper, WebSocketSession webSocketSession) {
+ this.session = webSocketSession;
+ logger.log(Level.INFO, () -> "Creating web socket " + session.getUri() + " ID " + session.getId());
+ this.objectMapper = objectMapper;
+ this.id = webSocketSession.getId();
+ Thread writeThread = new Thread(this::writeQueuedMessages, "Web Socket Write Thread");
+ writeThread.setName("Web Socket Write Thread " + this.id);
+ writeThread.setDaemon(true);
+ writeThread.start();
+ }
+
+ /**
+ * @return Session ID
+ */
+ public String getId() {
+ if (session == null)
+ return "(" + id + ")";
+ else
+ return id;
+ }
+
+ /**
+ * @param message Potentially long message
+ * @return Message shorted to 200 chars
+ */
+ private String shorten(final String message) {
+ if (message == null || message.length() < 200)
+ return message;
+ return message.substring(0, 200) + " ...";
+ }
+
+ public void queueMessage(final String message) {
+ // Ignore messages after 'dispose'
+ if (session == null)
+ return;
+
+ if (writeQueue.offer(message)) { // Queued OK. Is this a recovery from stuffed queue?
+ if (stuffed.getAndSet(false))
+ logger.log(Level.WARNING, () -> "Un-stuffed message queue for " + id);
+ } else { // Log, but only for the first message to prevent flooding the log
+ if (!stuffed.getAndSet(true))
+ logger.log(Level.WARNING, () -> "Cannot queue message '" + shorten(message) + "' for " + id);
+ }
+ }
+
+ private void writeQueuedMessages() {
+ try {
+ while (true) {
+ final String message;
+ try {
+ message = writeQueue.take();
+ } catch (final InterruptedException ex) {
+ return;
+ }
+
+ // Check if we should exit the thread
+ if (message.equals(EXIT_MESSAGE)) {
+ logger.log(Level.FINE, () -> "Exiting write thread " + id);
+ return;
+ }
+
+ final WebSocketSession safeSession = session;
+ try {
+ if (safeSession == null)
+ throw new Exception("No session");
+ if (!safeSession.isOpen())
+ throw new Exception("Session closed");
+ safeSession.sendMessage(new TextMessage(message));
+ } catch (final Exception ex) {
+ logger.log(Level.WARNING, ex, () -> "Cannot write '" + shorten(message) + "' for " + id);
+
+ // Clear queue
+ String drop = writeQueue.take();
+ while (drop != null) {
+ if (drop.equals(EXIT_MESSAGE)) {
+ logger.log(Level.FINE, () -> "Exiting write thread " + id);
+ return;
+ }
+ drop = writeQueue.take();
+ }
+ }
+ }
+ } catch (Throwable ex) {
+ logger.log(Level.WARNING, "Write thread error for " + id, ex);
+ }
+ }
+
+ /**
+ * Called when client sends a general message
+ *
+ * @param message {@link TextMessage}, its payload is expected to be JSON.
+ */
+ public void handleTextMessage(TextMessage message) throws Exception {
+ final JsonNode json = objectMapper.readTree(message.getPayload());
+ final JsonNode node = json.path("type");
+ if (node.isMissingNode())
+ throw new Exception("Missing 'type' in " + shorten(message.getPayload()));
+ final String type = node.asText();
+ logger.log(Level.INFO, "Client message type: " + type);
+ }
+
+ /**
+ * Clears all PVs
+ *
+ * Web socket calls this onClose(),
+ * but context may also call this again just in case
+ */
+ public void dispose() {
+ // Exit write thread
+ try {
+ // Drop queued messages (which might be stuffed):
+ // We're closing and just need the EXIT_MESSAGE
+ writeQueue.clear();
+ queueMessage(EXIT_MESSAGE);
+ // TODO: is this needed?
+ session.close();
+ } catch (Throwable ex) {
+ logger.log(Level.WARNING, "Error disposing " + getId(), ex);
+ }
+ logger.log(Level.INFO, () -> "Web socket " + session.getId() + " closed");
+ }
+}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocketConfig.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocketConfig.java
new file mode 100644
index 0000000000..f0e89df46d
--- /dev/null
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocketConfig.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2023 European Spallation Source ERIC.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ */
+package org.phoebus.service.saveandrestore.websocket;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.socket.config.annotation.EnableWebSocket;
+import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
+import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
+
+import java.util.List;
+import java.util.logging.Logger;
+
+@SuppressWarnings("unused")
+@Configuration
+@EnableWebSocket
+public class WebSocketConfig implements WebSocketConfigurer {
+
+ @Autowired
+ public ObjectMapper objectMapper;
+
+ @Autowired
+ private List sockets;
+
+ @Autowired
+ private WebSocketHandler webSocketHandler;
+
+ private final Logger logger = Logger.getLogger(WebSocketConfig.class.getName());
+
+ @Override
+ public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
+ registry.addHandler(webSocketHandler, "/web-socket");
+ }
+}
diff --git a/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocketHandler.java b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocketHandler.java
new file mode 100644
index 0000000000..2bcb98a0da
--- /dev/null
+++ b/services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/websocket/WebSocketHandler.java
@@ -0,0 +1,173 @@
+/*
+ * Copyright (C) 2023 European Spallation Source ERIC.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ */
+
+package org.phoebus.service.saveandrestore.websocket;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.lang.NonNull;
+import org.springframework.stereotype.Component;
+import org.springframework.web.socket.CloseStatus;
+import org.springframework.web.socket.PongMessage;
+import org.springframework.web.socket.TextMessage;
+import org.springframework.web.socket.WebSocketSession;
+import org.springframework.web.socket.handler.TextWebSocketHandler;
+
+import javax.annotation.PreDestroy;
+import java.io.EOFException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+/**
+ * Single web socket end-point routing messages to active {@link WebSocket} instances.
+ */
+@Component
+public class WebSocketHandler extends TextWebSocketHandler {
+
+ /**
+ * List of active {@link WebSocket}
+ */
+ @SuppressWarnings("unused")
+ private List sockets = new ArrayList<>();
+
+ @SuppressWarnings("unused")
+ @Autowired
+ private ObjectMapper objectMapper;
+
+ @SuppressWarnings("unused")
+
+ private final Logger logger = Logger.getLogger(WebSocketHandler.class.getName());
+
+ /**
+ * Handles text message from web socket client
+ *
+ * @param session The {@link WebSocketSession} associated with the remote client.
+ * @param message Message sent by client
+ */
+ @Override
+ public void handleTextMessage(@NonNull WebSocketSession session, @NonNull TextMessage message) {
+ try {
+ // Find the WebSocket instance associated with the WebSocketSession
+ Optional webSocketOptional =
+ sockets.stream().filter(webSocket -> webSocket.getId().equals(session.getId())).findFirst();
+ if (webSocketOptional.isEmpty()) {
+ return; // Should only happen in case of timing issues?
+ }
+ webSocketOptional.get().handleTextMessage(message);
+ } catch (final Exception ex) {
+ logger.log(Level.WARNING, ex, () -> "Error for message " + shorten(message.getPayload()));
+ }
+ }
+
+ /**
+ * Called when client connects.
+ *
+ * @param session Associated {@link WebSocketSession}
+ */
+ @Override
+ public void afterConnectionEstablished(@NonNull WebSocketSession session) {
+ logger.log(Level.INFO, "Opening web socket session from remote " + session.getRemoteAddress().getAddress());
+ WebSocket webSocket = new WebSocket(objectMapper, session);
+ sockets.add(webSocket);
+ }
+
+ /**
+ * Called when web socket is closed. Depending on the web browser, {@link #handleTransportError(WebSocketSession, Throwable)}
+ * may be called first.
+ *
+ * @param session Associated {@link WebSocketSession}
+ * @param status See {@link CloseStatus}
+ */
+ @Override
+ public void afterConnectionClosed(@NonNull WebSocketSession session, @NonNull CloseStatus status) {
+ Optional webSocketOptional =
+ sockets.stream().filter(webSocket -> webSocket.getId().equals(session.getId())).findFirst();
+ if (webSocketOptional.isPresent()) {
+ logger.log(Level.INFO, "Closing web socket session from remote " + session.getRemoteAddress().getAddress());
+ webSocketOptional.get().dispose();
+ sockets.remove(webSocketOptional.get());
+ }
+ }
+
+ /**
+ * Depending on the web browser, this is called before {@link #afterConnectionClosed(WebSocketSession, CloseStatus)}
+ * when tab or browser is closes.
+ *
+ * @param session Associated {@link WebSocketSession}
+ * @param ex {@link Throwable} that should indicate reason
+ */
+ @Override
+ public void handleTransportError(@NonNull WebSocketSession session, @NonNull Throwable ex) {
+ if (ex instanceof EOFException)
+ logger.log(Level.FINE, "Web Socket closed", ex);
+ else
+ logger.log(Level.WARNING, "Web Socket error", ex);
+ }
+
+ /**
+ * Called when client sends ping message, i.e. a pong message is sent and time for last message
+ * in the {@link WebSocket} instance is refreshed.
+ *
+ * @param session Associated {@link WebSocketSession}
+ * @param message See {@link PongMessage}
+ */
+ @Override
+ protected void handlePongMessage(@NonNull WebSocketSession session, @NonNull PongMessage message) {
+ logger.log(Level.INFO, "Got pong");
+ // Find the WebSocket instance associated with this WebSocketSession
+ Optional webSocketOptional =
+ sockets.stream().filter(webSocket -> webSocket.getId().equals(session.getId())).findFirst();
+ if (webSocketOptional.isEmpty()) {
+ return; // Should only happen in case of timing issues?
+ }
+ }
+
+ /**
+ * @param message Potentially long message
+ * @return Message shorted to 200 chars
+ */
+ private String shorten(final String message) {
+ if (message == null || message.length() < 200)
+ return message;
+ return message.substring(0, 200) + " ...";
+ }
+
+ @PreDestroy
+ public void cleanup() {
+ sockets.forEach(s -> {
+ logger.log(Level.INFO, "Disposing socket " + s.getId());
+ s.dispose();
+ });
+ }
+
+ public void sendMessage(SaveAndRestoreWebSocketMessage webSocketMessage) {
+ sockets.forEach(ws -> {
+ try {
+ ws.queueMessage(objectMapper.writeValueAsString(webSocketMessage));
+ } catch (JsonProcessingException e) {
+ throw new RuntimeException(e);
+ }
+ });
+ }
+}
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/persistence/dao/impl/DAOTestIT.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/persistence/dao/impl/DAOTestIT.java
index c16a335dcd..63a21f75d9 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/persistence/dao/impl/DAOTestIT.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/persistence/dao/impl/DAOTestIT.java
@@ -22,18 +22,35 @@
import co.elastic.clients.elasticsearch.indices.DeleteIndexRequest;
import co.elastic.clients.elasticsearch.indices.ExistsRequest;
import co.elastic.clients.transport.endpoints.BooleanResponse;
-import org.epics.vtype.*;
+import org.epics.vtype.Alarm;
+import org.epics.vtype.AlarmSeverity;
+import org.epics.vtype.AlarmStatus;
+import org.epics.vtype.Display;
+import org.epics.vtype.Time;
+import org.epics.vtype.VDouble;
+import org.epics.vtype.VInt;
import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestInstance;
import org.junit.jupiter.api.TestInstance.Lifecycle;
-import org.phoebus.applications.saveandrestore.model.*;
+import org.phoebus.applications.saveandrestore.model.CompositeSnapshot;
+import org.phoebus.applications.saveandrestore.model.CompositeSnapshotData;
+import org.phoebus.applications.saveandrestore.model.ConfigPv;
+import org.phoebus.applications.saveandrestore.model.Configuration;
+import org.phoebus.applications.saveandrestore.model.ConfigurationData;
+import org.phoebus.applications.saveandrestore.model.Node;
+import org.phoebus.applications.saveandrestore.model.NodeType;
+import org.phoebus.applications.saveandrestore.model.Snapshot;
+import org.phoebus.applications.saveandrestore.model.SnapshotData;
+import org.phoebus.applications.saveandrestore.model.SnapshotItem;
+import org.phoebus.applications.saveandrestore.model.Tag;
+import org.phoebus.applications.saveandrestore.model.TagData;
import org.phoebus.applications.saveandrestore.model.search.Filter;
import org.phoebus.applications.saveandrestore.model.search.SearchResult;
import org.phoebus.service.saveandrestore.NodeNotFoundException;
import org.phoebus.service.saveandrestore.persistence.config.ElasticConfig;
-import org.phoebus.service.saveandrestore.persistence.dao.impl.elasticsearch.ConfigurationDataRepository;
import org.phoebus.service.saveandrestore.persistence.dao.impl.elasticsearch.ElasticsearchDAO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
@@ -46,9 +63,20 @@
import java.io.IOException;
import java.time.Instant;
-import java.util.*;
-
-import static org.junit.jupiter.api.Assertions.*;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Date;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
/**
* Integration test to be executed against a running Elasticsearch 8.x instance.
@@ -56,7 +84,7 @@
*/
@TestInstance(Lifecycle.PER_CLASS)
@SpringBootTest
-@ContextConfiguration(classes = ElasticConfig.class)
+@ContextConfiguration(classes = {ElasticConfig.class})
@TestPropertySource(locations = "classpath:test_application.properties")
@Profile("IT")
@SuppressWarnings("unused")
@@ -65,9 +93,6 @@ public class DAOTestIT {
@Autowired
private ElasticsearchDAO nodeDAO;
- @Autowired
- private ConfigurationDataRepository configurationDataRepository;
-
@Autowired
private ElasticsearchClient client;
@@ -89,6 +114,13 @@ public void init() {
time = Time.of(Instant.now());
alarm = Alarm.of(AlarmSeverity.NONE, AlarmStatus.NONE, "name");
display = Display.none();
+ clearAllData();
+ System.out.println();
+ }
+
+ @AfterEach
+ public void cleanUp(){
+ clearAllData();
}
@Test
@@ -102,8 +134,6 @@ public void testNewNode() {
assertEquals(NodeType.FOLDER, newNode.getNodeType());
// Check that the parent folder's last modified date is updated
assertTrue(root.getLastModified().getTime() > lastModified.getTime());
-
- clearAllData();
}
@Test
@@ -116,8 +146,6 @@ public void testNewFolderNoDuplicateName() {
assertNotNull(nodeDAO.createNode(rootNode.getUniqueId(), folder1));
// Try to create a new folder with a different name in the same parent directory
assertNotNull(nodeDAO.createNode(rootNode.getUniqueId(), folder2));
-
- clearAllData();
}
@Test
@@ -166,8 +194,6 @@ public void testDeleteConfigurationAndPvs() {
// This should not throw exception
nodeDAO.createNode(topLevelFolderNode.getUniqueId(), config);
-
- clearAllData();
}
@@ -215,7 +241,6 @@ public void testGetNodeAsConfig() {
Node configFromDB = nodeDAO.getNode(newConfig.getUniqueId());
assertEquals(newConfig.getUniqueId(), configFromDB.getUniqueId());
- clearAllData();
}
@Test
@@ -252,7 +277,6 @@ public void testGetConfigForSnapshot() {
assertNotNull(config);
- clearAllData();
}
@Test
@@ -297,8 +321,6 @@ public void testDeleteSnapshotReferencedInCompositeSnapshot() {
assertThrows(RuntimeException.class, () -> nodeDAO.deleteNode(snapshotNode.getUniqueId()));
nodeDAO.deleteNode(compositeSnapshot.getCompositeSnapshotNode().getUniqueId());
-
- clearAllData();
}
@Test
@@ -380,7 +402,6 @@ public void testUpdateCompositeSnapshot() {
nodeDAO.deleteNode(compositeSnapshot.getCompositeSnapshotNode().getUniqueId());
- clearAllData();
}
@Test
@@ -434,8 +455,6 @@ public void testGetAllCompositeSnapshotData() {
compositeSnapshotNodeIds.forEach(id -> nodeDAO.deleteNode(id));
- clearAllData();
-
}
@Test
@@ -486,7 +505,6 @@ public void testTakeSnapshot() {
snapshots = nodeDAO.getSnapshots(config.getUniqueId());
assertTrue(snapshots.isEmpty());
- clearAllData();
}
@Test
@@ -544,7 +562,6 @@ public void testUpdateSnapshot() {
assertEquals("other snapshot name", snapshotNode.getName());
assertEquals("other comment", snapshotNode.getDescription());
- clearAllData();
}
@Test
@@ -603,7 +620,6 @@ public void testGetSnapshotItemsWithNullPvValues() {
assertNull(snapshot1.getSnapshotData().getSnapshotItems());
- clearAllData();
}
@Test
@@ -679,7 +695,6 @@ public void testSnapshotTag() {
tagList2 = n2.getTags();
assertFalse(tagList2.stream().anyMatch(t -> t.getName().equals(newTag.getName())));
- clearAllData();
}
@Test
@@ -701,7 +716,6 @@ public void testGetChildNodes() {
List childNodes = nodeDAO.getChildNodes(rootNode.getUniqueId());
assertTrue(nodeDAO.getChildNodes(folder1.getUniqueId()).isEmpty());
- clearAllData();
}
@Test
@@ -722,7 +736,6 @@ public void testUpdateNode() {
assertEquals("folderB", folderA.getName());
assertEquals(uniqueId, folderA.getUniqueId());
- clearAllData();
}
@@ -824,8 +837,6 @@ public void testUpdateNodeType() {
Node node = folderNode;
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.updateNode(node, false));
-
- clearAllData();
}
@@ -842,7 +853,6 @@ public void testNoNameClash1() {
Node n2 = Node.builder().nodeType(NodeType.CONFIGURATION).uniqueId("2").name("n1").build();
nodeDAO.createNode(topLevelFolderNode.getUniqueId(), n2);
- clearAllData();
}
@Test
@@ -854,8 +864,6 @@ public void testNoNameClash() {
nodeDAO.createNode(rootNode.getUniqueId(), n1);
Node n2 = Node.builder().uniqueId("2").name("n2").build();
nodeDAO.createNode(rootNode.getUniqueId(), n2);
-
- clearAllData();
}
@Test
@@ -877,7 +885,6 @@ public void testUpdateNodeNewNameInvalid() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.updateNode(node, false));
- clearAllData();
}
@Test
@@ -886,7 +893,6 @@ public void testCreateNodeWithNonNullUniqueId() {
Node folder = Node.builder().name("Folder").nodeType(NodeType.FOLDER).uniqueId("uniqueid").build();
folder = nodeDAO.createNode(rootNode.getUniqueId(), folder);
assertEquals("uniqueid", folder.getUniqueId());
- clearAllData();
}
@Test
@@ -914,8 +920,6 @@ public void testCreateFolderInConfigNode() {
Node node = configNode;
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.createNode(node.getUniqueId(), folderNode));
-
- clearAllData();
}
@Test
@@ -936,8 +940,6 @@ public void testCreateConfigInConfigNode() {
Node node = configNode;
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.createNode(node.getUniqueId(), node));
-
- clearAllData();
}
@Test
@@ -971,8 +973,6 @@ public void testCreateNameClash() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.createNode(rootNode.getUniqueId(), anotherConfig));
-
- clearAllData();
}
@Test
@@ -1008,8 +1008,6 @@ public void testFindParentFromPathElements() {
found = nodeDAO.findParentFromPathElements(rootNode, "/a/d/c".split("/"), 1);
assertNull(found);
-
- clearAllData();
}
@Test
@@ -1022,8 +1020,6 @@ public void testGetFromPathTwoNodes() {
List nodes = nodeDAO.getFromPath("/a/b/c");
assertEquals(2, nodes.size());
-
- clearAllData();
}
@Test
@@ -1044,8 +1040,6 @@ public void testGetFromPathOneNode() {
nodes = nodeDAO.getFromPath("/a");
assertEquals(1, nodes.size());
assertEquals(a.getUniqueId(), nodes.get(0).getUniqueId());
-
- clearAllData();
}
@Test
@@ -1060,8 +1054,6 @@ public void testGetFromPathZeroNodes() {
nodes = nodeDAO.getFromPath("/a/x/c");
assertNull(nodes);
-
- clearAllData();
}
@Test
@@ -1091,8 +1083,6 @@ public void testGetFullPathNonExistingNode() {
// This will throw NodeNotFoundException
assertThrows(NodeNotFoundException.class,
() -> nodeDAO.getFullPath("nonExisting"));
-
- clearAllData();
}
@Test
@@ -1103,8 +1093,6 @@ public void testGetFullPathRootNode() {
nodeDAO.createNode(b.getUniqueId(), Node.builder().nodeType(NodeType.FOLDER).name("c").build());
assertEquals("/", nodeDAO.getFullPath(rootNode.getUniqueId()));
-
- clearAllData();
}
@Test
@@ -1115,8 +1103,6 @@ public void testGetFullPath() {
Node c = nodeDAO.createNode(b.getUniqueId(), Node.builder().nodeType(NodeType.FOLDER).name("c").build());
assertEquals("/a/b/c", nodeDAO.getFullPath(c.getUniqueId()));
-
- clearAllData();
}
@Test
@@ -1137,8 +1123,6 @@ public void testMoveNodesInvalidId() {
assertThrows(NodeNotFoundException.class,
() -> nodeDAO.moveNodes(nodeIds, rootNode.getUniqueId(), "userName"));
-
- clearAllData();
}
@Test
@@ -1167,8 +1151,6 @@ public void testMoveConfiguration() {
assertEquals(1, nodeDAO.getChildNodes(topLevelFolderNode2.getUniqueId()).size());
assertEquals(0, nodeDAO.getChildNodes(topLevelFolderNode.getUniqueId()).size());
-
- clearAllData();
}
@Test
@@ -1197,8 +1179,6 @@ public void testMoveConfigurationNameClash() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.moveNodes(List.of(_configNode.getUniqueId()), topLevelFolderNode2.getUniqueId(), "user"));
-
- clearAllData();
}
@Test
@@ -1222,8 +1202,6 @@ public void testMoveSnasphotToRoot() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.moveNodes(List.of(uniqueId), rootNode.getUniqueId(),
"user"));
-
- clearAllData();
}
@Test
@@ -1247,8 +1225,6 @@ public void testMoveSnasphotToConfiguration() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.moveNodes(List.of(uniqueId), rootNode.getUniqueId(),
"user"));
-
- clearAllData();
}
@Test
@@ -1285,8 +1261,6 @@ public void testMoveNodes() {
// After move parent of source nodes should now have only one element
assertEquals(1, nodeDAO.getChildNodes(folderNode.getUniqueId()).size());
-
- clearAllData();
}
@Test
@@ -1301,8 +1275,6 @@ public void testCopyFolderToSameParent() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.copyNodes(List.of(uniqueId), rootNode.getUniqueId(),
"username"));
-
- clearAllData();
}
@Test
@@ -1320,8 +1292,6 @@ public void testCopyConfigToSameParent() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.copyNodes(List.of(uniqueId), rootNode.getUniqueId(),
"username"));
-
- clearAllData();
}
@Test
@@ -1342,8 +1312,6 @@ public void testCopyFolderNotSupported() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.copyNodes(List.of(_childFolderNode.getUniqueId()), rootNode.getUniqueId(), "username"));
-
- clearAllData();
}
@Test
@@ -1375,8 +1343,6 @@ public void testCopyConfigToOtherParent() {
List childNodes = nodeDAO.getChildNodes(rootNode.getUniqueId());
assertEquals(2, childNodes.size());
-
- clearAllData();
}
@Test
@@ -1403,8 +1369,6 @@ public void testCopyMultipleFolders() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.copyNodes(Arrays.asList(f1, f2), rootNode.getUniqueId(), "username"));
-
- clearAllData();
}
@Test
@@ -1431,8 +1395,6 @@ public void testCopyFolderAndConfig() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.copyNodes(Arrays.asList(folderUniqueId,
configUniqueId), rootNode.getUniqueId(), "username"));
-
- clearAllData();
}
@Test
@@ -1474,8 +1436,6 @@ public void testCopySnapshotToFolderNotSupported() {
String uniqueId = folderNode1.getUniqueId();
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.copyNodes(List.of(snapshotId), uniqueId, "username"));
-
- clearAllData();
}
@Test
@@ -1516,12 +1476,10 @@ public void testCopySnapshotToConfiguration() {
String snapshotId = snapshot.getSnapshotNode().getUniqueId();
- Node updatedConfigNode =
+ List newNodes =
nodeDAO.copyNodes(List.of(snapshotId), configuration2.getConfigurationNode().getUniqueId(), "useername");
- assertEquals(1, nodeDAO.getChildNodes(updatedConfigNode.getUniqueId()).size());
-
- clearAllData();
+ assertEquals(1, newNodes.size());
}
@Test
@@ -1567,8 +1525,6 @@ public void testCopySnapshotToConfigurationPvListMismatch() {
assertThrows(IllegalArgumentException.class,
() -> nodeDAO.copyNodes(List.of(snapshotId), config2Id, "userName"));
-
- clearAllData();
}
@Test
@@ -1617,18 +1573,17 @@ public void testCopyCompositeSnapshot() {
String compositeSnapshotId = compositeSnapshot.getCompositeSnapshotNode().getUniqueId();
- folderNode1 = nodeDAO.copyNodes(List.of(compositeSnapshotId), folderNode1.getUniqueId(), "user");
+ List newNodes = nodeDAO.copyNodes(List.of(compositeSnapshotId), folderNode1.getUniqueId(), "user");
List childNodes = nodeDAO.getChildNodes(folderNode1.getUniqueId());
+ assertEquals(1, newNodes.size());
assertEquals(1, childNodes.size());
// Make sure referenced nodes have been copied to copied composite snapshot
assertEquals(1, nodeDAO.getCompositeSnapshotData(childNodes.get(0).getUniqueId()).getReferencedSnapshotNodes().size());
nodeDAO.deleteNode(childNodes.get(0).getUniqueId());
nodeDAO.deleteNode(compositeSnapshot.getCompositeSnapshotNode().getUniqueId());
-
- clearAllData();
}
@Test
@@ -1692,8 +1647,6 @@ public void testCopyCompositeSnapshotToConfiguration() {
() -> nodeDAO.copyNodes(List.of(compositeSnapshotId), config2Id, "user"));
nodeDAO.deleteNode(compositeSnapshot.getCompositeSnapshotNode().getUniqueId());
-
- clearAllData();
}
@Test
@@ -1769,8 +1722,6 @@ public void testIsContainedInSubTree() {
assertFalse(nodeDAO.isContainedInSubtree(L2F2.getUniqueId(), rootNode.getUniqueId()));
assertFalse(nodeDAO.isContainedInSubtree(L1F1.getUniqueId(), L1F1.getUniqueId()));
assertFalse(nodeDAO.isContainedInSubtree(L2F1.getUniqueId(), L1F1.getUniqueId()));
-
- clearAllData();
}
@Test
@@ -1812,8 +1763,6 @@ public void testGetAllTags() {
List tags = nodeDAO.getAllTags();
assertEquals(4, tags.size());
-
- clearAllData();
}
@Test
@@ -1853,8 +1802,6 @@ public void testGetAllSnapshots() {
List snapshotNodes = nodeDAO.getAllSnapshots();
assertEquals(1, snapshotNodes.size());
-
- clearAllData();
}
@Test
@@ -1872,8 +1819,6 @@ public void testGetAllNodes() {
List nodes = nodeDAO.getNodes(Arrays.asList(folderNode1.getUniqueId(), folderNode2.getUniqueId()));
assertEquals(2, nodes.size());
-
- clearAllData();
}
/**
@@ -1883,7 +1828,6 @@ private void clearAllData() {
List childNodes = nodeDAO.getChildNodes(Node.ROOT_FOLDER_UNIQUE_ID);
childNodes.forEach(node -> nodeDAO.deleteNode(node.getUniqueId()));
nodeDAO.deleteAllFilters();
-
}
@@ -2030,8 +1974,6 @@ public void testCheckForPVNameDuplicates() {
assertEquals("pv1", duplicates.get(0));
nodeDAO.deleteNode(compositeSnapshotNode.getUniqueId());
-
- clearAllData();
}
@Test
@@ -2116,8 +2058,6 @@ public void testCheckForRejectedReferencedNodesInCompositeSnapshot() {
compositeSnapshot.setCompositeSnapshotData(compositeSnapshotData);
assertFalse(nodeDAO.checkCompositeSnapshotReferencedNodeTypes(compositeSnapshot));
-
- clearAllData();
}
@Test
@@ -2200,8 +2140,6 @@ public void testGetSnapshotItemsFromCompositeSnapshot() {
assertEquals(4, snapshotItems.size());
nodeDAO.deleteNode(compositeSnapshotNode.getUniqueId());
-
- clearAllData();
}
@Test
@@ -2254,12 +2192,10 @@ public void testFilters() {
unformattedQueryStringFilter = nodeDAO.saveFilter(unformattedQueryStringFilter);
assertTrue(unformattedQueryStringFilter.getQueryString().contains("type=Folder,Configuration"));
assertFalse(unformattedQueryStringFilter.getQueryString().contains("unsupoorted"));
-
- clearAllData();
}
@Test
- public void testSearchForPvs() {
+ public void testSearchForPvs() {
Node rootNode = nodeDAO.getRootNode();
Node folderNode =
Node.builder().name("folder").build();
@@ -2316,8 +2252,5 @@ public void testSearchForPvs() {
searchResult = nodeDAO.search(searchParameters);
// No pvs specified -> find all nodes.
assertEquals(4, searchResult.getHitCount());
-
- clearAllData();
-
}
}
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/ControllersTestConfig.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/ControllersTestConfig.java
index 588f8c2c9a..fa8b973151 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/ControllersTestConfig.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/config/ControllersTestConfig.java
@@ -27,6 +27,7 @@
import org.phoebus.service.saveandrestore.persistence.dao.impl.elasticsearch.FilterRepository;
import org.phoebus.service.saveandrestore.persistence.dao.impl.elasticsearch.SnapshotDataRepository;
import org.phoebus.service.saveandrestore.search.SearchUtil;
+import org.phoebus.service.saveandrestore.websocket.WebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.context.annotation.Bean;
@@ -34,6 +35,7 @@
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.Profile;
import org.springframework.util.Base64Utils;
+import org.springframework.web.socket.WebSocketSession;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
@@ -129,4 +131,15 @@ public ExecutorService executorService() {
public SnapshotUtil snapshotUtil() {
return new SnapshotUtil();
}
+
+ @Bean
+ public WebSocketSession webSocketSession(){
+ return Mockito.mock(WebSocketSession.class);
+ }
+
+ @Bean
+ public WebSocketHandler webSocketHandler(){
+ return Mockito.mock(WebSocketHandler.class);
+ }
+
}
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/CompositeSnapshotControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/CompositeSnapshotControllerTest.java
index 8d4162cf24..1eb9fdfd21 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/CompositeSnapshotControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/CompositeSnapshotControllerTest.java
@@ -21,6 +21,8 @@
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
@@ -30,8 +32,10 @@
import org.phoebus.applications.saveandrestore.model.Node;
import org.phoebus.applications.saveandrestore.model.NodeType;
import org.phoebus.applications.saveandrestore.model.SnapshotItem;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
+import org.phoebus.service.saveandrestore.websocket.WebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
@@ -45,6 +49,8 @@
import java.util.List;
import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.phoebus.service.saveandrestore.web.controllers.BaseController.JSON;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
@@ -77,6 +83,9 @@ public class CompositeSnapshotControllerTest {
@Autowired
private MockMvc mockMvc;
+ @Autowired
+ private WebSocketHandler webSocketHandler;
+
private final ObjectMapper objectMapper = new ObjectMapper();
private static CompositeSnapshot compositeSnapshot;
@@ -91,8 +100,13 @@ public static void init() {
compositeSnapshot.setCompositeSnapshotData(compositeSnapshotData);
}
+ @AfterEach
+ public void resetMocks(){
+ reset(nodeDAO, webSocketHandler);
+ }
+
@Test
- public void testCreateCompositeSnapshot() throws Exception {
+ public void testCreateCompositeSnapshot1() throws Exception {
when(nodeDAO.createCompositeSnapshot(Mockito.any(String.class), Mockito.any(CompositeSnapshot.class))).thenReturn(compositeSnapshot);
@@ -110,27 +124,54 @@ public void testCreateCompositeSnapshot() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(s, CompositeSnapshot.class);
- request = put("/composite-snapshot?parentNodeId=id")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateCompositeSnapshot2() throws Exception {
+
+ when(nodeDAO.createCompositeSnapshot(Mockito.any(String.class), Mockito.any(CompositeSnapshot.class))).thenReturn(compositeSnapshot);
+
+ String compositeSnapshotString = objectMapper.writeValueAsString(compositeSnapshot);
+
+ MockHttpServletRequestBuilder request = put("/composite-snapshot?parentNodeId=id")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
.content(compositeSnapshotString);
mockMvc.perform(request).andExpect(status().isOk());
- request = put("/composite-snapshot?parentNodeId=id")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateCompositeSnapshot3() throws Exception {
+
+ String compositeSnapshotString = objectMapper.writeValueAsString(compositeSnapshot);
+
+ MockHttpServletRequestBuilder request = put("/composite-snapshot?parentNodeId=id")
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
.contentType(JSON)
.content(compositeSnapshotString);
mockMvc.perform(request).andExpect(status().isForbidden());
- request = put("/composite-snapshot?parentNodeId=id")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateCompositeSnapshot4() throws Exception {
+
+ String compositeSnapshotString = objectMapper.writeValueAsString(compositeSnapshot);
+
+ MockHttpServletRequestBuilder request = put("/composite-snapshot?parentNodeId=id")
.contentType(JSON)
.content(compositeSnapshotString);
mockMvc.perform(request).andExpect(status().isUnauthorized());
- reset(nodeDAO);
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
}
@Test
@@ -144,10 +185,12 @@ public void testCreateCompositeSnapshotWrongNodeType() throws Exception{
.contentType(JSON)
.content(objectMapper.writeValueAsString(compositeSnapshot1));
mockMvc.perform(request).andExpect(status().isBadRequest());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
- public void testUpdateCompositeSnapshot() throws Exception {
+ public void testUpdateCompositeSnapshot1() throws Exception {
Node node = Node.builder().uniqueId("c").nodeType(NodeType.COMPOSITE_SNAPSHOT).userName(demoUser).build();
CompositeSnapshot compositeSnapshot1 = new CompositeSnapshot();
@@ -170,16 +213,42 @@ public void testUpdateCompositeSnapshot() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(s, CompositeSnapshot.class);
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateCompositeSnapshot2() throws Exception {
+
+ Node node = Node.builder().uniqueId("c").nodeType(NodeType.COMPOSITE_SNAPSHOT).userName(demoUser).build();
when(nodeDAO.getNode("c")).thenReturn(Node.builder().nodeType(NodeType.COMPOSITE_SNAPSHOT).uniqueId("c").userName("notUser").build());
- request = post("/composite-snapshot")
+ CompositeSnapshot compositeSnapshot1 = new CompositeSnapshot();
+ compositeSnapshot1.setCompositeSnapshotNode(node);
+
+ String compositeSnapshotString = objectMapper.writeValueAsString(compositeSnapshot1);
+
+ MockHttpServletRequestBuilder request = post("/composite-snapshot")
.header(HttpHeaders.AUTHORIZATION, userAuthorization)
.contentType(JSON)
.content(compositeSnapshotString);
mockMvc.perform(request).andExpect(status().isForbidden());
- request = post("/composite-snapshot")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateCompositeSnapshot3() throws Exception {
+
+ Node node = Node.builder().uniqueId("c").nodeType(NodeType.COMPOSITE_SNAPSHOT).userName(demoUser).build();
+ when(nodeDAO.getNode("c")).thenReturn(Node.builder().nodeType(NodeType.COMPOSITE_SNAPSHOT).uniqueId("c").userName("notUser").build());
+
+ CompositeSnapshot compositeSnapshot1 = new CompositeSnapshot();
+ compositeSnapshot1.setCompositeSnapshotNode(node);
+
+ String compositeSnapshotString = objectMapper.writeValueAsString(compositeSnapshot1);
+
+ MockHttpServletRequestBuilder request = post("/composite-snapshot")
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
.contentType(JSON)
.content(compositeSnapshotString);
@@ -192,16 +261,30 @@ public void testUpdateCompositeSnapshot() throws Exception {
mockMvc.perform(request).andExpect(status().isUnauthorized());
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateCompositeSnapshot4() throws Exception {
+
+ Node node = Node.builder().uniqueId("c").nodeType(NodeType.COMPOSITE_SNAPSHOT).userName(demoUser).build();
when(nodeDAO.getNode("c")).thenReturn(Node.builder().nodeType(NodeType.COMPOSITE_SNAPSHOT).uniqueId("c").userName("notUser").build());
- request = post("/composite-snapshot")
+ CompositeSnapshot compositeSnapshot1 = new CompositeSnapshot();
+ compositeSnapshot1.setCompositeSnapshotNode(node);
+
+ String compositeSnapshotString = objectMapper.writeValueAsString(compositeSnapshot1);
+
+ when(nodeDAO.updateCompositeSnapshot(compositeSnapshot1)).thenReturn(compositeSnapshot1);
+
+ MockHttpServletRequestBuilder request = post("/composite-snapshot")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
.content(compositeSnapshotString);
mockMvc.perform(request).andExpect(status().isOk());
- reset(nodeDAO);
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
@@ -217,6 +300,8 @@ public void testUpdateCompositeSnapshotWrongNodeType() throws Exception{
.contentType(JSON)
.content(objectMapper.writeValueAsString(compositeSnapshot1));
mockMvc.perform(request).andExpect(status().isBadRequest());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
@@ -236,7 +321,6 @@ public void testGetCompositeSnapshotData() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(s, CompositeSnapshotData.class);
- reset(nodeDAO);
}
@Test
@@ -257,8 +341,6 @@ public void testGetCompositeSnapshotNodes() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(s, new TypeReference>() {
});
-
- reset(nodeDAO);
}
@Test
@@ -276,8 +358,6 @@ public void testGetCompositeSnapshotItems() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(s, new TypeReference>() {
});
-
- reset(nodeDAO);
}
@Test
@@ -317,7 +397,5 @@ public void testGetCompositeSnapshotConsistency() throws Exception {
.content(objectMapper.writeValueAsString(List.of("id")));
mockMvc.perform(request).andExpect(status().isOk());
-
- reset(nodeDAO);
}
}
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ConfigurationControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ConfigurationControllerTest.java
index bf355ff07f..bc114aa464 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ConfigurationControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/ConfigurationControllerTest.java
@@ -20,17 +20,26 @@
package org.phoebus.service.saveandrestore.web.controllers;
import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
+
+import org.mockito.Mockito;
import org.phoebus.applications.saveandrestore.model.Comparison;
import org.phoebus.applications.saveandrestore.model.ConfigPv;
+
import org.phoebus.applications.saveandrestore.model.Configuration;
import org.phoebus.applications.saveandrestore.model.ConfigurationData;
import org.phoebus.applications.saveandrestore.model.Node;
import org.phoebus.applications.saveandrestore.model.NodeType;
+
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
+
import org.phoebus.applications.saveandrestore.model.ComparisonMode;
+
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
+import org.phoebus.service.saveandrestore.websocket.WebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
@@ -43,6 +52,8 @@
import java.util.List;
import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.phoebus.service.saveandrestore.web.controllers.BaseController.JSON;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
@@ -76,10 +87,16 @@ public class ConfigurationControllerTest {
@Autowired
private String demoUser;
- @Test
- public void testCreateConfiguration() throws Exception {
+ @Autowired
+ private WebSocketHandler webSocketHandler;
- reset(nodeDAO);
+ @AfterEach
+ public void resetMocks(){
+ reset(nodeDAO, webSocketHandler);
+ }
+
+ @Test
+ public void testCreateConfiguration1() throws Exception {
Configuration configuration = new Configuration();
configuration.setConfigurationNode(Node.builder().build());
@@ -93,26 +110,56 @@ public void testCreateConfiguration() throws Exception {
mockMvc.perform(request).andExpect(status().isOk());
- request = put("/config?parentNodeId=a")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateConfiguration2() throws Exception {
+
+ Configuration configuration = new Configuration();
+ configuration.setConfigurationNode(Node.builder().build());
+
+ MockHttpServletRequestBuilder request = put("/config?parentNodeId=a")
.header(HttpHeaders.AUTHORIZATION, userAuthorization)
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
mockMvc.perform(request).andExpect(status().isOk());
- request = put("/config?parentNodeId=a")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateConfiguration3() throws Exception {
+
+
+ Configuration configuration = new Configuration();
+ configuration.setConfigurationNode(Node.builder().build());
+
+ MockHttpServletRequestBuilder request = put("/config?parentNodeId=a")
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
mockMvc.perform(request).andExpect(status().isForbidden());
- request = put("/config?parentNodeId=a")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateConfiguration4() throws Exception{
+
+ Configuration configuration = new Configuration();
+ configuration.setConfigurationNode(Node.builder().build());
+
+ MockHttpServletRequestBuilder request = put("/config?parentNodeId=a")
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
mockMvc.perform(request).andExpect(status().isUnauthorized());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
- public void testUpdateConfiguration() throws Exception {
+ public void testUpdateConfiguration1() throws Exception {
Node configurationNode = Node.builder().uniqueId("uniqueId").nodeType(NodeType.CONFIGURATION).userName(demoUser).build();
@@ -127,51 +174,97 @@ public void testUpdateConfiguration() throws Exception {
mockMvc.perform(request).andExpect(status().isOk());
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void tesUpdateConfiguration2() throws Exception {
+
+ Node configurationNode = Node.builder().uniqueId("uniqueId").nodeType(NodeType.CONFIGURATION).userName(demoUser).build();
+
+ Configuration configuration = new Configuration();
+ configuration.setConfigurationNode(configurationNode);
+
when(nodeDAO.getNode("uniqueId")).thenReturn(configurationNode);
- request = post("/config")
+ MockHttpServletRequestBuilder request = post("/config")
.header(HttpHeaders.AUTHORIZATION, userAuthorization)
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
mockMvc.perform(request).andExpect(status().isOk());
- configurationNode = Node.builder().uniqueId("uniqueId").nodeType(NodeType.CONFIGURATION).userName("someUser").build();
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateConfiguration3() throws Exception {
+
+ Configuration configuration = new Configuration();
+ Node configurationNode = Node.builder().uniqueId("uniqueId").nodeType(NodeType.CONFIGURATION).userName("someUser").build();
configuration.setConfigurationNode(configurationNode);
when(nodeDAO.getNode("uniqueId")).thenReturn(configurationNode);
- request = post("/config")
+ MockHttpServletRequestBuilder request = post("/config")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
mockMvc.perform(request).andExpect(status().isOk());
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateConfiguration4() throws Exception {
+
+ Configuration configuration = new Configuration();
+ Node configurationNode = Node.builder().uniqueId("uniqueId").nodeType(NodeType.CONFIGURATION).userName("someUser").build();
+ configuration.setConfigurationNode(configurationNode);
+
when(nodeDAO.getNode("uniqueId")).thenReturn(configurationNode);
- request = post("/config")
+ MockHttpServletRequestBuilder request = post("/config")
.header(HttpHeaders.AUTHORIZATION, userAuthorization)
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
mockMvc.perform(request).andExpect(status().isForbidden());
+ }
+
+ @Test
+ public void testUpdateConfiguration5() throws Exception {
+
+ Configuration configuration = new Configuration();
+ Node configurationNode = Node.builder().uniqueId("uniqueId").nodeType(NodeType.CONFIGURATION).userName("someUser").build();
+ configuration.setConfigurationNode(configurationNode);
- request = post("/config")
+ MockHttpServletRequestBuilder request = post("/config")
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
mockMvc.perform(request).andExpect(status().isForbidden());
- request = post("/config")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateConfiguration6() throws Exception{
+
+ Configuration configuration = new Configuration();
+ Node configurationNode = Node.builder().uniqueId("uniqueId").nodeType(NodeType.CONFIGURATION).userName("someUser").build();
+ configuration.setConfigurationNode(configurationNode);
+
+ MockHttpServletRequestBuilder request = post("/config")
.contentType(JSON).content(objectMapper.writeValueAsString(configuration));
- mockMvc.perform(request).andExpect(status().isUnauthorized()
- );
+ mockMvc.perform(request).andExpect(status().isUnauthorized());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ mockMvc.perform(request).andExpect(status().isUnauthorized());
}
@Test
public void testCreateInvalidConfiguration() throws Exception {
- reset(nodeDAO);
-
Configuration configuration = new Configuration();
configuration.setConfigurationNode(Node.builder().build());
ConfigurationData configurationData = new ConfigurationData();
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/FilterControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/FilterControllerTest.java
index dccca5a33e..3d268e201b 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/FilterControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/FilterControllerTest.java
@@ -20,12 +20,15 @@
package org.phoebus.service.saveandrestore.web.controllers;
import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mockito;
import org.phoebus.applications.saveandrestore.model.search.Filter;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
+import org.phoebus.service.saveandrestore.websocket.WebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
@@ -40,6 +43,8 @@
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.phoebus.service.saveandrestore.web.controllers.BaseController.JSON;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
@@ -73,10 +78,16 @@ public class FilterControllerTest {
@Autowired
private String demoUser;
- @Test
- public void testSaveFilter() throws Exception {
+ @Autowired
+ private WebSocketHandler webSocketHandler;
- reset(nodeDAO);
+ @AfterEach
+ public void resetMocks(){
+ reset(webSocketHandler,nodeDAO);
+ }
+
+ @Test
+ public void testSaveFilter1() throws Exception {
Filter filter = new Filter();
filter.setName("name");
@@ -99,25 +110,68 @@ public void testSaveFilter() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(s, Filter.class);
- request = put("/filter")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testSaveFilter2() throws Exception {
+
+ Filter filter = new Filter();
+ filter.setName("name");
+ filter.setQueryString("query");
+ filter.setUser("user");
+
+ String filterString = objectMapper.writeValueAsString(filter);
+
+ MockHttpServletRequestBuilder request = put("/filter")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
.content(filterString);
mockMvc.perform(request).andExpect(status().isOk());
- request = put("/filter")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+ }
+
+ @Test
+ public void testSaveFiliter3() throws Exception {
+
+ Filter filter = new Filter();
+ filter.setName("name");
+ filter.setQueryString("query");
+ filter.setUser("user");
+
+ String filterString = objectMapper.writeValueAsString(filter);
+ MockHttpServletRequestBuilder request = put("/filter")
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
.contentType(JSON)
.content(filterString);
mockMvc.perform(request).andExpect(status().isForbidden());
- request = put("/filter")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+ }
+
+ @Test
+ public void testSaveFiliter4() throws Exception{
+
+ Filter filter = new Filter();
+ filter.setName("name");
+ filter.setQueryString("query");
+ filter.setUser("user");
+
+ String filterString = objectMapper.writeValueAsString(filter);
+
+ MockHttpServletRequestBuilder request = put("/filter")
.contentType(JSON)
.content(filterString);
mockMvc.perform(request).andExpect(status().isUnauthorized());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
}
@Test
@@ -134,28 +188,60 @@ public void testDeleteFilter() throws Exception {
.contentType(JSON);
mockMvc.perform(request).andExpect(status().isOk());
- request = delete("/filter/name")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+ }
+
+ @Test
+ public void testDeleteFilter2() throws Exception {
+
+ MockHttpServletRequestBuilder request = delete("/filter/name")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON);
mockMvc.perform(request).andExpect(status().isOk());
- request = delete("/filter/name")
- .header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
- .contentType(JSON);
- mockMvc.perform(request).andExpect(status().isForbidden());
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+ }
- request = delete("/filter/name")
+ @Test
+ public void testDeleteFilter3() throws Exception {
+
+ MockHttpServletRequestBuilder request = delete("/filter/name")
+ .header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
+ .contentType(JSON);
+ mockMvc.perform(request).andExpect(status().isForbidden());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+ }
+
+ @Test
+ public void testDeleteFilter4() throws Exception {
+ MockHttpServletRequestBuilder request = delete("/filter/name")
.contentType(JSON);
mockMvc.perform(request).andExpect(status().isUnauthorized());
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+ }
+
+ @Test
+ public void testDeleteFilter5() throws Exception{
+ Filter filter = new Filter();
+ filter.setName("name");
+ filter.setQueryString("query");
filter.setUser("notUser");
when(nodeDAO.getAllFilters()).thenReturn(List.of(filter));
- request = delete("/filter/name")
+ MockHttpServletRequestBuilder request = delete("/filter/name")
.header(HttpHeaders.AUTHORIZATION, userAuthorization)
.contentType(JSON);
mockMvc.perform(request).andExpect(status().isForbidden());
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+
}
@Test
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java
index 37fc550b12..677225fd74 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/NodeControllerTest.java
@@ -20,6 +20,7 @@
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
@@ -33,9 +34,12 @@
import org.phoebus.applications.saveandrestore.model.Node;
import org.phoebus.applications.saveandrestore.model.NodeType;
import org.phoebus.applications.saveandrestore.model.Tag;
+import org.phoebus.applications.saveandrestore.model.websocket.MessageType;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
import org.phoebus.service.saveandrestore.NodeNotFoundException;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
+import org.phoebus.service.saveandrestore.websocket.WebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
@@ -49,9 +53,12 @@
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
+import java.util.Set;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.phoebus.service.saveandrestore.web.controllers.BaseController.JSON;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
@@ -77,6 +84,9 @@ public class NodeControllerTest {
@Autowired
private MockMvc mockMvc;
+ @Autowired
+ private WebSocketHandler webSocketHandler;
+
private static Node folderFromClient;
private static Node config1;
@@ -107,6 +117,11 @@ public static void setUp() {
folderFromClient = Node.builder().name("SomeFolder").userName("myusername").uniqueId("11").build();
}
+ @AfterEach
+ public void resetMocks(){
+ reset(webSocketHandler, nodeDAO);
+ }
+
@Test
public void testCreateFolder() throws Exception {
@@ -161,8 +176,6 @@ public void testCreateFolderParentIdDoesNotExist() throws Exception {
@Test
public void testCreateConfig() throws Exception {
- reset(nodeDAO);
-
Node config = Node.builder().nodeType(NodeType.CONFIGURATION).name("config").uniqueId("hhh")
.userName("user").build();
@@ -273,7 +286,6 @@ public void testCreateConfigWithBadToleranceData2() throws Exception {
@Test
public void testUpdateConfig() throws Exception {
- reset(nodeDAO);
Node config = Node.builder().nodeType(NodeType.CONFIGURATION).name("config").uniqueId("hhh")
.userName("user").build();
@@ -328,7 +340,6 @@ public void testUpdateConfig() throws Exception {
@Test
public void testCreateNodeBadRequests() throws Exception {
- reset(nodeDAO);
Node config = Node.builder().nodeType(NodeType.FOLDER).uniqueId("hhh")
.userName("valid").build();
@@ -349,7 +360,6 @@ public void testCreateNodeBadRequests() throws Exception {
@Test
public void testGetChildNodes() throws Exception {
- reset(nodeDAO);
when(nodeDAO.getChildNodes("p")).thenAnswer((Answer>) invocation -> Collections.singletonList(config1));
@@ -367,7 +377,6 @@ public void testGetChildNodes() throws Exception {
@Test
public void testGetChildNodesNonExistingNode() throws Exception {
- reset(nodeDAO);
when(nodeDAO.getChildNodes("non-existing")).thenThrow(NodeNotFoundException.class);
MockHttpServletRequestBuilder request = get("/node/non-existing/children").contentType(JSON);
@@ -419,6 +428,7 @@ public void testDeleteFolder() throws Exception {
mockMvc.perform(request).andExpect(status().isUnauthorized());
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").userName(demoUser).build());
+ when(nodeDAO.getParentNode("a")).thenReturn(Node.builder().uniqueId("b").build());
request =
delete("/node")
@@ -426,62 +436,115 @@ public void testDeleteFolder() throws Exception {
.header(HttpHeaders.AUTHORIZATION, userAuthorization);
mockMvc.perform(request).andExpect(status().isOk());
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testDeleteForbiddenAccess() throws Exception {
+
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").userName("notDemoUser").build());
- request =
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, userAuthorization);
mockMvc.perform(request).andExpect(status().isForbidden());
+ verify(webSocketHandler, times(0)).sendMessage(new SaveAndRestoreWebSocketMessage(MessageType.NODE_REMOVED, "b"));
+ }
+
+ @Test
+ public void testDeleteForbiddenAccess2() throws Exception {
+
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").userName(demoUser).build());
+ when(nodeDAO.getParentNode("a")).thenReturn(Node.builder().uniqueId("b").build());
- request =
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization);
mockMvc.perform(request).andExpect(status().isForbidden());
+ verify(webSocketHandler, times(0)).sendMessage(new SaveAndRestoreWebSocketMessage(MessageType.NODE_REMOVED, "b"));
+
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").nodeType(NodeType.CONFIGURATION).userName(demoUser).build());
when(nodeDAO.getChildNodes("a")).thenReturn(Collections.emptyList());
- request =
+ verify(webSocketHandler, times(0)).sendMessage(new SaveAndRestoreWebSocketMessage(MessageType.NODE_REMOVED, "b"));
+
+ }
+
+ @Test
+ public void testDeleteFolder2() throws Exception {
+
+ when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").userName(demoUser).build());
+ when(nodeDAO.getParentNode("a")).thenReturn(Node.builder().uniqueId("b").build());
+ //when(nodeDAO.deleteNodes(List.of("a"))).thenReturn(Set.of("b"));
+
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, userAuthorization);
mockMvc.perform(request).andExpect(status().isOk());
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+
+ }
+
+ @Test
+ public void testDeleteFolder3() throws Exception {
+
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").nodeType(NodeType.FOLDER).userName(demoUser).build());
+ when(nodeDAO.getParentNode("a")).thenReturn(Node.builder().uniqueId("b").build());
when(nodeDAO.getChildNodes("a")).thenReturn(Collections.emptyList());
- request =
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, userAuthorization);
mockMvc.perform(request).andExpect(status().isOk());
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testDeleteForbidden3() throws Exception{
+
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").nodeType(NodeType.CONFIGURATION).userName(demoUser).build());
when(nodeDAO.getChildNodes("a")).thenReturn(List.of(Node.builder().build()));
- request =
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, userAuthorization);
mockMvc.perform(request).andExpect(status().isForbidden());
+ verify(webSocketHandler, times(0)).sendMessage(new SaveAndRestoreWebSocketMessage(MessageType.NODE_REMOVED, "b"));
+ }
+
+ @Test
+ public void testDeleteForbidden4() throws Exception{
+
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").nodeType(NodeType.FOLDER).userName(demoUser).build());
when(nodeDAO.getChildNodes("a")).thenReturn(List.of(Node.builder().build()));
- request =
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, userAuthorization);
mockMvc.perform(request).andExpect(status().isForbidden());
+ verify(webSocketHandler, times(0)).sendMessage(new SaveAndRestoreWebSocketMessage(MessageType.NODE_REMOVED, "b"));
+
+ }
+
+ @Test
+ public void testDeleteFolder5() throws Exception{
+
when(nodeDAO.getNode("a")).thenReturn(Node.builder().uniqueId("a").nodeType(NodeType.CONFIGURATION).userName(demoUser).build());
when(nodeDAO.getChildNodes("a")).thenReturn(List.of(Node.builder().build()));
- request =
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, adminAuthorization);
@@ -513,8 +576,6 @@ public void testGetFolder() throws Exception {
@Test
public void testGetConfiguration() throws Exception {
- Mockito.reset(nodeDAO);
-
when(nodeDAO.getNode("a")).thenReturn(Node.builder().build());
MockHttpServletRequestBuilder request = get("/node/a");
@@ -528,7 +589,6 @@ public void testGetConfiguration() throws Exception {
@Test
public void testGetNonExistingConfiguration() throws Exception {
- Mockito.reset(nodeDAO);
when(nodeDAO.getNode("a")).thenThrow(NodeNotFoundException.class);
MockHttpServletRequestBuilder request = get("/node/a");
@@ -540,8 +600,6 @@ public void testGetNonExistingConfiguration() throws Exception {
@Test
public void testGetNonExistingFolder() throws Exception {
-
- Mockito.reset(nodeDAO);
when(nodeDAO.getNode("a")).thenThrow(NodeNotFoundException.class);
MockHttpServletRequestBuilder request = get("/node/a");
@@ -570,8 +628,6 @@ public void testGetFolderIllegalArgument() throws Exception {
@Test
public void testUpdateNode() throws Exception {
- reset(nodeDAO);
-
Node node = Node.builder().name("foo").uniqueId("a").userName(demoUser).build();
when(nodeDAO.getNode("a")).thenReturn(node);
@@ -726,7 +782,6 @@ public void testCreateNodeWithValidTags1() throws Exception {
mockMvc.perform(request).andExpect(status().isOk());
- reset(nodeDAO);
}
@Test
@@ -750,6 +805,5 @@ public void testCreateNodeWithValidTags2() throws Exception {
mockMvc.perform(request).andExpect(status().isOk());
- reset(nodeDAO);
}
}
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SnapshotControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SnapshotControllerTest.java
index 5424ce6965..43dc9378e9 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SnapshotControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/SnapshotControllerTest.java
@@ -20,6 +20,7 @@
package org.phoebus.service.saveandrestore.web.controllers;
import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mockito;
@@ -27,8 +28,10 @@
import org.phoebus.applications.saveandrestore.model.Node;
import org.phoebus.applications.saveandrestore.model.NodeType;
import org.phoebus.applications.saveandrestore.model.Snapshot;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
+import org.phoebus.service.saveandrestore.websocket.WebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
@@ -40,7 +43,11 @@
import org.springframework.test.web.servlet.request.MockHttpServletRequestBuilder;
import java.util.List;
+import java.util.Set;
+import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.phoebus.service.saveandrestore.web.controllers.BaseController.JSON;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
@@ -75,6 +82,14 @@ public class SnapshotControllerTest {
@Autowired
private String demoUser;
+ @Autowired
+ private WebSocketHandler webSocketHandler;
+
+ @AfterEach
+ public void resetMocks(){
+ reset(webSocketHandler, nodeDAO);
+ }
+
@Test
public void testSaveSnapshotWrongNodeType() throws Exception {
@@ -92,6 +107,8 @@ public void testSaveSnapshotWrongNodeType() throws Exception {
.content(objectMapper.writeValueAsString(snapshot));
mockMvc.perform(request).andExpect(status().isBadRequest());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
@@ -105,10 +122,12 @@ public void testSaveSnapshotNoParentNodeId() throws Exception {
.content(objectMapper.writeValueAsString(snapshot));
mockMvc.perform(request).andExpect(status().isBadRequest());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
- public void testCreateSnapshot() throws Exception {
+ public void testCreateSnapshot1() throws Exception {
Node node = Node.builder().uniqueId("uniqueId").nodeType(NodeType.SNAPSHOT).userName(demoUser).build();
Snapshot snapshot = new Snapshot();
snapshot.setSnapshotNode(node);
@@ -130,7 +149,19 @@ public void testCreateSnapshot() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(result.getResponse().getContentAsString(), Snapshot.class);
- request = put("/snapshot?parentNodeId=a")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateSnapshot2() throws Exception {
+
+ Node node = Node.builder().uniqueId("uniqueId").nodeType(NodeType.SNAPSHOT).userName(demoUser).build();
+ Snapshot snapshot = new Snapshot();
+ snapshot.setSnapshotNode(node);
+
+ String snapshotString = objectMapper.writeValueAsString(snapshot);
+
+ MockHttpServletRequestBuilder request = put("/snapshot?parentNodeId=a")
.contentType(JSON)
.content(snapshotString);
mockMvc.perform(request).andExpect(status().isUnauthorized());
@@ -141,15 +172,29 @@ public void testCreateSnapshot() throws Exception {
.content(snapshotString);
mockMvc.perform(request).andExpect(status().isForbidden());
- request = put("/snapshot?parentNodeId=a")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCreateSnapshot3() throws Exception{
+
+ Node node = Node.builder().uniqueId("uniqueId").nodeType(NodeType.SNAPSHOT).userName(demoUser).build();
+ Snapshot snapshot = new Snapshot();
+ snapshot.setSnapshotNode(node);
+
+ String snapshotString = objectMapper.writeValueAsString(snapshot);
+
+ MockHttpServletRequestBuilder request = put("/snapshot?parentNodeId=a")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
.content(snapshotString);
mockMvc.perform(request).andExpect(status().isOk());
+
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
- public void testUpdateSnapshot() throws Exception {
+ public void testUpdateSnapshot1() throws Exception {
Node node = Node.builder().uniqueId("s").nodeType(NodeType.SNAPSHOT).userName(demoUser).build();
Snapshot snapshot = new Snapshot();
snapshot.setSnapshotNode(node);
@@ -171,30 +216,72 @@ public void testUpdateSnapshot() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(result.getResponse().getContentAsString(), Snapshot.class);
- request = put("/snapshot")
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateSnapshot2() throws Exception {
+
+ Node node = Node.builder().uniqueId("s").nodeType(NodeType.SNAPSHOT).userName(demoUser).build();
+ Snapshot snapshot = new Snapshot();
+ snapshot.setSnapshotNode(node);
+
+ String snapshotString = objectMapper.writeValueAsString(snapshot);
+
+ MockHttpServletRequestBuilder request = put("/snapshot")
.contentType(JSON)
.content(snapshotString);
mockMvc.perform(request).andExpect(status().isUnauthorized());
- request = post("/snapshot")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateSnapshot3() throws Exception {
+
+ Node node = Node.builder().uniqueId("s").nodeType(NodeType.SNAPSHOT).userName(demoUser).build();
+ Snapshot snapshot = new Snapshot();
+ snapshot.setSnapshotNode(node);
+
+ String snapshotString = objectMapper.writeValueAsString(snapshot);
+
+ MockHttpServletRequestBuilder request = post("/snapshot")
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
.contentType(JSON)
.content(snapshotString);
mockMvc.perform(request).andExpect(status().isForbidden());
- request = post("/snapshot")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testUpdateSnapshot4() throws Exception{
+
+ Node node = Node.builder().uniqueId("s").nodeType(NodeType.SNAPSHOT).userName(demoUser).build();
+ Snapshot snapshot = new Snapshot();
+ snapshot.setSnapshotNode(node);
+
+ String snapshotString = objectMapper.writeValueAsString(snapshot);
+
+ MockHttpServletRequestBuilder request = post("/snapshot")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
.content(snapshotString);
mockMvc.perform(request).andExpect(status().isOk());
+
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
- public void testDeleteSnapshot() throws Exception{
+ public void testDeleteSnapshot1() throws Exception {
- when(nodeDAO.getNode("a")).thenReturn(Node.builder()
+ Node node = Node.builder()
.nodeType(NodeType.SNAPSHOT)
- .uniqueId("a").userName(demoUser).build());
+ .uniqueId("a").userName(demoUser).build();
+
+ when(nodeDAO.getNode("a")).thenReturn(node);
+
+ //when(nodeDAO.deleteNodes(List.of("a"))).thenReturn(Set.of("a"));
MockHttpServletRequestBuilder request =
delete("/node")
@@ -203,28 +290,51 @@ public void testDeleteSnapshot() throws Exception{
mockMvc.perform(request).andExpect(status().isOk());
- request =
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testDeleteSnapshot2() throws Exception {
+
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization);
mockMvc.perform(request).andExpect(status().isForbidden());
- when(nodeDAO.getNode("a")).thenReturn(Node.builder()
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testDeleteSnapshot3() throws Exception {
+
+ Node node = Node.builder()
.nodeType(NodeType.SNAPSHOT)
- .uniqueId("a").userName("otherUser").build());
+ .uniqueId("a").userName("otherUser").build();
+
+ when(nodeDAO.getNode("a")).thenReturn(node);
+ //when(nodeDAO.deleteNodes(List.of("a"))).thenReturn(Set.of("a"));
- request =
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")))
.header(HttpHeaders.AUTHORIZATION, adminAuthorization);
mockMvc.perform(request).andExpect(status().isOk());
- request =
+ verify(webSocketHandler, times(1)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testDeleteSnapshot4() throws Exception{
+
+ MockHttpServletRequestBuilder request =
delete("/node")
.contentType(JSON).content(objectMapper.writeValueAsString(List.of("a")));
mockMvc.perform(request).andExpect(status().isUnauthorized());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
}
diff --git a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/StructureControllerTest.java b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/StructureControllerTest.java
index df736f8acc..67eeb88386 100644
--- a/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/StructureControllerTest.java
+++ b/services/save-and-restore/src/test/java/org/phoebus/service/saveandrestore/web/controllers/StructureControllerTest.java
@@ -20,11 +20,15 @@
package org.phoebus.service.saveandrestore.web.controllers;
import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mockito;
import org.phoebus.applications.saveandrestore.model.Node;
+import org.phoebus.applications.saveandrestore.model.websocket.SaveAndRestoreWebSocketMessage;
import org.phoebus.service.saveandrestore.persistence.dao.NodeDAO;
import org.phoebus.service.saveandrestore.web.config.ControllersTestConfig;
+import org.phoebus.service.saveandrestore.websocket.WebSocketHandler;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.http.HttpHeaders;
@@ -38,6 +42,9 @@
import java.util.Collections;
import java.util.List;
+import static org.mockito.Mockito.reset;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.phoebus.service.saveandrestore.web.controllers.BaseController.JSON;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
@@ -73,9 +80,16 @@ public class StructureControllerTest {
@Autowired
private String readOnlyAuthorization;
+ @Autowired
+ private WebSocketHandler webSocketHandler;
+
+ @AfterEach
+ public void resetMocks(){
+ reset(webSocketHandler, nodeDAO);
+ }
@Test
- public void testMoveNode() throws Exception {
+ public void testMoveNode1() throws Exception {
when(nodeDAO.moveNodes(List.of("a"), "b", demoAdmin))
.thenReturn(Node.builder().uniqueId("2").uniqueId("a").userName(demoAdmin).build());
@@ -92,10 +106,16 @@ public void testMoveNode() throws Exception {
// Make sure response contains expected data
objectMapper.readValue(result.getResponse().getContentAsString(), Node.class);
+ verify(webSocketHandler, times(2)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testMoveNode2() throws Exception{
+
when(nodeDAO.moveNodes(List.of("a"), "b", demoUser))
.thenReturn(Node.builder().uniqueId("2").uniqueId("a").userName(demoUser).build());
- request = post("/move")
+ MockHttpServletRequestBuilder request = post("/move")
.header(HttpHeaders.AUTHORIZATION, userAuthorization)
.contentType(JSON)
.content(objectMapper.writeValueAsString(List.of("a")))
@@ -104,8 +124,13 @@ public void testMoveNode() throws Exception {
mockMvc.perform(request).andExpect(status().isForbidden());
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
- request = post("/move")
+ @Test
+ public void testMoveNode3() throws Exception{
+
+ MockHttpServletRequestBuilder request = post("/move")
.header(HttpHeaders.AUTHORIZATION, readOnlyAuthorization)
.contentType(JSON)
.content(objectMapper.writeValueAsString(List.of("a")))
@@ -121,6 +146,8 @@ public void testMoveNode() throws Exception {
.param("username", "username");
mockMvc.perform(request).andExpect(status().isUnauthorized());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
@@ -133,6 +160,8 @@ public void testMoveNodeSourceNodeListEmpty() throws Exception {
.param("username", "user");
mockMvc.perform(request).andExpect(status().isBadRequest());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
@@ -145,10 +174,12 @@ public void testMoveNodeTargetIdEmpty() throws Exception {
.param("username", "user");
mockMvc.perform(request).andExpect(status().isBadRequest());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
@Test
- public void testCopyNodes() throws Exception {
+ public void testCopyNodes1() throws Exception {
MockHttpServletRequestBuilder request = post("/copy")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
@@ -163,7 +194,13 @@ public void testCopyNodes() throws Exception {
.param("to", "target");
mockMvc.perform(request).andExpect(status().isForbidden());
- request = post("/copy")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCopyNodes2() throws Exception{
+
+ MockHttpServletRequestBuilder request = post("/copy")
.contentType(JSON)
.content(objectMapper.writeValueAsString(List.of("a")))
.param("to", "target");
@@ -171,8 +208,8 @@ public void testCopyNodes() throws Exception {
}
@Test
- public void testCopyNodesBadRequest() throws Exception {
- Node node = Node.builder().uniqueId("uniqueId").userName(demoUser).build();
+ public void testCopyNodesBadRequest1() throws Exception {
+
MockHttpServletRequestBuilder request = post("/copy")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
@@ -180,17 +217,30 @@ public void testCopyNodesBadRequest() throws Exception {
.param("to", "");
mockMvc.perform(request).andExpect(status().isBadRequest());
- request = post("/copy")
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
+ }
+
+ @Test
+ public void testCopyNodesBadRequest2() throws Exception {
+
+ MockHttpServletRequestBuilder request = post("/copy")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
.content(objectMapper.writeValueAsString(List.of("a")));
mockMvc.perform(request).andExpect(status().isBadRequest());
- request = post("/copy")
+ }
+
+ @Test
+ public void testCopyNodesBadRequest3() throws Exception {
+
+ MockHttpServletRequestBuilder request = post("/copy")
.header(HttpHeaders.AUTHORIZATION, adminAuthorization)
.contentType(JSON)
.content(objectMapper.writeValueAsString(Collections.emptyList()))
.param("to", "target");
mockMvc.perform(request).andExpect(status().isBadRequest());
+
+ verify(webSocketHandler, times(0)).sendMessage(Mockito.any(SaveAndRestoreWebSocketMessage.class));
}
}