Index

AbstractSelectiveFlow

Abstract base class for flow which selects another bench function each given number of benchmark iterations.
Bench…

AllOf

Accepted if all matchers from the given list are accepted otherwise rejected.

Any

Verifies if matching stream of Iterable has at least a one element that satisfies the given predicate function.

AnyOf

Verifies if matching stream of Iterable has at least a one element that satisfies the given matcher.

ApplyStatementAnnotation

Indicates that the given test statements have to be applied to the annotated test function.
Each value declaration from

ArgumentVariants

Specifies variants for a test function argument.

ArgumentsAnnotation

Indicates that test container class or test prepost function have to be instantiated or called using arguments provided b…

AsyncFactoryContext

Factory submited to factory function in order to perform asynchronous instantiation in initialization of test class. W

AsyncPrePostContext

Allows prepost function functions to interract with test executor.

AsyncRunnerContext

Base interface to push test messages to.
The interface is mainly used by test runners, see package herd.asynctest.runner

AsyncTestContext

Provides interaction with asynchronous test executor.

AsyncTestExecutor

Async test executor.

AsyncTestRunner

Test runner is applied to execute test function with a one test variant.

AtomicValueRule

Atomic reference on some value which is re-initialized to initial value each time the test is started.
If Element is…

Beginning

Verifies if matching List value is beginning point of the given list.

Bench

Represents benchmark test parameterized with Parameter type.

BenchFlow

Represents benchmark function + test flow.

BenchResult

Represents results of a one benchmark.
Contains execution statistic and some additional results.

CPUClock

CPU clock uses ThreadMXBean.currentThreadCpuTime to measure time interval.
If thread CPU time is not supported measures…

CSVReporter

Reports to a file.

ChainedRunner

Provides runners chaining:
the first runner executes the second one and so on, the last runner calls testing directly.

Chart

Chart as axis definitions and a list of plots.

ChartBuilder

Builds a chart.

ChartDescription

Description of a chart:

Clock

Measures the time interval.

CloseTo

Verifies if matching value is close to merit with the given tolerance.

CollectAndDelegateContext

Context which collects results and delegates to another context.
To get results of the test run examine CollectorContext.

CollectorContext

Context which collects results but not actually reports on.
To get results of the test run examine CollectorContext.

CombinatorialAnnotation

Indicates that the test function has to be executed with variants provided by combinations of the test function…

CombinatorialKind

Indicates the kind of the combinatorial source data.

CombinedReporter

Reports to a set of reporters

CompletionCriterion

Identifies if benchmark iterations have to be completed or continued.

ConcurrentAnnotation

