A B C D E F G H I J M P R S T U V W

A

addPropertySource(source) - Method in class cz.encircled.jput.context.JPutContext

analyzeTestTrend(execution, sample) - Method in class cz.encircled.jput.trend.SampleBasedTrendAnalyzer

sample represents times of previous executions in ms, which is used for trend analysis

analyzeTestTrend(execution, sample) - Method in interface cz.encircled.jput.trend.TrendAnalyzer

sample represents times of previous executions in ms, which is used for trend analysis

analyzeUnitTrend(execution) - Method in interface cz.encircled.jput.unit.UnitPerformanceAnalyzer

analyzeUnitTrend(execution) - Method in class cz.encircled.jput.unit.UnitPerformanceAnalyzerImpl

appendTrendResult(execution) - Method in interface cz.encircled.jput.recorder.ResultRecorder

Append the new execution result

appendTrendResult(execution) - Method in class cz.encircled.jput.recorder.ThreadsafeResultRecorder

Append the new execution result

averageTimeLimit() - Method in interface cz.encircled.jput.unit.PerformanceTest

Upper limit for average execution time when using

averageTimeThreshold() - Method in interface cz.encircled.jput.trend.PerformanceTrend

Static average time threshold.

B

BaseTestExecutor - Class in cz.encircled.jput.runner

Executes particular piece of code (junit test, or any other function) and runs performance and trend assertions.

BaseTestExecutor() - Constructor for class cz.encircled.jput.runner.BaseTestExecutor

Executes particular piece of code (junit test, or any other function) and runs performance and trend assertions.

C

close() - Method in interface cz.encircled.jput.recorder.ElasticsearchClient

close() - Method in class cz.encircled.jput.recorder.ElasticsearchClientWrapper

collectRuns(sample) - Method in class cz.encircled.jput.trend.SampleBasedTrendAnalyzer

Companion - Static variable in class cz.encircled.jput.context.JPutContext

Companion - Static variable in class cz.encircled.jput.model.PerfTestConfiguration

Companion - Static variable in class cz.encircled.jput.model.TrendTestConfiguration

component1() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Unique test id,

component1() - Method in class cz.encircled.jput.model.PerfTestExecution

Configuration used for this execution

component1() - Method in class cz.encircled.jput.model.PerfTestResult

component1() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Sample size which will be used for trend analysis

component2() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Count of warm up test executions

component2() - Method in class cz.encircled.jput.model.PerfTestExecution

Parameters related to the global execution

component2() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Static average time threshold.

component3() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Test execution repeats count

component3() - Method in class cz.encircled.jput.model.PerfTestExecution

List of result execution times in ms

component3() - Method in class cz.encircled.jput.model.TrendTestConfiguration

if true - use the sample variance as an average time threshold

component4() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Delay between test repeats,

component4() - Method in class cz.encircled.jput.model.PerfTestExecution

Validation result is set after executions

component4() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Defines the strategy for sample selection

component5() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Upper limit for test execution time in milliseconds

component5() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Only result from given percentile are counted for trend tests,

component6() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Upper limit for average execution time when using

component7() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Performance trend analyzing

component8() - Method in class cz.encircled.jput.model.PerfTestConfiguration

context - Static variable in class cz.encircled.jput.context.JPutContextKt

copy(testId, warmUp, repeats, delay, maxTimeLimit, avgTimeLimit, trendConfiguration, percentiles) - Method in class cz.encircled.jput.model.PerfTestConfiguration

Performance test configuration of a single junit test method

copy(conf, executionParams, executionResult, result) - Method in class cz.encircled.jput.model.PerfTestExecution

Represents the execution state of a particular performance test

copy(violations) - Method in class cz.encircled.jput.model.PerfTestResult

Represents the execution result of a performance test. If a test violates any of it's performance constraints, it will be added to the violations field.

copy(sampleSize, averageTimeThreshold, useStandardDeviationAsThreshold, sampleSelectionStrategy, noisePercentile) - Method in class cz.encircled.jput.model.TrendTestConfiguration

Represents the configuration of a single trend performance test

cz.encircled.jput - package cz.encircled.jput

cz.encircled.jput.context - package cz.encircled.jput.context

cz.encircled.jput.model - package cz.encircled.jput.model

cz.encircled.jput.recorder - package cz.encircled.jput.recorder

cz.encircled.jput.runner - package cz.encircled.jput.runner

