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

A

addPropertySource(source, index) - Method in class cz.encircled.jput.context.JPutContext
Index defines the priority of a given source, where 0 is the highest
afterClass(clazz) - Method in class cz.encircled.jput.reporter.JPutAllureReporter
 
afterClass(clazz) - Method in class cz.encircled.jput.reporter.JPutConsoleReporter
 
afterClass(clazz) - Method in interface cz.encircled.jput.reporter.JPutReporter
 
afterTest(execution) - Method in class cz.encircled.jput.reporter.JPutAllureReporter
 
afterTest(execution) - Method in class cz.encircled.jput.reporter.JPutConsoleReporter
 
afterTest(execution) - Method in interface cz.encircled.jput.reporter.JPutReporter
 
afterTestClass(clazz) - Method in class cz.encircled.jput.context.JPutContext
 
analyzeTestTrend(execution, sample) - Method in class cz.encircled.jput.analyzer.SampleBasedTrendAnalyzer
sample represents times of previous executions in ms, which is used for trend analysis
analyzeTestTrend(execution, sample) - Method in interface cz.encircled.jput.analyzer.TrendAnalyzer
sample represents times of previous executions in ms, which is used for trend analysis
analyzeUnitTrend(execution) - Method in class cz.encircled.jput.analyzer.TestExceptionsAnalyzer
 
analyzeUnitTrend(execution) - Method in interface cz.encircled.jput.analyzer.UnitPerformanceAnalyzer
 
analyzeUnitTrend(execution) - Method in class cz.encircled.jput.analyzer.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.annotation.PerformanceTest
Upper limit for average execution time when using
averageTimeThreshold() - Method in interface cz.encircled.jput.annotation.PerformanceTrend
Static average time threshold.

B

beforeClass(clazz) - Method in class cz.encircled.jput.reporter.JPutAllureReporter
 
beforeClass(clazz) - Method in class cz.encircled.jput.reporter.JPutConsoleReporter
 
beforeClass(clazz) - Method in interface cz.encircled.jput.reporter.JPutReporter
 
beforeTest(execution) - Method in class cz.encircled.jput.reporter.JPutAllureReporter
 
beforeTest(execution) - Method in class cz.encircled.jput.reporter.JPutConsoleReporter
 
beforeTest(execution) - Method in interface cz.encircled.jput.reporter.JPutReporter
 
buildConfig(conf, method) - Method in class cz.encircled.jput.context.ConfigurationBuilder
Builds class PerfTestConfiguration from an conf annotation and available properties as well
bulk(request, options) - Method in interface cz.encircled.jput.recorder.ElasticsearchClient
 
bulk(request, options) - Method in class cz.encircled.jput.recorder.ElasticsearchClientWrapper
 

C

ClasspathFilePropertySource - Class in cz.encircled.jput.context
 
ClasspathFilePropertySource() - Constructor for class cz.encircled.jput.context.ClasspathFilePropertySource
 
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.analyzer.SampleBasedTrendAnalyzer
 
Companion - Static variable in class cz.encircled.jput.context.JPutContext
 
Companion - Static variable in class cz.encircled.jput.model.SuiteConfiguration
 
Companion - Static variable in class cz.encircled.jput.runner.JPutJUnit4Runner
 
Companion - Static variable in class cz.encircled.jput.runner.JPutSpringRunner
 
Companion - Static variable in class cz.encircled.jput.runner.Junit4TestExecutor
 
component1() - Method in class cz.encircled.jput.model.ExecutionRun
Parent execution
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.RunResult
 
component1() - Method in class cz.encircled.jput.model.SuiteConfiguration
 
component1() - Method in class cz.encircled.jput.model.TrendTestConfiguration
Sample size which will be used for trend analysis
component10() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Ramp-up in milliseconds.
component11() - Method in class cz.encircled.jput.model.PerfTestConfiguration
 
