restconf/restconf-nb-bierman02/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
  17 import com.google.common.base.Preconditions;
  18 import java.io.FileNotFoundException;
  19 import java.text.ParseException;
  20 import java.util.Date;
  21 import java.util.Set;
  22 import javax.ws.rs.core.MultivaluedMap;
  23 import javax.ws.rs.core.UriBuilder;
  24 import javax.ws.rs.core.UriInfo;
  25 import org.junit.Before;
  26 import org.junit.Test;
  27 import org.mockito.Mockito;
  28 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  29 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  30 import org.opendaylight.netconf.sal.restconf.impl.BrokerFacade;
  31 import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
  32 import org.opendaylight.netconf.sal.restconf.impl.InstanceIdentifierContext;
  33 import org.opendaylight.netconf.sal.restconf.impl.NormalizedNodeContext;
  34 import org.opendaylight.netconf.sal.restconf.impl.RestconfImpl;
  35 import org.opendaylight.netconf.sal.streams.listeners.ListenerAdapter;
  36 import org.opendaylight.netconf.sal.streams.listeners.Notificator;
  37 import org.opendaylight.yang.gen.v1.urn.sal.restconf.event.subscription.rev140708.NotificationOutputTypeGrouping.NotificationOutputType;
  38 import org.opendaylight.yangtools.yang.common.QName;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  41 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder;
  42 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  43 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  45 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  49 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
  50 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  52 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  53 import org.opendaylight.yangtools.yang.model.api.Module;
  54 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  55 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  56 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  57 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
  58 import org.opendaylight.yangtools.yang.parser.spi.meta.ReactorException;
  59
  60 public class URIParametersParsing {
  61
  62     private RestconfImpl restconf;
  63     private BrokerFacade mockedBrokerFacade;
  64     private ControllerContext controllerContext;
  65
  66     @Before
  67     public void init() throws FileNotFoundException, ReactorException {
  68         this.restconf = RestconfImpl.getInstance();
  69         this.mockedBrokerFacade = mock(BrokerFacade.class);
  70         this.controllerContext = ControllerContext.getInstance();
  71         this.controllerContext.setSchemas(TestUtils.loadSchemaContext("/datastore-and-scope-specification"));
  72         this.restconf.setControllerContext(this.controllerContext);
  73         this.restconf.setBroker(this.mockedBrokerFacade);
  74     }
  75
  76     @Test
  77     public void resolveURIParametersConcreteValues() {
  78         resolveURIParameters("OPERATIONAL", "SUBTREE", LogicalDatastoreType.OPERATIONAL, DataChangeScope.SUBTREE);
  79     }
  80
  81     @Test
  82     public void resolveURIParametersDefaultValues() {
  83         resolveURIParameters(null, null, LogicalDatastoreType.CONFIGURATION, DataChangeScope.BASE);
  84     }
  85
  86     private void resolveURIParameters(final String datastore, final String scope,
  87             final LogicalDatastoreType datastoreExpected, final DataChangeScope scopeExpected) {
  88
  89         final InstanceIdentifierBuilder iiBuilder = YangInstanceIdentifier.builder();
  90         iiBuilder.node(QName.create("dummyStreamName"));
  91
  92         final String datastoreValue = datastore == null ? "CONFIGURATION" : datastore;
  93         final String scopeValue = scope == null ? "BASE" : scope + "";
  94         Notificator.createListener(iiBuilder.build(), "dummyStreamName/datastore=" + datastoreValue + "/scope="
  95                 + scopeValue, NotificationOutputType.XML);
  96
  97         final UriInfo mockedUriInfo = mock(UriInfo.class);
  98         @SuppressWarnings("unchecked")
  99         final MultivaluedMap<String, String> mockedMultivaluedMap = mock(MultivaluedMap.class);
 100         when(mockedMultivaluedMap.getFirst(eq("datastore"))).thenReturn(datastoreValue);
 101         when(mockedMultivaluedMap.getFirst(eq("scope"))).thenReturn(scopeValue);
 102
 103         when(mockedUriInfo.getQueryParameters(eq(false))).thenReturn(mockedMultivaluedMap);
 104
 105         final UriBuilder uriBuilder = UriBuilder.fromUri("www.whatever.com");
 106         when(mockedUriInfo.getAbsolutePathBuilder()).thenReturn(uriBuilder);
 107
 108         this.restconf.invokeRpc("sal-remote:create-data-change-event-subscription", prepareDomRpcNode(datastore, scope),
 109                 mockedUriInfo);
 110
 111         final ListenerAdapter listener =
 112                 Notificator.getListenerFor("data-change-event-subscription/opendaylight-inventory:nodes/datastore="
 113                 + datastoreValue + "/scope=" + scopeValue);
 114         assertNotNull(listener);
 115     }
 116
 117     private NormalizedNodeContext prepareDomRpcNode(final String datastore, final String scope) {
 118         final SchemaContext schema = this.controllerContext.getGlobalSchema();
 119         final Date revDate;
 120         try {
 121             revDate = getRevisionFormat().parse("2014-01-14");
 122         } catch (final ParseException e) {
 123             throw new IllegalStateException(e);
 124         }
 125         final Module rpcSalRemoteModule = schema.findModuleByName("sal-remote", revDate);
 126         final Set<RpcDefinition> setRpcs = rpcSalRemoteModule.getRpcs();
 127         final QName rpcQName =
 128                 QName.create(rpcSalRemoteModule.getQNameModule(), "create-data-change-event-subscription");
 129         final QName rpcInputQName =
 130                 QName.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "2014-01-14", "input");
 131         final RpcDefinition rpcDef = Mockito.mock(RpcDefinition.class);
 132         ContainerSchemaNode rpcInputSchemaNode = null;
 133         for (final RpcDefinition rpc : setRpcs) {
 134             if (rpcQName.isEqualWithoutRevision(rpc.getQName())) {
 135                 rpcInputSchemaNode = SchemaNodeUtils.getRpcDataSchema(rpc, rpcInputQName);
 136                 break;
 137             }
 138         }
 139         assertNotNull("RPC ContainerSchemaNode was not found!", rpcInputSchemaNode);
 140
 141         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> container =
 142                 Builders.containerBuilder(rpcInputSchemaNode);
 143
 144         final QName pathQName =
 145                 QName.create("urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote", "2014-01-14", "path");
 146         final DataSchemaNode pathSchemaNode = rpcInputSchemaNode.getDataChildByName(pathQName);
 147         assertTrue(pathSchemaNode instanceof LeafSchemaNode);
 148         final LeafNode<Object> pathNode = (Builders.leafBuilder((LeafSchemaNode) pathSchemaNode)
 149                 .withValue(YangInstanceIdentifier.builder()
 150                         .node(QName.create("urn:opendaylight:inventory", "2013-08-19", "nodes")).build())).build();
 151         container.withChild(pathNode);
 152
 153         final AugmentationSchema augmentationSchema = rpcInputSchemaNode.getAvailableAugmentations().iterator().next();
 154         Preconditions.checkNotNull(augmentationSchema);
 155         final DataContainerNodeBuilder<AugmentationIdentifier, AugmentationNode> augmentationBuilder =
 156                 Builders.augmentationBuilder(augmentationSchema);
 157
 158         final QName dataStoreQName = QName.create("urn:sal:restconf:event:subscription", "2014-7-8", "datastore");
 159         final DataSchemaNode dsSchemaNode = augmentationSchema.getDataChildByName(dataStoreQName);
 160         assertTrue(dsSchemaNode instanceof LeafSchemaNode);
 161         final LeafNode<Object> dsNode = (Builders.leafBuilder((LeafSchemaNode) dsSchemaNode)
 162                 .withValue(datastore)).build();
 163         augmentationBuilder.withChild(dsNode);
 164
 165         final QName scopeQName = QName.create("urn:sal:restconf:event:subscription", "2014-7-8", "scope");
 166         final DataSchemaNode scopeSchemaNode = augmentationSchema.getDataChildByName(scopeQName);
 167         assertTrue(scopeSchemaNode instanceof LeafSchemaNode);
 168         final LeafNode<Object> scopeNode = (Builders.leafBuilder((LeafSchemaNode) scopeSchemaNode)
 169                 .withValue(scope)).build();
 170         augmentationBuilder.withChild(scopeNode);
 171
 172         final QName outputQName =
 173                 QName.create("urn:sal:restconf:event:subscription", "2014-7-8", "notification-output-type");
 174         final DataSchemaNode outputSchemaNode = augmentationSchema.getDataChildByName(outputQName);
 175         assertTrue(outputSchemaNode instanceof LeafSchemaNode);
 176         final LeafNode<Object> outputNode =
 177                 (Builders.leafBuilder((LeafSchemaNode) outputSchemaNode).withValue("XML")).build();
 178         augmentationBuilder.withChild(outputNode);
 179
 180         container.withChild(augmentationBuilder.build());
 181
 182         when(rpcDef.getInput()).thenReturn(rpcInputSchemaNode);
 183         when(rpcDef.getPath()).thenReturn(SchemaPath.create(true, rpcQName));
 184         when(rpcDef.getQName()).thenReturn(rpcQName);
 185
 186         return new NormalizedNodeContext(new InstanceIdentifierContext<RpcDefinition>(null, rpcDef, null, schema),
 187                 container.build());
 188     }
 189 }