2 * Copyright (c) 2016 Cisco Systems, Inc. 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.server.mdsal.streams.dtcl;
10 import static org.hamcrest.CoreMatchers.startsWith;
11 import static org.hamcrest.MatcherAssert.assertThat;
12 import static org.junit.jupiter.api.Assertions.assertEquals;
13 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
14 import static org.junit.jupiter.api.Assertions.assertNotNull;
15 import static org.junit.jupiter.api.Assertions.assertThrows;
16 import static org.mockito.ArgumentMatchers.any;
17 import static org.mockito.ArgumentMatchers.eq;
18 import static org.mockito.Mockito.doCallRealMethod;
19 import static org.mockito.Mockito.doNothing;
20 import static org.mockito.Mockito.doReturn;
23 import java.util.List;
24 import java.util.UUID;
25 import org.eclipse.jdt.annotation.Nullable;
26 import org.junit.jupiter.api.BeforeEach;
27 import org.junit.jupiter.api.Test;
28 import org.junit.jupiter.api.extension.ExtendWith;
29 import org.mockito.ArgumentCaptor;
30 import org.mockito.Captor;
31 import org.mockito.Mock;
32 import org.mockito.junit.jupiter.MockitoExtension;
33 import org.opendaylight.mdsal.common.api.CommitInfo;
34 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
35 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
36 import org.opendaylight.mdsal.dom.api.DOMDataBroker.DataTreeChangeExtension;
37 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
38 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
39 import org.opendaylight.restconf.server.api.DatabindContext;
40 import org.opendaylight.restconf.server.api.DatabindPath;
41 import org.opendaylight.restconf.server.mdsal.MdsalRestconfStreamRegistry;
42 import org.opendaylight.restconf.server.spi.DatabindProvider;
43 import org.opendaylight.restconf.server.spi.OperationInput;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.monitoring.rev170126.restconf.state.streams.stream.Access;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.CreateDataChangeEventSubscription;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.CreateDataChangeEventSubscriptionOutput;
47 import org.opendaylight.yangtools.yang.common.ErrorTag;
48 import org.opendaylight.yangtools.yang.common.ErrorType;
49 import org.opendaylight.yangtools.yang.common.QName;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
56 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
57 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
58 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
59 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
60 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
62 @ExtendWith(MockitoExtension.class)
63 class CreateNotificationStreamRpcTest {
64 private static final EffectiveModelContext SCHEMA_CTX = YangParserTestUtils.parseYangResourceDirectory("/streams");
65 private static final URI RESTCONF_URI = URI.create("/rests");
66 private static final YangInstanceIdentifier TOASTER = YangInstanceIdentifier.of(
67 QName.create("http://netconfcentral.org/ns/toaster", "2009-11-20", "toaster"));
70 private DOMDataBroker dataBroker;
72 private DataTreeChangeExtension treeChange;
74 private DOMDataTreeWriteTransaction tx;
76 private ArgumentCaptor<YangInstanceIdentifier> pathCaptor;
78 private ArgumentCaptor<NormalizedNode> dataCaptor;
80 private DatabindProvider databindProvider;
82 private CreateDataChangeEventSubscriptionRpc rpc;
85 public void before() {
86 databindProvider = () -> DatabindContext.ofModel(SCHEMA_CTX);
88 doReturn(List.of(treeChange)).when(dataBroker).supportedExtensions();
89 doCallRealMethod().when(dataBroker).extension(any());
90 rpc = new CreateDataChangeEventSubscriptionRpc(new MdsalRestconfStreamRegistry(dataBroker), databindProvider,
95 void createStreamTest() {
96 doReturn(tx).when(dataBroker).newWriteOnlyTransaction();
97 doNothing().when(tx).put(eq(LogicalDatastoreType.OPERATIONAL), pathCaptor.capture(), dataCaptor.capture());
98 doReturn(CommitInfo.emptyFluentFuture()).when(tx).commit();
100 final var output = assertInstanceOf(ContainerNode.class, rpc.invoke(RESTCONF_URI, createInput("path", TOASTER))
103 assertEquals(new NodeIdentifier(CreateDataChangeEventSubscriptionOutput.QNAME), output.name());
104 assertEquals(1, output.size());
106 final var streamName = assertInstanceOf(LeafNode.class,
107 output.childByArg(new NodeIdentifier(
108 QName.create(CreateDataChangeEventSubscriptionOutput.QNAME, "stream-name"))));
109 final var name = assertInstanceOf(String.class, streamName.body());
110 assertEquals(45, name.length());
111 assertThat(name, startsWith("urn:uuid:"));
112 assertNotNull(UUID.fromString(name.substring(9)));
114 final var rcStream = QName.create("urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring", "2017-01-26",
116 final var rcName = QName.create(rcStream, "name");
117 final var streamId = NodeIdentifierWithPredicates.of(rcStream, rcName, name);
118 final var rcEncoding = QName.create(rcStream, "encoding");
119 final var rcLocation = QName.create(rcStream, "location");
121 assertEquals(YangInstanceIdentifier.of(
122 new NodeIdentifier(QName.create(rcStream, "restconf-state")),
123 new NodeIdentifier(QName.create(rcStream, "streams")),
124 new NodeIdentifier(rcStream),
125 streamId), pathCaptor.getValue());
126 assertEquals(ImmutableNodes.newMapEntryBuilder()
127 .withNodeIdentifier(streamId)
128 .withChild(ImmutableNodes.leafNode(rcName, name))
129 .withChild(ImmutableNodes.leafNode(QName.create(rcStream, "description"),
130 "Events occuring in CONFIGURATION datastore under /toaster:toaster"))
131 .withChild(ImmutableNodes.newSystemMapBuilder()
132 .withNodeIdentifier(new NodeIdentifier(Access.QNAME))
133 .withChild(ImmutableNodes.newMapEntryBuilder()
134 .withNodeIdentifier(NodeIdentifierWithPredicates.of(Access.QNAME, rcEncoding, "json"))
135 .withChild(ImmutableNodes.leafNode(rcEncoding, "json"))
136 .withChild(ImmutableNodes.leafNode(rcLocation, "/rests/streams/json/" + name))
138 .withChild(ImmutableNodes.newMapEntryBuilder()
139 .withNodeIdentifier(NodeIdentifierWithPredicates.of(Access.QNAME, rcEncoding, "xml"))
140 .withChild(ImmutableNodes.leafNode(rcEncoding, "xml"))
141 .withChild(ImmutableNodes.leafNode(rcLocation, "/rests/streams/xml/" + name))
144 .build().prettyTree().toString(), dataCaptor.getValue().prettyTree().toString());
148 void createStreamWrongValueTest() {
149 final var payload = createInput("path", "String value");
150 final var ex = assertThrows(IllegalArgumentException.class, () -> rpc.invoke(RESTCONF_URI, payload));
152 Bad child leafNode (urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote@2014-01-14)path = \
154 """, ex.getMessage());
158 void createStreamWrongInputRpcTest() {
159 final var future = rpc.invoke(RESTCONF_URI, createInput(null, null));
160 final var errors = assertThrows(RestconfDocumentedException.class, future::getOrThrow).getErrors();
161 assertEquals(1, errors.size());
162 final var error = errors.get(0);
163 assertEquals(ErrorType.APPLICATION, error.getErrorType());
164 assertEquals(ErrorTag.MISSING_ELEMENT, error.getErrorTag());
165 assertEquals("missing path", error.getErrorMessage());
168 private OperationInput createInput(final @Nullable String leafName, final Object leafValue) {
169 final var stack = SchemaInferenceStack.of(SCHEMA_CTX);
170 final var rpcStmt = assertInstanceOf(RpcEffectiveStatement.class,
171 stack.enterSchemaTree(CreateDataChangeEventSubscription.QNAME));
172 final var inference = stack.toInference();
174 final var builder = ImmutableNodes.newContainerBuilder()
175 .withNodeIdentifier(new NodeIdentifier(rpcStmt.input().argument()));
176 if (leafName != null) {
177 final var lfQName = QName.create(rpcStmt.argument(), leafName);
178 stack.enterDataTree(rpcStmt.input().argument());
179 stack.enterDataTree(lfQName);
180 builder.withChild(ImmutableNodes.leafNode(lfQName, leafValue));
182 return new OperationInput(new DatabindPath.Rpc(databindProvider.currentDatabind(), inference, rpcStmt),