Indicates that all test suites (each suite contains all top-level test functions in the given package or all test…

ConsoleReporter

Reports to console

Contained

Verifies if matching value is contained in the given stream of Sequence.

Contains

Verifies if matching stream of Iterable contains the given item.

ContainsAny

Verifies if matching stream of Iterable contains at least one item from the given elements stream.

ContainsEvery

Verifies if matching stream of Iterable contains every item from the given elements stream.

ContainsItem

Verifies if matching map contains the given item item.

ContainsNoDuplicates

Verifies if matching stream of Sequence does not contain duplicate elements.

ContextualRule

Test rule which stores values local to the current thread of execution meaning that each thread or process that…

CounterRule

Atomically counts something. R

CurrentTestStore

The rule which returns an element only if it is requested from the same test which initializes the rule.
Otherwise

DataSourceAnnotation

Indicates that the test has to be performed by applying a list of values to the marked test function argument.
source

DefinesKey

Verifies if matching map defines the given key key, see Map.defines.

DoesNotContain

Verifies if matching stream of Iterable does not contain the given item.

DoesNotContainItem

Verifies if matching map doesn't contain the given item item.

DoesNotDefineKey

Verifies if matching map doesn't define the given key key, see Map.defines.

Empty

Verifies if matching stream of Iterable is empty.

EndsWith

Verifies if matching List value ends with the given subList.

EqualContent

Verifies if matching stream contains the same elements as the given one.
The matcher doesn't rely on exact stream type -…

EqualTo

Verifies if matching value equals to merit using operator ==.

EqualWith

Verifies if matching value is equal to merit using given comparator.

ErrorCollectorRunner

Collects all errors into a one ceylon.test.engine::MultipleFailureException exception.
Ignores success messages.

ErrorCriterion

Continues benchmark iterations while relative sample error doesn't exceed maxRelativeError.
I.e.

Every

Verifies if matching stream of Iterable has all elements satisfy the given predicate function.

EveryOf

Verifies if matching stream of Iterable has all elements that satisfies the given matcher.

ExceptionHasCause

Verifies if matching exception has any cause.

ExceptionHasMessage

Verifies if matching exception has message equaled to messageCondition.

ExceptionHasNoCause

Verifies if matching exception doesn't have any cause.

ExceptionHasType

Verifies if matching exception has type of ExceptionType.

FactoryAnnotation

Indicates that class has to be instantiated using a given factory function.
factory() annotation takes declaration of…

FactoryReturnsNothing

Exception errored when no object instantiated no error throwed by factory.

Finishing

Verifies if matching List value is finishing point of the given list.

First

Verifies if matching value is the first in the given stream of Sequence.

GaugeStatement

Statement which verifies an element against given matcher each time when gauged, i.e. when GaugeStatement.gauge()

Greater

Verifies if matching value is greater than given merit.

GreaterOrEqual

Verifies if matching value is greater or equal to given merit.

HasKey

Verifies if matching value is a key in the given map, see Map.defines.

Identical

Verifies if matching value is identical to merit using operator ===.

InRange

Verifies if matching value is within given range of lower to upper including bounds.

Included

Verifies if matching List value is included in the given list.
SearchableList.includes is used in order to perform the…

IncludedAt

Verifies if matching List value is included in the given list at the given index of the list.
SearchableList.includesAt

Includes

Verifies if matching SearchableList value includes the given list.
SearchableList.includes is used in order to perform…

IncludesAt

Verifies if matching SearchableList value includes the given list at the given index.
SearchableList.includesAt is used…

IncompatibleInstantiation

Thrown when instantiated class has neither default constructor nor factory function.

IsControl

Verifies if matching character is an ISO control character.

IsDefined

Verifies if matching value is defined i.e. is not NaN.

IsDigit

Verifies if matching character is a numeric digit.

IsEven

Verifies if matching integer is even, i.e. if exists number that i=2*k.

IsFalse

Verifies if matching value is false.

IsFinite

Verifies if matching value is finite.

IsInfinite

Verifies if matching value is infinite.

IsLetter

Verifies if matching character is a letter.

IsLowercase

Verifies if matching character is a lowercase representation of the character.

IsNegative

Verifies if matching value is negative, i.e. is < 0.

IsNotNegative

Verifies if matching value is not negative, i.e. is >= 0.

IsNotNull

Verifies if matching value is not null.

IsNotPositive

Verifies if matching value is not positive, i.e. is <= 0.

IsNotType

Verifies if matching value is not of Check type.

IsNotZero

Verifies if matching value is not zero.

IsNull

Verifies if matching value is null.

IsOdd

Verifies if matching integer is odd, i.e. if exists number that i=2*k+1.

IsPositive

Verifies if matching value is positive, i.e. is > 0.

IsSorted

Verifies if matching stream is sorted.

IsTitlecase

Verifies if matching character is a titlecase representation of the character.

IsTrue

Verifies if matching value is true.

IsType

Verifies if matching value is of Check type.

IsUndefined

Verifies if matching value is undefined i.e. is not a number or NaN.

IsUppercase

Verifies if matching character is a uppercase representation of the character.

IsWhitespace

Verifies if matching character is whitespace character.

IsZero

Verifies if matching value is zero.

ItemAtKey

Verifies if the given map contains the given item item at the matching value as key. I

ItemByKey

Verifies if matching map contains the given item item with the given key key. I

Last

Verifies if matching value is the last in the given stream of Sequence.

Less

Verifies if matching value is less than given merit.

LessOrEqual

Verifies if matching value is less or equal to given merit.

LockAccessRule

Tool for controlling access to a shared resource of Element type by multiple threads.

LongerThan

Verifies if matching stream of Iterable is longer than the given size.

MapExisted

Maps matching value if it is not null to another type To using convert and passes converted to the given matcher.…

Mapping

Maps matching value to another one using convert and passes converted value to the given matcher.

MatchResult

Represents a result of matching operation:

Matcher

Matcher is a rule and verification method which identifies if submitted test value satisfies this rule or not.

MemberFactoryException

Thrown when class is instantiated using member factory function (neither static nor toplevel).

MeterRule

Lock-free and thread-safely collects statistic data on an execution time and on a rate (per second) at which a set of…

MultiBench

Executes bench functions benches in separated threads.
Number of threads for each bench function is specified by the…

MultipleAbortException

Collects multiple abort reasons in a one exception.

NoneOf

Accepted if no one matcher from the given list is accepted and rejected if all matchers from the given list are…

NotContained

Verifies if matching value is not contained in the given stream of Sequence.

NotEmpty

Verifies if matching stream of Iterable is not empty.

NotEqualTo

Verifies if matching value is not equal to merit using operator !=

NotEqualWith

Verifies if matching value is not equal to merit using given comparator.

NotIdentical

Verifies if matching value is not identical to merit using operator ===.

NotInRange

Verifies if matching value is not within given range of lower to upper including bounds.

NotWithin

Verifies if matching value is not within given range of lower to upper excluding bounds.

NumberOfLoops

Continues benchmark iterations while total number of benchmark loops doesn't exceed numberOfLoops.

Occured

Verifies if matching value occurs in the given list at any index within from:length segment.
SearchableList.occurs is…

OccuredAt

Verifies if matching value occurs in the given list at the given index.
SearchableList.occursAt is used in order to…

Occurs

Verifies if the given element occurs in matching SearchableList value within from:length segment.
SearchableList.occurs

OccursAt

Verifies if the given element occurs in matching SearchableList value at the given index.
SearchableList.occursAt is…

OneOf

Accepted if one and only one from the given matchers is accepted otherwise rejected.

Options

Benchmark options.

ParameterResult

Benchmark run result for a given parameter and a set of benches.

ParameterizedAnnotation

Indicates that generic (with possibly empty generic parameter list) test function has to be executed with given test…

PassExisted

Pass matching value to the given matcher if the value is not null.
Rejects matching if the value is null.

PassType

Pass matching value if it satisfies given type Value to another matcher.
Rejects matching if value is is not Value.

PermutationKind

Indicates that the test data has to be permuted.

Plot

A one plot as a list of points.

Plotter

Plot builder.

Point

A one point on a plot.

Predicate

Redirects matching to a predicate function.
If predicate returns true matching is accepted otherwise it is rejected

RandomDataFlow

Randomly chooses bench function argument from sourceData and pass selected argument to benchFunction.
The argument is…

RandomFlow

Randomly selects benchmark function from the given list each time before execution.
Each function is paired with…

Rectangle

Rectangle in 2D.

RepeatRunner

Runner which repeats test execution a number of times identified by strategy but at least once.

RepeatStrategy

Identifies if test has to be repeated or completed.

RepeatUpToFailedRun

Repeats up to the first failed run but no more than maxRepeats times.
Reports result from the latest run.

RepeatUpToFailureMessage

Repeats up to the first failure message but no more than maxRepeats times.
Reports the first failure message only.

RepeatUpToSuccessfulRun

Repeats up to the first successful run but no more than maxRepeats times.
Reports result from the latest run.

ReportFormat

Represents details of report format.

Reporter

Reports charts.

ResourceRule

A file packaged within a module and loaded before all tests started.
See ceylon.language::Resource for details.

Result

Benchmark run result for a set of parameters and benches.

RetryAnnotation

Indicates that execution of a test function or all test functions within annotated test container have to be retryed u…

RunWithAnnotation

Indicates that the test function has to be run with the given runner.
The runner has to satisfy AsyncTestRunner

SelectiveFlow

Flow which selects another bench function each given number of benchmark iterations.
select has to return currently…

SequentialFlow

Sequentially selects bench function from the given list independently for the each running thread.

ShorterThan

Verifies if matching stream of Iterable is shorter than the given size.

SignalRule

Provides suspend / resume capability.

SingleBench

Executes test function in a single thread.

SizeOf

Verifies if matching stream of Iterable has the given size.

SomeOf

Accepted if some from the given matchers is accepted and rejected only if all matchers are rejected.

StartsWith

Verifies if matching List value starts with the given subList.

Statistic

Provides statistic data for a stream of variate values.

StatisticRule

Lock-free and thread-safely accumulates statistics data of some variate values.
Doesn't collect values, just accumulates…

Subset

Verifies if the given subset is subset of matching set.

SubsetOf

Verifies if matching set is subset of the given superset.

SuiteRule

Base interface for suite rule, which is initialized or disposed before or after execution of all tests in the scope (p…

SuiteRuleChain

Applies suite rules in the given order. I

Superset

Verifies if the given superset is superset of matching set.

SupersetOf

Verifies if matching set is superset of the given subset.

TemporaryDirectoryRule

Creates new temporary directory before each test and destroyes it after.

TemporaryFileRule

Creates new temporary file before each test and destroyes it after.

TestAccessDenied

Exception thrown when access to a value is requested from a test which doesn't own the value.

TestInfo

Information on currently running test variant.

TestOutput

Represents a one test report.

TestRule

Base interface for test rule, which is initialized or disposed before or after execution of each test in the scope (p…

TestRuleAnnotation

Indicates that the annotated value or attribute identifies a test rule.
The value declaration has to satisfy SuiteRule,

TestRuleChain

Applies test rules in the given order. I

TestStatement

Base interface for test statement, which is applied after execution of each test in the scope (package for top-level v…

TestStatementChain

Applies test statements in the given order.

TestVariant

Represents test variant, i.e. test function generic type parameters and arguments.

TestVariantEnumerator

Enumerates test variants.

TestVariantProvider

Provides enumerator for test variants.
Test execution context looks for annotations of the test function which support…

TestVariantResult

Results of a one test function run with some arguments.

ThreadClock

Base for the CPU time interval measurements.
Calculates a factor to scale wall time interval corresponds to measure…

TimeOutException

Exception which shows that time out has been reached.

TimeUnit

Specifies time unit.

TimeoutAnnotation

Indicates that if test function execution takes more than timeoutMilliseconds the test has to be interrupted.
The…

TotalBenchTime

Continues benchmark iterations while overall time accumulated by benchmark iterations doesn't exceed totalTime.
This…

TotalExecutionTime

Continues benchmark iterations while total execution time doesn't exceed timeLimit.
Execution time is overall time spent…

UpToFailureMessageRepeater

Runner which repeats up to the first failure message but no more then maxRepeats.
Reports the first failure message only

UpToFailureRepeater

Runner which repeats up to the first failed run but no more then maxRepeats.
Reports result from the latest run.

UpToSuccessRepeater

Runner which repeats up to the first successfull run but no more then maxRepeats.
Reports result from the latest run.

UserClock

User clock uses ThreadMXBean.currentThreadUserTime to measure time interval.
If thread CPU time is not supported…

ValueEquality

The matcher is useful to test classes which implements equals method.

Verifier

Verifies if element given by source matches to specified matcher.
Actually source is called when the verifier is e…

VerifyRule

Verifies if the stored value matches a given matcher when the statement is applied The initial value is evaluated before…

WallClock

Wall clock - uses system.nanoseconds to measure time interval.

Within

Verifies if matching value is within given range of lower to upper excluding bounds.

ZippedKind

Indicates that the test data has to be zipped.

applyStatement()

Indicates that the given test statements have to be applied to the annotated test function.
Each value declaration from

arguments()

Provides arguments for a one-shot functions. S

async()

The same as testExecutor(`class AsyncTestExecutor`).

benchmark()

Runs benchmark testing.
Executes each given bench with each given parameter.
Bench is responsible for the execution…

combinatorial()

Indicates the test has to be performed with combinatorial test variants.
See details in CombinatorialAnnotation.

concurrent()

Indicates that all test suites contained in the marked container have to be executed in concurrent mode.

dataSource()

Provides values for the marked test function argument. S

delegateWriter()

Delegates writing of the benchmark run results to the given writers.

factory()

Provides factory function for an object instantiation. S

mixing()

Returns CombinatorialAnnotation with mixingCombinations() combinator function. I

mixingCombinations()

Mixes zip and permutation sources. I

parameterized()

Provides parameters for the parameterized testing. S

permutationKind

Indicates that the test data has to be permuted.

permutationSource()

Provides permutationKind kind values for the marked test function argument.
See DataSourceAnnotation for details.
The…

permuting()

Returns CombinatorialAnnotation with permutingCombinations() combinator function. I

permutingCombinations()

Enumerates test variants by all possible combinations from provided arguments of ArgumentVariants[] which provides list…

pushToBlackHole()

Prevents JIT to eliminate dependent computations.

repeatOnce

Repeats just once and returns the given test variant result.

reportChartByLines()

Reports charts writing line by line:

retry()

Provides retry trategy for the tet function execution. S

runWith()

Provides test runner for the annotated test function. S

testRule()

Indicates that the annotated value or attribute identifies a test rule.
The value declaration has to satisfy SuiteRule,

timeout()

Indicates that if test function execution takes more than timeoutMilliseconds the test has to be interrupted.

writeAbsolute()

Writes absolute results of the benchmarking to the context in format:
bench.title with parameter: mean=mean value, dev=s…

writeRelativeToFastest()

Writes relative to the fastest results of the benchmarking to the context in format:
bench.title with parameter: mean=m…

writeRelativeToSlowest()

Writes relative to the slowest results of the benchmarking to the context in format:
bench.title with parameter: mean=m…

zippedKind

Indicates that the test data has to be zipped.

zippedSource()

Provides zippedKind kind values for the marked test function argument.
See DataSourceAnnotation for details.
The…

zipping()

Returns CombinatorialAnnotation with zippingCombinations() combinator function. I

zippingCombinations()

Enumerates test variants by zipping provided arguments of ArgumentVariants[] which provides list of variants for the…