opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/URIParametersParsing.java

   1 /*
   2  * Copyright (c) 2014 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.controller.sal.restconf.impl.test;
   9
  10 import static org.junit.Assert.assertNotNull;
  11 import static org.junit.Assert.assertTrue;
  12 import static org.mockito.Matchers.eq;
  13 import static org.mockito.Mockito.mock;
  14 import static org.mockito.Mockito.when;
  15 import static org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil.getRevisionFormat;
  16 import java.io.FileNotFoundException;
  17 import java.text.ParseException;
  18 import java.util.Date;
  19 import java.util.Set;
  20 import javax.ws.rs.core.MultivaluedMap;
  21 import javax.ws.rs.core.UriBuilder;
  22 import javax.ws.rs.core.UriInfo;
  23 import org.junit.Before;
  24 import org.junit.Ignore;
  25 import org.junit.Test;
  26 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  28 import org.opendaylight.controller.sal.restconf.impl.BrokerFacade;
  29 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
  30 import org.opendaylight.controller.sal.restconf.impl.InstanceIdentifierContext;
  31 import org.opendaylight.controller.sal.restconf.impl.NormalizedNodeContext;
  32 import org.opendaylight.controller.sal.restconf.impl.RestconfImpl;
  33 import org.opendaylight.controller.sal.streams.listeners.ListenerAdapter;
  34 import org.opendaylight.controller.sal.streams.listeners.Notificator;
  35 import org.opendaylight.yangtools.yang.common.QName;
  36 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  42 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder;
  46 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  48 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  49 import org.opendaylight.yangtools.yang.model.api.Module;
  50 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  51 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  52 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
  53
  54 public class URIParametersParsing {
  55
  56     private RestconfImpl restconf;
  57     private BrokerFacade mockedBrokerFacade;
  58     private ControllerContext controllerContext;
  59
  60     @Before
  61     public void init() throws FileNotFoundException {
  62         restconf = RestconfImpl.getInstance();
  63         mockedBrokerFacade = mock(BrokerFacade.class);
  64         controllerContext = ControllerContext.getInstance();
  65         controllerContext.setSchemas(TestUtils.loadSchemaContext("/datastore-and-scope-specification"));
  66         restconf.setControllerContext(controllerContext);
  67         restconf.setBroker(mockedBrokerFacade);
  68     }
  69
  70     @Test
  71     @Ignore // URI parsing test - not able to catch a motivation + bad mocking response now - it needs to change Controller RPC table holder approach
  72     public void resolveURIParametersConcreteValues() {
  73         resolveURIParameters("OPERATIONAL", "SUBTREE", LogicalDatastoreType.OPERATIONAL, DataChangeScope.SUBTREE);
  74     }
  75
  76     @Test
  77     @Ignore // URI parsing test - not able to catch a motivation + bad mocking response now - it needs to change Controller RPC table holder approach
  78     public void resolveURIParametersDefaultValues() {
  79         resolveURIParameters(null, null, LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE);
  80     }
  81
  82     private void resolveURIParameters(final String datastore, final String scope,
  83             final LogicalDatastoreType datastoreExpected, final DataChangeScope scopeExpected) {
  84
  85         final InstanceIdentifierBuilder iiBuilder = YangInstanceIdentifier.builder();
  86         iiBuilder.node(QName.create("dummyStreamName"));
  87
  88         final String datastoreValue = datastore == null ? "CONFIGURATION" : datastore;
  89         final String scopeValue = scope == null ? "BASE" : scope + "";
  90         Notificator.createListener(iiBuilder.build(), "dummyStreamName/datastore=" + datastoreValue + "/scope="
  91                 + scopeValue);
  92
  93         final UriInfo mockedUriInfo = mock(UriInfo.class);
  94         final MultivaluedMap<String, String> mockedMultivaluedMap = mock(MultivaluedMap.class);
  95         when(mockedMultivaluedMap.getFirst(eq("datastore"))).thenReturn(datastoreValue);
  96         when(mockedMultivaluedMap.getFirst(eq("scope"))).thenReturn(scopeValue);
  97
  98         when(mockedUriInfo.getQueryParameters(eq(false))).thenReturn(mockedMultivaluedMap);
  99
 100          final UriBuilder uriBuilder = UriBuilder.fromUri("www.whatever.com");
 101          when(mockedUriInfo.getAbsolutePathBuilder()).thenReturn(uriBuilder);
 102
 103 //       when(mockedBrokerFacade.invokeRpc(any(SchemaPath.class), any(NormalizedNode.class)))
 104 //       .thenReturn(Futures.<DOMRpcResult, DOMRpcException> immediateCheckedFuture(new DefaultDOMRpcResult(Builders.containerBuilder().build())));
 105
 106         restconf.invokeRpc("sal-remote:create-data-change-event-subscription", prepareDomRpcNode(datastore, scope),
 107                 mockedUriInfo);
 108
 109         final ListenerAdapter listener = Notificator.getListenerFor("opendaylight-inventory:nodes/datastore="
 110                 + datastoreValue + "/scope=" + scopeValue);
 111         assertNotNull(listener);
 112
 113     }
 114
 115     private NormalizedNodeContext prepareDomRpcNode(final String datastore, final String scope) {
 116         final SchemaContext schema = controllerContext.getGlobalSchema();
 117         final Date revDate;
 118         try {
 119             revDate = getRevisionFormat().parse("2014-01-14");
 120         }
 121         catch (final ParseException e) {
 122             throw new IllegalStateException(e);
 123         }
 124         final Module rpcSalRemoteModule = schema.findModuleByName("sal-remote", revDate);
 125         final Set<RpcDefinition> setRpcs = rpcSalRemoteModule.getRpcs();
 126         final QName rpcQName = QName.create(rpcSalRemoteModule.getQNameModule(), "create-data-change-event-subscription");
 127         final QName rpcInputQName = QName.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote","2014-01-14","input");
 128         ContainerSchemaNode rpcInputSchemaNode = null;
 129         for (final RpcDefinition rpc : setRpcs) {
 130             if (rpcQName.isEqualWithoutRevision(rpc.getQName())) {
 131                 rpcInputSchemaNode = SchemaNodeUtils.getRpcDataSchema(rpc, rpcInputQName);
 132                 break;
 133             }
 134         }
 135         assertNotNull("RPC ContainerSchemaNode was not found!", rpcInputSchemaNode);
 136
 137         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> container = Builders.containerBuilder(rpcInputSchemaNode);
 138
 139         final QName pathQName = QName.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "2014-01-14", "path");
 140         final DataSchemaNode pathSchemaNode = rpcInputSchemaNode.getDataChildByName(pathQName);
 141         assertTrue(pathSchemaNode instanceof LeafSchemaNode);
 142         final LeafNode<Object> pathNode = (Builders.leafBuilder((LeafSchemaNode) pathSchemaNode)
 143                 .withValue(YangInstanceIdentifier.builder().node(QName.create("urn:opendaylight:inventory", "2013-08-19", "nodes")).build())).build();
 144         container.withChild(pathNode);
 145
 146         final QName dataStoreQName = QName.create("urn:sal:restconf:event:subscription", "2014-7-8", "datastore");
 147         final DataSchemaNode dsSchemaNode = rpcInputSchemaNode.getDataChildByName(dataStoreQName);
 148         assertTrue(dsSchemaNode instanceof LeafSchemaNode);
 149         final LeafNode<Object> dsNode = (Builders.leafBuilder((LeafSchemaNode) dsSchemaNode)
 150                 .withValue(datastore)).build();
 151         container.withChild(dsNode);
 152
 153         final QName scopeQName = QName.create("urn:sal:restconf:event:subscription", "2014-7-8", "scope");
 154         final DataSchemaNode scopeSchemaNode = rpcInputSchemaNode.getDataChildByName(scopeQName);
 155         assertTrue(scopeSchemaNode instanceof LeafSchemaNode);
 156         final LeafNode<Object> scopeNode = (Builders.leafBuilder((LeafSchemaNode) scopeSchemaNode)
 157                 .withValue(scope)).build();
 158         container.withChild(scopeNode);
 159
 160         return new NormalizedNodeContext(new InstanceIdentifierContext(null, rpcInputSchemaNode, null, schema), container.build());
 161     }
 162
 163     /**
 164      * @deprecated method has to be removed for a Lithium release
 165      */
 166     @Deprecated
 167     private CompositeNode prepareRpcNode(final String datastore, final String scope) {
 168         final CompositeNodeBuilder<ImmutableCompositeNode> inputBuilder = ImmutableCompositeNode.builder();
 169         inputBuilder.setQName(QName.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote",
 170                 "2014-01-14", "input"));
 171         inputBuilder.addLeaf(
 172                 QName.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "2014-01-14", "path"),
 173                 YangInstanceIdentifier.builder().node(QName.create("urn:opendaylight:inventory", "2013-08-19", "nodes")).build());
 174         inputBuilder.addLeaf(QName.create("urn:sal:restconf:event:subscription", "2014-7-8", "datastore"), datastore);
 175         inputBuilder.addLeaf(QName.create("urn:sal:restconf:event:subscription", "2014-7-8", "scope"), scope);
 176         return inputBuilder.toInstance();
 177     }
 178 }