2 * Copyright (c) 2023 PANTHEON.tech, s.r.o. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.restconf.nb.rfc8040.rests.transactions;
10 import static org.mockito.ArgumentMatchers.any;
11 import static org.mockito.Mockito.doReturn;
12 import static org.mockito.Mockito.mock;
13 import static org.mockito.Mockito.verify;
14 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
15 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
17 import com.google.common.util.concurrent.Futures;
18 import java.util.Optional;
19 import org.junit.Before;
20 import org.junit.Test;
21 import org.junit.runner.RunWith;
22 import org.mockito.Mock;
23 import org.mockito.junit.MockitoJUnitRunner;
24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
25 import org.opendaylight.mdsal.common.api.TransactionCommitFailedException;
26 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
27 import org.opendaylight.netconf.api.NetconfDocumentedException;
28 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
29 import org.opendaylight.restconf.nb.rfc8040.WriteDataParams;
30 import org.opendaylight.restconf.nb.rfc8040.rests.utils.PutDataTransactionUtil;
31 import org.opendaylight.yangtools.yang.common.ErrorSeverity;
32 import org.opendaylight.yangtools.yang.common.ErrorTag;
33 import org.opendaylight.yangtools.yang.common.ErrorType;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
37 import org.w3c.dom.DOMException;
39 @RunWith(MockitoJUnitRunner.StrictStubs.class)
40 public final class NetconfRestconfStrategyTest extends AbstractRestconfStrategyTest {
42 private NetconfDataTreeService netconfService;
45 public void before() {
46 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
47 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).discardChanges();
48 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).unlock();
49 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).lock();
50 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
51 .delete(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.of());
55 RestconfStrategy testDeleteDataStrategy() {
56 return new NetconfRestconfStrategy(netconfService);
60 RestconfStrategy testNegativeDeleteDataStrategy() {
61 doReturn(Futures.immediateFailedFuture(new TransactionCommitFailedException(
62 "Commit of transaction " + this + " failed", new NetconfDocumentedException("id",
63 ErrorType.RPC, ErrorTag.DATA_MISSING, ErrorSeverity.ERROR)))).when(netconfService).commit();
64 return new NetconfRestconfStrategy(netconfService);
68 RestconfStrategy testPostContainerDataStrategy() {
69 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
70 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
71 .create(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, EMPTY_JUKEBOX, Optional.empty());
72 return new NetconfRestconfStrategy(netconfService);
76 RestconfStrategy testPostListDataStrategy(final MapEntryNode entryNode, final YangInstanceIdentifier node) {
77 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
78 .merge(any(), any(), any(), any());
79 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
80 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).create(
81 LogicalDatastoreType.CONFIGURATION, node, entryNode, Optional.empty());
82 return new NetconfRestconfStrategy(netconfService);
86 RestconfStrategy testPostDataFailStrategy(final DOMException domException) {
87 doReturn(immediateFailedFluentFuture(domException)).when(netconfService)
88 .create(any(), any(), any(), any());
89 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).discardChanges();
90 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).unlock();
91 return new NetconfRestconfStrategy(netconfService);
95 public void testPutCreateContainerData() {
96 doReturn(immediateFluentFuture(Optional.empty())).when(netconfService).getConfig(JUKEBOX_IID);
97 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
98 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
99 .replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, EMPTY_JUKEBOX, Optional.empty());
101 PutDataTransactionUtil.putData(JUKEBOX_IID, EMPTY_JUKEBOX, JUKEBOX_SCHEMA,
102 new NetconfRestconfStrategy(netconfService), WriteDataParams.empty());
103 verify(netconfService).lock();
104 verify(netconfService).getConfig(JUKEBOX_IID);
105 verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, EMPTY_JUKEBOX,
110 public void testPutReplaceContainerData() {
111 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class)))).when(netconfService)
112 .getConfig(JUKEBOX_IID);
113 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
114 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
115 .replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, EMPTY_JUKEBOX, Optional.empty());
117 PutDataTransactionUtil.putData(JUKEBOX_IID, EMPTY_JUKEBOX, JUKEBOX_SCHEMA,
118 new NetconfRestconfStrategy(netconfService), WriteDataParams.empty());
119 verify(netconfService).getConfig(JUKEBOX_IID);
120 verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, EMPTY_JUKEBOX,
125 public void testPutCreateLeafData() {
126 doReturn(immediateFluentFuture(Optional.empty())).when(netconfService).getConfig(GAP_IID);
127 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
128 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
129 .replace(LogicalDatastoreType.CONFIGURATION, GAP_IID, GAP_LEAF, Optional.empty());
131 PutDataTransactionUtil.putData(GAP_IID, GAP_LEAF, JUKEBOX_SCHEMA, new NetconfRestconfStrategy(netconfService),
132 WriteDataParams.empty());
133 verify(netconfService).getConfig(GAP_IID);
134 verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, GAP_IID, GAP_LEAF, Optional.empty());
138 public void testPutReplaceLeafData() {
139 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class)))).when(netconfService)
141 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
142 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
143 .replace(LogicalDatastoreType.CONFIGURATION, GAP_IID, GAP_LEAF, Optional.empty());
145 PutDataTransactionUtil.putData(GAP_IID, GAP_LEAF, JUKEBOX_SCHEMA, new NetconfRestconfStrategy(netconfService),
146 WriteDataParams.empty());
147 verify(netconfService).getConfig(GAP_IID);
148 verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, GAP_IID, GAP_LEAF, Optional.empty());
152 public void testPutCreateListData() {
153 doReturn(immediateFluentFuture(Optional.empty())).when(netconfService).getConfig(JUKEBOX_IID);
154 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
155 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
156 .replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, JUKEBOX_WITH_BANDS, Optional.empty());
158 PutDataTransactionUtil.putData(JUKEBOX_IID, JUKEBOX_WITH_BANDS, JUKEBOX_SCHEMA,
159 new NetconfRestconfStrategy(netconfService), WriteDataParams.empty());
160 verify(netconfService).getConfig(JUKEBOX_IID);
161 verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, JUKEBOX_WITH_BANDS,
166 public void testPutReplaceListData() {
167 doReturn(immediateFluentFuture(Optional.of(mock(NormalizedNode.class)))).when(netconfService)
168 .getConfig(JUKEBOX_IID);
169 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService).commit();
170 doReturn(Futures.immediateFuture(new DefaultDOMRpcResult())).when(netconfService)
171 .replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, JUKEBOX_WITH_BANDS, Optional.empty());
173 PutDataTransactionUtil.putData(JUKEBOX_IID, JUKEBOX_WITH_BANDS, JUKEBOX_SCHEMA,
174 new NetconfRestconfStrategy(netconfService), WriteDataParams.empty());
175 verify(netconfService).getConfig(JUKEBOX_IID);
176 verify(netconfService).replace(LogicalDatastoreType.CONFIGURATION, JUKEBOX_IID, JUKEBOX_WITH_BANDS,