cz.encircled.jput.context

Class JPutContext

cz.encircled.jput.context.JPutContext

public class JPutContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JPutContext.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static JPutContext.Companion	Companion
static java.lang.String	PROP_ELASTIC_CLEANUP_DAYS Automatically delete data older than given days from Elasticsearch
static java.lang.String	PROP_ELASTIC_ENABLED Boolean - enables/disables elasticsearch as a Result Recorder
static java.lang.String	PROP_ELASTIC_ENV_IDENTIFIERS This property can be use to distinguish perf results from different environments or client machine. For example when tested application is running on multiple servers each with different available resources (CPU/RAM/DISC) which may affect the results.
static java.lang.String	PROP_ELASTIC_HOST Elasticsearch server host name
static java.lang.String	PROP_ELASTIC_INDEX Elasticsearch index name to be used
static java.lang.String	PROP_ELASTIC_PORT Elasticsearch server port
static java.lang.String	PROP_ELASTIC_SCHEME Network scheme, e.g. http/https
static java.lang.String	PROP_ENABLED Enables/disables execution of performance tests
static java.lang.String	PROP_ENV_PARAMS Custom parameters which will be passed to Result Recorders (for example to Kibana). Might be used for example for tested application version, environment code, name of test runner etc. Format is key1:value1,key2:value2, i.e. value split by :, multiple values separated by ,.
static java.lang.String	PROP_PATH_TO_STORAGE_FILE Absolute path to the file which will be used a a storeage
static java.lang.String	PROP_REPORTER_CLASS Fully classified class name of custom Result Recorder
static java.lang.String	PROP_STORAGE_FILE_ENABLED Boolean - enables/disables file Result Recorder
static java.lang.String	PROP_TEST_CONFIG

Constructor Summary

Constructors

Constructor and Description
JPutContext()

Method Summary

Modifier and Type	Method and Description
void	addPropertySource(PropertySource source, int index)
void	afterTestClass(java.lang.Class<?> clazz)
SuiteConfiguration	getCurrentSuite() Currently running class suite, should be set by org.junit.runner.Runner
java.lang.reflect.Method	getCurrentSuiteMethod() Currently running method of a suite, should be set by org.junit.runner.Runner
long	getExecutionId() Unique ID of current tests execution
java.util.List<cz.encircled.jput.context.PropertySource>	getPropertySources()
java.util.List<cz.encircled.jput.recorder.ResultRecorder>	getResultRecorders() Test results recorders
java.util.List<cz.encircled.jput.reporter.JPutReporter>	getResultReporters()
TrendAnalyzer	getTrendAnalyzer()
java.util.List<cz.encircled.jput.analyzer.UnitPerformanceAnalyzer>	getUnitPerformanceAnalyzers()
JPutContext	init()
boolean	isPerformanceTestEnabled() Global enabled/disabled switch
void	setCurrentSuite(SuiteConfiguration p) Currently running class suite, should be set by org.junit.runner.Runner
void	setCurrentSuiteMethod(java.lang.reflect.Method p) Currently running method of a suite, should be set by org.junit.runner.Runner
void	setPropertySources(java.util.List<cz.encircled.jput.context.PropertySource> p)
void	setResultReporters(java.util.List<cz.encircled.jput.reporter.JPutReporter> p)
void	setTrendAnalyzer(TrendAnalyzer p)
void	setUnitPerformanceAnalyzers(java.util.List<? extends cz.encircled.jput.analyzer.UnitPerformanceAnalyzer> p)

Field Detail

PROP_ENABLED

public static java.lang.String PROP_ENABLED

Enables/disables execution of performance tests

PROP_REPORTER_CLASS

public static java.lang.String PROP_REPORTER_CLASS

Fully classified class name of custom Result Recorder

PROP_ELASTIC_ENABLED

public static java.lang.String PROP_ELASTIC_ENABLED

Boolean - enables/disables elasticsearch as a Result Recorder

PROP_ELASTIC_HOST

public static java.lang.String PROP_ELASTIC_HOST