component12() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Unit test will be marked as failed,
component13() - Method in class cz.encircled.jput.model.PerfTestConfiguration
TODO implement: reactive
component14() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Performance trend analyzing
component2() - Method in class cz.encircled.jput.model.ExecutionRun
Start time in nanoseconds relative to execution start time
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.RunResult
 
component2() - Method in class cz.encircled.jput.model.SuiteConfiguration
 
component2() - Method in class cz.encircled.jput.model.TrendTestConfiguration
Static average time threshold.
component3() - Method in class cz.encircled.jput.model.ExecutionRun
Elapsed time in ms
component3() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Test execution repeats count
component3() - Method in class cz.encircled.jput.model.PerfTestExecution
Start time of this execution in nanoseconds
component3() - Method in class cz.encircled.jput.model.RunResult
 
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.ExecutionRun
 
component4() - Method in class cz.encircled.jput.model.PerfTestConfiguration
TODO
component4() - Method in class cz.encircled.jput.model.PerfTestExecution
Repeat number to its execution
component4() - Method in class cz.encircled.jput.model.TrendTestConfiguration
Defines the strategy for sample selection
component5() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Delay between test repeats,
component5() - Method in class cz.encircled.jput.model.PerfTestExecution
Validation result is set after executions
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 test execution time in milliseconds
component7() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Upper limit for average execution time when using
component8() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Upper limits for test execution time in milliseconds within defined percentiles. Defining multiple percentiles allows to have multiple validation constraints, for instance 200ms for 75% and 500ms for 95%.
component9() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Count of maximum parallel executions
ConfigurationBuilder - Class in cz.encircled.jput.context
 
ConfigurationBuilderKt - Class in cz.encircled.jput.context
 
continueOnException() - Method in interface cz.encircled.jput.annotation.PerformanceTest
If true,
copy(execution, relativeStartTime, elapsedTime, resultDetails) - Method in class cz.encircled.jput.model.ExecutionRun
Each test (i.e. class PerfTestExecution) may have multiple repeats, this class represent a single repeat/run
copy(testId, warmUp, repeats, runTime, delay, maxTimeLimit, avgTimeLimit, percentiles, parallelCount, rampUp, isReactive, maxAllowedExceptionsCount, continueOnException, trendConfiguration) - Method in class cz.encircled.jput.model.PerfTestConfiguration
Performance test configuration of a single junit test method
copy(conf, executionParams, startTime, executionResult, violations) - Method in class cz.encircled.jput.model.PerfTestExecution
Represents the execution state of a particular performance test.
copy(resultCode, error, errorMessage) - Method in class cz.encircled.jput.model.RunResult
 
copy(clazz, isParallel) - Method in class cz.encircled.jput.model.SuiteConfiguration
 
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.analyzer - package cz.encircled.jput.analyzer
 
cz.encircled.jput.annotation - package cz.encircled.jput.annotation
 
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.reporter - package cz.encircled.jput.reporter
 
cz.encircled.jput.runner - package cz.encircled.jput.runner
 
cz.encircled.jput.trend - package cz.encircled.jput.trend
 

D

delay() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Delay between test repeats,
deleteByQuery(deleteByQueryRequest, options) - Method in interface cz.encircled.jput.recorder.ElasticsearchClient
 
deleteByQuery(deleteByQueryRequest, options) - Method in class cz.encircled.jput.recorder.ElasticsearchClientWrapper
 
deviation($receiver) - Static method in class cz.encircled.jput.StatisticsKt
 
doCleanup() - Method in class cz.encircled.jput.recorder.ElasticsearchResultRecorder
 
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.ExecutionRun
 
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.RunResult
 
equals(p) - Method in class cz.encircled.jput.model.SuiteConfiguration
 
equals(p) - Method in class cz.encircled.jput.model.TrendTestConfiguration
 
evaluate() - Method in class cz.encircled.jput.runner.InvokeMethodWithParams
 
exceptionsCount() - Method in class cz.encircled.jput.model.PerfTestExecution
Count of repeats which finished with an exception
executeTest(method, notifier, description, statement) - Method in class cz.encircled.jput.runner.Junit4TestExecutor
 
