org.dynamide.restreplay

Class RestReplayReport

java.lang.Object

org.dynamide.restreplay.RestReplayReport

public class RestReplayReport
extends Object

Format a report based on RestReplay ServiceResult object from a test group.

Author:

Laramie Crocker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestReplayReport.FilePath
static class	RestReplayReport.Header
static class	RestReplayReport.ReportDetailLocations
static class	RestReplayReport.ReportMasterLocations
static class	RestReplayReport.TOC

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BR
protected static String	DETAIL_END
protected static String	DETAIL_HDR
protected static String	DETAIL_LINESEP
protected static String	DIV_END
protected static String	EVAL_REPORT_HDR
protected static String	EVAL_REPORT_LINKS_FILE
protected static String	GROUP_END
protected static String	GROUP_START
protected static String	HDRBEGIN
protected static String	HDREND
protected static String	HR
protected static String	HTML_PAGE_END
protected static String	HTML_TEST_END
protected static String	HTML_TEST_START
static String	INCLUDES_DIR
protected static String	LIVE_SECTION_BEGIN
protected static String	LIVE_SECTION_END
static String	POWERED_BY
protected static String	PRE_END
protected static String	PRE_START
protected static String	RUNINFO_END
protected static String	RUNINFO_START
protected static String	TOC_CELLEND
protected static String	TOC_CELLSEP
protected static String	TOC_CELLSTART
protected static String	TOC_END
protected static String	TOC_LINESEP
protected static String	TOC_START
protected static String	TOPLINKS_FILE
protected static String	WRAP_END
protected static String	WRAP_START

Constructor Summary

Constructors

Constructor and Description
RestReplayReport(String reportsDir, String relativePathFromReportsDir)

Method Summary

Modifier and Type	Method and Description
void	addFailure(String msg)
void	addRunInfo(String text)
RestReplayReport.Header	addTestGroup(String groupID, String controlFile, String runID, String comment, String anchor, int idx)
void	addTestResult(ServiceResult serviceResult)
protected String	alertError(String msg)
protected static void	appendPayload(ServiceResult serviceResult, StringBuffer fb, String payload, ServiceResult.PRETTY_FORMAT format, String title, String theDivID, String subtitle)
protected static void	appendPayload(ServiceResult serviceResult, StringBuffer fb, String payload, ServiceResult.PRETTY_FORMAT format, String title, String theDivID, String subtitle, boolean usePRE)
protected static String	brown(String label)
static RestReplayReport.ReportMasterLocations	calculateMasterReportRelname(String reportsDir, String localMasterFilename, String envID)
void	clearRunInfo()
String	detail(ServiceResult s, boolean includePayloads, boolean includePartSummary, String linesep, String end, int tocID)
static String	dotdotdot(String value)
static String	dotdotdot(String value, int newlen)
static String	escape(String source)
String	evalReportToString(RestReplay replay)
protected static String	formatCollapse(String myDivID, String linkText)
protected static String	formatCollapse(String myDivID, String linkText, String subtitle)
static String	formatExpectedTreewalkRangeColumns(ServiceResult s)
protected static String	formatMasterVars(Map<String,Object> masterVars)
static String	formatMutatorSUCCESS(ServiceResult serviceResult)
static String	formatPageStart(String testdir, ResourceManager rm, String pageTitle)
static String	formatPayloads(ServiceResult serviceResult, int tocID)
String	formatSummary(ServiceResult serviceResult, int tocID) Note: anchor tag is spit out by appendTestAnchor() before this because this gets wrapped in divs by appendServiceResult()
String	getPage(String testdir, RestReplay restReplay, String testGroupID)
String	getRelativePathFromReportsDir()
String	getReportsDir()
String	getRunInfo()
String	getRunInfoHTML()
String	getTOC(String reportName)
protected static String	lbl(String label)
static String	makeShort(String theComment, String blockID)
protected static String	noerror(String label)
protected static String	ok(String label)
protected static String	red(String label)
static File	saveIndexForMaster(String testdir, String reportsDir, String localMasterFilename, List<String> reportsList, String envID, Map<String,Object> masterVars, List<RestReplayReport.Header> testGroups, Master master, List<List<ServiceResult>> list, List<String> masterAlertStrings)
static File	saveIndexNoMaster(ResourceManager rm, String testdir, String reportsDir, String localMasterFilename, List<String> reportsList)
File	saveReport(String testdir, String reportsDir, String reportName, RestReplay restReplay, String testGroupID)
static String	scriptifyName(String name)
protected static String	small(String label)
protected static String	smallblack(String label)
protected static String	tocError(int count)
protected String	tocWarn(int count)
protected String	units(String label)