Elasticsearch server host name

PROP_ELASTIC_PORT

public static java.lang.String PROP_ELASTIC_PORT

Elasticsearch server port

PROP_ELASTIC_SCHEME

public static java.lang.String PROP_ELASTIC_SCHEME

Network scheme, e.g. http/https

PROP_ELASTIC_INDEX

public static java.lang.String PROP_ELASTIC_INDEX

Elasticsearch index name to be used

PROP_ELASTIC_ENV_IDENTIFIERS

public static java.lang.String PROP_ELASTIC_ENV_IDENTIFIERS

This property can be use to distinguish perf results from different environments or client machine. For example when tested application is running on multiple servers each with different available resources (CPU/RAM/DISC) which may affect the results.

This property will be used during trend analysis to compare results from the same environment.

Format is: list of property names, separated by comma. Property values must be provided using jput.env.custom.params property.

PROP_ELASTIC_CLEANUP_DAYS

public static java.lang.String PROP_ELASTIC_CLEANUP_DAYS

Automatically delete data older than given days from Elasticsearch

PROP_STORAGE_FILE_ENABLED

public static java.lang.String PROP_STORAGE_FILE_ENABLED

Boolean - enables/disables file Result Recorder

PROP_PATH_TO_STORAGE_FILE

public static java.lang.String PROP_PATH_TO_STORAGE_FILE

Absolute path to the file which will be used a a storeage

PROP_ENV_PARAMS

public static java.lang.String PROP_ENV_PARAMS

Custom parameters which will be passed to Result Recorders (for example to Kibana). Might be used for example for tested application version, environment code, name of test runner etc. Format is key1:value1,key2:value2, i.e. value split by :, multiple values separated by ,.

PROP_TEST_CONFIG

public static java.lang.String PROP_TEST_CONFIG

Companion

public static JPutContext.Companion Companion

Constructor Detail

JPutContext

public JPutContext()

Method Detail

getExecutionId

public long getExecutionId()

Unique ID of current tests execution

isPerformanceTestEnabled

public boolean isPerformanceTestEnabled()

Global enabled/disabled switch

getPropertySources

public java.util.List<cz.encircled.jput.context.PropertySource> getPropertySources()

setPropertySources

public void setPropertySources(java.util.List<cz.encircled.jput.context.PropertySource> p)

getResultRecorders

public java.util.List<cz.encircled.jput.recorder.ResultRecorder> getResultRecorders()

Test results recorders

getUnitPerformanceAnalyzers

public java.util.List<cz.encircled.jput.analyzer.UnitPerformanceAnalyzer> getUnitPerformanceAnalyzers()

setUnitPerformanceAnalyzers

public void setUnitPerformanceAnalyzers(java.util.List<? extends cz.encircled.jput.analyzer.UnitPerformanceAnalyzer> p)

getTrendAnalyzer

public TrendAnalyzer getTrendAnalyzer()

setTrendAnalyzer

public void setTrendAnalyzer(TrendAnalyzer p)

getCurrentSuite

public SuiteConfiguration getCurrentSuite()

Currently running class suite, should be set by org.junit.runner.Runner

setCurrentSuite

public void setCurrentSuite(SuiteConfiguration p)

Currently running class suite, should be set by org.junit.runner.Runner

getCurrentSuiteMethod

public java.lang.reflect.Method getCurrentSuiteMethod()

Currently running method of a suite, should be set by org.junit.runner.Runner

setCurrentSuiteMethod

public void setCurrentSuiteMethod(java.lang.reflect.Method p)

Currently running method of a suite, should be set by org.junit.runner.Runner

getResultReporters

public java.util.List<cz.encircled.jput.reporter.JPutReporter> getResultReporters()

setResultReporters

public void setResultReporters(java.util.List<cz.encircled.jput.reporter.JPutReporter> p)

init

public JPutContext init()

afterTestClass

public void afterTestClass(java.lang.Class<?> clazz)

addPropertySource

public void addPropertySource(PropertySource source,
                              int index)