홍길동 / onos

Go to a project
Toggle navigation Toggle navigation pinning
Bharat saraswal
Committed by Gerrit Code Review
8f2a6c5b 1 parent 07b54481

[ONOS-4144] ,[ONOS-4145] Bug fixes for YANG translator. 

Change-Id: I6922c01269611b3aec61a9e46cda5166f8fe1ec0
Expand all
Inline Side-by-side
Showing 11 changed files with 80 additions and 259 deletions
......@@ -333,6 +333,7 @@ public class YangTypeDef extends YangNode implements YangCommonInfo, Parsable {
throw new IOException("Failed to create the source files.");
}
setFileHandle(handle);
getDerivedType().getDataTypeExtendedInfo().getBaseType().setJavaPackage(getPackage());
addAttributeInfo();
addAttributeInParent();
}
......
......@@ -17,7 +17,6 @@
package org.onosproject.yangutils.plugin.manager;
import java.io.File;
import java.io.IOException;
import java.util.Iterator;
import java.util.List;
......@@ -56,6 +55,12 @@ public class YangUtilManager extends AbstractMojo {
private String yangFilesDir;
/**
* Source directory for generated files.
*/
@Parameter(property = "genFilesDir", defaultValue = "src/main/java")
private String genFilesDir;
/**
* Base directory for project.
*/
@Parameter(property = "basedir", defaultValue = "${basedir}")
......@@ -105,7 +110,7 @@ public class YangUtilManager extends AbstractMojo {
YangIoUtils.clean(baseDir);
searchDir = baseDir + File.separator + yangFilesDir;
codeGenDir = baseDir + File.separator + UtilConstants.YANG_GEN_DIR;
codeGenDir = baseDir + File.separator + genFilesDir + File.separator;
List<String> yangFiles = YangFileScanner.getYangFiles(searchDir);
Iterator<String> yangFileIterator = yangFiles.iterator();
......@@ -129,8 +134,8 @@ public class YangUtilManager extends AbstractMojo {
}
YangIoUtils.addToSource(baseDir + File.separator + UtilConstants.YANG_GEN_DIR, project, context);
} catch (final IOException e) {
getLog().info("IOException occured");
} catch (Exception e) {
getLog().info(e);
}
}
......
......@@ -305,8 +305,8 @@ public class CachedJavaFileHandle implements CachedFileHandle {
@Override
public void close() throws IOException {
List<AttributeInfo> attrList = getCachedAttributeList();
flushCacheAttrToTempFile();
String className = getYangName();
className = JavaIdentifierSyntax.getCaptialCase(className);
String path = getRelativeFilePath();
......@@ -322,11 +322,14 @@ public class CachedJavaFileHandle implements CachedFileHandle {
for (ImportInfo importInfo : new ArrayList<ImportInfo>(getImportSet())) {
importString = UtilConstants.IMPORT;
if (importInfo.getPkgInfo() != null) {
if (importInfo.getPkgInfo() != "" && importInfo.getClassInfo() != null
&& importInfo.getPkgInfo() != UtilConstants.JAVA_LANG) {
importString = importString + importInfo.getPkgInfo() + ".";
importString = importString + importInfo.getClassInfo() + UtilConstants.SEMI_COLAN
+ UtilConstants.NEW_LINE;
imports.add(importString);
}
importString = importString + importInfo.getClassInfo() + UtilConstants.SEMI_COLAN + UtilConstants.NEW_LINE;
imports.add(importString);
}
java.util.Collections.sort(imports);
......@@ -342,7 +345,7 @@ public class CachedJavaFileHandle implements CachedFileHandle {
String interfaceFileName = className;
File interfaceFile = JavaFileGenerator.getFileObject(path, interfaceFileName, JAVA_FILE_EXTENSION, this);
interfaceFile = JavaFileGenerator.generateInterfaceFile(interfaceFile, className, imports,
getCachedAttributeList(), path.replace('/', '.'), this);
attrList, path.replace('/', '.'), this);
/**
* Create temp builder interface file.
*/
......@@ -350,7 +353,7 @@ public class CachedJavaFileHandle implements CachedFileHandle {
File builderInterfaceFile = JavaFileGenerator.getFileObject(path, builderInterfaceFileName,
TEMP_FILE_EXTENSION, this);
builderInterfaceFile = JavaFileGenerator.generateBuilderInterfaceFile(builderInterfaceFile, className,
path.replace('/', '.'), getCachedAttributeList(), this);
path.replace('/', '.'), attrList, this);
/**
* Append builder interface file to interface file and close it.
*/
......@@ -369,9 +372,11 @@ public class CachedJavaFileHandle implements CachedFileHandle {
JavaFileGenerator.clean(builderInterfaceFile);
}
imports.add(UtilConstants.MORE_OBJECT_IMPORT);
imports.add(UtilConstants.JAVA_UTIL_OBJECTS_IMPORT);
java.util.Collections.sort(imports);
if (!attrList.isEmpty()) {
imports.add(UtilConstants.MORE_OBJECT_IMPORT);
imports.add(UtilConstants.JAVA_UTIL_OBJECTS_IMPORT);
java.util.Collections.sort(imports);
}
if ((fileType & GeneratedFileType.BUILDER_CLASS_MASK) != 0
|| fileType == GeneratedFileType.GENERATE_INTERFACE_WITH_BUILDER) {
......@@ -382,7 +387,7 @@ public class CachedJavaFileHandle implements CachedFileHandle {
String builderFileName = className + UtilConstants.BUILDER;
File builderFile = JavaFileGenerator.getFileObject(path, builderFileName, JAVA_FILE_EXTENSION, this);
builderFile = JavaFileGenerator.generateBuilderClassFile(builderFile, className, imports,
path.replace('/', '.'), getCachedAttributeList(), this);
path.replace('/', '.'), attrList, this);
/**
* Create temp impl class file.
*/
......@@ -390,7 +395,7 @@ public class CachedJavaFileHandle implements CachedFileHandle {
String implFileName = className + UtilConstants.IMPL;
File implTempFile = JavaFileGenerator.getFileObject(path, implFileName, TEMP_FILE_EXTENSION, this);
implTempFile = JavaFileGenerator.generateImplClassFile(implTempFile, className,
path.replace('/', '.'), getCachedAttributeList(), this);
path.replace('/', '.'), attrList, this);
/**
* Append impl class to builder class and close it.
*/
......@@ -418,7 +423,7 @@ public class CachedJavaFileHandle implements CachedFileHandle {
String typeDefFileName = className;
File typeDefFile = JavaFileGenerator.getFileObject(path, typeDefFileName, JAVA_FILE_EXTENSION, this);
typeDefFile = JavaFileGenerator.generateTypeDefClassFile(typeDefFile, className, imports,
path.replace('/', '.'), getCachedAttributeList(), this);
path.replace('/', '.'), attrList, this);
JavaFileGenerator.insert(typeDefFile,
JavaFileGenerator.closeFile(GeneratedFileType.GENERATE_TYPEDEF_CLASS, typeDefFileName));
......@@ -428,10 +433,17 @@ public class CachedJavaFileHandle implements CachedFileHandle {
JavaFileGenerator.closeFileHandles(typeDefFile);
}
closeTempDataFileHandles(className, getCodeGenFilePath() + getRelativeFilePath());
JavaFileGenerator
.cleanTempFiles(new File(getCodeGenFilePath() + getRelativeFilePath() + File.separator + className
+ TEMP_FOLDER_NAME_SUFIX));
if (!getCachedAttributeList().isEmpty()) {
closeTempDataFileHandles(className, getCodeGenFilePath() + getRelativeFilePath());
JavaFileGenerator
.cleanTempFiles(new File(getCodeGenFilePath() + getRelativeFilePath() + File.separator + className
+ TEMP_FOLDER_NAME_SUFIX));
}
/*
* clear the contents from the cached attribute list.
*/
getCachedAttributeList().clear();
}
@Override
......@@ -512,7 +524,12 @@ public class CachedJavaFileHandle implements CachedFileHandle {
+ File.separator + className + TEMP_FOLDER_NAME_SUFIX + File.separator;
try {
return readFile(path + fileName + TEMP_FILE_EXTENSION);
String file = path + fileName + TEMP_FILE_EXTENSION;
if (new File(file).exists()) {
return readFile(path + fileName + TEMP_FILE_EXTENSION);
} else {
return "";
}
} catch (FileNotFoundException e) {
throw new FileNotFoundException("No such file or directory.");
......@@ -533,8 +550,14 @@ public class CachedJavaFileHandle implements CachedFileHandle {
String line = bufferReader.readLine();
while (line != null) {
stringBuilder.append(line);
stringBuilder.append("\n");
if (line.equals(UtilConstants.FOUR_SPACE_INDENTATION)
|| line.equals(UtilConstants.EIGHT_SPACE_INDENTATION)
|| line.equals(UtilConstants.SPACE) || line.equals("") || line.equals(UtilConstants.NEW_LINE)) {
stringBuilder.append("\n");
} else {
stringBuilder.append(line);
stringBuilder.append("\n");
}
line = bufferReader.readLine();
}
return stringBuilder.toString();
......
......@@ -84,7 +84,7 @@ public final class ClassDefinitionGenerator {
*/
private static String getBuilderInterfaceDefinition(String yangName) {
return UtilConstants.INTERFACE + UtilConstants.SPACE + yangName + UtilConstants.BUILDER + UtilConstants.SPACE
+ UtilConstants.OPEN_CURLY_BRACKET + UtilConstants.NEW_LINE;
+ UtilConstants.OPEN_CURLY_BRACKET + UtilConstants.NEW_LINE + UtilConstants.NEW_LINE;
}
/**
......@@ -112,8 +112,7 @@ public final class ClassDefinitionGenerator {
return UtilConstants.PUBLIC + UtilConstants.SPACE + UtilConstants.FINAL + UtilConstants.SPACE
+ UtilConstants.CLASS + UtilConstants.SPACE + yangName + UtilConstants.IMPL + UtilConstants.SPACE
+ UtilConstants.IMPLEMENTS + UtilConstants.SPACE + yangName + UtilConstants.SPACE
+ UtilConstants.OPEN_CURLY_BRACKET
+ UtilConstants.SPACE + UtilConstants.NEW_LINE;
+ UtilConstants.OPEN_CURLY_BRACKET + UtilConstants.NEW_LINE + UtilConstants.NEW_LINE;
}
/**
......@@ -126,7 +125,7 @@ public final class ClassDefinitionGenerator {
return UtilConstants.PUBLIC + UtilConstants.SPACE + UtilConstants.FINAL + UtilConstants.SPACE
+ UtilConstants.CLASS + UtilConstants.SPACE + yangName + UtilConstants.SPACE
+ UtilConstants.OPEN_CURLY_BRACKET + UtilConstants.SPACE + UtilConstants.NEW_LINE;
+ UtilConstants.OPEN_CURLY_BRACKET + UtilConstants.NEW_LINE;
}
}
......
......@@ -434,7 +434,7 @@ public final class MethodsGenerator {
String constructor = UtilConstants.EIGHT_SPACE_INDENTATION + UtilConstants.THIS
+ UtilConstants.PERIOD + JavaIdentifierSyntax.getCamelCase(attributeName)
+ UtilConstants.SPACE + UtilConstants.EQUAL + UtilConstants.SPACE + builderAttribute
+ UtilConstants.OBJECT + UtilConstants.PERIOD + UtilConstants.GET_METHOD_PREFIX
+ UtilConstants.BUILDER + UtilConstants.OBJECT + UtilConstants.PERIOD + UtilConstants.GET_METHOD_PREFIX
+ JavaIdentifierSyntax.getCaptialCase(JavaIdentifierSyntax.getCamelCase(attributeName))
+ UtilConstants.OPEN_PARENTHESIS + UtilConstants.CLOSE_PARENTHESIS + UtilConstants.SEMI_COLAN
+ UtilConstants.NEW_LINE;
......@@ -539,7 +539,6 @@ public final class MethodsGenerator {
public static String getHashCodeMethodClose(String hashcodeString) {
hashcodeString = YangIoUtils.trimAtLast(hashcodeString, UtilConstants.COMMA);
hashcodeString = YangIoUtils.trimAtLast(hashcodeString, UtilConstants.SPACE);
hashcodeString = YangIoUtils.partString(hashcodeString);
return hashcodeString + UtilConstants.CLOSE_PARENTHESIS + UtilConstants.SEMI_COLAN + UtilConstants.NEW_LINE
+ UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.CLOSE_CURLY_BRACKET;
}
......
......@@ -119,7 +119,7 @@ public final class UtilConstants {
/**
* For directories.
*/
public static final String YANG_GEN_DIR = "src/main/yangmodel/";
public static final String YANG_GEN_DIR = "src/main/java/";
public static final String DEFAULT_BASE_PKG = "org.onosproject.yang.gen";
public static final String REVISION_PREFIX = "rev";
public static final String VERSION_PREFIX = "v";
......
......@@ -122,8 +122,14 @@ public final class FileSystemUtil {
String line = bufferReader.readLine();
while (line != null) {
stringBuilder.append(UtilConstants.FOUR_SPACE_INDENTATION + line);
stringBuilder.append("\n");
if (line.equals(UtilConstants.FOUR_SPACE_INDENTATION)
|| line.equals(UtilConstants.EIGHT_SPACE_INDENTATION)
|| line.equals(UtilConstants.SPACE) || line.equals("") || line.equals(UtilConstants.NEW_LINE)) {
stringBuilder.append("\n");
} else {
stringBuilder.append(UtilConstants.FOUR_SPACE_INDENTATION + line);
stringBuilder.append("\n");
}
line = bufferReader.readLine();
}
return stringBuilder.toString();
......
......@@ -245,8 +245,8 @@ public final class JavaDocGen {
* @return javaDocs
*/
private static String generateForImplClass(String className) {
return UtilConstants.JAVA_DOC_FIRST_LINE + UtilConstants.IMPL_CLASS_JAVA_DOC + className + UtilConstants.PERIOD
+ UtilConstants.NEW_LINE + UtilConstants.JAVA_DOC_END_LINE;
return UtilConstants.NEW_LINE + UtilConstants.JAVA_DOC_FIRST_LINE + UtilConstants.IMPL_CLASS_JAVA_DOC
+ className + UtilConstants.PERIOD + UtilConstants.NEW_LINE + UtilConstants.JAVA_DOC_END_LINE;
}
/**
......@@ -310,13 +310,15 @@ public final class JavaDocGen {
* @return javaDocs
*/
private static String generateForConstructors(String className) {
return UtilConstants.JAVA_DOC_FIRST_LINE + UtilConstants.FOUR_SPACE_INDENTATION
+ UtilConstants.JAVA_DOC_CONSTRUCTOR + className + UtilConstants.IMPL + UtilConstants.PERIOD
+ UtilConstants.NEW_LINE + UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.NEW_LINE_ESTRIC
return UtilConstants.NEW_LINE + UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.JAVA_DOC_FIRST_LINE
+ UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.JAVA_DOC_CONSTRUCTOR + className
+ UtilConstants.IMPL + UtilConstants.PERIOD + UtilConstants.NEW_LINE
+ UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.NEW_LINE_ESTRIC
+ UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.JAVA_DOC_PARAM
+ className.substring(0, 1).toLowerCase() + className.substring(1) + UtilConstants.OBJECT
+ UtilConstants.SPACE + UtilConstants.BUILDER_OBJECT + UtilConstants.SPACE + className
+ UtilConstants.NEW_LINE + UtilConstants.FOUR_SPACE_INDENTATION + UtilConstants.JAVA_DOC_END_LINE;
+ className.substring(0, 1).toLowerCase() + className.substring(1) + UtilConstants.BUILDER
+ UtilConstants.OBJECT + UtilConstants.SPACE + UtilConstants.BUILDER_OBJECT + UtilConstants.SPACE
+ className + UtilConstants.NEW_LINE + UtilConstants.FOUR_SPACE_INDENTATION
+ UtilConstants.JAVA_DOC_END_LINE;
}
/**
......
/*
* Copyright 2016 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.yangutils.utils.io.impl;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInput;
import java.io.ObjectInputStream;
import java.io.ObjectOutput;
import java.io.ObjectOutputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.List;
/**
* Provides storage for Temp data while traversing data model tree for code
* generation.
*/
public final class TempDataStore {
/**
* Data Store types.
*/
public static enum TempDataStoreType {
/**
* Methods.
*/
GETTER_METHODS,
/**
* Methods.
*/
BUILDER_METHODS,
/**
* Methods.
*/
BUILDER_INTERFACE_METHODS,
/**
* Methods.
*/
IMPL_METHODS,
/**
* Attributes.
*/
ATTRIBUTE,
/**
* Imports.
*/
IMPORT
}
/**
* File name string for Temp files of methods.
*/
private static final String GETTER_METHOD_FILE_NAME = "TempGetterMethodDataStore";
/**
* File name string for Temp files of methods.
*/
private static final String BUILDER_METHOD_FILE_NAME = "TempBuilderMethodDataStore";
/**
* File name string for Temp files of methods.
*/
private static final String BUILDER_INTERFACE_METHOD_FILE_NAME = "TempBuilderInterfaceMethodDataStore";
/**
* File name string for Temp files of methods.
*/
private static final String IMPL_METHOD_FILE_NAME = "TempImplMethodDataStore";
/**
* File name string for Temp files of attributes.
*/
private static final String ATTRIBUTE_FILE_NAME = "TempAttributeDataStore";
/**
* File name string for Temp files of imports.
*/
private static final String IMPORT_FILE_NAME = "TempImportDataStore";
/**
* File extension of Temp files.
*/
private static final String FILE_EXTENSION = ".tmp";
/**
* Directory for generating Temp files.
*/
private static final String GEN_DIR = "target/";
/**
* Buffer size.
*/
private static final int BUFFER_SIZE = 8 * 1024;
/**
* Default constructor.
*/
private TempDataStore() {
}
/**
* Writes specific info to a Temp file.
*
* @param data data to be stored
* @param type type of Temp data store
* @param className class name
* @throws IOException when fails to create a Temp data file
*/
public static void setTempData(String data, TempDataStoreType type, String className) throws IOException {
String fileName = "";
if (type.equals(TempDataStoreType.ATTRIBUTE)) {
fileName = ATTRIBUTE_FILE_NAME;
} else if (type.equals(TempDataStoreType.GETTER_METHODS)) {
fileName = GETTER_METHOD_FILE_NAME;
} else if (type.equals(TempDataStoreType.BUILDER_INTERFACE_METHODS)) {
fileName = BUILDER_INTERFACE_METHOD_FILE_NAME;
} else if (type.equals(TempDataStoreType.BUILDER_METHODS)) {
fileName = BUILDER_METHOD_FILE_NAME;
} else if (type.equals(TempDataStoreType.IMPL_METHODS)) {
fileName = IMPL_METHOD_FILE_NAME;
} else {
fileName = IMPORT_FILE_NAME;
}
File dir = new File(GEN_DIR + className + File.separator);
dir.mkdirs();
try {
OutputStream file = new FileOutputStream(GEN_DIR + className + File.separator + fileName + FILE_EXTENSION);
OutputStream buffer = new BufferedOutputStream(file, BUFFER_SIZE);
ObjectOutput output = new ObjectOutputStream(buffer);
try {
output.writeObject(data);
} finally {
output.close();
}
} catch (IOException ex) {
throw new IOException("failed to serialize data");
}
}
/**
* Get the Temp data.
*
* @param type type of Temp data store
* @param className name of the class
* @return list of attribute info
* @throws IOException when fails to read from the file
* @throws ClassNotFoundException when class is missing
* @throws FileNotFoundException when file is missing
*/
public static List<String> getTempData(TempDataStoreType type, String className)
throws IOException, FileNotFoundException, ClassNotFoundException {
String fileName = "";
if (type.equals(TempDataStoreType.ATTRIBUTE)) {
fileName = ATTRIBUTE_FILE_NAME;
} else if (type.equals(TempDataStoreType.GETTER_METHODS)) {
fileName = GETTER_METHOD_FILE_NAME;
} else if (type.equals(TempDataStoreType.BUILDER_INTERFACE_METHODS)) {
fileName = BUILDER_INTERFACE_METHOD_FILE_NAME;
} else if (type.equals(TempDataStoreType.BUILDER_METHODS)) {
fileName = BUILDER_METHOD_FILE_NAME;
} else if (type.equals(TempDataStoreType.IMPL_METHODS)) {
fileName = IMPL_METHOD_FILE_NAME;
} else {
fileName = IMPORT_FILE_NAME;
}
try {
InputStream file = new FileInputStream(GEN_DIR + className + File.separator + fileName + FILE_EXTENSION);
InputStream buffer = new BufferedInputStream(file);
ObjectInput input = new ObjectInputStream(buffer);
try {
String data = (String) input.readObject();
List<String> recoveredData = new ArrayList<>();
recoveredData.add(data);
return recoveredData;
} finally {
input.close();
file.close();
}
} catch (FileNotFoundException ex) {
throw new FileNotFoundException("No such file or directory.");
} catch (ClassNotFoundException ex) {
throw new ClassNotFoundException("failed to fetch the Temp data file.");
}
}
}
......@@ -94,7 +94,8 @@ public final class YangIoUtils {
* @param baseDir generated directory in previous build
*/
public static void clean(String baseDir) {
File generatedDirectory = new File(baseDir + File.separator + UtilConstants.YANG_GEN_DIR);
File generatedDirectory = new File(baseDir + File.separator + UtilConstants.YANG_GEN_DIR
+ UtilConstants.DEFAULT_BASE_PKG.replace(UtilConstants.PERIOD, UtilConstants.SLASH));
if (generatedDirectory.exists()) {
List<String> javafiles;
try {
......@@ -151,10 +152,11 @@ public final class YangIoUtils {
String[] strArray = partString.split(UtilConstants.COMMA);
String newString = "";
for (int i = 0; i < strArray.length; i++) {
if (i % 4 != 0) {
if (i % 4 != 0 || i == 0) {
newString = newString + strArray[i] + UtilConstants.COMMA;
} else {
newString = newString + UtilConstants.NEW_LINE + UtilConstants.TWELVE_SPACE_INDENTATION + strArray[i]
newString = newString + UtilConstants.NEW_LINE + UtilConstants.TWELVE_SPACE_INDENTATION
+ strArray[i]
+ UtilConstants.COMMA;
}
}
......