executeTest(config, statement) - Method in class cz.encircled.jput.runner.ThreadBasedTestExecutor
 
executionPercentile(rank) - Method in class cz.encircled.jput.model.PerfTestExecution
Get max execution time for given percentile rank
ExecutionRun - Class in cz.encircled.jput.model
Each test (i.e. class PerfTestExecution) may have multiple repeats, this class represent a single repeat/run
ExecutionRun(execution, relativeStartTime, elapsedTime, resultDetails) - Constructor for class cz.encircled.jput.model.ExecutionRun
Each test (i.e. class PerfTestExecution) may have multiple repeats, this class represent a single repeat/run

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
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(clazz, annotation) - Method in class cz.encircled.jput.model.SuiteConfiguration.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
getClazz() - Method in class cz.encircled.jput.model.SuiteConfiguration
 
getConf() - Method in class cz.encircled.jput.model.PerfTestExecution
Configuration used for this execution
getContext() - Static method in class cz.encircled.jput.context.JPutContextKt
 
getContinueOnException() - Method in class cz.encircled.jput.model.PerfTestConfiguration
TODO implement: reactive
getCurrentSuite() - Method in class cz.encircled.jput.context.JPutContext
Currently running class suite, should be set by org.junit.runner.Runner
getCurrentSuiteMethod() - Method in class cz.encircled.jput.context.JPutContext
Currently running method of a suite, should be set by org.junit.runner.Runner
getDelay() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Delay between test repeats,
getElapsedTime() - Method in class cz.encircled.jput.model.ExecutionRun
Elapsed time in ms
getElapsedTimes() - Method in class cz.encircled.jput.model.PerfTestExecution
List of elapsed times of all repeats
getError() - Method in class cz.encircled.jput.model.RunResult
 
getErrorMessage() - Method in class cz.encircled.jput.model.RunResult
 
getErrorResults() - Method in class cz.encircled.jput.model.PerfTestExecution
 
getExecution() - Method in class cz.encircled.jput.model.ExecutionRun
Parent execution
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
Repeat number to its execution
getExecutor() - Method in class cz.encircled.jput.runner.Junit4TestExecutor
 
getJPut() - Method in class cz.encircled.jput.runner.Junit4TestExecutor.Companion
Hack for class InvokeMethodWithParams - there is no other easy way how to pass the interface JPut argument to the unit test and re-use existing JUnit Statements (like BeforeTest, AfterTest etc)
getMaxAllowedExceptionsCount() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Unit test will be marked as failed,
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
 
getMethod() - Method in class cz.encircled.jput.runner.InvokeMethodWithParams
 
getNoisePercentile() - Method in class cz.encircled.jput.model.TrendTestConfiguration
Only result from given percentile are counted for trend tests,
getParallelCount() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Count of maximum parallel executions
getPercentiles() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Upper limits for test execution time in milliseconds within defined percentiles. Defining multiple percentiles allows to have multiple validation constraints, for instance 200ms for 75% and 500ms for 95%.
getProperty(key) - Method in class cz.encircled.jput.context.ClasspathFilePropertySource
 
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
 
getRampUp() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Ramp-up in milliseconds.
getRelativeStartTime() - Method in class cz.encircled.jput.model.ExecutionRun
Start time in nanoseconds relative to execution start time
getRepeats() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Test execution repeats count
getResult() - Method in class cz.encircled.jput.runner.Junit4TestExecutor.Companion
Hack for class InvokeMethodWithParams - there is no other easy way how to receive return value from the unit test and re-use existing JUnit Statements (like BeforeTest, AfterTest etc)
getResultCode() - Method in class cz.encircled.jput.model.RunResult
 
getResultDetails() - Method in class cz.encircled.jput.model.ExecutionRun
 