Methods inherited from class java.lang.Object

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

Field Detail

INCLUDES_DIR

public static final String INCLUDES_DIR

See Also:

Constant Field Values

TOPLINKS_FILE

protected static final String TOPLINKS_FILE

See Also:

Constant Field Values

EVAL_REPORT_LINKS_FILE

protected static final String EVAL_REPORT_LINKS_FILE

See Also:

Constant Field Values

POWERED_BY

public static final String POWERED_BY

See Also:

Constant Field Values

HTML_PAGE_END

protected static final String HTML_PAGE_END

See Also:

Constant Field Values

LIVE_SECTION_BEGIN

protected static final String LIVE_SECTION_BEGIN

See Also:

Constant Field Values

LIVE_SECTION_END

protected static final String LIVE_SECTION_END

See Also:

Constant Field Values

HTML_TEST_START

protected static final String HTML_TEST_START

See Also:

Constant Field Values

HTML_TEST_END

protected static final String HTML_TEST_END

See Also:

Constant Field Values

GROUP_START

protected static final String GROUP_START

See Also:

Constant Field Values

GROUP_END

protected static final String GROUP_END

See Also:

Constant Field Values

RUNINFO_START

protected static final String RUNINFO_START

See Also:

Constant Field Values

RUNINFO_END

protected static final String RUNINFO_END

See Also:

Constant Field Values

DIV_END

protected static final String DIV_END

See Also:

Constant Field Values

WRAP_START

protected static final String WRAP_START

See Also:

Constant Field Values

WRAP_END

protected static final String WRAP_END

See Also:

Constant Field Values

PRE_START

protected static final String PRE_START

See Also:

Constant Field Values

PRE_END

protected static final String PRE_END

See Also:

Constant Field Values

BR

protected static final String BR

See Also:

Constant Field Values

HR

protected static final String HR

See Also:

Constant Field Values

DETAIL_HDR

protected static final String DETAIL_HDR

See Also:

Constant Field Values

DETAIL_LINESEP

protected static final String DETAIL_LINESEP

See Also:

Constant Field Values

DETAIL_END

protected static final String DETAIL_END

See Also:

Constant Field Values

EVAL_REPORT_HDR

protected static final String EVAL_REPORT_HDR

See Also:

Constant Field Values

TOC_START

protected static final String TOC_START

See Also:

Constant Field Values

TOC_LINESEP

protected static final String TOC_LINESEP

See Also:

Constant Field Values

TOC_CELLSEP

protected static final String TOC_CELLSEP

See Also:

Constant Field Values

TOC_END

protected static final String TOC_END

See Also:

Constant Field Values

TOC_CELLSTART

protected static final String TOC_CELLSTART

See Also:

Constant Field Values

TOC_CELLEND

protected static final String TOC_CELLEND

See Also:

Constant Field Values

HDRBEGIN

protected static final String HDRBEGIN

See Also:

Constant Field Values

HDREND

protected static final String HDREND

See Also:

Constant Field Values

Constructor Detail

RestReplayReport

public RestReplayReport(String reportsDir,
                        String relativePathFromReportsDir)

Parameters:

relativePathFromReportsDir - is relative to the uri the master is served from, and in the current implementation, is the env so that each env can have equivalent output file directories.

reportsDir - is the physical location of the reports output directory where master index files, and environments (as directories), and also the db output if turned on.

Method Detail

getReportsDir

public String getReportsDir()

getRelativePathFromReportsDir

public String getRelativePathFromReportsDir()

formatCollapse

protected static String formatCollapse(String myDivID,
                                       String linkText)

formatCollapse

protected static String formatCollapse(String myDivID,
                                       String linkText,
                                       String subtitle)

getPage

public String getPage(String testdir,
                      RestReplay restReplay,
                      String testGroupID)
               throws IOException

Throws:

