2 * Copyright (c) 2013 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
9 package org.opendaylight.controller.netconf.confignetconfconnector;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Lists;
14 import com.google.common.collect.Maps;
15 import org.junit.Before;
16 import org.junit.Ignore;
17 import org.junit.Test;
18 import org.junit.matchers.JUnitMatchers;
19 import org.mockito.Mock;
20 import org.mockito.MockitoAnnotations;
21 import org.opendaylight.controller.config.manager.impl.AbstractConfigTest;
22 import org.opendaylight.controller.config.manager.impl.factoriesresolver.HardcodedModuleFactoriesResolver;
23 import org.opendaylight.controller.config.util.ConfigTransactionJMXClient;
24 import org.opendaylight.controller.config.yang.store.api.YangStoreSnapshot;
25 import org.opendaylight.controller.config.yang.store.impl.MbeParser;
26 import org.opendaylight.controller.config.yang.test.impl.ComplexDtoBInner;
27 import org.opendaylight.controller.config.yang.test.impl.ComplexList;
28 import org.opendaylight.controller.config.yang.test.impl.Deep;
29 import org.opendaylight.controller.config.yang.test.impl.DepTestImplModuleFactory;
30 import org.opendaylight.controller.config.yang.test.impl.DtoAInner;
31 import org.opendaylight.controller.config.yang.test.impl.DtoAInnerInner;
32 import org.opendaylight.controller.config.yang.test.impl.DtoC;
33 import org.opendaylight.controller.config.yang.test.impl.DtoD;
34 import org.opendaylight.controller.config.yang.test.impl.NetconfTestImplModuleFactory;
35 import org.opendaylight.controller.config.yang.test.impl.NetconfTestImplModuleMXBean;
36 import org.opendaylight.controller.config.yang.test.impl.Peers;
37 import org.opendaylight.controller.config.yangjmxgenerator.ModuleMXBeanEntry;
38 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
39 import org.opendaylight.controller.netconf.api.NetconfOperationRouter;
40 import org.opendaylight.controller.netconf.confignetconfconnector.operations.Commit;
41 import org.opendaylight.controller.netconf.confignetconfconnector.operations.DiscardChanges;
42 import org.opendaylight.controller.netconf.confignetconfconnector.operations.editconfig.EditConfig;
43 import org.opendaylight.controller.netconf.confignetconfconnector.operations.get.Get;
44 import org.opendaylight.controller.netconf.confignetconfconnector.operations.getconfig.GetConfig;
45 import org.opendaylight.controller.netconf.confignetconfconnector.operations.runtimerpc.RuntimeRpc;
46 import org.opendaylight.controller.netconf.confignetconfconnector.transactions.TransactionProvider;
47 import org.opendaylight.controller.netconf.impl.mapping.operations.DefaultCloseSession;
48 import org.opendaylight.controller.netconf.mapping.api.HandlingPriority;
49 import org.opendaylight.controller.netconf.mapping.api.NetconfOperation;
50 import org.opendaylight.controller.netconf.util.test.XmlFileLoader;
51 import org.opendaylight.controller.netconf.util.xml.XmlElement;
52 import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
53 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
56 import org.w3c.dom.Document;
57 import org.w3c.dom.Element;
58 import org.w3c.dom.NodeList;
59 import org.xml.sax.SAXException;
61 import javax.management.InstanceAlreadyExistsException;
62 import javax.management.ObjectName;
63 import javax.xml.parsers.ParserConfigurationException;
64 import java.io.FileNotFoundException;
65 import java.io.IOException;
66 import java.io.InputStream;
67 import java.math.BigInteger;
68 import java.util.ArrayList;
69 import java.util.Arrays;
70 import java.util.Collection;
71 import java.util.List;
74 import static org.junit.Assert.assertEquals;
75 import static org.junit.Assert.assertThat;
76 import static org.junit.Assert.fail;
77 import static org.mockito.Mockito.doNothing;
78 import static org.mockito.Mockito.doReturn;
79 import static org.mockito.Mockito.verify;
80 import static org.mockito.Mockito.verifyNoMoreInteractions;
83 public class NetconfMappingTest extends AbstractConfigTest {
84 private static final Logger logger = LoggerFactory.getLogger(NetconfMappingTest.class);
86 private static final String INSTANCE_NAME = "test1";
87 private static final String NETCONF_SESSION_ID = "foo";
88 private NetconfTestImplModuleFactory factory;
89 private DepTestImplModuleFactory factory2;
92 YangStoreSnapshot yangStoreSnapshot;
94 NetconfOperationRouter netconfOperationRouter;
96 private TransactionProvider transactionProvider;
99 public void setUp() throws Exception {
100 MockitoAnnotations.initMocks(this);
101 doReturn(getMbes()).when(this.yangStoreSnapshot).getModuleMXBeanEntryMap();
102 this.factory = new NetconfTestImplModuleFactory();
103 this.factory2 = new DepTestImplModuleFactory();
104 super.initConfigTransactionManagerImpl(new HardcodedModuleFactoriesResolver(this.factory, this.factory2));
106 transactionProvider = new TransactionProvider(this.configRegistryClient, NETCONF_SESSION_ID);
109 private ObjectName createModule(final String instanceName) throws InstanceAlreadyExistsException {
110 final ConfigTransactionJMXClient transaction = this.configRegistryClient.createTransaction();
112 final ObjectName on = transaction.createModule(this.factory.getImplementationName(), instanceName);
113 final NetconfTestImplModuleMXBean mxBean = transaction.newMXBeanProxy(on, NetconfTestImplModuleMXBean.class);
114 setModule(mxBean, transaction);
116 transaction.commit();
121 public void testConfigNetconf() throws Exception {
123 createModule(INSTANCE_NAME);
125 edit("netconfMessages/editConfig.xml");
126 checkBinaryLeafEdited(getConfigCandidate());
128 // default-operation:none, should not affect binary leaf
129 edit("netconfMessages/editConfig_none.xml");
130 checkBinaryLeafEdited(getConfigCandidate());
134 Element response = getConfigRunning();
136 checkBinaryLeafEdited(response);
137 checkTypeConfigAttribute(response);
138 checkTypedefs(response);
141 edit("netconfMessages/editConfig_remove.xml");
144 response = getConfigCandidate();
145 final String responseFromCandidate = XmlUtil.toString(response).replaceAll("\\s+", "");
146 // System.out.println(responseFromCandidate);
147 response = getConfigRunning();
148 final String responseFromRunning = XmlUtil.toString(response).replaceAll("\\s+", "");
149 // System.out.println(responseFromRunning);
150 assertEquals(responseFromCandidate, responseFromRunning);
152 final String expectedResult = XmlFileLoader.fileToString("netconfMessages/editConfig_expectedResult.xml")
153 .replaceAll("\\s+", "");
155 assertEquals(expectedResult, responseFromRunning);
156 assertEquals(expectedResult, responseFromCandidate);
158 edit("netconfMessages/editConfig_none.xml");
159 doNothing().when(netconfOperationRouter).close();
161 verify(netconfOperationRouter).close();
162 verifyNoMoreInteractions(netconfOperationRouter);
165 private void closeSession() throws NetconfDocumentedException, ParserConfigurationException, SAXException,
167 DefaultCloseSession closeOp = new DefaultCloseSession(NETCONF_SESSION_ID);
168 executeOp(closeOp, "netconfMessages/closeSession.xml");
171 private void edit(String resource) throws ParserConfigurationException, SAXException, IOException,
172 NetconfDocumentedException {
173 EditConfig editOp = new EditConfig(yangStoreSnapshot, transactionProvider, configRegistryClient,
175 executeOp(editOp, resource);
178 private void commit() throws ParserConfigurationException, SAXException, IOException, NetconfDocumentedException {
179 Commit commitOp = new Commit(transactionProvider, configRegistryClient, NETCONF_SESSION_ID);
180 executeOp(commitOp, "netconfMessages/commit.xml");
183 private Element getConfigCandidate() throws ParserConfigurationException, SAXException, IOException,
184 NetconfDocumentedException {
185 GetConfig getConfigOp = new GetConfig(yangStoreSnapshot, Optional.<String> absent(), transactionProvider,
186 configRegistryClient, NETCONF_SESSION_ID);
187 return executeOp(getConfigOp, "netconfMessages/getConfig_candidate.xml");
190 private Element getConfigRunning() throws ParserConfigurationException, SAXException, IOException,
191 NetconfDocumentedException {
192 GetConfig getConfigOp = new GetConfig(yangStoreSnapshot, Optional.<String> absent(), transactionProvider,
193 configRegistryClient, NETCONF_SESSION_ID);
194 return executeOp(getConfigOp, "netconfMessages/getConfig.xml");
197 @Test(expected = NetconfDocumentedException.class)
198 public void testConfigNetconfReplaceDefaultEx() throws Exception {
200 createModule(INSTANCE_NAME);
202 edit("netconfMessages/editConfig.xml");
203 edit("netconfMessages/editConfig_replace_default_ex.xml");
207 public void testConfigNetconfReplaceDefault() throws Exception {
209 createModule(INSTANCE_NAME);
211 edit("netconfMessages/editConfig.xml");
213 Element response = getConfigRunning();
214 final int allInstances = response.getElementsByTagName("module").getLength();
216 edit("netconfMessages/editConfig_replace_default.xml");
219 response = getConfigRunning();
221 final int afterReplace = response.getElementsByTagName("module").getLength();
222 assertEquals(4, allInstances);
223 assertEquals(2, afterReplace);
226 @Test(expected = NetconfDocumentedException.class)
227 public void testSameAttrDifferentNamespaces() throws Exception {
229 edit("netconfMessages/namespaces/editConfig_sameAttrDifferentNamespaces.xml");
230 } catch (NetconfDocumentedException e) {
231 String message = e.getMessage();
234 .containsString("Element simple-long-2 present multiple times with different namespaces"));
236 JUnitMatchers.containsString("urn:opendaylight:params:xml:ns:yang:controller:test:impl"));
239 .containsString(XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG));
244 @Test(expected = NetconfDocumentedException.class)
245 public void testDifferentNamespaceInTO() throws Exception {
247 edit("netconfMessages/namespaces/editConfig_differentNamespaceTO.xml");
248 } catch (NetconfDocumentedException e) {
249 String message = e.getMessage();
250 assertThat(message, JUnitMatchers.containsString("Unrecognised elements"));
251 assertThat(message, JUnitMatchers.containsString("simple-int2"));
252 assertThat(message, JUnitMatchers.containsString("dto_d"));
257 @Test(expected = NetconfDocumentedException.class)
258 public void testSameAttrDifferentNamespacesList() throws Exception {
260 edit("netconfMessages/namespaces/editConfig_sameAttrDifferentNamespacesList.xml");
261 } catch (NetconfDocumentedException e) {
262 String message = e.getMessage();
264 JUnitMatchers.containsString("Element binaryLeaf present multiple times with different namespaces"));
266 JUnitMatchers.containsString("urn:opendaylight:params:xml:ns:yang:controller:test:impl"));
269 .containsString(XmlNetconfConstants.URN_OPENDAYLIGHT_PARAMS_XML_NS_YANG_CONTROLLER_CONFIG));
275 public void testTypeNameConfigAttributeMatching() throws Exception {
276 edit("netconfMessages/editConfig.xml");
278 edit("netconfMessages/namespaces/editConfig_typeNameConfigAttributeMatching.xml");
281 Element response = getConfigRunning();
282 checkTypeConfigAttribute(response);
285 // TODO add <modules operation="replace"> functionality
286 @Test(expected = NetconfDocumentedException.class)
287 public void testConfigNetconfReplaceModuleEx() throws Exception {
289 createModule(INSTANCE_NAME);
291 edit("netconfMessages/editConfig.xml");
292 edit("netconfMessages/editConfig_replace_module_ex.xml");
296 public void testUnrecognisedConfigElements() throws Exception {
298 String format = "netconfMessages/unrecognised/editConfig_unrecognised%d.xml";
299 final int TESTS_COUNT = 8;
301 for (int i = 0; i < TESTS_COUNT; i++) {
302 String file = String.format(format, i + 1);
305 } catch (NetconfDocumentedException e) {
306 assertThat(e.getMessage(), JUnitMatchers.containsString("Unrecognised elements"));
307 assertThat(e.getMessage(), JUnitMatchers.containsString("unknownAttribute"));
310 fail("Unrecognised test should throw exception " + file);
317 public void testConfigNetconfReplaceModule() throws Exception {
319 createModule(INSTANCE_NAME);
321 edit("netconfMessages/editConfig.xml");
323 Element response = getConfigRunning();
324 final int allInstances = response.getElementsByTagName("instance").getLength();
326 edit("netconfMessages/editConfig_replace_module.xml");
329 response = getConfigRunning();
330 final int afterReplace = response.getElementsByTagName("instance").getLength();
332 assertEquals(4 + 4 /* Instances from services */, allInstances);
333 assertEquals(3 + 3, afterReplace);
336 @Test(expected = NetconfDocumentedException.class)
337 public void testEx() throws Exception {
342 @Test(expected = NetconfDocumentedException.class)
343 public void testEx2() throws Exception {
347 private void discard() throws ParserConfigurationException, SAXException, IOException, NetconfDocumentedException {
348 DiscardChanges discardOp = new DiscardChanges(transactionProvider, configRegistryClient, NETCONF_SESSION_ID);
349 executeOp(discardOp, "netconfMessages/discardChanges.xml");
352 private void checkBinaryLeafEdited(final Element response) {
353 final NodeList children = response.getElementsByTagName("binaryLeaf");
354 assertEquals(3, children.getLength());
355 final StringBuffer buf = new StringBuffer();
356 for (int i = 0; i < 3; i++) {
357 final Element e = (Element) children.item(i);
358 buf.append(XmlElement.fromDomElement(e).getTextContent());
360 assertEquals("810", buf.toString());
363 private void checkTypedefs(final Element response) {
364 NodeList children = response.getElementsByTagName("extended");
365 assertEquals(1, children.getLength());
367 children = response.getElementsByTagName("extended-twice");
368 assertEquals(1, children.getLength());
371 private void checkEnum(final Element response) {
372 XmlElement modulesElement = XmlElement.fromDomElement(response).getOnlyChildElement("data")
373 .getOnlyChildElement("modules");
375 String enumName = "extended-enum";
376 String enumContent = "TWO";
378 for (XmlElement moduleElement : modulesElement.getChildElements("module")) {
379 String name = moduleElement.getOnlyChildElement("name").getTextContent();
380 if(name.equals("test1")) {
381 XmlElement enumAttr = moduleElement.getOnlyChildElement(enumName);
382 assertEquals(enumContent, enumAttr.getTextContent());
388 fail("Enum attribute " + enumName + ":" + enumContent + " not present in " + XmlUtil.toString(response));
391 private void checkTypeConfigAttribute(Element response) {
393 XmlElement modulesElement = XmlElement.fromDomElement(response).getOnlyChildElement("data")
394 .getOnlyChildElement("modules");
396 XmlElement configAttributeType = null;
397 for (XmlElement moduleElement : modulesElement.getChildElements("module")) {
398 for (XmlElement type : moduleElement.getChildElements("type")) {
399 if (type.getAttribute(XmlUtil.XMLNS_ATTRIBUTE_KEY).equals("") == false) {
400 configAttributeType = type;
405 assertEquals("configAttributeType", configAttributeType.getTextContent());
408 private Map<String, Map<String, ModuleMXBeanEntry>> getMbes() throws Exception {
409 final List<InputStream> yangDependencies = getYangs();
411 final Map<String, Map<String, ModuleMXBeanEntry>> mBeanEntries = Maps.newHashMap();
412 mBeanEntries.putAll(new MbeParser().parseYangFiles(yangDependencies).getModuleMXBeanEntryMap());
418 public void testConfigNetconfRuntime() throws Exception {
420 createModule(INSTANCE_NAME);
422 edit("netconfMessages/editConfig.xml");
423 checkBinaryLeafEdited(getConfigCandidate());
427 Element response = get();
429 assertEquals(2/*With runtime beans*/ + 2 /*Without runtime beans*/, getElementsSize(response, "module"));
431 assertEquals(2, getElementsSize(response, "asdf"));
432 // data from running config
433 assertEquals(2, getElementsSize(response, "simple-short"));
435 assertEquals(8, getElementsSize(response, "inner-running-data"));
436 assertEquals(8, getElementsSize(response, "deep2"));
437 assertEquals(8 * 4, getElementsSize(response, "inner-inner-running-data"));
438 assertEquals(8 * 4, getElementsSize(response, "deep3"));
439 assertEquals(8 * 4 * 2, getElementsSize(response, "list-of-strings"));
440 assertEquals(8, getElementsSize(response, "inner-running-data-additional"));
441 assertEquals(8, getElementsSize(response, "deep4"));
444 RuntimeRpc netconf = new RuntimeRpc(yangStoreSnapshot, configRegistryClient, NETCONF_SESSION_ID);
446 response = executeOp(netconf, "netconfMessages/rpc.xml");
447 assertThat(XmlUtil.toString(response), JUnitMatchers.containsString("testarg1".toUpperCase()));
449 response = executeOp(netconf, "netconfMessages/rpcInner.xml");
450 assertThat(XmlUtil.toString(response), JUnitMatchers.containsString("ok"));
452 response = executeOp(netconf, "netconfMessages/rpcInnerInner.xml");
453 assertThat(XmlUtil.toString(response), JUnitMatchers.containsString("true"));
455 response = executeOp(netconf, "netconfMessages/rpcInnerInner_complex_output.xml");
456 assertThat(XmlUtil.toString(response), JUnitMatchers.containsString("1"));
457 assertThat(XmlUtil.toString(response), JUnitMatchers.containsString("2"));
460 private Element get() throws NetconfDocumentedException, ParserConfigurationException, SAXException, IOException {
461 Get getOp = new Get(yangStoreSnapshot, configRegistryClient, NETCONF_SESSION_ID);
462 return executeOp(getOp, "netconfMessages/get.xml");
465 private int getElementsSize(Element response, String elementName) {
466 return response.getElementsByTagName(elementName).getLength();
469 private Element executeOp(final NetconfOperation op, final String filename) throws ParserConfigurationException,
470 SAXException, IOException, NetconfDocumentedException {
472 final Document request = XmlFileLoader.xmlFileToDocument(filename);
474 logger.debug("Executing netconf operation\n{}", XmlUtil.toString(request));
475 HandlingPriority priority = op.canHandle(request);
477 Preconditions.checkState(priority != HandlingPriority.CANNOT_HANDLE);
479 final Document response = op.handle(request, netconfOperationRouter);
480 logger.debug("Got response\n{}", XmlUtil.toString(response));
481 return response.getDocumentElement();
484 private List<InputStream> getYangs() throws FileNotFoundException {
485 List<String> paths = Arrays.asList("/META-INF/yang/config.yang", "/META-INF/yang/rpc-context.yang",
486 "/META-INF/yang/config-test.yang", "/META-INF/yang/config-test-impl.yang", "/META-INF/yang/test-types.yang",
487 "/META-INF/yang/ietf-inet-types.yang");
488 final Collection<InputStream> yangDependencies = new ArrayList<>();
489 for (String path : paths) {
490 final InputStream is = Preconditions
491 .checkNotNull(getClass().getResourceAsStream(path), path + " not found");
492 yangDependencies.add(is);
494 return Lists.newArrayList(yangDependencies);
497 private void setModule(final NetconfTestImplModuleMXBean mxBean, final ConfigTransactionJMXClient transaction)
498 throws InstanceAlreadyExistsException {
499 mxBean.setSimpleInt((long) 44);
500 mxBean.setBinaryLeaf(new byte[] { 8, 7, 9 });
501 final DtoD dtob = getDtoD();
502 mxBean.setDtoD(dtob);
504 final DtoC dtoa = getDtoC();
505 mxBean.setDtoC(dtoa);
506 mxBean.setSimpleBoolean(false);
508 final Peers p1 = new Peers();
511 p1.setSimpleInt3(456);
512 final Peers p2 = new Peers();
514 p2.setPort("port23");
515 p2.setSimpleInt3(456);
516 mxBean.setPeers(Lists.<Peers> newArrayList(p1, p2));
518 mxBean.setSimpleLong(454545L);
519 mxBean.setSimpleLong2(44L);
520 mxBean.setSimpleBigInteger(BigInteger.valueOf(999L));
521 mxBean.setSimpleByte(new Byte((byte) 4));
522 mxBean.setSimpleShort(new Short((short) 4));
523 mxBean.setSimpleTest(545);
525 mxBean.setComplexList(Lists.<ComplexList> newArrayList());
526 mxBean.setSimpleList(Lists.<Integer> newArrayList());
528 final ObjectName testingDepOn = transaction.createModule(this.factory2.getImplementationName(), "dep");
529 mxBean.setTestingDep(testingDepOn);
532 private static DtoD getDtoD() {
533 final DtoD dtob = new DtoD();
534 dtob.setSimpleInt1((long) 444);
535 dtob.setSimpleInt2((long) 4444);
536 dtob.setSimpleInt3(454);
537 final ComplexDtoBInner dtobInner = new ComplexDtoBInner();
538 final Deep deep = new Deep();
539 deep.setSimpleInt3(4);
540 dtobInner.setDeep(deep);
541 dtobInner.setSimpleInt3(44);
542 dtobInner.setSimpleList(Lists.newArrayList(4));
543 dtob.setComplexDtoBInner(Lists.newArrayList(dtobInner));
544 dtob.setSimpleList(Lists.newArrayList(4));
548 private static DtoC getDtoC() {
549 final DtoC dtoa = new DtoC();
550 // dtoa.setSimpleArg((long) 55);
551 final DtoAInner dtoAInner = new DtoAInner();
552 final DtoAInnerInner dtoAInnerInner = new DtoAInnerInner();
553 dtoAInnerInner.setSimpleArg(456L);
554 dtoAInner.setDtoAInnerInner(dtoAInnerInner);
555 dtoAInner.setSimpleArg(44L);
556 dtoa.setDtoAInner(dtoAInner);