edu.utexas.cs.bevotest

Class PlaintextTestReporter

java.lang.Object

edu.utexas.cs.bevotest.PlaintextTestReporter

public class PlaintextTestReporter
extends java.lang.Object

A report-producing utility for a BevoTest.TestLog. Writes a formatted plaintext test summary report and optionally the test log to the given Appendable. The report format can be varied by supplying ReportOptions.

This framework conforms to IEEE Std 829, IEEE Standard for Software Test Documentation.

Some operations of this class use actions that are considered privileged under the Java security model. The permissions needed for these actions are given by REQUESTED_PERMISSIONS. If these privileged actions fail with an AccessControlException, the framework recovers gracefully and proceeds with slightly less detailed output. In other words, the current security policy can choose to grant PlaintextTestReporter its REQUESTED_PERMISSIONS or not, with no catastrophic consequences.

Version:

$Id$

Author:

John Thywissen

See Also:

BevoTest, "IEEE Std 829, Software Test Documentation", REQUESTED_PERMISSIONS, Appendable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlaintextTestReporter.ReportOption Option that affect the level of detail in test log reports.

Field Summary

Fields

Modifier and Type	Field and Description
static java.security.Permissions	REQUESTED_PERMISSIONS These permissions let the test framework output more detail, if the security policy grants them to this class.

Constructor Summary

Constructors

Constructor and Description
PlaintextTestReporter(BevoTest.TestLog log) Constructs a TestLogReporter.

Method Summary

Modifier and Type	Method and Description
void	report(java.lang.Appendable out) Output a detailed report of this test execution.
void	report(java.lang.Appendable out, java.util.Set<PlaintextTestReporter.ReportOption> reportOpts) Output a detailed report of this test execution.
void	reportCase(BevoTest.TestCase<?,?> testCase, java.lang.Appendable out, java.util.Set<PlaintextTestReporter.ReportOption> reportOpts) Output a detailed description of the given test case.
void	reportEntry(BevoTest.TestExecutionResult<?,?> entry, java.lang.Appendable out, java.util.Set<PlaintextTestReporter.ReportOption> reportOpts) Output a detailed report of the given test execution result.
void	reportEntry(BevoTest.TestLogEntry entry, java.lang.Appendable out, java.util.Set<PlaintextTestReporter.ReportOption> reportOpts)
void	reportSummary(java.lang.Appendable out, java.util.Set<PlaintextTestReporter.ReportOption> reportOpts) Output a summary report of this test execution.

Methods inherited from class java.lang.Object

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

Field Detail

REQUESTED_PERMISSIONS

public static final java.security.Permissions REQUESTED_PERMISSIONS

These permissions let the test framework output more detail, if the security policy grants them to this class. If the security policy does not grant these permissions, the framework falls-back with slightly less detailed output.

Constructor Detail

PlaintextTestReporter

public PlaintextTestReporter(BevoTest.TestLog log)

Constructs a TestLogReporter.

Parameters:

log - the TestLog to report upon

Method Detail

report

public void report(java.lang.Appendable out)
            throws java.io.IOException

Output a detailed report of this test execution. Convenience method for report(out, ReportOption.EMPTY_SET).

Parameters:

out - an Appendable on which the description should be written.

Throws:

java.io.IOException - if the Appendable's append operation throws an IOException

report

public void report(java.lang.Appendable out,
                   java.util.Set<PlaintextTestReporter.ReportOption> reportOpts)
            throws java.io.IOException

Output a detailed report of this test execution.

Parameters:

out - an Appendable on which the description should be written.

reportOpts - an EnumSet<ReportOption>

Throws:

java.io.IOException - if the Appendable's append operation throws an IOException

reportSummary

public void reportSummary(java.lang.Appendable out,
                          java.util.Set<PlaintextTestReporter.ReportOption> reportOpts)
                   throws java.io.IOException

Output a summary report of this test execution.

Parameters:

out - an Appendable on which the description should be written.

reportOpts - an EnumSet<ReportOption>

Throws:

java.io.IOException - if the Appendable's append operation throws an IOException

reportCase

public void reportCase(BevoTest.TestCase<?,?> testCase,
                       java.lang.Appendable out,
                       java.util.Set<PlaintextTestReporter.ReportOption> reportOpts)
                throws java.io.IOException

Output a detailed description of the given test case.

Parameters:

testCase - the TestCase to describe

out - an Appendable on which the description should be written.

reportOpts - an EnumSet<ReportOption>

Throws:

java.io.IOException - if the Appendable's append operation throws an IOException

reportEntry

public void reportEntry(BevoTest.TestLogEntry entry,
                        java.lang.Appendable out,
                        java.util.Set<PlaintextTestReporter.ReportOption> reportOpts)
                 throws java.io.IOException

Throws:

java.io.IOException

reportEntry

public void reportEntry(BevoTest.TestExecutionResult<?,?> entry,
                        java.lang.Appendable out,
                        java.util.Set<PlaintextTestReporter.ReportOption> reportOpts)
                 throws java.io.IOException

Output a detailed report of the given test execution result.

Parameters:

entry - the TestExecutionResult to report upon

out - an Appendable on which the description should be written.

reportOpts - an EnumSet<ReportOption>

Throws:

java.io.IOException - if the Appendable's append operation throws an IOException