cz.encircled.jput.trend - package cz.encircled.jput.trend

cz.encircled.jput.unit - package cz.encircled.jput.unit

D

defaultTestId(method) - Method in class cz.encircled.jput.model.PerfTestConfiguration.Companion

delay() - Method in interface cz.encircled.jput.unit.PerformanceTest

Delay between test repeats,

destroy() - Method in class cz.encircled.jput.context.JPutContext

destroy() - Method in class cz.encircled.jput.recorder.ElasticsearchResultRecorder

Graceful destroy, called after test

destroy($this) - Static method in class cz.encircled.jput.recorder.ResultRecorder.DefaultImpls

Graceful destroy, called after test

destroy() - Method in interface cz.encircled.jput.recorder.ResultRecorder

Graceful destroy, called after test

deviation($receiver) - Static method in class cz.encircled.jput.StatisticsKt

doFlush(data) - Method in class cz.encircled.jput.recorder.ElasticsearchResultRecorder

doFlush(data) - Method in class cz.encircled.jput.recorder.FileSystemResultRecorder

doFlush(data) - Method in class cz.encircled.jput.recorder.ThreadsafeResultRecorder

E

ElasticsearchClient - Interface in cz.encircled.jput.recorder

ElasticsearchClientWrapper - Class in cz.encircled.jput.recorder

ElasticsearchClientWrapper(builder) - Constructor for class cz.encircled.jput.recorder.ElasticsearchClientWrapper

ElasticsearchResultRecorder - Class in cz.encircled.jput.recorder

Elasticsearch-based implementation of tests execution results recorder

ElasticsearchResultRecorder(client) - Constructor for class cz.encircled.jput.recorder.ElasticsearchResultRecorder

Elasticsearch-based implementation of tests execution results recorder

equals(p) - Method in class cz.encircled.jput.model.PerfTestConfiguration

equals(p) - Method in class cz.encircled.jput.model.PerfTestExecution

equals(p) - Method in class cz.encircled.jput.model.PerfTestResult

equals(p) - Method in class cz.encircled.jput.model.TrendTestConfiguration

executeTest(config, statement) - Method in class cz.encircled.jput.runner.BaseTestExecutor

executeTest(method, notifier, description, statement) - Method in class cz.encircled.jput.runner.Junit4TestExecutor

F

FileSystemResultRecorder - Class in cz.encircled.jput.recorder

Filesystem-based implementation of tests execution results recorder

FileSystemResultRecorder(pathToFile) - Constructor for class cz.encircled.jput.recorder.FileSystemResultRecorder

Filesystem-based implementation of tests execution results recorder

finishExecution() - Method in class cz.encircled.jput.model.PerfTestExecution

flush() - Method in interface cz.encircled.jput.recorder.ResultRecorder

Flush appended data to the storage

flush() - Method in class cz.encircled.jput.recorder.ThreadsafeResultRecorder

Flush appended data to the storage

fromAnnotation(conf, method) - Method in class cz.encircled.jput.model.PerfTestConfiguration.Companion

fromAnnotation(conf) - Method in class cz.encircled.jput.model.TrendTestConfiguration.Companion

G

getAverageTimeThreshold() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Static average time threshold.

getAvgTimeLimit() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Upper limit for average execution time when using

getCollectionProperty(key, defaultValue) - Static method in class cz.encircled.jput.context.PropertySourceKt

getConf() - Method in class cz.encircled.jput.model.PerfTestExecution

Configuration used for this execution

getContext() - Static method in class cz.encircled.jput.context.JPutContextKt

getCurrentExecutionStart() - Method in class cz.encircled.jput.model.PerfTestExecution

Holds start time of current execution

getCustomTestIds() - Method in class cz.encircled.jput.context.JPutContext

customTestId -> defaultTestId

getDelay() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Delay between test repeats,

getExecutionAvg() - Method in class cz.encircled.jput.model.PerfTestExecution

getExecutionId() - Method in class cz.encircled.jput.context.JPutContext

Unique ID of current tests execution

getExecutionMax() - Method in class cz.encircled.jput.model.PerfTestExecution

getExecutionParams() - Method in class cz.encircled.jput.model.PerfTestExecution

Parameters related to the global execution

getExecutionResult() - Method in class cz.encircled.jput.model.PerfTestExecution

List of result execution times in ms

getJunit4TestExecutor() - Method in class cz.encircled.jput.context.JPutContext

