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.eq;
17 import static org.mockito.Mockito.doNothing;
18 import static org.mockito.Mockito.doReturn;
20 import com.google.common.collect.ImmutableClassToInstanceMap;
22 import java.util.UUID;
23 import org.eclipse.jdt.annotation.Nullable;
24 import org.junit.jupiter.api.BeforeEach;
25 import org.junit.jupiter.api.Test;
26 import org.junit.jupiter.api.extension.ExtendWith;
27 import org.mockito.ArgumentCaptor;
28 import org.mockito.Captor;
29 import org.mockito.Mock;
30 import org.mockito.junit.jupiter.MockitoExtension;
31 import org.opendaylight.mdsal.common.api.CommitInfo;
32 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
33 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
34 import org.opendaylight.mdsal.dom.api.DOMDataTreeChangeService;
35 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction;
36 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
37 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindContext;
38 import org.opendaylight.restconf.nb.rfc8040.databind.DatabindProvider;
39 import org.opendaylight.restconf.server.mdsal.MdsalRestconfStreamRegistry;
40 import org.opendaylight.restconf.server.spi.OperationInput;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.monitoring.rev170126.restconf.state.streams.stream.Access;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.CreateDataChangeEventSubscription;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.CreateDataChangeEventSubscriptionOutput;
44 import org.opendaylight.yangtools.yang.common.ErrorTag;
45 import org.opendaylight.yangtools.yang.common.ErrorType;
46 import org.opendaylight.yangtools.yang.common.QName;
47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
51 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
52 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
53 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
54 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
55 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
56 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
57 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
58 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
60 @ExtendWith(MockitoExtension.class)
61 class CreateNotificationStreamRpcTest {
62 private static final EffectiveModelContext SCHEMA_CTX = YangParserTestUtils.parseYangResourceDirectory("/streams");
63 private static final URI RESTCONF_URI = URI.create("/rests");
64 private static final YangInstanceIdentifier TOASTER = YangInstanceIdentifier.of(
65 QName.create("http://netconfcentral.org/ns/toaster", "2009-11-20", "toaster"));
68 private DOMDataBroker dataBroker;
70 private DOMDataTreeChangeService treeChange;
72 private DOMDataTreeWriteTransaction tx;
74 private ArgumentCaptor<YangInstanceIdentifier> pathCaptor;
76 private ArgumentCaptor<NormalizedNode> dataCaptor;
78 private DatabindProvider databindProvider;
80 private CreateDataChangeEventSubscriptionRpc rpc;
83 public void before() {
84 databindProvider = () -> DatabindContext.ofModel(SCHEMA_CTX);
86 doReturn(ImmutableClassToInstanceMap.of(DOMDataTreeChangeService.class, treeChange))
87 .when(dataBroker).getExtensions();
88 rpc = new CreateDataChangeEventSubscriptionRpc(new MdsalRestconfStreamRegistry(dataBroker), databindProvider,
93 void createStreamTest() {
94 doReturn(tx).when(dataBroker).newWriteOnlyTransaction();
95 doNothing().when(tx).put(eq(LogicalDatastoreType.OPERATIONAL), pathCaptor.capture(), dataCaptor.capture());
96 doReturn(CommitInfo.emptyFluentFuture()).when(tx).commit();
98 final var output = assertInstanceOf(ContainerNode.class, rpc.invoke(RESTCONF_URI, createInput("path", TOASTER))
99 .getOrThrow().output());
101 assertEquals(new NodeIdentifier(CreateDataChangeEventSubscriptionOutput.QNAME), output.name());
102 assertEquals(1, output.size());
104 final var streamName = assertInstanceOf(LeafNode.class,
105 output.childByArg(new NodeIdentifier(
106 QName.create(CreateDataChangeEventSubscriptionOutput.QNAME, "stream-name"))));
107 final var name = assertInstanceOf(String.class, streamName.body());
108 assertEquals(45, name.length());
109 assertThat(name, startsWith("urn:uuid:"));
110 assertNotNull(UUID.fromString(name.substring(9)));
112 final var rcStream = QName.create("urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring", "2017-01-26",
114 final var rcName = QName.create(rcStream, "name");
115 final var streamId = NodeIdentifierWithPredicates.of(rcStream, rcName, name);
116 final var rcEncoding = QName.create(rcStream, "encoding");
117 final var rcLocation = QName.create(rcStream, "location");
119 assertEquals(YangInstanceIdentifier.of(
120 new NodeIdentifier(QName.create(rcStream, "restconf-state")),
121 new NodeIdentifier(QName.create(rcStream, "streams")),
122 new NodeIdentifier(rcStream),
123 streamId), pathCaptor.getValue());
124 assertEquals(Builders.mapEntryBuilder()
125 .withNodeIdentifier(streamId)
126 .withChild(ImmutableNodes.leafNode(rcName, name))
127 .withChild(ImmutableNodes.leafNode(QName.create(rcStream, "description"),
128 "Events occuring in CONFIGURATION datastore under /toaster:toaster"))
129 .withChild(Builders.mapBuilder()
130 .withNodeIdentifier(new NodeIdentifier(Access.QNAME))
131 .withChild(Builders.mapEntryBuilder()
132 .withNodeIdentifier(NodeIdentifierWithPredicates.of(Access.QNAME, rcEncoding, "json"))
133 .withChild(ImmutableNodes.leafNode(rcEncoding, "json"))
134 .withChild(ImmutableNodes.leafNode(rcLocation, "/rests/streams/json/" + name))
136 .withChild(Builders.mapEntryBuilder()
137 .withNodeIdentifier(NodeIdentifierWithPredicates.of(Access.QNAME, rcEncoding, "xml"))
138 .withChild(ImmutableNodes.leafNode(rcEncoding, "xml"))
139 .withChild(ImmutableNodes.leafNode(rcLocation, "/rests/streams/xml/" + name))
142 .build().prettyTree().toString(), dataCaptor.getValue().prettyTree().toString());
146 void createStreamWrongValueTest() {
147 final var payload = createInput("path", "String value");
148 final var ex = assertThrows(IllegalArgumentException.class, () -> rpc.invoke(RESTCONF_URI, payload));
150 Bad child leafNode (urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote@2014-01-14)path = \
152 """, ex.getMessage());
156 void createStreamWrongInputRpcTest() {
157 final var future = rpc.invoke(RESTCONF_URI, createInput(null, null));
158 final var errors = assertThrows(RestconfDocumentedException.class, future::getOrThrow).getErrors();
159 assertEquals(1, errors.size());
160 final var error = errors.get(0);
161 assertEquals(ErrorType.APPLICATION, error.getErrorType());
162 assertEquals(ErrorTag.MISSING_ELEMENT, error.getErrorTag());
163 assertEquals("missing path", error.getErrorMessage());
166 private OperationInput createInput(final @Nullable String leafName, final Object leafValue) {
167 final var stack = SchemaInferenceStack.of(SCHEMA_CTX);
168 final var rpcStmt = assertInstanceOf(RpcEffectiveStatement.class,
169 stack.enterSchemaTree(CreateDataChangeEventSubscription.QNAME));
170 final var inference = stack.toInference();
172 final var builder = Builders.containerBuilder()
173 .withNodeIdentifier(new NodeIdentifier(rpcStmt.input().argument()));
174 if (leafName != null) {
175 final var lfQName = QName.create(rpcStmt.argument(), leafName);
176 stack.enterDataTree(rpcStmt.input().argument());
177 stack.enterDataTree(lfQName);
178 builder.withChild(ImmutableNodes.leafNode(lfQName, leafValue));
180 return new OperationInput(databindProvider.currentContext(), inference, builder.build());