com.fillumina.performance.consumer.assertion.AssertPerformance Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of performance-tools Show documentation

Configurable tool to easily compare performances of different code snippets and to take performance telemetry of a running application.

The newest version!

package com.fillumina.performance.consumer.assertion;

import com.fillumina.performance.consumer.PerformanceConsumer;
import com.fillumina.performance.producer.LoopPerformances;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * Asserts specific conditions over the performance it consumes.
 *
 * @author Francesco Illuminati
 */
public class AssertPerformance
        implements PerformanceConsumer, Serializable, PerformanceAssertion {
    private static final long serialVersionUID = 1L;

    private final List tests = new ArrayList<>();
    private float tolerancePercentage = SAFE_TOLERANCE;

    public static AssertPerformance withTolerance(final float tolerance) {
        return new AssertPerformance().withPercentageTolerance(tolerance);
    }

    /**
     * Asserts that a test is faster, slower or equals of a given target
     * percentage.
     *      * assertion.assertPercentageFor("some test").lessThan(35);
     * 
     */
    @Override
    public AssertPercentage assertPercentageFor(final String name) {
        return new AssertPercentage(this, name);
    }

    /**
     * Asserts the relative order (faster, same, slower) of a test in
     * respect to the others.
     *      * assertion.assertTest("some test").fasterThan("other test);
     * 
     */
    @Override
    public AssertOrder assertTest(final String name) {
        return new AssertOrder(this, name);
    }

    /**
     * This method is basically used by {@link AssertOrder} and
     * {@link AssertPercentage} to register their conditions but may be
     * used by clients to specify customized conditions as well.
     *
     * @param condition A consumer that should implement a condition to check.
     * @return          {@code this} to allow for
     *                  
     *                  fluent interface.
     */
    public AssertPerformance addCondition(final PerformanceConsumer condition) {
        tests.add(condition);
        return this;
    }

    /** Checks the given performances against the registered conditions. */
    @Override
    public void check(final LoopPerformances loopPerformances) {
        consume(null, loopPerformances);
    }

    /** Checks the given performances against the registered conditions. */
    @Override
    public void consume(final String message,
            final LoopPerformances loopPerformances) {
        for (final PerformanceConsumer performanceConsumer: tests) {
            performanceConsumer.consume(message, loopPerformances);
        }
    }

    /**
     * Set the test tolerance. A tolerance is given as a percentage so that
     * a tolerance of 5 means that if the required performance is 20 and the
     * measured one is 25 than it's ok, but if the measured one is 26 or 19 than
     * the test fails.
     */
    @Override
    public AssertPerformance withPercentageTolerance(
            final float tolerancePercentage) {
        this.tolerancePercentage = tolerancePercentage;
        return this;
    }

    public float getTolerancePercentage() {
        return tolerancePercentage;
    }
}