com.ca.apm.jenkins.api

Interface ComparisonStrategy<T>

public interface ComparisonStrategy<T>

This interface the contract for implementing a comparison Strategy. setConfiguration method gets called up when initializing this strategy in which StrategyConfiguration entity is provided, which contains all the properties configured for this Strategy. The main formula for comparison has to be implemented in doCompare method. The properties present in StrategyConfiguration provides you all the query inputs for getting metrics information from APM.

Author:

Avinash Chandwani

Method Summary

Modifier and Type	Method and Description
StrategyResult<T>	doCompare(BuildInfo benchMarkBuild, BuildInfo currentBuild) This method compares the performance of current build with the benchmark build.
void	setConfiguration(StrategyConfiguration strategyConfiguration) This method is called automatically by plug-in run, whose main object is to provide you a comparison strategy attribute entity, which have complete information about the particular comparison strategy in question, You can create a local variable in your implemented class to get hold of the properties required by you for executing the comparison strategy

Method Detail

setConfiguration

void setConfiguration(StrategyConfiguration strategyConfiguration)

This method is called automatically by plug-in run, whose main object is to provide you a comparison strategy attribute entity, which have complete information about the particular comparison strategy in question, You can create a local variable in your implemented class to get hold of the properties required by you for executing the comparison strategy

Parameters:

strategyConfiguration - The comparison-strategy specific configuration provided in the properties file

doCompare

StrategyResult<T> doCompare(BuildInfo benchMarkBuild,
                            BuildInfo currentBuild)
                     throws BuildExecutionException

This method compares the performance of current build with the benchmark build.

Parameters:

benchMarkBuild - This object contains build number, start time and end time of benchmark build number selected

currentBuild - This object contains build number, start time and end time of the current build

Returns:

ComparisonStrategyResult object is returned, which contain detailed transaction to transaction metric comparison values

Throws:

BuildComparatorException - ComparisonStrategyResult object is returned, which contain detailed transaction to transaction metric comparison values

BuildExecutionException