getMaxTimeLimit() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Upper limit for test execution time in milliseconds

getMessageProducer() - Method in enum cz.encircled.jput.model.PerfConstraintViolation

getNoisePercentile() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Only result from given percentile are counted for trend tests,

getPercentiles() - Method in class cz.encircled.jput.model.PerfTestConfiguration

getProperty(key) - Method in interface cz.encircled.jput.context.PropertySource

getProperty(key) - Method in class cz.encircled.jput.context.SystemPropertySource

getPropertySources() - Method in class cz.encircled.jput.context.JPutContext

getRepeats() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Test execution repeats count

getResult() - Method in class cz.encircled.jput.model.PerfTestExecution

Validation result is set after executions

getResultRecorders() - Method in class cz.encircled.jput.context.JPutContext

Test results recorders

getSample(execution) - Method in class cz.encircled.jput.recorder.ElasticsearchResultRecorder

Fetch execution times sample for the given execution

getSample(execution) - Method in class cz.encircled.jput.recorder.FileSystemResultRecorder

Fetch execution times sample for the given execution

getSample(execution) - Method in interface cz.encircled.jput.recorder.ResultRecorder

Fetch execution times sample for the given execution

getSampleSelectionStrategy() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Defines the strategy for sample selection

getSampleSize() - Method in class cz.encircled.jput.model.TrendTestConfiguration

Sample size which will be used for trend analysis

getTarget() - Method in class cz.encircled.jput.recorder.FileSystemResultRecorder

getTestExecutions() - Method in class cz.encircled.jput.context.JPutContext

getTestId() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Unique test id,

getTrendAnalyzer() - Method in class cz.encircled.jput.context.JPutContext

getTrendConfiguration() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Performance trend analyzing

getUnitPerformanceAnalyzer() - Method in class cz.encircled.jput.context.JPutContext

getUserDefinedEnvParams($this) - Static method in class cz.encircled.jput.recorder.ResultRecorder.DefaultImpls

Get user-defined environment parameters, which should be persisted along with test results

getUserDefinedEnvParams() - Method in interface cz.encircled.jput.recorder.ResultRecorder

Get user-defined environment parameters, which should be persisted along with test results

getUseStandardDeviationAsThreshold() - Method in class cz.encircled.jput.model.TrendTestConfiguration

if true - use the sample variance as an average time threshold

getViolations() - Method in class cz.encircled.jput.model.PerfTestResult

getWarmUp() - Method in class cz.encircled.jput.model.PerfTestConfiguration

Count of warm up test executions

H

hashCode() - Method in class cz.encircled.jput.model.PerfTestConfiguration

hashCode() - Method in class cz.encircled.jput.model.PerfTestExecution

hashCode() - Method in class cz.encircled.jput.model.PerfTestResult

hashCode() - Method in class cz.encircled.jput.model.TrendTestConfiguration

I

index(indexRequest, options) - Method in interface cz.encircled.jput.recorder.ElasticsearchClient

index(indexRequest, options) - Method in class cz.encircled.jput.recorder.ElasticsearchClientWrapper

init() - Method in class cz.encircled.jput.context.JPutContext

INSTANCE - Static variable in class cz.encircled.jput.JPut

Helper functions for JPut users to control the perf tests execution

isError() - Method in class cz.encircled.jput.model.PerfTestResult

isPerformanceTestEnabled() - Method in class cz.encircled.jput.context.JPutContext

Global enabled/disabled switch

J

JPut - Class in cz.encircled.jput

Helper functions for JPut users to control the perf tests execution

JPutContext - Class in cz.encircled.jput.context

JPutContext() - Constructor for class cz.encircled.jput.context.JPutContext

JPutContext.Companion - Class in cz.encircled.jput.context

JPutContextKt - Class in cz.encircled.jput.context

JPutJUnit4Runner - Class in cz.encircled.jput.runner

JPutJUnit4Runner(clazz) - Constructor for class cz.encircled.jput.runner.JPutJUnit4Runner

junit4TestExecutor - Variable in class cz.encircled.jput.context.JPutContext

Junit4TestExecutor - Class in cz.encircled.jput.runner

Junit4TestExecutor() - Constructor for class cz.encircled.jput.runner.Junit4TestExecutor

M

markPerformanceTestStart() - Method in class cz.encircled.jput.JPut

