This commit is the first of a series aiming to decouple the writing and formatting logic of text report files in the asdc tool. Unfortunately because of a significant amount of technical debt, a small hack had to be done so that the header of the file is not written twice. This will be removed in a future change.
Signed-off-by: Francis Toth <francis.toth@yoppworks.com>
Change-Id: I8d2a7c1353d59562d8026088824c26ae0daa36e9
Issue-ID: SDC-2499
import org.openecomp.sdc.asdctool.impl.validator.executers.ValidatorExecuter;
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
+import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile;
import org.openecomp.sdc.common.log.wrappers.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class ValidationToolBL {
- private static Logger log = Logger.getLogger(ValidationToolBL.class.getName());
+ private static final Logger log = Logger.getLogger(ValidationToolBL.class);
protected List<ValidatorExecuter> validators;
this.validators = validators;
}
- public boolean validateAll(Report report, String outputFilePath) {
+ public boolean validateAll(Report report, ReportFile.TXTFile textFile, String outputFilePath) {
for (ValidatorExecuter validatorExec: validators) {
log.debug("ValidatorExecuter "+validatorExec.getName()+" started");
- if (!validatorExec.executeValidations(report, outputFilePath)) {
+ if (!validatorExec.executeValidations(report, textFile, outputFilePath)) {
allValid = false;
log.debug("ValidatorExecuter "+validatorExec.getName()+" finished with warnings");
}
package org.openecomp.sdc.asdctool.impl.validator.executers;
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
+import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.TXTFile;
import org.openecomp.sdc.asdctool.impl.validator.tasks.ServiceValidationTask;
import org.openecomp.sdc.be.dao.jsongraph.GraphVertex;
import org.openecomp.sdc.be.dao.jsongraph.JanusGraphDao;
}
@Override
- public boolean executeValidations(Report report, String outputFilePath) {
+ public boolean executeValidations(Report report, TXTFile reportFile, String outputFilePath) {
List<GraphVertex> vertices = getVerticesToValidate(ComponentTypeEnum.SERVICE);
- return validate(report, tasks, vertices, outputFilePath);
- }
-
- @Override
- public String getName() {
- return super.getName();
+ return validate(report, tasks, vertices, reportFile, outputFilePath);
}
}
import fj.data.Either;
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
+import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.TXTFile;
import org.openecomp.sdc.asdctool.impl.validator.tasks.TopologyTemplateValidationTask;
import org.openecomp.sdc.asdctool.impl.validator.utils.ReportManager;
import org.openecomp.sdc.asdctool.impl.validator.utils.VertexResult;
public class TopologyTemplateValidatorExecuter {
- private static Logger log = Logger.getLogger(VfValidatorExecuter.class.getName());
+ private static final Logger log = Logger.getLogger(VfValidatorExecuter.class);
protected JanusGraphDao janusGraphDao;
return results.left().value();
}
- protected boolean validate(Report report, List<? extends TopologyTemplateValidationTask> tasks, List<GraphVertex> vertices,
- String outputFilePath) {
+ protected boolean validate(
+ Report report,
+ List<? extends TopologyTemplateValidationTask> tasks,
+ List<GraphVertex> vertices,
+ TXTFile reportFile,
+ String outputFilePath
+ ) {
ReportManager.reportStartValidatorRun(getName(), vertices.size(), outputFilePath);
Set<String> failedTasks = new HashSet<>();
Set<String> successTasks = new HashSet<>();
vertexNum++;
boolean successAllTasks = true;
for (TopologyTemplateValidationTask task : tasks) {
- ReportManager.reportStartTaskRun(vertex, task.getTaskName(), outputFilePath);
+ reportFile.reportStartTaskRun(vertex, task.getTaskName());
VertexResult result = task.validate(report, vertex, outputFilePath);
if (!result.getStatus()) {
failedTasks.add(task.getTaskName());
package org.openecomp.sdc.asdctool.impl.validator.executers;
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
+import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.TXTFile;
public interface ValidatorExecuter {
- boolean executeValidations(Report report, String outputFilePath);
+ boolean executeValidations(Report report, TXTFile textFile, String outputFilePath);
String getName();
}
package org.openecomp.sdc.asdctool.impl.validator.executers;
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
+import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.TXTFile;
import org.openecomp.sdc.asdctool.impl.validator.tasks.VfValidationTask;
import org.openecomp.sdc.be.dao.jsongraph.GraphVertex;
import org.openecomp.sdc.be.dao.jsongraph.JanusGraphDao;
}
@Override
- public boolean executeValidations(Report report, String outputFilePath) {
+ public boolean executeValidations(Report report, TXTFile reportFile, String outputFilePath) {
List<GraphVertex> vertices = getVerticesToValidate(ComponentTypeEnum.RESOURCE);
- return validate(report, tasks, vertices, outputFilePath);
- }
-
- @Override
- public String getName() {
- return super.getName();
+ return validate(report, tasks, vertices, reportFile, outputFilePath);
}
}
* a {@link org.openecomp.sdc.asdctool.impl.validator.report.ReportFileWriter }.
*/
public interface FileType {
+ interface TXT extends FileType { }
+
interface CSV extends FileType { }
}
package org.openecomp.sdc.asdctool.impl.validator.report;
+import org.openecomp.sdc.be.dao.jsongraph.GraphVertex;
+
/**
* Provides business logic in regards to file writing required by the validation tools
*/
public class ReportFile {
+ // TODO: Delete this function once all the report file business logic has been moved to ReportFile
+ static public TXTFile makeAppendableTxtFile(ReportFileWriter<FileType.TXT> writer) {
+ return new TXTFile(writer);
+ }
+
+ static public TXTFile makeTxtFile(ReportFileWriter<FileType.TXT> writer) {
+ writer.writeln("-----------------------Validation Tool Results:-------------------------");
+ return new TXTFile(writer);
+ }
+
static public CSVFile makeCsvFile(ReportFileWriter<FileType.CSV> writer) {
writer.writeln("Vertex ID,Task Name,Success,Result Details,Result Description");
return new CSVFile(writer);
}
+ /**
+ * Provides csv writing business logic related to {@link org.openecomp.sdc.asdctool.main.ValidationTool}
+ */
+ public static final class TXTFile extends ReportFile {
+
+ private final ReportFileWriter<FileType.TXT> writer;
+
+ private TXTFile(ReportFileWriter<FileType.TXT> writer) {
+ this.writer = writer;
+ }
+
+ public void reportStartTaskRun(GraphVertex vertex, String taskName) {
+ writer.writeln("");
+ writer.writeln("-----------------------Vertex: " + vertex.getUniqueId() +
+ ", Task " + taskName + " Started-----------------------");
+ }
+ }
+
/**
* Provides csv writing business logic related to {@link org.openecomp.sdc.asdctool.main.ValidationTool}
*/
import java.io.IOException;
import java.nio.file.Files;
+import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.util.Set;
}
private void initReportFile(String txtReportFilePath) throws IOException {
- StrBuilder sb = new StrBuilder();
- sb.appendln("-----------------------Validation Tool Results:-------------------------");
- Files.write(Paths.get(txtReportFilePath), sb.toString().getBytes());
+ Path path = Paths.get(txtReportFilePath);
+ // TODO: Remove this once all the report file business logic has been moved to ReportFile
+ if(Files.notExists(path)) {
+ StrBuilder sb = new StrBuilder();
+ sb.appendln("-----------------------Validation Tool Results:-------------------------");
+ Files.write(path, sb.toString().getBytes());
+ }
}
public static void printValidationTaskStatus(GraphVertex vertexScanned, String taskName, boolean success,
writeReportLineToFile(sb.toString(), outputFilePath);
}
- public static void reportStartTaskRun(GraphVertex vertex, String taskName, String outputFilePath) {
- StrBuilder sb = new StrBuilder();
- sb.appendln("-----------------------Vertex: " + vertex.getUniqueId() + ", Task " + taskName
- + " Started-----------------------");
- writeReportLineToFile(sb.toString(), outputFilePath);
- }
-
public static void reportEndOfToolRun(Report report, String outputFilePath) {
StrBuilder sb = new StrBuilder();
sb.appendln("-----------------------------------Validator Tool Summary-----------------------------------");
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile;
import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.CSVFile;
+import org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.TXTFile;
import org.openecomp.sdc.asdctool.impl.validator.report.ReportFileWriter;
import org.openecomp.sdc.asdctool.impl.validator.utils.ReportManager;
import org.openecomp.sdc.be.config.ConfigurationManager;
String csvReportFilePath = ValidationConfigManager.csvReportFilePath(outputPath, System::currentTimeMillis);
CSVFile csvFile = ReportFile.makeCsvFile(makeNioWriter(Paths.get(csvReportFilePath)));
+ TXTFile textFile = ReportFile.makeTxtFile(makeNioWriter(Paths.get(txtReportFilePath)));
String appConfigDir = args[1];
AnnotationConfigApplicationContext context = initContext(appConfigDir);
log.info("Start Validation Tool");
Report report = Report.make();
- boolean result = validationToolBL.validateAll(report, txtReportFilePath);
+ boolean result = validationToolBL.validateAll(report, textFile, txtReportFilePath);
ReportManager.reportEndOfToolRun(report, txtReportFilePath);
csvFile.printAllResults(report);
if (result) {
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
import org.openecomp.sdc.be.dao.jsongraph.JanusGraphDao;
+import static org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.makeTxtFile;
+import static org.openecomp.sdc.asdctool.impl.validator.report.ReportFileWriterTestFactory.makeConsoleWriter;
+
import java.util.ArrayList;
import java.util.LinkedList;
Report report = Report.make();
// Initially no outputFilePath was passed to this function (hence it is set to null)
// TODO: Fix this null and see if the argument is used by this function
- testSubject.validateAll(report, null);
+ testSubject.validateAll(report, makeTxtFile(makeConsoleWriter()), null);
}
}
package org.openecomp.sdc.asdctool.impl.validator.executers;
+import static org.mockito.Mockito.mock;
+import static org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.makeTxtFile;
+import static org.openecomp.sdc.asdctool.impl.validator.report.ReportFileWriterTestFactory.makeConsoleWriter;
+
import org.junit.Test;
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
import org.openecomp.sdc.be.dao.jsongraph.JanusGraphDao;
-import static org.mockito.Mockito.mock;
-
public class ServiceValidatorExecuterTest {
private ServiceValidatorExecuter createTestSubject() {
Report report = Report.make();
// Initially no outputFilePath was passed to this function (hence it is set to null)
// TODO: Fix this null and see if the argument is used by this function
- createTestSubject().executeValidations(report, null);
+ createTestSubject().executeValidations(report, makeTxtFile(makeConsoleWriter()), null);
}
}
package org.openecomp.sdc.asdctool.impl.validator.executers;
+import static org.mockito.Mockito.mock;
+import static org.openecomp.sdc.asdctool.impl.validator.report.ReportFile.makeTxtFile;
+import static org.openecomp.sdc.asdctool.impl.validator.report.ReportFileWriterTestFactory.makeConsoleWriter;
+
+import java.util.ArrayList;
+import java.util.List;
import org.junit.Test;
import org.openecomp.sdc.asdctool.impl.validator.report.Report;
import org.openecomp.sdc.asdctool.impl.validator.tasks.VfValidationTask;
import org.openecomp.sdc.be.dao.jsongraph.JanusGraphDao;
-import java.util.ArrayList;
-import java.util.List;
-
-import static org.mockito.Mockito.mock;
-
public class VfValidatorExecuterTest {
private VfValidatorExecuter createTestSubject() {
Report report = Report.make();
// Initially no outputFilePath was passed to this function (hence it is set to null)
// TODO: Fix this null and see if the argument is used by this function
- createTestSubject().executeValidations(report, null);
+ createTestSubject().executeValidations(report, makeTxtFile(makeConsoleWriter()), null);
}
}
package org.openecomp.sdc.asdctool.impl.validator.report;
+import static org.openecomp.sdc.asdctool.impl.validator.report.ReportFileWriterTestFactory.makeNioWriter;
+
+import java.io.BufferedReader;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
+import java.util.List;
import java.util.function.Function;
+import java.util.stream.Collectors;
/**
* Provides facilities to for writing report files when testing
throw new RuntimeException(ex);
}
}
+
+ /**
+ * Provides a transactional context for TXT report file writing
+ *
+ * @param txtReportFilePath The resulting file path
+ * @param f The function to write in a TXT file
+ * @param <A> The type returned by the function consuming the file
+ */
+ public static <A> A withTxtFile(String txtReportFilePath, Function<ReportFile.TXTFile, A> f) {
+ // TODO: Switch to makeTxtFile once all the report file business logic has been moved to
+ // ReportFile
+ ReportFile.TXTFile file = ReportFile.makeAppendableTxtFile(makeNioWriter(txtReportFilePath));
+ A result = f.apply(file);
+ try {
+ Files.delete(Paths.get(txtReportFilePath));
+ return result;
+ } catch (IOException ex) {
+ throw new RuntimeException(ex);
+ }
+ }
+
+ /**
+ * Reads the content of a file and store each line in a list
+ * @param filePath The path to the file
+ */
+ public static List<String> readFileAsList(String filePath) {
+ try (BufferedReader br = Files.newBufferedReader(Paths.get(filePath))) {
+ return br.lines().collect(Collectors.toList());
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
}
public static <A extends FileType> ReportFileWriter<A> makeNioWriter(Path path) {
return ReportFileWriter.makeNioWriter(path, ex -> fail(ex.getMessage()));
}
+
+ /**
+ * Creates a writer rendering the data written in the console
+ * @param <A> a Phantom type used only for type-safety
+ */
+ public static <A extends FileType> ReportFileWriter<A> makeConsoleWriter() {
+ return new ReportFileWriter<A>() {
+ @Override
+ public void write(String line) {
+ System.out.print(line);
+ }
+ };
+ }
}
when(vertexScanned.getUniqueId()).thenReturn(UNIQUE_ID);
// when
- ReportManager.reportStartTaskRun(vertexScanned, TASK_1_NAME, txtReportFilePath);
-
- List<String> reportOutputFile = ReportManagerHelper.getReportOutputFileAsList(txtReportFilePath);
+ List<String> reportTxtFile = ReportFileNioHelper.withTxtFile(txtReportFilePath, file -> {
+ file.reportStartTaskRun(vertexScanned, TASK_1_NAME);
+ return ReportFileNioHelper.readFileAsList(txtReportFilePath);
+ });
// then
- assertNotNull(reportOutputFile);
- assertEquals(EXPECTED_OUTPUT_FILE_HEADER, reportOutputFile.get(0));
+ assertNotNull(reportTxtFile);
+ assertEquals(EXPECTED_OUTPUT_FILE_HEADER, reportTxtFile.get(0));
assertEquals("-----------------------Vertex: " + UNIQUE_ID + ", Task " + TASK_1_NAME
- + " Started-----------------------", reportOutputFile.get(2));
+ + " Started-----------------------", reportTxtFile.get(2));
}
private String getCsvExpectedResult(String vertexID, String taskID) {
Code Review / sdc.git / commitdiff