2 * Copyright (c) 2014, 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.netconf.sal.connect.netconf;
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.junit.Assert.assertNotEquals;
14 import static org.junit.Assert.assertTrue;
15 import static org.mockito.ArgumentMatchers.any;
16 import static org.mockito.ArgumentMatchers.eq;
17 import static org.mockito.Mockito.doReturn;
18 import static org.mockito.Mockito.mock;
19 import static org.mockito.Mockito.when;
20 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
21 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFailedFluentFuture;
22 import static org.opendaylight.yangtools.util.concurrent.FluentFutures.immediateFluentFuture;
24 import com.google.common.util.concurrent.FluentFuture;
25 import com.google.common.util.concurrent.ListenableFuture;
26 import java.net.InetSocketAddress;
27 import java.util.Collections;
29 import java.util.concurrent.ExecutionException;
30 import java.util.concurrent.Executors;
31 import java.util.concurrent.Future;
32 import java.util.concurrent.TimeUnit;
33 import org.junit.Before;
34 import org.junit.Ignore;
35 import org.junit.Test;
36 import org.junit.runner.RunWith;
37 import org.mockito.Mock;
38 import org.mockito.junit.MockitoJUnitRunner;
39 import org.opendaylight.mdsal.dom.api.DOMRpcImplementationNotAvailableException;
40 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
41 import org.opendaylight.mdsal.dom.api.DOMRpcService;
42 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
43 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfSessionPreferences;
44 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
45 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
48 import org.opendaylight.yangtools.util.xml.UntrustedXML;
49 import org.opendaylight.yangtools.yang.common.QName;
50 import org.opendaylight.yangtools.yang.common.RpcError;
51 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
52 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
55 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
56 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
57 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
58 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
59 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
60 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
64 @RunWith(MockitoJUnitRunner.StrictStubs.class)
65 public class NetconfStateSchemasTest extends AbstractBaseSchemasTest {
67 private static final Logger LOG = LoggerFactory.getLogger(NetconfStateSchemasTest.class);
69 private static final NetconfSessionPreferences CAPS = NetconfSessionPreferences.fromStrings(Collections.singleton(
70 "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring?module=ietf-netconf-monitoring&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;
77 private DOMRpcService rpc;
79 private EffectiveModelContext schemaContext;
82 public void setUp() throws Exception {
83 schemaContext = BASE_SCHEMAS.getBaseSchemaWithNotifications().getEffectiveModelContext();
85 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
86 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
87 final XmlParserStream xmlParser = XmlParserStream.create(writer,
88 SchemaInferenceStack.ofDataTreePath(schemaContext, NetconfState.QNAME, Schemas.QNAME).toInference(), false);
90 xmlParser.parse(UntrustedXML.createXMLStreamReader(getClass().getResourceAsStream(
91 "/netconf-state.schemas.payload.xml")));
92 compositeNodeSchemas = (ContainerNode) resultHolder.getResult();
96 public void testCreate() throws Exception {
97 final NetconfStateSchemas schemas = NetconfStateSchemas.create(deviceId, compositeNodeSchemas);
99 final Set<QName> availableYangSchemasQNames = schemas.getAvailableYangSchemasQNames();
100 assertEquals(numberOfLegalSchemas, availableYangSchemasQNames.size());
102 assertThat(availableYangSchemasQNames,
103 hasItem(QName.create("urn:TBD:params:xml:ns:yang:network-topology", "2013-07-12", "network-topology")));
108 public void testCreate2() throws Exception {
109 final ContainerNode netconfState = Builders.containerBuilder()
110 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NetconfState.QNAME))
111 .withChild(compositeNodeSchemas)
113 final ContainerNode data = Builders.containerBuilder()
114 .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
115 .withChild(netconfState)
117 final ContainerNode rpcReply = Builders.containerBuilder()
118 .withNodeIdentifier(new YangInstanceIdentifier
119 .NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME))
122 doReturn(immediateFluentFuture(new DefaultDOMRpcResult(rpcReply))).when(rpc)
123 .invokeRpc(eq(NETCONF_GET_QNAME), any());
124 final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
125 final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
126 assertEquals(numberOfLegalSchemas, availableYangSchemasQNames.size());
128 assertThat(availableYangSchemasQNames,
129 hasItem(QName.create("urn:TBD:params:xml:ns:yang:network-topology", "2013-07-12", "network-topology")));
133 public void testCreateMonitoringNotSupported() throws Exception {
134 final NetconfSessionPreferences caps = NetconfSessionPreferences.fromStrings(Collections.emptySet());
135 final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, caps, deviceId, schemaContext);
136 final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
137 assertTrue(availableYangSchemasQNames.isEmpty());
141 public void testCreateFail() throws Exception {
142 when(rpc.invokeRpc(eq(NETCONF_GET_QNAME), any())).thenReturn(
143 immediateFailedFluentFuture(new DOMRpcImplementationNotAvailableException("not available")));
144 final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
145 final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
146 assertTrue(availableYangSchemasQNames.isEmpty());
150 public void testCreateRpcError() throws Exception {
151 final RpcError rpcError = RpcResultBuilder.newError(RpcError.ErrorType.RPC, "fail", "fail");
152 doReturn(immediateFluentFuture(new DefaultDOMRpcResult(rpcError))).when(rpc)
153 .invokeRpc(eq(NETCONF_GET_QNAME), any());
154 final NetconfStateSchemas stateSchemas = NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
155 final Set<QName> availableYangSchemasQNames = stateSchemas.getAvailableYangSchemasQNames();
156 assertTrue(availableYangSchemasQNames.isEmpty());
159 @SuppressWarnings({ "checkstyle:IllegalThrows", "checkstyle:avoidHidingCauseException" })
160 @Test(expected = RuntimeException.class)
161 public void testCreateInterrupted() throws Throwable {
162 //NetconfStateSchemas.create calls Thread.currentThread().interrupt(), so it must run in its own thread
163 final Future<?> testFuture = Executors.newSingleThreadExecutor().submit(() -> {
164 final ListenableFuture<DOMRpcResult> interruptedFuture = mock(ListenableFuture.class);
166 when(interruptedFuture.get()).thenThrow(new InterruptedException("interrupted"));
167 doReturn(FluentFuture.from(interruptedFuture)).when(rpc)
168 .invokeRpc(eq(NETCONF_GET_QNAME), any());
169 NetconfStateSchemas.create(rpc, CAPS, deviceId, schemaContext);
170 } catch (final InterruptedException | ExecutionException e) {
171 LOG.info("Operation failed.", e);
176 testFuture.get(3, TimeUnit.SECONDS);
177 } catch (final ExecutionException e) {
183 public void testRemoteYangSchemaEquals() throws Exception {
184 final NetconfStateSchemas.RemoteYangSchema schema1 =
185 new NetconfStateSchemas.RemoteYangSchema(NetconfState.QNAME);
186 final NetconfStateSchemas.RemoteYangSchema schema2 =
187 new NetconfStateSchemas.RemoteYangSchema(NetconfState.QNAME);
188 final NetconfStateSchemas.RemoteYangSchema schema3 =
189 new NetconfStateSchemas.RemoteYangSchema(Schemas.QNAME);
190 assertEquals(schema1, schema2);
191 assertEquals(schema2, schema1);
192 assertNotEquals(schema1, schema3);
193 assertNotEquals(schema2, schema3);