getResultRecorders() - Method in class cz.encircled.jput.context.JPutContext
Test results recorders
getResultReporters() - Method in class cz.encircled.jput.context.JPutContext
 
getRunTime() - Method in class cz.encircled.jput.model.PerfTestConfiguration
TODO
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
getStartTime() - Method in class cz.encircled.jput.model.ExecutionRun
 
getStartTime() - Method in class cz.encircled.jput.model.PerfTestExecution
Start time of this execution in nanoseconds
getSuccessResults() - Method in class cz.encircled.jput.model.PerfTestExecution
Only success executionResult
getTarget() - Method in class cz.encircled.jput.recorder.FileSystemResultRecorder
 
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
getUnitPerformanceAnalyzers() - 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.PerfTestExecution
Validation result is set after executions
getViolationsErrorMessage() - Method in class cz.encircled.jput.model.PerfTestExecution
Build error messages from violations
getWarmUp() - Method in class cz.encircled.jput.model.PerfTestConfiguration
Count of warm up test executions

H

hashCode() - Method in class cz.encircled.jput.model.ExecutionRun
 
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.RunResult
 
hashCode() - Method in class cz.encircled.jput.model.SuiteConfiguration
 
hashCode() - Method in class cz.encircled.jput.model.TrendTestConfiguration
 

I

init() - Method in class cz.encircled.jput.context.JPutContext
 
INSTANCE - Static variable in class cz.encircled.jput.context.ConfigurationBuilder
 
INSTANCE - Static variable in class cz.encircled.jput.JPutUtils
 
InvokeMethodWithParams - Class in cz.encircled.jput.runner
 
InvokeMethodWithParams(target, method) - Constructor for class cz.encircled.jput.runner.InvokeMethodWithParams
 
isError() - Method in class cz.encircled.jput.model.ExecutionRun
 
isInitialized() - Method in class cz.encircled.jput.runner.JPutJUnit4Runner.Companion
 
isInitialized() - Method in class cz.encircled.jput.runner.JPutSpringRunner.Companion
 
isParallel() - Method in class cz.encircled.jput.model.SuiteConfiguration
 
isPerformanceTestEnabled() - Method in class cz.encircled.jput.context.JPutContext
Global enabled/disabled switch
isReactive() - Method in interface cz.encircled.jput.annotation.PerformanceTest
 
isReactive() - Method in class cz.encircled.jput.model.PerfTestConfiguration
 

J

JPut - Interface in cz.encircled.jput
TODO list:
JPutAllureReporter - Class in cz.encircled.jput.reporter
 
JPutAllureReporter() - Constructor for class cz.encircled.jput.reporter.JPutAllureReporter
 
JPutBaseTextReporter - Class in cz.encircled.jput.reporter
 
JPutBaseTextReporter() - Constructor for class cz.encircled.jput.reporter.JPutBaseTextReporter
 
JPutConsoleReporter - Class in cz.encircled.jput.reporter
 
JPutConsoleReporter() - Constructor for class cz.encircled.jput.reporter.JPutConsoleReporter
 
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
 
JPutImpl - Class in cz.encircled.jput
 
JPutImpl(executionRun) - Constructor for class cz.encircled.jput.JPutImpl
 
JPutJUnit4Runner - Class in cz.encircled.jput.runner
org.junit.runner.Runner impl for JUnit 4
JPutJUnit4Runner(clazz) - Constructor for class cz.encircled.jput.runner.JPutJUnit4Runner
org.junit.runner.Runner impl for JUnit 4
JPutJUnit4Runner.Companion - Class in cz.encircled.jput.runner
 
JPutReporter - Interface in cz.encircled.jput.reporter
Allows to report the state of executed performance tests. Implementation class name must be set using property jput.reporter.class
JPutSpringRunner - Class in cz.encircled.jput.runner
 
JPutSpringRunner(clazz) - Constructor for class cz.encircled.jput.runner.JPutSpringRunner
 
JPutSpringRunner.Companion - Class in cz.encircled.jput.runner
 
