com.segue.scc.published.api.codeanalysis

Interface CodeAnalysisProfile

public interface CodeAnalysisProfile

Method Summary

Modifier and Type	Method and Description
CodeAnalysisResult	getBaseline() This function is called before starting coverage.
CodeAnalysisResult	getCoverage() This function is called after stopCoverage().
java.lang.String	getName() This function is called first by the SCTM Code Coverage framework The name of the plug-in is displayed in the code coverage drop down in SCTM
boolean	startCoverage() This function is called by the SCTM Code Coverage Framework after the getBaseLine() method is complete this is where you should start your code coverage tool collecting code coverage data
boolean	stopCoverage() This function is called after startCoverage, This is triggered by the SCTM Execution Server finishing a test run.

Method Detail

startCoverage

boolean startCoverage()
               throws CodeAnalysisProfileException

This function is called by the SCTM Code Coverage Framework after the getBaseLine() method is complete this is where you should start your code coverage tool collecting code coverage data

Returns:

true if the operation is successful

Throws:

CodeAnalysisProfileException - if an error occurs in this operation

stopCoverage

boolean stopCoverage()
              throws CodeAnalysisProfileException

This function is called after startCoverage, This is triggered by the SCTM Execution Server finishing a test run. Call to your code coverage tool to stop collecting data here.

Returns:

true if the operation is successful

Throws:

CodeAnalysisProfileException - if an error occurs in this operation

getBaseline

CodeAnalysisResult getBaseline()
                        throws CodeAnalysisProfileException

This function is called before starting coverage. This is triggered by the SCTM Execution Server starting a test run.

Returns:

all of the objects to be covered. The output needs to be a CodeAnalysisResult object which has two methods exposed, one for the xml string, the other for messages to be added to the log file. The xml is converted using the specified format in the XML schema CCoverage.xsd included in the CA-Framework installation folder

Throws:

CodeAnalysisProfileException - if an error occurs in this operation

getCoverage

CodeAnalysisResult getCoverage()
                        throws CodeAnalysisProfileException

This function is called after stopCoverage().

Returns:

all of the covered objects. The output needs to be a CodeAnalysisResult object which has two methods exposed, one for the xml string, the other for messages to be added to the log file. The xml is converted using the specified format in the XML schema CCoverage.xsd included in the CA-Framework installation folder

Throws:

CodeAnalysisProfileException - if an error occurs in this operation

getName

java.lang.String getName()

This function is called first by the SCTM Code Coverage framework The name of the plug-in is displayed in the code coverage drop down in SCTM

Returns:

the name of the plug-in tool