org.junit.jupiter.api.RepetitionInfo Maven / Gradle / Ivy
Show all versions of junit-jupiter-api Show documentation
/*
* Copyright 2015-2024 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* https://www.eclipse.org/legal/epl-v20.html
*/
package org.junit.jupiter.api;
import static org.apiguardian.api.API.Status.EXPERIMENTAL;
import static org.apiguardian.api.API.Status.STABLE;
import org.apiguardian.api.API;
/**
* {@code RepetitionInfo} is used to inject information about the current
* repetition of a repeated test into {@code @RepeatedTest}, {@code @BeforeEach},
* and {@code @AfterEach} methods.
*
* If a method parameter is of type {@code RepetitionInfo}, JUnit will
* supply an instance of {@code RepetitionInfo} corresponding to the current
* repeated test as the value for the parameter.
*
*
WARNING: {@code RepetitionInfo} cannot be injected into
* a {@code @BeforeEach} or {@code @AfterEach} method if the corresponding test
* method is not a {@code @RepeatedTest}. Any attempt to do so will result in a
* {@link org.junit.jupiter.api.extension.ParameterResolutionException
* ParameterResolutionException}.
*
* @since 5.0
* @see RepeatedTest
* @see TestInfo
*/
@API(status = STABLE, since = "5.0")
public interface RepetitionInfo {
/**
* Get the current repetition of the corresponding
* {@link RepeatedTest @RepeatedTest} method.
*/
int getCurrentRepetition();
/**
* Get the total number of repetitions of the corresponding
* {@link RepeatedTest @RepeatedTest} method.
*
* @see RepeatedTest#value
*/
int getTotalRepetitions();
/**
* Get the current number of repetitions of the corresponding
* {@link RepeatedTest @RepeatedTest} method that have ended in a failure.
*
* @since 5.10
* @see #getFailureThreshold()
*/
@API(status = EXPERIMENTAL, since = "5.10")
int getFailureCount();
/**
* Get the configured failure threshold of the corresponding
* {@link RepeatedTest @RepeatedTest} method.
*
* @since 5.10
* @see RepeatedTest#failureThreshold()
*/
@API(status = EXPERIMENTAL, since = "5.10")
int getFailureThreshold();
}