JPutUtils - Class in cz.encircled.jput
 
Junit4TestExecutor - Class in cz.encircled.jput.runner
TODO redesign executors / inheritance / composition
Junit4TestExecutor() - Constructor for class cz.encircled.jput.runner.Junit4TestExecutor
TODO redesign executors / inheritance / composition
Junit4TestExecutor.Companion - Class in cz.encircled.jput.runner
 
JUnitTestRunnerSupport - Class in cz.encircled.jput.runner
 
JUnitTestRunnerSupport(clazz) - Constructor for class cz.encircled.jput.runner.JUnitTestRunnerSupport
 

M

markPerformanceTestEnd() - Method in interface cz.encircled.jput.JPut
This function may be called directly from the performance test to tell JPut that time measurement must end at this point, i.e. not until the end of the method. This might be useful when performance test makes some expensive assertions/cleanup after each test repeat.
markPerformanceTestEnd() - Method in class cz.encircled.jput.JPutImpl
This function may be called directly from the performance test to tell JPut that time measurement must end at this point, i.e. not until the end of the method. This might be useful when performance test makes some expensive assertions/cleanup after each test repeat.
markPerformanceTestStart() - Method in interface 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.
markPerformanceTestStart() - Method in class cz.encircled.jput.JPutImpl
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.
max() - Method in interface cz.encircled.jput.annotation.Percentile
Upper limit for test execution time in milliseconds
maxAllowedExceptionsCount() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Unit test will be marked as failed,
maxTimeLimit() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Upper limit for test execution time in milliseconds
measureElapsed() - Method in class cz.encircled.jput.model.ExecutionRun
Set elapsed time as difference before current time and start time
methodInvoker(method, test) - Method in class cz.encircled.jput.runner.JPutJUnit4Runner
Allows passing interface JPut to the test
methodInvoker(method, test) - Method in class cz.encircled.jput.runner.JPutSpringRunner
Allows passing interface JPut to the test

N

noisePercentile() - Method in interface cz.encircled.jput.annotation.PerformanceTrend
Only result from given percentile are counted for trend tests,

P

parallel() - Method in interface cz.encircled.jput.annotation.PerformanceSuite
If true,
parallel() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Tests will run in parallel if threads count is greater than 1
parseDuration(src) - Method in class cz.encircled.jput.context.ConfigurationBuilder
Parse duration in milliseconds from a src string in format like "1h 2min 3sec"
Percentile - Interface in cz.encircled.jput.annotation
Represents percentile rank and its execution time limit
percentile($receiver, rank) - Static method in class cz.encircled.jput.StatisticsKt
List must be ordered
percentiles() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Upper limits for test execution time in milliseconds within defined percentiles.
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
PerformanceSuite - Interface in cz.encircled.jput.annotation
Marker for class which contains multiple performance tests
PerformanceTest - Interface in cz.encircled.jput.annotation
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.annotation
Configuration for performance trend analysis, must be defined through interface PerformanceTest
performExecution(execution, statement) - Method in class cz.encircled.jput.runner.ThreadBasedTestExecutor
 
PerfTestConfiguration - Class in cz.encircled.jput.model
Performance test configuration of a single junit test method
PerfTestConfiguration(testId, warmUp, repeats, runTime, delay, maxTimeLimit, avgTimeLimit, percentiles, parallelCount, rampUp, isReactive, maxAllowedExceptionsCount, continueOnException, trendConfiguration) - Constructor for class cz.encircled.jput.model.PerfTestConfiguration
Performance test configuration of a single junit test method
PerfTestExecution - Class in cz.encircled.jput.model
Represents the execution state of a particular performance test.
PerfTestExecution(conf, executionParams, startTime, executionResult, violations) - Constructor for class cz.encircled.jput.model.PerfTestExecution
Represents the execution state of a particular performance test.
prepareRunner(runner) - Method in class cz.encircled.jput.runner.JUnitTestRunnerSupport
 
