SyncIterNotOnlyMeasurementTest.java

/*
 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.openjdk.jmh.it.synciter;

import org.junit.Assert;
import org.junit.Test;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.Fork;
import org.openjdk.jmh.annotations.Level;
import org.openjdk.jmh.annotations.Measurement;
import org.openjdk.jmh.annotations.Scope;
import org.openjdk.jmh.annotations.Setup;
import org.openjdk.jmh.annotations.State;
import org.openjdk.jmh.annotations.TearDown;
import org.openjdk.jmh.annotations.Threads;
import org.openjdk.jmh.annotations.Warmup;
import org.openjdk.jmh.it.Fixtures;
import org.openjdk.jmh.runner.Runner;
import org.openjdk.jmh.runner.RunnerException;
import org.openjdk.jmh.runner.options.Options;
import org.openjdk.jmh.runner.options.OptionsBuilder;

import java.util.concurrent.TimeUnit;

@State(Scope.Benchmark)
public class SyncIterNotOnlyMeasurementTest {

    private boolean inMeasurementLoopOnly;

    @Setup(Level.Trial)
    public void setup() {
        inMeasurementLoopOnly = true;
    }

    @TearDown(Level.Trial)
    public void check() {
        Assert.assertFalse(inMeasurementLoopOnly);
    }

    @Benchmark
    @Warmup(iterations = 0)
    @Measurement(iterations = 2, time = 100, timeUnit = TimeUnit.MILLISECONDS)
    @Fork(1)
    @Threads(2)
    public void test() {
        inMeasurementLoopOnly &= isInMeasurementLoop();
        Fixtures.work();
    }

    private boolean isInMeasurementLoop() {
        boolean inMeasurementLoop = false;
        for (StackTraceElement element : new Exception().getStackTrace()) {
            inMeasurementLoop |= element.getMethodName().contains("jmhStub");
        }
        return inMeasurementLoop;
    }

    @Test
    public void invokeAPI() throws RunnerException {
        // This test is probabilistic, and it can fail sometimes, but not all the time.

        Options opt = new OptionsBuilder()
                .include(Fixtures.getTestMask(this.getClass()))
                .shouldFailOnError(true)
                .syncIterations(true)
                .build();

        final int trials = 200;

        RunnerException last = null;
        for (int c = 0; c < trials; c++) {
            try {
                new Runner(opt).run();

                // no assert, yay, we can break away now
                return;
            } catch (RunnerException e) {
                last = e;
            }
        }

        // we consistently throw exceptions, re-throw the last one
        throw last;
    }

}