X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Frestconf%2Fimpl%2Ftest%2FTestUtils.java;h=853c19f93530c16449840b1043ac07d30edaab4f;hb=2727bea09c83646b6cbd2ef9672d0b7f6cf3b22f;hp=25488457b20cd80fe55165472a415cae511b4caf;hpb=6eb461f54fe6705b07f34b6cee197ea968de4991;p=controller.git diff --git a/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/TestUtils.java b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/TestUtils.java index 25488457b2..75cce14d09 100644 --- a/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/TestUtils.java +++ b/opendaylight/md-sal/sal-rest-connector/src/test/java/org/opendaylight/controller/sal/restconf/impl/test/TestUtils.java @@ -1,51 +1,67 @@ +/* + * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. + * + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0 which accompanies this distribution, + * and is available at http://www.eclipse.org/legal/epl-v10.html + */ package org.opendaylight.controller.sal.restconf.impl.test; import static org.junit.Assert.assertNotNull; -import static org.junit.Assert.assertTrue; -import static org.mockito.Matchers.any; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.when; -import java.io.*; +import com.google.common.base.Preconditions; +import java.io.BufferedReader; +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStreamWriter; import java.net.URI; import java.net.URISyntaxException; import java.sql.Date; -import java.util.*; - -import javax.ws.rs.WebApplicationException; -import javax.ws.rs.ext.MessageBodyReader; -import javax.ws.rs.ext.MessageBodyWriter; -import javax.xml.parsers.*; -import javax.xml.stream.XMLStreamException; -import javax.xml.transform.*; +import java.text.ParseException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.transform.OutputKeys; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactory; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; - -import org.opendaylight.controller.md.sal.common.api.TransactionStatus; -import org.opendaylight.controller.sal.rest.impl.UnsupportedFormatException; -import org.opendaylight.controller.sal.rest.impl.XmlReader; -import org.opendaylight.controller.sal.restconf.impl.*; -import org.opendaylight.controller.sal.restconf.impl.json.to.cnsn.test.JsonToCnSnTest; import org.opendaylight.yangtools.yang.common.QName; -import org.opendaylight.yangtools.yang.data.api.CompositeNode; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier; -import org.opendaylight.yangtools.yang.model.api.*; -import org.opendaylight.yangtools.yang.model.parser.api.YangModelParser; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode; +import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafNodeBuilder; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder; +import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; +import org.opendaylight.yangtools.yang.model.api.Module; +import org.opendaylight.yangtools.yang.model.api.SchemaContext; +import org.opendaylight.yangtools.yang.model.parser.api.YangContextParser; import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.xml.sax.SAXException; -import com.google.common.base.Preconditions; - public final class TestUtils { private static final Logger LOG = LoggerFactory.getLogger(TestUtils.class); - private final static YangModelParser parser = new YangParserImpl(); + private final static YangContextParser PARSER = new YangParserImpl(); - public static Set loadModules(String resourceDirectory) throws FileNotFoundException { + private static Set loadModules(final String resourceDirectory) throws FileNotFoundException { final File testDir = new File(resourceDirectory); final String[] fileList = testDir.list(); final List testFiles = new ArrayList(); @@ -53,37 +69,45 @@ public final class TestUtils { throw new FileNotFoundException(resourceDirectory); } for (int i = 0; i < fileList.length; i++) { - String fileName = fileList[i]; + final String fileName = fileList[i]; if (new File(testDir, fileName).isDirectory() == false) { testFiles.add(new File(testDir, fileName)); } } - return parser.parseYangModels(testFiles); + return PARSER.parseYangModels(testFiles); + } + + public static Set loadModulesFrom(final String yangPath) { + try { + return TestUtils.loadModules(TestUtils.class.getResource(yangPath).getPath()); + } catch (final FileNotFoundException e) { + LOG.error("Yang files at path: " + yangPath + " weren't loaded."); + } + + return null; } - public static SchemaContext loadSchemaContext(Set modules) { - return parser.resolveSchemaContext(modules); + public static SchemaContext loadSchemaContext(final Set modules) { + return PARSER.resolveSchemaContext(modules); } - public static SchemaContext loadSchemaContext(String resourceDirectory) throws FileNotFoundException { - return parser.resolveSchemaContext(loadModules(resourceDirectory)); + public static SchemaContext loadSchemaContext(final String resourceDirectory) throws FileNotFoundException { + return PARSER.resolveSchemaContext(loadModulesFrom(resourceDirectory)); } - public static Module findModule(Set modules, String moduleName) { - Module result = null; - for (Module module : modules) { + public static Module findModule(final Set modules, final String moduleName) { + for (final Module module : modules) { if (module.getName().equals(moduleName)) { - result = module; - break; + return module; } } - return result; + return null; } - public static Document loadDocumentFrom(InputStream inputStream) { + public static Document loadDocumentFrom(final InputStream inputStream) { try { - DocumentBuilderFactory dbfac = DocumentBuilderFactory.newInstance(); - DocumentBuilder docBuilder = dbfac.newDocumentBuilder(); + final DocumentBuilderFactory dbfac = DocumentBuilderFactory.newInstance(); + final DocumentBuilder docBuilder = dbfac.newDocumentBuilder(); return docBuilder.parse(inputStream); } catch (SAXException | IOException | ParserConfigurationException e) { LOG.error("Error during loading Document from XML", e); @@ -91,12 +115,12 @@ public final class TestUtils { } } - public static String getDocumentInPrintableForm(Document doc) { + public static String getDocumentInPrintableForm(final Document doc) { Preconditions.checkNotNull(doc); try { - ByteArrayOutputStream out = new ByteArrayOutputStream(); - TransformerFactory tf = TransformerFactory.newInstance(); - Transformer transformer = tf.newTransformer(); + final ByteArrayOutputStream out = new ByteArrayOutputStream(); + final TransformerFactory tf = TransformerFactory.newInstance(); + final Transformer transformer = tf.newTransformer(); transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); transformer.setOutputProperty(OutputKeys.METHOD, "xml"); transformer.setOutputProperty(OutputKeys.INDENT, "yes"); @@ -104,10 +128,10 @@ public final class TestUtils { transformer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "4"); transformer.transform(new DOMSource(doc), new StreamResult(new OutputStreamWriter(out, "UTF-8"))); - byte[] charData = out.toByteArray(); + final byte[] charData = out.toByteArray(); return new String(charData, "UTF-8"); } catch (IOException | TransformerException e) { - String msg = "Error during transformation of Document into String"; + final String msg = "Error during transformation of Document into String"; LOG.error(msg, e); return msg; } @@ -115,24 +139,14 @@ public final class TestUtils { } /** - * - * Fill missing data (namespaces) and build correct data type in - * {@code compositeNode} according to {@code dataSchemaNode}. The method - * {@link RestconfImpl#createConfigurationData createConfigurationData} is - * used because it contains calling of method {code normalizeNode} + * Searches module with name {@code searchedModuleName} in {@code modules}. If module name isn't specified and + * module set has only one element then this element is returned. + * */ - public static void normalizeCompositeNode(CompositeNode compositeNode, Set modules, String schemaNodePath) { - RestconfImpl restconf = RestconfImpl.getInstance(); - ControllerContext.getInstance().setSchemas(TestUtils.loadSchemaContext(modules)); - - prepareMockForRestconfBeforeNormalization(modules, restconf); - restconf.createConfigurationData(schemaNodePath, compositeNode); - } - - public static Module resolveModule(String searchedModuleName, Set modules) { - assertNotNull("modules can't be null.", modules); + public static Module resolveModule(final String searchedModuleName, final Set modules) { + assertNotNull("Modules can't be null.", modules); if (searchedModuleName != null) { - for (Module m : modules) { + for (final Module m : modules) { if (m.getName().equals(searchedModuleName)) { return m; } @@ -143,21 +157,11 @@ public final class TestUtils { return null; } - public static Set resolveModulesFrom(String yangPath) { - try { - return TestUtils.loadModules(TestUtils.class.getResource(yangPath).getPath()); - } catch (FileNotFoundException e) { - LOG.error("Yang files at path: " + yangPath + " weren't loaded."); - } - - return null; - } - - public static DataSchemaNode resolveDataSchemaNode(String searchedDataSchemaName, Module module) { + public static DataSchemaNode resolveDataSchemaNode(final String searchedDataSchemaName, final Module module) { assertNotNull("Module can't be null", module); if (searchedDataSchemaName != null) { - for (DataSchemaNode dsn : module.getChildNodes()) { + for (final DataSchemaNode dsn : module.getChildNodes()) { if (dsn.getQName().getLocalName().equals(searchedDataSchemaName)) { return dsn; } @@ -168,160 +172,114 @@ public final class TestUtils { return null; } - public static CompositeNode loadCompositeNode(String xmlDataPath) { - return loadCompositeNode(xmlDataPath, false); - } - - public static CompositeNode loadCompositeNode(String xmlDataPath, boolean addDumyNamespace) { - InputStream xmlStream = TestUtils.class.getResourceAsStream(xmlDataPath); - CompositeNode compositeNode = null; - try { - XmlReader xmlReader = new XmlReader(); - compositeNode = xmlReader.read(xmlStream); - } catch (UnsupportedFormatException | XMLStreamException e) { - LOG.error(e.getMessage()); - } - if (addDumyNamespace) { - try { - addDummyNamespaceToAllNodes((CompositeNodeWrapper) compositeNode); - } catch (URISyntaxException e) { - LOG.error(e.getMessage()); - } - } - return compositeNode; - } - - public static QName buildQName(String name, String uri, String date, String prefix) { + public static QName buildQName(final String name, final String uri, final String date, final String prefix) { try { - URI u = new URI(uri); + final URI u = new URI(uri); Date dt = null; if (date != null) { dt = Date.valueOf(date); } - return new QName(u, dt, prefix, name); - } catch (URISyntaxException e) { + return QName.create(u, dt, name); + } catch (final URISyntaxException e) { return null; } } - public static QName buildQName(String name, String uri, String date) { + public static QName buildQName(final String name, final String uri, final String date) { return buildQName(name, uri, date, null); } - public static QName buildQName(String name) { + public static QName buildQName(final String name) { return buildQName(name, "", null); } - public static DataSchemaNode obtainSchemaFromYang(String yangFolder) throws FileNotFoundException { - return obtainSchemaFromYang(yangFolder, null); - } - - public static DataSchemaNode obtainSchemaFromYang(String yangFolder, String moduleName) - throws FileNotFoundException { - Set modules = null; - modules = TestUtils.loadModules(TestUtils.class.getResource(yangFolder).getPath()); - - if (modules == null) { - return null; - } - if (modules.size() < 1) { - return null; - } - - Module moduleRes = null; - if (modules.size() > 1) { - if (moduleName == null) { - return null; - } else { - for (Module module : modules) { - if (module.getName().equals(moduleName)) { - moduleRes = module; - } - } - if (moduleRes == null) { - return null; - } - } - } else { - moduleRes = modules.iterator().next(); - } + public static String loadTextFile(final String filePath) throws IOException { + final FileReader fileReader = new FileReader(filePath); + final BufferedReader bufReader = new BufferedReader(fileReader); - if (moduleRes.getChildNodes() == null) { - return null; - } - - if (moduleRes.getChildNodes().size() != 1) { - return null; + String line = null; + final StringBuilder result = new StringBuilder(); + while ((line = bufReader.readLine()) != null) { + result.append(line); } - DataSchemaNode dataSchemaNode = moduleRes.getChildNodes().iterator().next(); - return dataSchemaNode; + bufReader.close(); + return result.toString(); } - public static void addDummyNamespaceToAllNodes(NodeWrapper wrappedNode) throws URISyntaxException { - wrappedNode.setNamespace(new URI("")); - if (wrappedNode instanceof CompositeNodeWrapper) { - for (NodeWrapper childNodeWrapper : ((CompositeNodeWrapper) wrappedNode).getValues()) { - addDummyNamespaceToAllNodes(childNodeWrapper); - } + private static Pattern patternForStringsSeparatedByWhiteChars(final String... substrings) { + final StringBuilder pattern = new StringBuilder(); + pattern.append(".*"); + for (final String substring : substrings) { + pattern.append(substring); + pattern.append("\\s*"); } + pattern.append(".*"); + return Pattern.compile(pattern.toString(), Pattern.DOTALL); } - private static void prepareMockForRestconfBeforeNormalization(Set modules, RestconfImpl restconf) { - - ControllerContext controllerContext = ControllerContext.getInstance(); - BrokerFacade mockedBrokerFacade = mock(BrokerFacade.class); - - controllerContext.setSchemas(TestUtils.loadSchemaContext(modules)); - - when(mockedBrokerFacade.commitConfigurationDataPut(any(InstanceIdentifier.class), any(CompositeNode.class))) - .thenReturn( - new DummyFuture.Builder().rpcResult( - new DummyRpcResult.Builder().result(TransactionStatus.COMMITED) - .build()).build()); - - restconf.setControllerContext(ControllerContext.getInstance()); - restconf.setBroker(mockedBrokerFacade); + public static boolean containsStringData(final String jsonOutput, final String... substrings) { + final Pattern pattern = patternForStringsSeparatedByWhiteChars(substrings); + final Matcher matcher = pattern.matcher(jsonOutput); + return matcher.matches(); } - public static CompositeNode readInputToCnSn(String jsonPath, boolean dummyNamespaces, - MessageBodyReader reader) throws WebApplicationException { - - InputStream jsonStream = JsonToCnSnTest.class.getResourceAsStream(jsonPath); - try { - CompositeNode compositeNode = reader.readFrom(null, null, null, null, null, jsonStream); - assertTrue(compositeNode instanceof CompositeNodeWrapper); - if (dummyNamespaces) { - try { - TestUtils.addDummyNamespaceToAllNodes((CompositeNodeWrapper) compositeNode); - return ((CompositeNodeWrapper) compositeNode).unwrap(); - } catch (URISyntaxException e) { - LOG.error(e.getMessage()); - assertTrue(e.getMessage(), false); - } - } - return compositeNode; - } catch (IOException e) { - LOG.error(e.getMessage()); - assertTrue(e.getMessage(), false); - } - return null; + public static YangInstanceIdentifier.NodeIdentifier getNodeIdentifier(final String localName, final String namespace, + final String revision) throws ParseException { + return new YangInstanceIdentifier.NodeIdentifier(QName.create(namespace, revision, localName)); } - public static String writeCompNodeWithSchemaContextToOutput(CompositeNode compositeNode, Set modules, - DataSchemaNode dataSchemaNode, MessageBodyWriter messageBodyWriter) throws IOException, - WebApplicationException { + public static YangInstanceIdentifier.NodeIdentifierWithPredicates getNodeIdentifierPredicate(final String localName, + final String namespace, final String revision, final Map keys) throws ParseException { + final Map predicate = new HashMap<>(); + for (final String key : keys.keySet()) { + predicate.put(QName.create(namespace, revision, key), keys.get(key)); + } - assertNotNull(dataSchemaNode); - assertNotNull("Composite node can't be null", compositeNode); - ByteArrayOutputStream byteArrayOS = new ByteArrayOutputStream(); + return new YangInstanceIdentifier.NodeIdentifierWithPredicates( - ControllerContext.getInstance().setSchemas(loadSchemaContext(modules)); + QName.create(namespace, revision, localName), predicate); + } - messageBodyWriter.writeTo(new StructuredData(compositeNode, dataSchemaNode), null, null, null, null, null, - byteArrayOS); + public static YangInstanceIdentifier.NodeIdentifierWithPredicates getNodeIdentifierPredicate(final String localName, + final String namespace, final String revision, final String... keysAndValues) throws ParseException { + if (keysAndValues.length % 2 != 0) { + new IllegalArgumentException("number of keys argument have to be divisible by 2 (map)"); + } + final Map predicate = new HashMap<>(); - return byteArrayOS.toString(); + int i = 0; + while (i < keysAndValues.length) { + predicate.put(QName.create(namespace, revision, keysAndValues[i++]), keysAndValues[i++]); + } + return new YangInstanceIdentifier.NodeIdentifierWithPredicates(QName.create(namespace, revision, localName), + predicate); } + static NormalizedNode prepareNormalizedNodeWithIetfInterfacesInterfacesData() throws ParseException { + final String ietfInterfacesDate = "2013-07-04"; + final String namespace = "urn:ietf:params:xml:ns:yang:ietf-interfaces"; + final DataContainerNodeAttrBuilder mapEntryNode = ImmutableMapEntryNodeBuilder.create(); + + final Map predicates = new HashMap<>(); + predicates.put("name", "eth0"); + + mapEntryNode.withNodeIdentifier(getNodeIdentifierPredicate("interface", namespace, ietfInterfacesDate, + predicates)); + mapEntryNode + .withChild(new ImmutableLeafNodeBuilder() + .withNodeIdentifier(getNodeIdentifier("name", namespace, ietfInterfacesDate)).withValue("eth0") + .build()); + mapEntryNode.withChild(new ImmutableLeafNodeBuilder() + .withNodeIdentifier(getNodeIdentifier("type", namespace, ietfInterfacesDate)) + .withValue("ethernetCsmacd").build()); + mapEntryNode.withChild(new ImmutableLeafNodeBuilder() + .withNodeIdentifier(getNodeIdentifier("enabled", namespace, ietfInterfacesDate)) + .withValue(Boolean.FALSE).build()); + mapEntryNode.withChild(new ImmutableLeafNodeBuilder() + .withNodeIdentifier(getNodeIdentifier("description", namespace, ietfInterfacesDate)) + .withValue("some interface").build()); + + return mapEntryNode.build(); + } }