restconf/restconf-nb/src/test/java/org/opendaylight/restconf/server/mdsal/streams/dtcl/CreateNotificationStreamRpcTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.restconf.server.mdsal.streams.dtcl;
   9
  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;
  21
  22 import java.net.URI;
  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.restconf.server.testlib.CompletingServerRequest;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.restconf.monitoring.rev170126.restconf.state.streams.stream.Access;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.CreateDataChangeEventSubscription;
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.remote.rev140114.CreateDataChangeEventSubscriptionOutput;
  48 import org.opendaylight.yangtools.yang.common.ErrorTag;
  49 import org.opendaylight.yangtools.yang.common.ErrorType;
  50 import org.opendaylight.yangtools.yang.common.QName;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  53 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  54 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  55 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  57 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
  58 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  59 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
  60 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
  61 import org.opendaylight.yangtools.yang.test.util.YangParserTestUtils;
  62
  63 @ExtendWith(MockitoExtension.class)
  64 class CreateNotificationStreamRpcTest {
  65     private static final EffectiveModelContext SCHEMA_CTX = YangParserTestUtils.parseYangResourceDirectory("/streams");
  66     private static final URI RESTCONF_URI = URI.create("/rests/");
  67     private static final YangInstanceIdentifier TOASTER = YangInstanceIdentifier.of(
  68         QName.create("http://netconfcentral.org/ns/toaster", "2009-11-20", "toaster"));
  69
  70     private final CompletingServerRequest<ContainerNode> request = new CompletingServerRequest<>();
  71
  72     @Mock
  73     private DOMDataBroker dataBroker;
  74     @Mock
  75     private DataTreeChangeExtension treeChange;
  76     @Mock
  77     private DOMDataTreeWriteTransaction tx;
  78     @Captor
  79     private ArgumentCaptor<YangInstanceIdentifier> pathCaptor;
  80     @Captor
  81     private ArgumentCaptor<NormalizedNode> dataCaptor;
  82
  83     private DatabindProvider databindProvider;
  84
  85     private CreateDataChangeEventSubscriptionRpc rpc;
  86
  87     @BeforeEach
  88     public void before() {
  89         databindProvider = () -> DatabindContext.ofModel(SCHEMA_CTX);
  90
  91         doReturn(List.of(treeChange)).when(dataBroker).supportedExtensions();
  92         doCallRealMethod().when(dataBroker).extension(any());
  93         rpc = new CreateDataChangeEventSubscriptionRpc(new MdsalRestconfStreamRegistry(dataBroker), databindProvider,
  94             dataBroker);
  95     }
  96
  97     @Test
  98     void createStreamTest() throws Exception {
  99         doReturn(tx).when(dataBroker).newWriteOnlyTransaction();
 100         doNothing().when(tx).put(eq(LogicalDatastoreType.OPERATIONAL), pathCaptor.capture(), dataCaptor.capture());
 101         doReturn(CommitInfo.emptyFluentFuture()).when(tx).commit();
 102
 103         rpc.invoke(request, RESTCONF_URI, createInput("path", TOASTER));
 104
 105         final var output = request.getResult();
 106         assertEquals(new NodeIdentifier(CreateDataChangeEventSubscriptionOutput.QNAME), output.name());
 107         assertEquals(1, output.size());
 108
 109         final var streamName = assertInstanceOf(LeafNode.class,
 110             output.childByArg(new NodeIdentifier(
 111                 QName.create(CreateDataChangeEventSubscriptionOutput.QNAME, "stream-name"))));
 112         final var name = assertInstanceOf(String.class, streamName.body());
 113         assertEquals(45, name.length());
 114         assertThat(name, startsWith("urn:uuid:"));
 115         assertNotNull(UUID.fromString(name.substring(9)));
 116
 117         final var rcStream = QName.create("urn:ietf:params:xml:ns:yang:ietf-restconf-monitoring", "2017-01-26",
 118             "stream");
 119         final var rcName = QName.create(rcStream, "name");
 120         final var streamId = NodeIdentifierWithPredicates.of(rcStream, rcName, name);
 121         final var rcEncoding = QName.create(rcStream, "encoding");
 122         final var rcLocation = QName.create(rcStream, "location");
 123
 124         assertEquals(YangInstanceIdentifier.of(
 125             new NodeIdentifier(QName.create(rcStream, "restconf-state")),
 126             new NodeIdentifier(QName.create(rcStream, "streams")),
 127             new NodeIdentifier(rcStream),
 128             streamId), pathCaptor.getValue());
 129         assertEquals(ImmutableNodes.newMapEntryBuilder()
 130             .withNodeIdentifier(streamId)
 131             .withChild(ImmutableNodes.leafNode(rcName, name))
 132             .withChild(ImmutableNodes.leafNode(QName.create(rcStream, "description"),
 133                 "Events occuring in CONFIGURATION datastore under /toaster:toaster"))
 134             .withChild(ImmutableNodes.newSystemMapBuilder()
 135                 .withNodeIdentifier(new NodeIdentifier(Access.QNAME))
 136                 .withChild(ImmutableNodes.newMapEntryBuilder()
 137                     .withNodeIdentifier(NodeIdentifierWithPredicates.of(Access.QNAME, rcEncoding, "json"))
 138                     .withChild(ImmutableNodes.leafNode(rcEncoding, "json"))
 139                     .withChild(ImmutableNodes.leafNode(rcLocation, "/rests/streams/json/" + name))
 140                     .build())
 141                 .withChild(ImmutableNodes.newMapEntryBuilder()
 142                     .withNodeIdentifier(NodeIdentifierWithPredicates.of(Access.QNAME, rcEncoding, "xml"))
 143                     .withChild(ImmutableNodes.leafNode(rcEncoding, "xml"))
 144                     .withChild(ImmutableNodes.leafNode(rcLocation, "/rests/streams/xml/" + name))
 145                     .build())
 146                 .build())
 147             .build().prettyTree().toString(), dataCaptor.getValue().prettyTree().toString());
 148     }
 149
 150     @Test
 151     void createStreamWrongValueTest() {
 152         rpc.invoke(request, RESTCONF_URI, createInput("path", "String value"));
 153
 154         final var ex = assertThrows(RestconfDocumentedException.class, request::getResult);
 155         final var errors = ex.getErrors();
 156         assertEquals(1, errors.size());
 157         final var error = errors.get(0);
 158         assertEquals(ErrorType.APPLICATION, error.getErrorType());
 159         assertEquals(ErrorTag.BAD_ELEMENT, error.getErrorTag());
 160         assertEquals("""
 161             Bad child leafNode (urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote@2014-01-14)path = \
 162             "String value"\
 163             """, error.getErrorMessage());
 164     }
 165
 166     @Test
 167     void createStreamWrongInputRpcTest() {
 168         rpc.invoke(request, RESTCONF_URI, createInput(null, null));
 169
 170         final var ex = assertThrows(RestconfDocumentedException.class, request::getResult);
 171         final var errors = ex.getErrors();
 172         assertEquals(1, errors.size());
 173         final var error = errors.get(0);
 174         assertEquals(ErrorType.APPLICATION, error.getErrorType());
 175         assertEquals(ErrorTag.MISSING_ELEMENT, error.getErrorTag());
 176         assertEquals("missing path", error.getErrorMessage());
 177     }
 178
 179     private OperationInput createInput(final @Nullable String leafName, final Object leafValue) {
 180         final var stack = SchemaInferenceStack.of(SCHEMA_CTX);
 181         final var rpcStmt = assertInstanceOf(RpcEffectiveStatement.class,
 182             stack.enterSchemaTree(CreateDataChangeEventSubscription.QNAME));
 183         final var inference = stack.toInference();
 184
 185         final var builder = ImmutableNodes.newContainerBuilder()
 186             .withNodeIdentifier(new NodeIdentifier(rpcStmt.input().argument()));
 187         if (leafName != null) {
 188             final var lfQName = QName.create(rpcStmt.argument(), leafName);
 189             stack.enterDataTree(rpcStmt.input().argument());
 190             stack.enterDataTree(lfQName);
 191             builder.withChild(ImmutableNodes.leafNode(lfQName, leafValue));
 192         }
 193         return new OperationInput(new DatabindPath.Rpc(databindProvider.currentDatabind(), inference, rpcStmt),
 194             builder.build());
 195     }
 196 }