PROP_ELASTIC_CLEANUP_DAYS - Static variable in class cz.encircled.jput.context.JPutContext
Automatically delete data older than given days from Elasticsearch
PROP_ELASTIC_ENABLED - Static variable in class cz.encircled.jput.context.JPutContext
Boolean - enables/disables elasticsearch as a Result Recorder
PROP_ELASTIC_ENV_IDENTIFIERS - Static variable in class cz.encircled.jput.context.JPutContext
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.
PROP_ELASTIC_HOST - Static variable in class cz.encircled.jput.context.JPutContext
Elasticsearch server host name
PROP_ELASTIC_INDEX - Static variable in class cz.encircled.jput.context.JPutContext
Elasticsearch index name to be used
PROP_ELASTIC_PORT - Static variable in class cz.encircled.jput.context.JPutContext
Elasticsearch server port
PROP_ELASTIC_SCHEME - Static variable in class cz.encircled.jput.context.JPutContext
Network scheme, e.g. http/https
PROP_ENABLED - Static variable in class cz.encircled.jput.context.JPutContext
Enables/disables execution of performance tests
PROP_ENV_PARAMS - Static variable in class cz.encircled.jput.context.JPutContext
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_PATH_TO_STORAGE_FILE - Static variable in class cz.encircled.jput.context.JPutContext
Absolute path to the file which will be used a a storage
PROP_REPORTER_CLASS - Static variable in class cz.encircled.jput.context.JPutContext
Fully classified class name of custom Result Recorder
PROP_STORAGE_FILE_ENABLED - Static variable in class cz.encircled.jput.context.JPutContext
Boolean - enables/disables file Result Recorder
PROP_TEST_CONFIG - Static variable in class cz.encircled.jput.context.JPutContext
 
PropertySource - Interface in cz.encircled.jput.context
Property source for JPut settings
PropertySourceKt - Class in cz.encircled.jput.context
 

R

rampUp() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Ramp-up in milliseconds.
rank() - Method in interface cz.encircled.jput.annotation.Percentile
Percentile rank,
repeats() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Count of test execution repeats
ResultRecorder - Interface in cz.encircled.jput.recorder
 
ResultRecorder.DefaultImpls - Class in cz.encircled.jput.recorder
 
run(notifier) - Method in class cz.encircled.jput.runner.JPutJUnit4Runner
 
run(notifier) - Method in class cz.encircled.jput.runner.JPutSpringRunner
 
runChild(method, notifier) - Method in class cz.encircled.jput.runner.JPutJUnit4Runner
 
runChild(method, notifier) - Method in class cz.encircled.jput.runner.JPutSpringRunner
 
RunResult - Class in cz.encircled.jput.model
 
RunResult(resultCode, error, errorMessage) - Constructor for class cz.encircled.jput.model.RunResult
 
RunResult(resultCode, error) - Constructor for class cz.encircled.jput.model.RunResult
 
RunResult(resultCode) - Constructor for class cz.encircled.jput.model.RunResult
 
RunResult() - Constructor for class cz.encircled.jput.model.RunResult
 
runTime() - Method in interface cz.encircled.jput.annotation.PerformanceTest
TODO

S

SampleBasedTrendAnalyzer - Class in cz.encircled.jput.analyzer
Trend analyzer which compares test execution with sample data from previous executions
SampleBasedTrendAnalyzer() - Constructor for class cz.encircled.jput.analyzer.SampleBasedTrendAnalyzer
Trend analyzer which compares test execution with sample data from previous executions
sampleSelectionStrategy() - Method in interface cz.encircled.jput.annotation.PerformanceTrend
Defines the way,
sampleSize() - Method in interface cz.encircled.jput.annotation.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
 
setCurrentSuite(p) - Method in class cz.encircled.jput.context.JPutContext
Currently running class suite, should be set by org.junit.runner.Runner
setCurrentSuiteMethod(p) - Method in class cz.encircled.jput.context.JPutContext
Currently running method of a suite, should be set by org.junit.runner.Runner
setElapsedTime(p) - Method in class cz.encircled.jput.model.ExecutionRun
Elapsed time in ms
setErrorMessage(p) - Method in class cz.encircled.jput.model.RunResult
 