IOException

formatMutatorSUCCESS

public static String formatMutatorSUCCESS(ServiceResult serviceResult)

dotdotdot

public static String dotdotdot(String value,
                               int newlen)

dotdotdot

public static String dotdotdot(String value)

evalReportToString

public String evalReportToString(RestReplay replay)

getTOC

public String getTOC(String reportName)

addRunInfo

public void addRunInfo(String text)

getRunInfo

public String getRunInfo()

getRunInfoHTML

public String getRunInfoHTML()

clearRunInfo

public void clearRunInfo()

addTestGroup

public RestReplayReport.Header addTestGroup(String groupID,
                                            String controlFile,
                                            String runID,
                                            String comment,
                                            String anchor,
                                            int idx)

addFailure

public void addFailure(String msg)

addTestResult

public void addTestResult(ServiceResult serviceResult)

formatPageStart

public static String formatPageStart(String testdir,
                                     ResourceManager rm,
                                     String pageTitle)
                              throws IOException

Throws:

IOException

saveReport

public File saveReport(String testdir,
                       String reportsDir,
                       String reportName,
                       RestReplay restReplay,
                       String testGroupID)

calculateMasterReportRelname

public static RestReplayReport.ReportMasterLocations calculateMasterReportRelname(String reportsDir,
                                                                                  String localMasterFilename,
                                                                                  String envID)

saveIndexForMaster

public static File saveIndexForMaster(String testdir,
                                      String reportsDir,
                                      String localMasterFilename,
                                      List<String> reportsList,
                                      String envID,
                                      Map<String,Object> masterVars,
                                      List<RestReplayReport.Header> testGroups,
                                      Master master,
                                      List<List<ServiceResult>> list,
                                      List<String> masterAlertStrings)

Parameters:

localMasterFilename - should be a local filename for the index of each restReplay master control file, e.g. objectexit.xml so what gets written to disk will be something like index.objectexit.xml.html . The actual filename will be available from the returned File object if successful.

Returns:

File if successful, else returns null.

saveIndexNoMaster

public static File saveIndexNoMaster(ResourceManager rm,
                                     String testdir,
                                     String reportsDir,
                                     String localMasterFilename,
                                     List<String> reportsList)

Parameters:

localMasterFilename - should be a local filename for the index of each restReplay master control file, e.g. objectexit.xml so what gets written to disk will be something like index.objectexit.xml.html . The actual filename will be available from the returned File object if successful.

Returns:

File if successful, else returns null.

formatMasterVars

protected static String formatMasterVars(Map<String,Object> masterVars)

formatSummary

public String formatSummary(ServiceResult serviceResult,
                            int tocID)

Note: anchor tag is spit out by appendTestAnchor() before this because this gets wrapped in divs by appendServiceResult()

formatPayloads

public static String formatPayloads(ServiceResult serviceResult,
                                    int tocID)

appendPayload

protected static void appendPayload(ServiceResult serviceResult,
                                    StringBuffer fb,
                                    String payload,
                                    ServiceResult.PRETTY_FORMAT format,
                                    String title,
                                    String theDivID,
                                    String subtitle)

appendPayload

protected static void appendPayload(ServiceResult serviceResult,
                                    StringBuffer fb,
                                    String payload,
                                    ServiceResult.PRETTY_FORMAT format,
                                    String title,
                                    String theDivID,
                                    String subtitle,
                                    boolean usePRE)

escape

public static String escape(String source)

red

protected static String red(String label)

brown

protected static String brown(String label)

tocWarn

protected String tocWarn(int count)

tocError

protected static String tocError(int count)

ok

protected static String ok(String label)

lbl

protected static String lbl(String label)

small

protected static String small(String label)

smallblack

protected static String smallblack(String label)

noerror

protected static String noerror(String label)

units

protected String units(String label)

alertError

protected String alertError(String msg)

makeShort

public static String makeShort(String theComment,
                               String blockID)

scriptifyName

public static String scriptifyName(String name)

detail

public String detail(ServiceResult s,
                     boolean includePayloads,
                     boolean includePartSummary,
                     String linesep,
                     String end,
                     int tocID)

formatExpectedTreewalkRangeColumns

public static String formatExpectedTreewalkRangeColumns(ServiceResult s)