This function may be called directly from the performance test to tell JPut that measurement must start from this point, i.e. not from the beginning of the method. This might be useful when performance test makes some expensive initialization first.

maxTimeLimit() - Method in interface cz.encircled.jput.unit.PerformanceTest

Upper limit for test execution time in milliseconds

P

percentile($receiver, rank) - Static method in class cz.encircled.jput.StatisticsKt

percentiles() - Method in interface cz.encircled.jput.unit.PerformanceTest

PerfConstraintViolation - Enum in cz.encircled.jput.model

Enumeration of possible perf constraint violations

PerfConstraintViolation(messageProducer) - Constructor for enum cz.encircled.jput.model.PerfConstraintViolation

Enumeration of possible perf constraint violations

PerformanceTest - Interface in cz.encircled.jput.unit

Mark the test as a JPut performance test, allowing to assert test execution time and analyze execution time trends

PerformanceTrend - Interface in cz.encircled.jput.trend

PerfTestConfiguration - Class in cz.encircled.jput.model

Performance test configuration of a single junit test method

PerfTestConfiguration(testId, warmUp, repeats, delay, maxTimeLimit, avgTimeLimit, trendConfiguration, percentiles) - Constructor for class cz.encircled.jput.model.PerfTestConfiguration

Performance test configuration of a single junit test method

PerfTestConfiguration.Companion - Class in cz.encircled.jput.model

PerfTestExecution - Class in cz.encircled.jput.model

Represents the execution state of a particular performance test

PerfTestExecution(conf, executionParams, executionResult, result) - Constructor for class cz.encircled.jput.model.PerfTestExecution

Represents the execution state of a particular performance test

PerfTestResult - Class in cz.encircled.jput.model

Represents the execution result of a performance test. If a test violates any of it's performance constraints, it will be added to the violations field.

PerfTestResult(violations) - Constructor for class cz.encircled.jput.model.PerfTestResult

Represents the execution result of a performance test. If a test violates any of it's performance constraints, it will be added to the violations field.

PerfTestResult() - Constructor for class cz.encircled.jput.model.PerfTestResult

Represents the execution result of a performance test. If a test violates any of it's performance constraints, it will be added to the violations field.

PROP_ELASTIC_ENABLED - Static variable in class cz.encircled.jput.context.JPutContext

PROP_ELASTIC_ENV_IDENTIFIERS - Static variable in class cz.encircled.jput.context.JPutContext

PROP_ELASTIC_HOST - Static variable in class cz.encircled.jput.context.JPutContext

PROP_ELASTIC_INDEX - Static variable in class cz.encircled.jput.context.JPutContext

PROP_ELASTIC_PORT - Static variable in class cz.encircled.jput.context.JPutContext

PROP_ELASTIC_SCHEME - Static variable in class cz.encircled.jput.context.JPutContext

PROP_ENABLED - Static variable in class cz.encircled.jput.context.JPutContext

PROP_ENV_PARAMS - Static variable in class cz.encircled.jput.context.JPutContext

PROP_PATH_TO_STORAGE_FILE - Static variable in class cz.encircled.jput.context.JPutContext

PROP_STORAGE_FILE_ENABLED - Static variable in class cz.encircled.jput.context.JPutContext

PropertySource - Interface in cz.encircled.jput.context

Property sources for settings

PropertySourceKt - Class in cz.encircled.jput.context

R

repeats() - Method in interface cz.encircled.jput.unit.PerformanceTest

Count of test execution repeats

ResultRecorder - Interface in cz.encircled.jput.recorder

ResultRecorder.DefaultImpls - Class in cz.encircled.jput.recorder

round(value) - Static method in class cz.encircled.jput.StatisticsKt

run(notifier) - Method in class cz.encircled.jput.runner.JPutJUnit4Runner

runChild(method, notifier) - Method in class cz.encircled.jput.runner.JPutJUnit4Runner

S

SampleBasedTrendAnalyzer - Class in cz.encircled.jput.trend

Trend analyzer which compares test execution with sample data from previous executions

SampleBasedTrendAnalyzer() - Constructor for class cz.encircled.jput.trend.SampleBasedTrendAnalyzer

Trend analyzer which compares test execution with sample data from previous executions

sampleSelectionStrategy() - Method in interface cz.encircled.jput.trend.PerformanceTrend

Defines the way,

sampleSize() - Method in interface cz.encircled.jput.trend.PerformanceTrend

