Package it.unive.lisa.outputs.compare

Class JsonReportComparer

java.lang.Object

it.unive.lisa.outputs.compare.JsonReportComparer

public class JsonReportComparer
extends java.lang.Object

A class providing capabilities for finding differences between two JsonReports. Reports are compared by:

1. configurations (JsonReport.getConfiguration()) are compared fist, treating each field as a string
2. run information (JsonReport.getInfo()) are then compared, treating each field as a string but ignoring timestamps (duration, start, end) and LiSA's version
3. warnings (JsonReport.getWarnings()) are then compared, using JsonReport.JsonWarning.compareTo(JsonWarning) method
4. the set of files produced during the analysis (JsonReport.getFiles()) is then compared, matching their paths
5. finally, the contents of every file produced by both analyses are compared, excluding the report itself (LiSA.REPORT_NAME) and visualization-only files

Comparison can be customized providing an implementation of JsonReportComparer.DiffAlgorithm.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonReportComparer.BaseDiffAlgorithm	A JsonReportComparer.DiffAlgorithm that dumps the differences using this class' logger, will compare all fields of the report, and will not fail fast.
static interface	JsonReportComparer.DiffAlgorithm	An object that provides callbacks for reporting differences when comparing JsonReports.
static class	JsonReportComparer.REPORT_TYPE	An enumeration defining the different type of reports that can be issued.
static class	JsonReportComparer.REPORTED_COMPONENT	An enumeration defining the different components of a JsonReport, in order to distinguish which one of them caused a difference being reported.

Constructor Summary

Constructors

Constructor	Description
JsonReportComparer()

Method Summary

Modifier and Type	Method	Description
static boolean	compare(JsonReport first, JsonReport second, java.io.File firstFileRoot, java.io.File secondFileRoot)	Compares the two reports using JsonReportComparer.BaseDiffAlgorithm.
static boolean	compare(JsonReport first, JsonReport second, java.io.File firstFileRoot, java.io.File secondFileRoot, JsonReportComparer.DiffAlgorithm diff)	Compares the two reports according to the given algorithm.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonReportComparer

public JsonReportComparer()

Method Detail

compare

public static boolean compare(JsonReport first,
                              JsonReport second,
                              java.io.File firstFileRoot,
                              java.io.File secondFileRoot)
                       throws java.io.IOException

Compares the two reports using JsonReportComparer.BaseDiffAlgorithm. See this class' documentation for information about how reports are compared.

Parameters:

first - the first report

second - the second report

firstFileRoot - the root folder for the resolution of the file names in the first report (this should be either the workdir of that analysis or the folder where first lies)

secondFileRoot - the root folder for the resolution of the file names in the second report (this should be either the workdir of that analysis or the folder where second lies)

Returns:

true if and only the two reports are equal

Throws:

java.io.IOException - if errors happen while opening or reading the files contained in the reports

compare

public static boolean compare(JsonReport first,
                              JsonReport second,
                              java.io.File firstFileRoot,
                              java.io.File secondFileRoot,
                              JsonReportComparer.DiffAlgorithm diff)
                       throws java.io.IOException

Compares the two reports according to the given algorithm. See this class' documentation for information about how reports are compared.

Parameters:

first - the first report

second - the second report

firstFileRoot - the root folder for the resolution of the file names in the first report (this should be either the workdir of that analysis or the folder where first lies)

secondFileRoot - the root folder for the resolution of the file names in the second report (this should be either the workdir of that analysis or the folder where second lies)

diff - the JsonReportComparer.DiffAlgorithm that will be used for dumping the differences found in the two reports and for customizing the reporting process

Returns:

true if and only the two reports are equal

Throws:

java.io.IOException - if errors happen while opening or reading the files contained in the reports