netconf/sal-netconf-connector/src/test/java/org/opendaylight/netconf/sal/connect/netconf/NetconfStateSchemasTest.java

   1 /*
   2  * Copyright (c) 2014, 2015 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.netconf.sal.connect.netconf;
   9
  10 import static org.hamcrest.CoreMatchers.hasItem;
  11 import static org.hamcrest.MatcherAssert.assertThat;
  12 import static org.junit.Assert.assertEquals;
  13 import static org.mockito.ArgumentMatchers.any;
  14 import static org.mockito.ArgumentMatchers.eq;
  15 import static org.mockito.Mockito.doReturn;
  16 import static org.mockito.Mockito.mock;
  17 import static org.mockito.Mockito.when;
  18 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
  19 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
  20 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
  21
  22 import com.google.common.util.concurrent.FluentFuture;
  23 import com.google.common.util.concurrent.ListenableFuture;
  24 import java.net.InetSocketAddress;
  25 import java.util.Collections;
  26 import java.util.Set;
  27 import java.util.concurrent.ExecutionException;
  28 import java.util.concurrent.Executors;
  29 import java.util.concurrent.Future;
  30 import java.util.concurrent.TimeUnit;
  31 import org.junit.Assert;
  32 import org.junit.Before;
  33 import org.junit.Ignore;
  34 import org.junit.Test;
  35 import org.junit.runner.RunWith;
  36 import org.mockito.Mock;
  37 import org.mockito.junit.MockitoJUnitRunner;
  38 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
  39 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  40 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  41 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  42 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
  43 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  44 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
  47 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  48 import org.opendaylight.yangtools.yang.common.QName;
  49 import org.opendaylight.yangtools.yang.common.RpcError;
  50 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  52 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  53 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  54 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  56 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  57 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  58 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  59 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  60 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  61 import org.slf4j.Logger;
  62 import org.slf4j.LoggerFactory;
  63
  64 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  65 public class NetconfStateSchemasTest extends AbstractBaseSchemasTest {
  66
  67     private static final Logger LOG = LoggerFactory.getLogger(NetconfStateSchemasTest.class);
  68
  69     private static final NetconfSessionPreferences CAPS = NetconfSessionPreferences.fromStrings(Collections.singleton(
  70         "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?module=ietf-netconf-monitoring&amp;revision=2010-10-04"));
  71     private final RemoteDeviceId deviceId = new RemoteDeviceId("device", new InetSocketAddress(99));
  72     private final int numberOfSchemas = 73;
  73     private final int numberOfLegalSchemas = numberOfSchemas - 3;
  74     private ContainerNode compositeNodeSchemas;
  75
  76     @Mock
  77     private DOMRpcService rpc;
  78
  79     private EffectiveModelContext schemaContext;
  80
  81     @Before
  82     public void setUp() throws Exception {
  83         schemaContext = BASE_SCHEMAS.getBaseSchemaWithNotifications().getEffectiveModelContext();
  84         final DataSchemaNode schemasNode =
  85                 ((ContainerSchemaNode) schemaContext.findDataChildByName(NetconfState.QNAME).orElseThrow())
  86                 .findDataChildByName(Schemas.QNAME).orElseThrow();
  87
  88         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
  89         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
  90         final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext, schemasNode, false);
  91
  92         xmlParser.parse(UntrustedXML.createXMLStreamReader(getClass().getResourceAsStream(
  93                 "/netconf-state.schemas.payload.xml")));
  94         compositeNodeSchemas = (ContainerNode) resultHolder.getResult();
  95
  96     }
  97
  98     @Test
  99     public void testCreate() throws Exception {
 100         final NetconfStateSchemas schemas = NetconfStateSchemas.create(deviceId, compositeNodeSchemas);
 101
 102         final Set<QName> availableYangSchemasQNames = schemas.getAvailableYangSchemasQNames();
 103         assertEquals(numberOfLegalSchemas, availableYangSchemasQNames.size());
 104
 105         assertThat(availableYangSchemasQNames,
 106                 hasItem(QName.create("urn:TBD:params:xml:ns:yang:network-topology", "2013-07-12", "network-topology")));
 107     }
 108
 109     @Ignore
 110     @Test
 111     public void testCreate2() throws Exception {
 112         final ContainerNode netconfState = Builders.containerBuilder()
 113                 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NetconfState.QNAME))
 114                 .withChild(compositeNodeSchemas)
 115                 .build();
 116         final ContainerNode data = Builders.containerBuilder()
 117                 .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
 118                 .withChild(netconfState)
 119                 .build();
 120         final ContainerNode rpcReply = Builders.containerBuilder()
 121                 .withNodeIdentifier(new YangInstanceIdentifier
 122                         .NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME))
 123                 .withChild(data)
 124                 .build();
 125         doReturn(immediateFluentFuture(new DefaultDOMRpcResult(rpcReply))).when(rpc)
 126             .invokeRpc(eq(NETCONF_GET_QNAME), any());
 127         final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
 128         final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
 129         assertEquals(numberOfLegalSchemas, availableYangSchemasQNames.size());
 130
 131         assertThat(availableYangSchemasQNames,
 132                 hasItem(QName.create("urn:TBD:params:xml:ns:yang:network-topology", "2013-07-12", "network-topology")));
 133     }
 134
 135     @Test
 136     public void testCreateMonitoringNotSupported() throws Exception {
 137         final NetconfSessionPreferences caps = NetconfSessionPreferences.fromStrings(Collections.emptySet());
 138         final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, caps, deviceId, schemaContext);
 139         final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
 140         Assert.assertTrue(availableYangSchemasQNames.isEmpty());
 141     }
 142
 143     @Test
 144     public void testCreateFail() throws Exception {
 145         when(rpc.invokeRpc(eq(NETCONF_GET_QNAME), any())).thenReturn(
 146                 immediateFailedFluentFuture(new DOMRpcImplementationNotAvailableException("not available")));
 147         final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
 148         final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
 149         Assert.assertTrue(availableYangSchemasQNames.isEmpty());
 150     }
 151
 152     @Test
 153     public void testCreateRpcError() throws Exception {
 154         final RpcError rpcError = RpcResultBuilder.newError(RpcError.ErrorType.RPC, "fail", "fail");
 155         doReturn(immediateFluentFuture(new DefaultDOMRpcResult(rpcError))).when(rpc)
 156             .invokeRpc(eq(NETCONF_GET_QNAME), any());
 157         final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
 158         final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
 159         Assert.assertTrue(availableYangSchemasQNames.isEmpty());
 160     }
 161
 162     @SuppressWarnings({ "checkstyle:IllegalThrows", "checkstyle:avoidHidingCauseException" })
 163     @Test(expected = RuntimeException.class)
 164     public void testCreateInterrupted() throws Throwable {
 165         //NetconfStateSchemas.create calls Thread.currentThread().interrupt(), so it must run in its own thread
 166         final Future<?> testFuture = Executors.newSingleThreadExecutor().submit(() -> {
 167             final ListenableFuture<DOMRpcResult> interruptedFuture = mock(ListenableFuture.class);
 168             try {
 169                 when(interruptedFuture.get()).thenThrow(new InterruptedException("interrupted"));
 170                 doReturn(FluentFuture.from(interruptedFuture)).when(rpc)
 171                     .invokeRpc(eq(NETCONF_GET_QNAME), any());
 172                 NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
 173             } catch (final InterruptedException | ExecutionException e) {
 174                 LOG.info("Operation failed.", e);
 175             }
 176
 177         });
 178         try {
 179             testFuture.get(3, TimeUnit.SECONDS);
 180         } catch (final ExecutionException e) {
 181             throw e.getCause();
 182         }
 183     }
 184
 185     @Test
 186     public void testRemoteYangSchemaEquals() throws Exception {
 187         final NetconfStateSchemas.RemoteYangSchema schema1 =
 188                 new NetconfStateSchemas.RemoteYangSchema(NetconfState.QNAME);
 189         final NetconfStateSchemas.RemoteYangSchema schema2 =
 190                 new NetconfStateSchemas.RemoteYangSchema(NetconfState.QNAME);
 191         final NetconfStateSchemas.RemoteYangSchema schema3 =
 192                 new NetconfStateSchemas.RemoteYangSchema(Schemas.QNAME);
 193         Assert.assertEquals(schema1, schema2);
 194         Assert.assertEquals(schema2, schema1);
 195         Assert.assertNotEquals(schema1, schema3);
 196         Assert.assertNotEquals(schema2, schema3);
 197     }
 198 }