X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-rest-connector%2Fsrc%2Ftest%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Frestconf%2Fimpl%2Ftest%2FTestUtils.java;h=67d98f6b558db0a0915928ff869d2a0f123a5b45;hp=20dfb31dab3362261fb1496dd1da9246fbc8052a;hb=de3e413b633b7555ae8f3fe2ec163dbb7dda5da8;hpb=237237663265bfda9069c66151371ce7697aed59 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 20dfb31dab..67d98f6b55 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,46 +1,74 @@ +/* + * 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.assertFalse; 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 java.net.*; +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 java.util.concurrent.Future; - +import java.util.ArrayList; +import java.util.List; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; import javax.ws.rs.WebApplicationException; -import javax.xml.parsers.*; -import javax.xml.stream.XMLStreamException; -import javax.xml.transform.*; +import javax.ws.rs.ext.MessageBodyReader; +import javax.ws.rs.ext.MessageBodyWriter; +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.StructuredDataToJsonProvider; -import org.opendaylight.controller.sal.restconf.impl.*; -import org.opendaylight.yangtools.yang.common.*; -import org.opendaylight.yangtools.yang.data.api.*; -import org.opendaylight.yangtools.yang.data.impl.XmlTreeBuilder; -import org.opendaylight.yangtools.yang.model.api.*; +import org.opendaylight.controller.sal.restconf.impl.BrokerFacade; +import org.opendaylight.controller.sal.restconf.impl.CompositeNodeWrapper; +import org.opendaylight.controller.sal.restconf.impl.ControllerContext; +import org.opendaylight.controller.sal.restconf.impl.NodeWrapper; +import org.opendaylight.controller.sal.restconf.impl.RestconfImpl; +import org.opendaylight.controller.sal.restconf.impl.StructuredData; +import org.opendaylight.yangtools.yang.common.QName; +import org.opendaylight.yangtools.yang.data.api.CompositeNode; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +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.YangModelParser; import org.opendaylight.yangtools.yang.parser.impl.YangParserImpl; -import org.slf4j.*; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.xml.sax.SAXException; -import com.google.common.base.Preconditions; - -final class TestUtils { +public final class TestUtils { - private static final Logger logger = LoggerFactory.getLogger(TestUtils.class); + private static final Logger LOG = LoggerFactory.getLogger(TestUtils.class); private final static YangModelParser parser = new YangParserImpl(); - public static Set loadModules(String resourceDirectory) throws FileNotFoundException { + private static Set loadModules(String resourceDirectory) throws FileNotFoundException { final File testDir = new File(resourceDirectory); final String[] fileList = testDir.list(); final List testFiles = new ArrayList(); @@ -56,45 +84,31 @@ final class TestUtils { return parser.parseYangModels(testFiles); } + public static Set loadModulesFrom(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 SchemaContext loadSchemaContext(Set modules) { return parser.resolveSchemaContext(modules); } public static SchemaContext loadSchemaContext(String resourceDirectory) throws FileNotFoundException { - return parser.resolveSchemaContext(loadModules(resourceDirectory)); + return parser.resolveSchemaContext(loadModulesFrom(resourceDirectory)); } public static Module findModule(Set modules, String moduleName) { - Module result = null; for (Module module : modules) { if (module.getName().equals(moduleName)) { - result = module; - break; + return module; } } - return result; - } - - public static CompositeNode loadCompositeNode(InputStream xmlInputStream) throws FileNotFoundException { - if (xmlInputStream == null) { - throw new IllegalArgumentException(); - } - Node dataTree; - try { - dataTree = XmlTreeBuilder.buildDataTree(xmlInputStream); - } catch (XMLStreamException e) { - logger.error("Error during building data tree from XML", e); - return null; - } - if (dataTree == null) { - logger.error("data tree is null"); - return null; - } - if (dataTree instanceof SimpleNode) { - logger.error("RPC XML was resolved as SimpleNode"); - return null; - } - return (CompositeNode) dataTree; + return null; } public static Document loadDocumentFrom(InputStream inputStream) { @@ -103,7 +117,7 @@ final class TestUtils { DocumentBuilder docBuilder = dbfac.newDocumentBuilder(); return docBuilder.parse(inputStream); } catch (SAXException | IOException | ParserConfigurationException e) { - logger.error("Error during loading Document from XML", e); + LOG.error("Error during loading Document from XML", e); return null; } } @@ -125,291 +139,177 @@ final class TestUtils { return new String(charData, "UTF-8"); } catch (IOException | TransformerException e) { String msg = "Error during transformation of Document into String"; - logger.error(msg, e); + LOG.error(msg, e); return msg; } } - static String convertCompositeNodeDataAndYangToJson(CompositeNode compositeNode, String yangPath, String outputPath) { - return convertCompositeNodeDataAndYangToJson(compositeNode, yangPath, outputPath, null, null); - } - - static String convertCompositeNodeDataAndYangToJson(CompositeNode compositeNode, String yangPath, - String outputPath, String searchedModuleName, String searchedDataSchemaName) { - Set modules = resolveModules(yangPath); - Module module = resolveModule(searchedModuleName, modules); - DataSchemaNode dataSchemaNode = resolveDataSchemaNode(module, searchedDataSchemaName); - - try { - return writeCompNodeWithSchemaContextToJson(compositeNode, outputPath, modules, dataSchemaNode); - } catch (WebApplicationException | IOException e) { - // TODO Auto-generated catch block - e.printStackTrace(); - } - return null; + /** + * + * 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} + */ + public static void normalizeCompositeNode(CompositeNode compositeNode, Set modules, String schemaNodePath) { + RestconfImpl restconf = RestconfImpl.getInstance(); + ControllerContext.getInstance().setSchemas(TestUtils.loadSchemaContext(modules)); + prepareMocksForRestconf(modules, restconf); + restconf.updateConfigurationData(schemaNodePath, compositeNode); } - static Module resolveModule(String searchedModuleName, Set modules) { - assertNotNull("modules can't be null.", modules); - Module module = null; + /** + * 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 Module resolveModule(String searchedModuleName, Set modules) { + assertNotNull("Modules can't be null.", modules); if (searchedModuleName != null) { for (Module m : modules) { if (m.getName().equals(searchedModuleName)) { - module = m; - break; + return m; } } } else if (modules.size() == 1) { - module = modules.iterator().next(); - } - return module; - } - - static Set resolveModules(String yangPath) { - Set modules = null; - - try { - modules = TestUtils.loadModules(ToJsonBasicDataTypesTest.class.getResource(yangPath).getPath()); - } catch (FileNotFoundException e) { - e.printStackTrace(); + return modules.iterator().next(); } - - return modules; + return null; } - static DataSchemaNode resolveDataSchemaNode(Module module, String searchedDataSchemaName) { - assertNotNull("Module is missing", module); + public static DataSchemaNode resolveDataSchemaNode(String searchedDataSchemaName, Module module) { + assertNotNull("Module can't be null", module); - DataSchemaNode dataSchemaNode = null; if (searchedDataSchemaName != null) { for (DataSchemaNode dsn : module.getChildNodes()) { if (dsn.getQName().getLocalName().equals(searchedDataSchemaName)) { - dataSchemaNode = dsn; + return dsn; } } } else if (module.getChildNodes().size() == 1) { - dataSchemaNode = module.getChildNodes().iterator().next(); + return module.getChildNodes().iterator().next(); } - return dataSchemaNode; + return null; } - static String writeCompNodeWithSchemaContextToJson(CompositeNode compositeNode, String outputPath, - Set modules, DataSchemaNode dataSchemaNode) throws IOException, WebApplicationException { - String jsonResult; - - assertNotNull(dataSchemaNode); - assertNotNull("Composite node can't be null", compositeNode); - ByteArrayOutputStream byteArrayOS = new ByteArrayOutputStream(); - - ControllerContext contContext = ControllerContext.getInstance(); - contContext.setSchemas(loadSchemaContext(modules)); - - StructuredDataToJsonProvider structuredDataToJsonProvider = StructuredDataToJsonProvider.INSTANCE; - structuredDataToJsonProvider.writeTo(new StructuredData(compositeNode, dataSchemaNode), null, null, null, null, - null, byteArrayOS); - - jsonResult = byteArrayOS.toString(); - if (outputPath != null) { - try { - outputToFile(byteArrayOS, outputPath); - } catch (IOException e) { - System.out.println("Output file wasn't cloased sucessfuly."); + public static QName buildQName(String name, String uri, String date, String prefix) { + try { + 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 null; } - - return jsonResult; } - static CompositeNode loadCompositeNode(String xmlDataPath) { - InputStream xmlStream = ToJsonBasicDataTypesTest.class.getResourceAsStream(xmlDataPath); - CompositeNode compositeNode = null; - try { - compositeNode = TestUtils.loadCompositeNode(xmlStream); - } catch (FileNotFoundException e) { - e.printStackTrace(); - } - return compositeNode; + public static QName buildQName(String name, String uri, String date) { + return buildQName(name, uri, date, null); } - static void outputToFile(ByteArrayOutputStream outputStream, String outputDir) throws IOException { - FileOutputStream fileOS = null; - try { - String path = ToJsonBasicDataTypesTest.class.getResource(outputDir).getPath(); - File outFile = new File(path + "/data.json"); - fileOS = new FileOutputStream(outFile); - try { - fileOS.write(outputStream.toByteArray()); - } catch (IOException e) { - e.printStackTrace(); - } - fileOS.close(); - } catch (FileNotFoundException e1) { - e1.printStackTrace(); - } + public static QName buildQName(String name) { + return buildQName(name, "", null); } - static String readJsonFromFile(String path, boolean removeWhiteChars) { - FileReader fileReader = getFileReader(path); - - StringBuilder strBuilder = new StringBuilder(); - char[] buffer = new char[1000]; - - while (true) { - int loadedCharNum; - try { - loadedCharNum = fileReader.read(buffer); - } catch (IOException e) { - break; - } - if (loadedCharNum == -1) { - break; + private static void addDummyNamespaceToAllNodes(NodeWrapper wrappedNode) throws URISyntaxException { + wrappedNode.setNamespace(new URI("")); + if (wrappedNode instanceof CompositeNodeWrapper) { + for (NodeWrapper childNodeWrapper : ((CompositeNodeWrapper) wrappedNode).getValues()) { + addDummyNamespaceToAllNodes(childNodeWrapper); } - strBuilder.append(buffer, 0, loadedCharNum); - } - try { - fileReader.close(); - } catch (IOException e) { - System.out.println("The file wasn't closed"); } - String rawStr = strBuilder.toString(); - if (removeWhiteChars) { - rawStr = rawStr.replace("\n", ""); - rawStr = rawStr.replace("\r", ""); - rawStr = rawStr.replace("\t", ""); - rawStr = removeSpaces(rawStr); - } - - return rawStr; } - private static FileReader getFileReader(String path) { - String fullPath = ToJsonBasicDataTypesTest.class.getResource(path).getPath(); - assertNotNull("Path to file can't be null.", fullPath); - File file = new File(fullPath); - assertNotNull("File can't be null", file); - FileReader fileReader = null; - try { - fileReader = new FileReader(file); - } catch (FileNotFoundException e) { - e.printStackTrace(); - } - assertNotNull("File reader can't be null.", fileReader); - return fileReader; - } + private static void prepareMocksForRestconf(Set modules, RestconfImpl restconf) { + ControllerContext controllerContext = ControllerContext.getInstance(); + BrokerFacade mockedBrokerFacade = mock(BrokerFacade.class); - private static String removeSpaces(String rawStr) { - StringBuilder strBuilder = new StringBuilder(); - int i = 0; - int quoteCount = 0; - while (i < rawStr.length()) { - if (rawStr.substring(i, i + 1).equals("\"")) { - quoteCount++; - } + controllerContext.setSchemas(TestUtils.loadSchemaContext(modules)); - if (!rawStr.substring(i, i + 1).equals(" ") || (quoteCount % 2 == 1)) { - strBuilder.append(rawStr.charAt(i)); - } - i++; - } + when(mockedBrokerFacade.commitConfigurationDataPut(any(YangInstanceIdentifier.class), any(CompositeNode.class))) + .thenReturn( + new DummyFuture.Builder().rpcResult( + new DummyRpcResult.Builder().result(TransactionStatus.COMMITED) + .build()).build()); - return strBuilder.toString(); + restconf.setControllerContext(controllerContext); + restconf.setBroker(mockedBrokerFacade); } - static QName buildQName(String name, String uri, String date) { + public static CompositeNode readInputToCnSn(String path, boolean dummyNamespaces, + MessageBodyReader reader) throws WebApplicationException { + + InputStream inputStream = TestUtils.class.getResourceAsStream(path); try { - URI u = new URI(uri); - Date dt = null; - if (date != null) { - dt = Date.valueOf(date); + CompositeNode compositeNode = reader.readFrom(null, null, null, null, null, inputStream); + 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 new QName(u, dt, name); - } catch (URISyntaxException e) { - return null; + return compositeNode; + } catch (IOException e) { + LOG.error(e.getMessage()); + assertTrue(e.getMessage(), false); } + return null; } - static QName buildQName(String name) { - return buildQName(name, "", null); + public static CompositeNode readInputToCnSn(String path, MessageBodyReader reader) { + return readInputToCnSn(path, false, reader); } - static void supplementNamespace(DataSchemaNode dataSchemaNode, CompositeNode compositeNode) { - RestconfImpl restconf = RestconfImpl.getInstance(); - - InstanceIdWithSchemaNode instIdAndSchema = new InstanceIdWithSchemaNode(mock(InstanceIdentifier.class), - dataSchemaNode); + public static String writeCompNodeWithSchemaContextToOutput(CompositeNode compositeNode, Set modules, + DataSchemaNode dataSchemaNode, MessageBodyWriter messageBodyWriter) throws IOException, + WebApplicationException { - ControllerContext controllerContext = mock(ControllerContext.class); - BrokerFacade broker = mock(BrokerFacade.class); - - RpcResult rpcResult = new DummyRpcResult.Builder().result( - TransactionStatus.COMMITED).build(); - Future> future = DummyFuture.builder().rpcResult(rpcResult).build(); - when(controllerContext.toInstanceIdentifier(any(String.class))).thenReturn(instIdAndSchema); - when(broker.commitConfigurationDataPut(any(InstanceIdentifier.class), any(CompositeNode.class))).thenReturn( - future); + assertNotNull(dataSchemaNode); + assertNotNull("Composite node can't be null", compositeNode); + ByteArrayOutputStream byteArrayOS = new ByteArrayOutputStream(); - restconf.setControllerContext(controllerContext); - restconf.setBroker(broker); + ControllerContext.getInstance().setSchemas(loadSchemaContext(modules)); - // method is called only because it contains call of method which - // supplement namespaces to compositeNode - restconf.createConfigurationData("something", compositeNode); - } + messageBodyWriter.writeTo(new StructuredData(compositeNode, dataSchemaNode, null), null, null, null, null, + null, byteArrayOS); - static DataSchemaNode obtainSchemaFromYang(String yangFolder) throws FileNotFoundException { - return obtainSchemaFromYang(yangFolder, null); + return byteArrayOS.toString(); } - static DataSchemaNode obtainSchemaFromYang(String yangFolder, String moduleName) throws FileNotFoundException { - Set modules = null; - modules = TestUtils.loadModules(ToJsonBasicDataTypesTest.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(String filePath) throws IOException { + FileReader fileReader = new FileReader(filePath); + BufferedReader bufReader = new BufferedReader(fileReader); - if (moduleRes.getChildNodes() == null) { - return null; - } - - if (moduleRes.getChildNodes().size() != 1) { - return null; + String line = null; + 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(); } - 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(String... substrings) { + StringBuilder pattern = new StringBuilder(); + pattern.append(".*"); + for (String substring : substrings) { + pattern.append(substring); + pattern.append("\\s*"); } + pattern.append(".*"); + return Pattern.compile(pattern.toString(), Pattern.DOTALL); } + public static boolean containsStringData(String jsonOutput, String... substrings) { + Pattern pattern = patternForStringsSeparatedByWhiteChars(substrings); + Matcher matcher = pattern.matcher(jsonOutput); + return matcher.matches(); + } }