junit-jupiter-params-generated/com.wesleyhome.test.jupiter.annotations.datetime/RandomInstantSource

RandomInstantSource

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

@SourceProvider(value = RandomInstanceSourceDataProvider::class)

annotation class RandomInstantSource(val min: String = "", val max: String = "", val useOffset: Boolean = false, val size: Int, val truncateTo: TruncateChronoUnit = TruncateChronoUnit.MINUTES)

This annotation is used to generate random java.time.Instants. The min and max values are used to determine the range of values to generate. If useOffset is true, the min and max values are treated as offsets from the current time. Otherwise, the min and max values are treated as java.time.Instants. The size parameter determines the number of random values to generate. The truncateTo parameter determines the truncation unit that the starting instant will be truncated to.

Samples

/**
 * This will generate 10 tests with random Instant values
 * between 2023-01-01T00:00:00.000Z and 2023-01-02T01:00:00.000Z
 */
@GeneratedParametersTest
fun testRandomInstantSourceWithInstant(
    @RandomInstantSource(
        size = 10,
        min = "2023-01-01T00:00:00.000Z",
        max = "2023-01-02T01:00:00.000Z"
    )
    value: Instant
) {
    assertThat(value).isLessThan(Instant.now())
}

@GeneratedParametersTest
fun testRandomInstantSourceWithOffset(
    @RandomInstantSource(
        size = 10,
        min = "PT1H",
        max = "PT2H",
        useOffset = true
    )
    value: Instant
) {
    assertThat(value).isBetween(
        Instant.now().plus(1, ChronoUnit.HOURS),
        Instant.now().plus(2, ChronoUnit.HOURS)
    )
}

Properties

max

val max: String

The maximum value that is used to generate random values. If useOffset is true, this value needs to be parsable to a java.time.Period Otherwise this value needs to be parseable to a java.time.Instant

min

val min: String

This minimum value that is used to generate random values. If useOffset is true, this value needs to be parsable to a java.time.Period Otherwise this value needs to be parseable to a java.time.Instant

size

val size: Int

The number of random values to generate

truncateTo

val truncateTo: TruncateChronoUnit

The truncation unit that the starting instant will be truncated to. This is only used if min is provided as an offset.

useOffset

val useOffset: Boolean = false

If true, the min and max values will be treated as offsets from the current time. If false, the min and max values will be treated as java.time.Instants.