setExecutor(p) - Method in class cz.encircled.jput.runner.Junit4TestExecutor
 
setInitialized(p) - Method in class cz.encircled.jput.runner.JPutJUnit4Runner.Companion
 
setInitialized(p) - Method in class cz.encircled.jput.runner.JPutSpringRunner.Companion
 
setPropertySources(p) - Method in class cz.encircled.jput.context.JPutContext
 
setRelativeStartTime(p) - Method in class cz.encircled.jput.model.ExecutionRun
Start time in nanoseconds relative to execution start time
setResultDetails(p) - Method in class cz.encircled.jput.model.ExecutionRun
 
setResultReporters(p) - Method in class cz.encircled.jput.context.JPutContext
 
setTrendAnalyzer(p) - Method in class cz.encircled.jput.context.JPutContext
 
setUnitPerformanceAnalyzers(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
SuiteConfiguration - Class in cz.encircled.jput.model
 
SuiteConfiguration(clazz, isParallel) - Constructor for class cz.encircled.jput.model.SuiteConfiguration
 
SuiteConfiguration.Companion - Class in cz.encircled.jput.model
 
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

TestExceptionsAnalyzer - Class in cz.encircled.jput.analyzer
This analyzer verifies that count of occurred exceptions is within defined limits
TestExceptionsAnalyzer() - Constructor for class cz.encircled.jput.analyzer.TestExceptionsAnalyzer
This analyzer verifies that count of occurred exceptions is within defined limits
testId() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Unique test id,
ThreadBasedTestExecutor - Class in cz.encircled.jput.runner
Executes particular piece of code (junit test, or any other function) and runs performance and trend assertions.
ThreadBasedTestExecutor() - Constructor for class cz.encircled.jput.runner.ThreadBasedTestExecutor
Executes particular piece of code (junit test, or any other function) and runs performance and trend assertions.
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.
toPercentile($receiver) - Static method in class cz.encircled.jput.context.ConfigurationBuilderKt
 
toString() - Method in class cz.encircled.jput.model.ExecutionRun
 
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.RunResult
 
toString() - Method in class cz.encircled.jput.model.SuiteConfiguration
 
toString() - Method in class cz.encircled.jput.model.TrendTestConfiguration
 
TrendAnalyzer - Interface in cz.encircled.jput.analyzer
 
trends() - Method in interface cz.encircled.jput.annotation.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

U

UnitPerformanceAnalyzer - Interface in cz.encircled.jput.analyzer
 
UnitPerformanceAnalyzerImpl - Class in cz.encircled.jput.analyzer
This analyzer verifies that execution times (avg, max etc) are within defined limits.
UnitPerformanceAnalyzerImpl() - Constructor for class cz.encircled.jput.analyzer.UnitPerformanceAnalyzerImpl
This analyzer verifies that execution times (avg, max etc) are within defined limits.
useStandardDeviationAsThreshold() - Method in interface cz.encircled.jput.annotation.PerformanceTrend
if true - use the sample standard deviation as an average time threshold

V

valid() - Method in class cz.encircled.jput.model.PerfTestConfiguration
 
validatePublicVoidNoArgMethods(annotation, isStatic, errors) - Method in class cz.encircled.jput.runner.JPutJUnit4Runner
Skip args/return type validation of performance tests
validatePublicVoidNoArgMethods(annotation, isStatic, errors) - Method in class cz.encircled.jput.runner.JPutSpringRunner
Skip args/return type validation of performance tests
variance($receiver) - Static method in class cz.encircled.jput.StatisticsKt
 

W

warmUp() - Method in interface cz.encircled.jput.annotation.PerformanceTest
Count of warm up test executions
A B C D E F G H I J M N P R S T U V W 
Skip navigation links