From: <mwl...@us...> - 2007-08-15 22:45:12
|
Revision: 473 http://cishell.svn.sourceforge.net/cishell/?rev=473&view=rev Author: mwlinnem Date: 2007-08-15 15:44:39 -0700 (Wed, 15 Aug 2007) Log Message: ----------- Added readme report that explains some basic stuff about all the reports. Modified Paths: -------------- trunk/testing/org.cishell.testing.convertertester.algorithm/src/org/cishell/testing/convertertester/algorithm/ConverterTesterAlgorithm.java trunk/testing/org.cishell.testing.convertertester.core.new/META-INF/MANIFEST.MF trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/ConvResultMaker.java Added Paths: ----------- trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/test_files/ReportREADME.txt trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/readme/ trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/readme/ReadMeReportGenerator.java trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/reports/ReadMeReport.java Modified: trunk/testing/org.cishell.testing.convertertester.algorithm/src/org/cishell/testing/convertertester/algorithm/ConverterTesterAlgorithm.java =================================================================== --- trunk/testing/org.cishell.testing.convertertester.algorithm/src/org/cishell/testing/convertertester/algorithm/ConverterTesterAlgorithm.java 2007-08-15 21:16:01 UTC (rev 472) +++ trunk/testing/org.cishell.testing.convertertester.algorithm/src/org/cishell/testing/convertertester/algorithm/ConverterTesterAlgorithm.java 2007-08-15 22:44:39 UTC (rev 473) @@ -17,10 +17,12 @@ import org.cishell.testing.convertertester.core.tester2.reportgen.allconvs.AllConvsReportGenerator; import org.cishell.testing.convertertester.core.tester2.reportgen.alltests.AllTestsReportGenerator; import org.cishell.testing.convertertester.core.tester2.reportgen.convgraph.GraphReportGenerator; +import org.cishell.testing.convertertester.core.tester2.reportgen.readme.ReadMeReportGenerator; import org.cishell.testing.convertertester.core.tester2.reportgen.reports.AllConvsReport; import org.cishell.testing.convertertester.core.tester2.reportgen.reports.AllTestsReport; import org.cishell.testing.convertertester.core.tester2.reportgen.reports.ConvReport; import org.cishell.testing.convertertester.core.tester2.reportgen.reports.FilePassReport; +import org.cishell.testing.convertertester.core.tester2.reportgen.reports.ReadMeReport; import org.cishell.testing.convertertester.core.tester2.reportgen.reports.TestReport; import org.eclipse.swt.widgets.Display; import org.eclipse.ui.IWorkbenchWindow; @@ -142,9 +144,18 @@ AllTestsReportGenerator allGen = new AllTestsReportGenerator(this.log); AllConvsReportGenerator allConvGen = new AllConvsReportGenerator(this.log); GraphReportGenerator graphGen = new GraphReportGenerator(nwbGraph, this.log); + ReadMeReportGenerator readmeGen = new ReadMeReportGenerator(); - ct.execute(converterGraph, new ReportGenerator[] {allGen, allConvGen, graphGen}, cContext, bContext); + ct.execute(converterGraph, new ReportGenerator[] {allGen, allConvGen, graphGen, readmeGen}, cContext, bContext); + // readme report + ReadMeReport readmeReport = readmeGen.getReadMe(); + File readmeFile = readmeReport.getReportFile(); + Data readMeData = createReportData(readmeFile, + readmeReport.getName(), null); + addReturn(readMeData); + + //all tests report AllTestsReport allReport = allGen.getAllTestsReport(); File allReportFile = allReport.getAllTestsReport(); Data allReportData = createReportData(allReportFile, @@ -184,6 +195,8 @@ "file:text/nwb", DataProperty.NETWORK_TYPE); addReturn(graphReport); + + } catch (Exception e) { System.out.println("Why oh why am I catching type Exception?"); System.out.println(e); Modified: trunk/testing/org.cishell.testing.convertertester.core.new/META-INF/MANIFEST.MF =================================================================== --- trunk/testing/org.cishell.testing.convertertester.core.new/META-INF/MANIFEST.MF 2007-08-15 21:16:01 UTC (rev 472) +++ trunk/testing/org.cishell.testing.convertertester.core.new/META-INF/MANIFEST.MF 2007-08-15 22:44:39 UTC (rev 473) @@ -26,6 +26,7 @@ org.cishell.testing.convertertester.core.tester2.reportgen.allconvs, org.cishell.testing.convertertester.core.tester2.reportgen.alltests, org.cishell.testing.convertertester.core.tester2.reportgen.convgraph, + org.cishell.testing.convertertester.core.tester2.reportgen.readme, org.cishell.testing.convertertester.core.tester2.reportgen.reports, org.cishell.testing.convertertester.core.tester2.reportgen.results, org.cishell.testing.convertertester.core.tester2.reportgen.results.converter, Added: trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/test_files/ReportREADME.txt =================================================================== --- trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/test_files/ReportREADME.txt (rev 0) +++ trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/test_files/ReportREADME.txt 2007-08-15 22:44:39 UTC (rev 473) @@ -0,0 +1,78 @@ +So I used to have a pretty long readme but it was +accidentally deleted, so now I'll just cover the basics +until I get motivated to do this thing all over again. + +There are three major reports: All Tests Report, + All Converters Report, and Annotated Graph Report. + +Bug Notes: The following problems (as well as others) +are known, and should be corrected. + +1. Data Manager is unable to collapse trees of + data by default. + +2. Some annoying converters output their +exceptions to the logger directly instead +of returning them. We need to redirect this +information into the reports. + +3. CIShell sometimes goofs with the numbering +of the reports, and either changes the last +digit or adds ".1" to the end of everything. + + +ALL TESTS REPORT + +All Tests Report provides results test by test. +It is hierarchically structured, with a general +overview at the root, which has each of the +test reports hanging from it, which in turn +have each of their file pass reports hanging +from them. + +Each test tests a single conversion path by +running a bunch of files through it then +comparing the original file to the resulting +file (just like how we used to do it with +the configuration files). + +Each file pass report represents the +results from a single test file being +passed through the test's converters. +File pass reports hang from their +corresponding test reports. + +ALL CONVERTERS REPORT + +All Converters Report provides results +from the point of view of each converter. +It has a general overview at the root, +with details about each converter +hanging from it. + +The two most interesting pieces of information +generated by this report are whether or +not a converter is "Trusted" and its +"Chance of Flaw" of "Chance Correct". +Converters are said to be trusted if they +are involved in a test where all the file passes +are successful. Chance correct is calculated +using an interesting algorithm involving trust. +For each failed file pass it looks at all the +converters involved, removes those that are +trusted, and says that the resulting converters +each have an equal likelihood of being at fault. +If a converter is not trusted, the more +failures it is involved in the more likely it +is to be broken, increasing its "Chance of Flaw". + +ANNOTATED GRAPH REPORT + +This is basically the converter graph annotated +with converter test results, allowing us to +visualize how likely to be broken each converter +is. Each converter has attributes for how likely +it is to be correct, and whether or not it is +trusted. + + Modified: trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/ConvResultMaker.java =================================================================== --- trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/ConvResultMaker.java 2007-08-15 21:16:01 UTC (rev 472) +++ trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/ConvResultMaker.java 2007-08-15 22:44:39 UTC (rev 473) @@ -106,7 +106,7 @@ if (trusted && fprs.length > 0) { //mark all converters involved as trusted. - ConverterPath allConvs = tr.getAllConverters(); + ConverterPath allConvs = tr.getTestConverters(); for (int kk = 0; kk < allConvs.size(); kk++) { ConvResult ctr = getResult(rh, allConvs.getRef(kk)); ctr.setTrusted(true); Added: trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/readme/ReadMeReportGenerator.java =================================================================== --- trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/readme/ReadMeReportGenerator.java (rev 0) +++ trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/readme/ReadMeReportGenerator.java 2007-08-15 22:44:39 UTC (rev 473) @@ -0,0 +1,29 @@ +package org.cishell.testing.convertertester.core.tester2.reportgen.readme; + +import java.io.File; + +import org.cishell.testing.convertertester.core.tester2.TestFileKeeper; +import org.cishell.testing.convertertester.core.tester2.reportgen.ReportGenerator; +import org.cishell.testing.convertertester.core.tester2.reportgen.reports.ReadMeReport; +import org.cishell.testing.convertertester.core.tester2.reportgen.reports.Report; +import org.cishell.testing.convertertester.core.tester2.reportgen.results.AllTestsResult; + +public class ReadMeReportGenerator implements ReportGenerator { + + private ReadMeReport readme; + + public void generateReport(AllTestsResult atr) { + //TODO: TOTAL HACK, CHANCE AS SOON AS POSSIBLE + String readmePath = (System.getProperty("user.home") + "/" + + TestFileKeeper.DEFAULT_ROOT_DIR + "ReportREADME.txt"); + System.out.println("ReadMe path is: " + readmePath); + File readmeFile = new File(readmePath); + + this.readme = new ReadMeReport(readmeFile, "README", ""); + } + + public ReadMeReport getReadMe() { + return this.readme; + } + +} Added: trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/reports/ReadMeReport.java =================================================================== --- trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/reports/ReadMeReport.java (rev 0) +++ trunk/testing/org.cishell.testing.convertertester.core.new/src/org/cishell/testing/convertertester/core/tester2/reportgen/reports/ReadMeReport.java 2007-08-15 22:44:39 UTC (rev 473) @@ -0,0 +1,29 @@ +package org.cishell.testing.convertertester.core.tester2.reportgen.reports; + +import java.io.File; + + +public class ReadMeReport implements Report { + + private File file; + private String name; + private String summary; + + public ReadMeReport(File file, String name, String summary) { + this.file = file; + this.name = name; + this.summary = summary; + } + public String getName() { + return this.name; + } + + public String getShortSummary() { + return this.summary; + } + + public File getReportFile() { + return this.file; + } + +} This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |