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