Sample size which is used for trend analysis,

search(searchRequest, options) - Method in interface cz.encircled.jput.recorder.ElasticsearchClient

search(searchRequest, options) - Method in class cz.encircled.jput.recorder.ElasticsearchClientWrapper

SelectionStrategy - Enum in cz.encircled.jput.trend

Strategy for sample selection

SelectionStrategy() - Constructor for enum cz.encircled.jput.trend.SelectionStrategy

Strategy for sample selection

setContext(p) - Static method in class cz.encircled.jput.context.JPutContextKt

setJunit4TestExecutor(p) - Method in class cz.encircled.jput.context.JPutContext

setPercentiles(p) - Method in class cz.encircled.jput.model.PerfTestConfiguration

setPerformanceTestEnabled(p) - Method in class cz.encircled.jput.context.JPutContext

Global enabled/disabled switch

setPropertySources(p) - Method in class cz.encircled.jput.context.JPutContext

setResult(p) - Method in class cz.encircled.jput.model.PerfTestExecution

Validation result is set after executions

setTrendAnalyzer(p) - Method in class cz.encircled.jput.context.JPutContext

setUnitPerformanceAnalyzer(p) - Method in class cz.encircled.jput.context.JPutContext

startNextExecution() - Method in class cz.encircled.jput.model.PerfTestExecution

Starts new execution, returns start time (nanoseconds)

StatisticsKt - Class in cz.encircled.jput

subList($this, sample, size, strategy) - Static method in class cz.encircled.jput.recorder.ResultRecorder.DefaultImpls

Select sub list of given size from sample according to the given strategy

subList(sample, size, strategy) - Method in interface cz.encircled.jput.recorder.ResultRecorder

Select sub list of given size from sample according to the given strategy

SystemPropertySource - Class in cz.encircled.jput.context

Uses System.property and System.env as a sources

SystemPropertySource() - Constructor for class cz.encircled.jput.context.SystemPropertySource

Uses System.property and System.env as a sources

T

testId() - Method in interface cz.encircled.jput.unit.PerformanceTest

Unique test id,

ThreadsafeResultRecorder - Class in cz.encircled.jput.recorder

Primitive thread-safe abstract impl of interface ResultRecorder. Adds synchronization on append and flush.

ThreadsafeResultRecorder() - Constructor for class cz.encircled.jput.recorder.ThreadsafeResultRecorder

Primitive thread-safe abstract impl of interface ResultRecorder. Adds synchronization on append and flush.

toString() - Method in class cz.encircled.jput.model.PerfTestConfiguration

toString() - Method in class cz.encircled.jput.model.PerfTestExecution

toString() - Method in class cz.encircled.jput.model.PerfTestResult

toString() - Method in class cz.encircled.jput.model.TrendTestConfiguration

trendAnalyzer - Variable in class cz.encircled.jput.context.JPutContext

TrendAnalyzer - Interface in cz.encircled.jput.trend

trends() - Method in interface cz.encircled.jput.unit.PerformanceTest

Performance trend analyzing

TrendTestConfiguration - Class in cz.encircled.jput.model

Represents the configuration of a single trend performance test

TrendTestConfiguration(sampleSize, averageTimeThreshold, useStandardDeviationAsThreshold, sampleSelectionStrategy, noisePercentile) - Constructor for class cz.encircled.jput.model.TrendTestConfiguration

Represents the configuration of a single trend performance test

TrendTestConfiguration.Companion - Class in cz.encircled.jput.model

U

unitPerformanceAnalyzer - Variable in class cz.encircled.jput.context.JPutContext

UnitPerformanceAnalyzer - Interface in cz.encircled.jput.unit

UnitPerformanceAnalyzerImpl - Class in cz.encircled.jput.unit

UnitPerformanceAnalyzerImpl() - Constructor for class cz.encircled.jput.unit.UnitPerformanceAnalyzerImpl

useStandardDeviationAsThreshold() - Method in interface cz.encircled.jput.trend.PerformanceTrend

if true - use the sample standard deviation as an average time threshold

V

valid() - Method in class cz.encircled.jput.model.PerfTestConfiguration

variance($receiver) - Static method in class cz.encircled.jput.StatisticsKt

W

warmUp() - Method in interface cz.encircled.jput.unit.PerformanceTest

Count of warm up test executions

A B C D E F G H I J M P R S T U V W