NIFI-11528 Refactored TestFormatUtilsGroovy to Java Parameterized Test

This closes #7248

Signed-off-by: David Handermann <exceptionfactory@apache.org>
This commit is contained in:
dan-s1 2023-05-08 13:19:38 +00:00 committed by exceptionfactory
parent 5bbde66f14
commit 57f5b518f8
No known key found for this signature in database
GPG Key ID: 29B6A52D2AAE8DBA
2 changed files with 309 additions and 461 deletions

View File

@ -1,461 +0,0 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.nifi.util
import org.junit.jupiter.api.BeforeAll
import org.junit.jupiter.api.Test
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import java.util.concurrent.TimeUnit
import java.util.stream.IntStream
import static org.junit.jupiter.api.Assertions.assertEquals
import static org.junit.jupiter.api.Assertions.assertThrows
import static org.junit.jupiter.api.Assertions.assertTrue
class TestFormatUtilsGroovy {
private static final Logger logger = LoggerFactory.getLogger(TestFormatUtilsGroovy.class)
@BeforeAll
static void setUpOnce() throws Exception {
logger.metaClass.methodMissing = { String name, args ->
logger.info("[${name?.toUpperCase()}] ${(args as List).join(" ")}")
}
}
/**
* New feature test
*/
@Test
void testGetTimeDurationShouldConvertWeeks() {
// Arrange
final List WEEKS = ["1 week", "1 wk", "1 w", "1 wks", "1 weeks"]
final long EXPECTED_DAYS = 7L
// Act
List days = WEEKS.collect { String week ->
FormatUtils.getTimeDuration(week, TimeUnit.DAYS)
}
logger.converted(days)
// Assert
days.forEach(it -> assertEquals(EXPECTED_DAYS, it))
}
@Test
void testGetTimeDurationShouldHandleNegativeWeeks() {
// Arrange
final List WEEKS = ["-1 week", "-1 wk", "-1 w", "-1 weeks", "- 1 week"]
// Act
WEEKS.stream().forEach(week -> {
IllegalArgumentException iae =
assertThrows(IllegalArgumentException.class, () -> FormatUtils.getTimeDuration(week, TimeUnit.DAYS))
// Assert
assertTrue(iae.message.contains("Value '" + week + "' is not a valid time duration"))
})
}
/**
* Regression test
*/
@Test
void testGetTimeDurationShouldHandleInvalidAbbreviations() {
// Arrange
final List WEEKS = ["1 work", "1 wek", "1 k"]
// Act
WEEKS.stream().forEach(week -> {
IllegalArgumentException iae =
assertThrows(IllegalArgumentException.class, () -> FormatUtils.getTimeDuration(week, TimeUnit.DAYS))
// Assert
assertTrue(iae.message.contains("Value '" + week + "' is not a valid time duration"))
})
}
/**
* New feature test
*/
@Test
void testGetTimeDurationShouldHandleNoSpaceInInput() {
// Arrange
final List WEEKS = ["1week", "1wk", "1w", "1wks", "1weeks"]
final long EXPECTED_DAYS = 7L
// Act
List days = WEEKS.collect { String week ->
FormatUtils.getTimeDuration(week, TimeUnit.DAYS)
}
logger.converted(days)
// Assert
days.forEach(it -> assertEquals(EXPECTED_DAYS, it))
}
/**
* New feature test
*/
@Test
void testGetTimeDurationShouldHandleDecimalValues() {
// Arrange
final List WHOLE_NUMBERS = ["10 ms", "10 millis", "10 milliseconds"]
final List DECIMAL_NUMBERS = ["0.010 s", "0.010 seconds"]
final long EXPECTED_MILLIS = 10
// Act
List parsedWholeMillis = WHOLE_NUMBERS.collect { String whole ->
FormatUtils.getTimeDuration(whole, TimeUnit.MILLISECONDS)
}
logger.converted(parsedWholeMillis)
List parsedDecimalMillis = DECIMAL_NUMBERS.collect { String decimal ->
FormatUtils.getTimeDuration(decimal, TimeUnit.MILLISECONDS)
}
logger.converted(parsedDecimalMillis)
// Assert
parsedWholeMillis.forEach(it -> assertEquals(EXPECTED_MILLIS, it))
parsedDecimalMillis.forEach(it -> assertEquals(EXPECTED_MILLIS, it))
}
/**
* Regression test for custom week logic
*/
@Test
void testGetPreciseTimeDurationShouldHandleWeeks() {
// Arrange
final String ONE_WEEK = "1 week"
final Map ONE_WEEK_IN_OTHER_UNITS = [
(TimeUnit.DAYS) : 7,
(TimeUnit.HOURS) : 7 * 24,
(TimeUnit.MINUTES) : 7 * 24 * 60,
(TimeUnit.SECONDS) : (long) 7 * 24 * 60 * 60,
(TimeUnit.MILLISECONDS): (long) 7 * 24 * 60 * 60 * 1000,
(TimeUnit.MICROSECONDS): (long) 7 * 24 * 60 * 60 * ((long) 1000 * 1000),
(TimeUnit.NANOSECONDS) : (long) 7 * 24 * 60 * 60 * ((long) 1000 * 1000 * 1000),
]
// Act
Map oneWeekInOtherUnits = TimeUnit.values()[0..<-1].collectEntries { TimeUnit destinationUnit ->
[destinationUnit, FormatUtils.getPreciseTimeDuration(ONE_WEEK, destinationUnit)]
}
logger.converted(oneWeekInOtherUnits)
// Assert
oneWeekInOtherUnits.entrySet().forEach(entry ->
assertEquals(ONE_WEEK_IN_OTHER_UNITS.get(entry.getKey()), entry.getValue()))
}
/**
* Positive flow test for custom week logic with decimal value
*/
@Test
void testGetPreciseTimeDurationShouldHandleDecimalWeeks() {
// Arrange
final String ONE_AND_A_HALF_WEEKS = "1.5 week"
final Map ONE_POINT_FIVE_WEEKS_IN_OTHER_UNITS = [
(TimeUnit.DAYS) : 7,
(TimeUnit.HOURS) : 7 * 24,
(TimeUnit.MINUTES) : 7 * 24 * 60,
(TimeUnit.SECONDS) : (long) 7 * 24 * 60 * 60,
(TimeUnit.MILLISECONDS): (long) 7 * 24 * 60 * 60 * 1000,
(TimeUnit.MICROSECONDS): (long) 7 * 24 * 60 * 60 * ((long) 1000 * 1000),
(TimeUnit.NANOSECONDS) : (long) 7 * 24 * 60 * 60 * ((long) 1000 * 1000 * 1000),
].collectEntries { k, v -> [k, v * 1.5] }
// Act
Map onePointFiveWeeksInOtherUnits = TimeUnit.values()[0..<-1].collectEntries { TimeUnit destinationUnit ->
[destinationUnit, FormatUtils.getPreciseTimeDuration(ONE_AND_A_HALF_WEEKS, destinationUnit)]
}
logger.converted(onePointFiveWeeksInOtherUnits)
// Assert
onePointFiveWeeksInOtherUnits.entrySet().forEach(entry ->
assertEquals(ONE_POINT_FIVE_WEEKS_IN_OTHER_UNITS.get(entry.getKey()), entry.getValue()))
}
/**
* Positive flow test for decimal time inputs
*/
@Test
void testGetPreciseTimeDurationShouldHandleDecimalValues() {
// Arrange
final List WHOLE_NUMBERS = ["10 ms", "10 millis", "10 milliseconds"]
final List DECIMAL_NUMBERS = ["0.010 s", "0.010 seconds"]
final float EXPECTED_MILLIS = 10.0
// Act
List parsedWholeMillis = WHOLE_NUMBERS.collect { String whole ->
FormatUtils.getPreciseTimeDuration(whole, TimeUnit.MILLISECONDS)
}
logger.converted(parsedWholeMillis)
List parsedDecimalMillis = DECIMAL_NUMBERS.collect { String decimal ->
FormatUtils.getPreciseTimeDuration(decimal, TimeUnit.MILLISECONDS)
}
logger.converted(parsedDecimalMillis)
// Assert
parsedWholeMillis.forEach(it -> assertEquals(EXPECTED_MILLIS, it))
parsedDecimalMillis.forEach(it -> assertEquals(EXPECTED_MILLIS, it))
}
/**
* Positive flow test for decimal inputs that are extremely small
*/
@Test
void testGetPreciseTimeDurationShouldHandleSmallDecimalValues() {
// Arrange
final Map SCENARIOS = [
"decimalNanos" : [originalUnits: TimeUnit.NANOSECONDS, expectedUnits: TimeUnit.NANOSECONDS, originalValue: 123.4, expectedValue: 123.0],
"lessThanOneNano" : [originalUnits: TimeUnit.NANOSECONDS, expectedUnits: TimeUnit.NANOSECONDS, originalValue: 0.9, expectedValue: 1],
"lessThanOneNanoToMillis": [originalUnits: TimeUnit.NANOSECONDS, expectedUnits: TimeUnit.MILLISECONDS, originalValue: 0.9, expectedValue: 0],
"decimalMillisToNanos" : [originalUnits: TimeUnit.MILLISECONDS, expectedUnits: TimeUnit.NANOSECONDS, originalValue: 123.4, expectedValue: 123_400_000],
]
// Act
Map results = SCENARIOS.collectEntries { String k, Map values ->
logger.debug("Evaluating ${k}: ${values}")
String input = "${values.originalValue} ${values.originalUnits.name()}"
[k, FormatUtils.getPreciseTimeDuration(input, values.expectedUnits)]
}
logger.info(results)
// Assert
results.entrySet().forEach(entry ->
assertEquals(SCENARIOS.get(entry.getKey()).expectedValue, entry.getValue()))
}
/**
* Positive flow test for decimal inputs that can be converted (all equal values)
*/
@Test
void testMakeWholeNumberTimeShouldHandleDecimals() {
// Arrange
final List DECIMAL_TIMES = [
[0.000_000_010, TimeUnit.SECONDS],
[0.000_010, TimeUnit.MILLISECONDS],
[0.010, TimeUnit.MICROSECONDS]
]
final long EXPECTED_NANOS = 10L
// Act
List parsedWholeNanos = DECIMAL_TIMES.collect { List it ->
FormatUtils.makeWholeNumberTime(it[0] as float, it[1] as TimeUnit)
}
logger.converted(parsedWholeNanos)
// Assert
parsedWholeNanos.forEach(it ->
assertEquals(Arrays.asList(EXPECTED_NANOS, TimeUnit.NANOSECONDS), it))
}
/**
* Positive flow test for decimal inputs that can be converted (metric values)
*/
@Test
void testMakeWholeNumberTimeShouldHandleMetricConversions() {
// Arrange
final Map SCENARIOS = [
"secondsToMillis": [originalUnits: TimeUnit.SECONDS, expectedUnits: TimeUnit.MILLISECONDS, expectedValue: 123_400, originalValue: 123.4],
"secondsToMicros": [originalUnits: TimeUnit.SECONDS, expectedUnits: TimeUnit.MICROSECONDS, originalValue: 1.000_345, expectedValue: 1_000_345],
"millisToNanos" : [originalUnits: TimeUnit.MILLISECONDS, expectedUnits: TimeUnit.NANOSECONDS, originalValue: 0.75, expectedValue: 750_000],
"nanosToNanosGE1": [originalUnits: TimeUnit.NANOSECONDS, expectedUnits: TimeUnit.NANOSECONDS, originalValue: 123.4, expectedValue: 123],
"nanosToNanosLE1": [originalUnits: TimeUnit.NANOSECONDS, expectedUnits: TimeUnit.NANOSECONDS, originalValue: 0.123, expectedValue: 1],
]
// Act
Map results = SCENARIOS.collectEntries { String k, Map values ->
logger.debug("Evaluating ${k}: ${values}")
[k, FormatUtils.makeWholeNumberTime(values.originalValue, values.originalUnits)]
}
logger.info(results)
// Assert
results.every { String key, List values ->
assertEquals(SCENARIOS[key].expectedValue, values.first())
assertEquals(SCENARIOS[key].expectedUnits, values.last())
}
}
/**
* Positive flow test for decimal inputs that can be converted (non-metric values)
*/
@Test
void testMakeWholeNumberTimeShouldHandleNonMetricConversions() {
// Arrange
final Map SCENARIOS = [
"daysToHours" : [originalUnits: TimeUnit.DAYS, expectedUnits: TimeUnit.HOURS, expectedValue: 36, originalValue: 1.5],
"hoursToMinutes" : [originalUnits: TimeUnit.HOURS, expectedUnits: TimeUnit.MINUTES, originalValue: 1.5, expectedValue: 90],
"hoursToMinutes2": [originalUnits: TimeUnit.HOURS, expectedUnits: TimeUnit.MINUTES, originalValue: 0.75, expectedValue: 45],
]
// Act
Map results = SCENARIOS.collectEntries { String k, Map values ->
logger.debug("Evaluating ${k}: ${values}")
[k, FormatUtils.makeWholeNumberTime(values.originalValue, values.originalUnits)]
}
logger.info(results)
// Assert
results.entrySet().forEach(entry -> {
assertEquals(SCENARIOS.get(entry.getKey()).expectedValue, entry.getValue().get(0))
assertEquals(SCENARIOS.get(entry.getKey()).expectedUnits, entry.getValue().get(1))
})
}
/**
* Positive flow test for whole inputs
*/
@Test
void testMakeWholeNumberTimeShouldHandleWholeNumbers() {
// Arrange
final List WHOLE_TIMES = [
[10.0, TimeUnit.DAYS],
[10.0, TimeUnit.HOURS],
[10.0, TimeUnit.MINUTES],
[10.0, TimeUnit.SECONDS],
[10.0, TimeUnit.MILLISECONDS],
[10.0, TimeUnit.MICROSECONDS],
[10.0, TimeUnit.NANOSECONDS],
]
// Act
List<List<Object>> parsedWholeTimes = WHOLE_TIMES.collect { List it ->
FormatUtils.makeWholeNumberTime(it[0] as float, it[1] as TimeUnit)
}
logger.converted(parsedWholeTimes)
// Assert
IntStream.range(0, parsedWholeTimes.size())
.forEach(index -> {
List<Object> elements = parsedWholeTimes.get(index)
assertEquals(10L, elements.get(0))
assertEquals(WHOLE_TIMES[index][1], elements.get(1))
})
}
/**
* Negative flow test for nanosecond inputs (regardless of value, the unit cannot be converted)
*/
@Test
void testMakeWholeNumberTimeShouldHandleNanoseconds() {
// Arrange
final List WHOLE_TIMES = [
[1100.0, TimeUnit.NANOSECONDS],
[2.1, TimeUnit.NANOSECONDS],
[1.0, TimeUnit.NANOSECONDS],
[0.1, TimeUnit.NANOSECONDS],
]
final List EXPECTED_TIMES = [
[1100L, TimeUnit.NANOSECONDS],
[2L, TimeUnit.NANOSECONDS],
[1L, TimeUnit.NANOSECONDS],
[1L, TimeUnit.NANOSECONDS],
]
// Act
List parsedWholeTimes = WHOLE_TIMES.collect { List it ->
FormatUtils.makeWholeNumberTime(it[0] as float, it[1] as TimeUnit)
}
logger.converted(parsedWholeTimes)
// Assert
assertEquals(EXPECTED_TIMES, parsedWholeTimes)
}
/**
* Positive flow test for whole inputs
*/
@Test
void testShouldGetSmallerTimeUnit() {
// Arrange
final List UNITS = TimeUnit.values() as List
// Act
IllegalArgumentException nullIae = assertThrows(IllegalArgumentException.class,
() -> FormatUtils.getSmallerTimeUnit(null))
IllegalArgumentException nanoIae = assertThrows(IllegalArgumentException.class,
() -> FormatUtils.getSmallerTimeUnit(TimeUnit.NANOSECONDS))
List smallerTimeUnits = UNITS[1..-1].collect { TimeUnit unit ->
FormatUtils.getSmallerTimeUnit(unit)
}
logger.converted(smallerTimeUnits)
// Assert
assertEquals("Cannot determine a smaller time unit than 'null'", nullIae.getMessage())
assertEquals("Cannot determine a smaller time unit than 'NANOSECONDS'", nanoIae.getMessage())
assertEquals(smallerTimeUnits, UNITS.subList(0, UNITS.size() - 1))
}
/**
* Positive flow test for multipliers based on valid time units
*/
@Test
void testShouldCalculateMultiplier() {
// Arrange
final Map SCENARIOS = [
"allUnits" : [original: TimeUnit.DAYS, destination: TimeUnit.NANOSECONDS, expectedMultiplier: (long) 24 * 60 * 60 * (long) 1_000_000_000],
"microsToNanos" : [original: TimeUnit.MICROSECONDS, destination: TimeUnit.NANOSECONDS, expectedMultiplier: 1_000],
"millisToNanos" : [original: TimeUnit.MILLISECONDS, destination: TimeUnit.NANOSECONDS, expectedMultiplier: 1_000_000],
"millisToMicros": [original: TimeUnit.MILLISECONDS, destination: TimeUnit.MICROSECONDS, expectedMultiplier: 1_000],
"daysToHours" : [original: TimeUnit.DAYS, destination: TimeUnit.HOURS, expectedMultiplier: 24],
"daysToSeconds" : [original: TimeUnit.DAYS, destination: TimeUnit.SECONDS, expectedMultiplier: 24 * 60 * 60],
]
// Act
Map results = SCENARIOS.collectEntries { String k, Map values ->
logger.debug("Evaluating ${k}: ${values}")
[k, FormatUtils.calculateMultiplier(values.original, values.destination)]
}
logger.converted(results)
// Assert
results.entrySet().forEach(entry ->
assertEquals(SCENARIOS.get(entry.getKey()).expectedMultiplier, entry.getValue()))
}
/**
* Negative flow test for multipliers based on incorrectly-ordered time units
*/
@Test
void testCalculateMultiplierShouldHandleIncorrectUnits() {
// Arrange
final Map<String, Map<String, TimeUnit>> SCENARIOS = [
"allUnits" : [original: TimeUnit.NANOSECONDS, destination: TimeUnit.DAYS],
"nanosToMicros": [original: TimeUnit.NANOSECONDS, destination: TimeUnit.MICROSECONDS],
"hoursToDays" : [original: TimeUnit.HOURS, destination: TimeUnit.DAYS],
]
// Act
SCENARIOS.entrySet().stream()
.forEach(entry -> {
// Assert
IllegalArgumentException iae = assertThrows(IllegalArgumentException.class,
() -> FormatUtils.calculateMultiplier(entry.getValue().get("original"),
entry.getValue().get("destination")))
assertTrue((iae.getMessage() =~ "The original time unit '.*' must be larger than the new time unit '.*'").find())
})
}
// TODO: Microsecond parsing
}

View File

@ -0,0 +1,309 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.nifi.util;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.EnumSource;
import org.junit.jupiter.params.provider.MethodSource;
import org.junit.jupiter.params.provider.NullSource;
import org.junit.jupiter.params.provider.ValueSource;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
import java.util.stream.Stream;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
public class TestFormatUtils {
@SuppressWarnings("deprecation")
@ParameterizedTest
@ValueSource(strings = {"1 week", "1 wk", "1 w", "1 wks", "1 weeks"})
public void testGetTimeDurationShouldConvertWeeks(String week) {
assertEquals(7L, FormatUtils.getTimeDuration(week, TimeUnit.DAYS));
}
@SuppressWarnings("deprecation")
@ParameterizedTest
@ValueSource(strings = {"-1 week", "-1 wk", "-1 w", "-1 weeks", "- 1 week"})
public void testGetTimeDurationShouldHandleNegativeWeeks(String week) {
IllegalArgumentException iae =
assertThrows(IllegalArgumentException.class, () -> FormatUtils.getTimeDuration(week, TimeUnit.DAYS));
assertTrue(iae.getMessage().contains("Value '" + week + "' is not a valid time duration"));
}
/**
* Regression test
*/
@SuppressWarnings("deprecation")
@ParameterizedTest
@ValueSource(strings = {"1 work", "1 wek", "1 k"})
public void testGetTimeDurationShouldHandleInvalidAbbreviations(String week) {
IllegalArgumentException iae =
assertThrows(IllegalArgumentException.class, () -> FormatUtils.getTimeDuration(week, TimeUnit.DAYS));
assertTrue(iae.getMessage().contains("Value '" + week + "' is not a valid time duration"));
}
/**
* New feature test
*/
@SuppressWarnings("deprecation")
@ParameterizedTest
@ValueSource(strings={"1week", "1wk", "1w", "1wks", "1weeks"})
public void testGetTimeDurationShouldHandleNoSpaceInInput(String week) {
assertEquals(7L, FormatUtils.getTimeDuration(week, TimeUnit.DAYS));
}
/**
* New feature test
*/
@SuppressWarnings("deprecation")
@ParameterizedTest
@ValueSource(strings={"10 ms", "10 millis", "10 milliseconds"})
public void testGetTimeDurationWithWholeNumbers(String whole){
assertEquals(10L, FormatUtils.getTimeDuration(whole, TimeUnit.MILLISECONDS));
}
/**
* New feature test
*/
@SuppressWarnings("deprecation")
@ParameterizedTest
@ValueSource(strings={"0.010 s", "0.010 seconds"})
public void testGetTimeDurationWithDecimalNumbers(String decimal){
assertEquals(10L, FormatUtils.getTimeDuration(decimal, TimeUnit.MILLISECONDS));
}
/**
* Regression test for custom week logic
*/
@ParameterizedTest
@MethodSource("getOneWeekInOtherUnits")
public void testGetPreciseTimeDurationShouldHandleWeeks(TimeUnit timeUnit, long expected){
assertEquals(expected, FormatUtils.getPreciseTimeDuration("1 week", timeUnit));
}
private static Stream<Arguments> getOneWeekInOtherUnits() {
return Stream.of(Arguments.of(TimeUnit.DAYS, 7L),
Arguments.of(TimeUnit.HOURS, 7 * 24L),
Arguments.of(TimeUnit.MINUTES, 7 * 24 * 60L),
Arguments.of(TimeUnit.SECONDS, 7 * 24 * 60 * 60L),
Arguments.of(TimeUnit.MILLISECONDS, 7 * 24 * 60 * 60 * 1000L),
Arguments.of(TimeUnit.MICROSECONDS, 7 * 24 * 60 * 60 * 1000 * 1000L),
Arguments.of(TimeUnit.NANOSECONDS, 7 * 24 * 60 * 60 * (1000 * 1000 * 1000L))
);
}
/**
* Positive flow test for custom week logic with decimal value
*/
@ParameterizedTest
@MethodSource("getOneAndAHalfWeeksInOtherUnits")
public void testGetPreciseTimeDurationShouldHandleDecimalWeeks(TimeUnit timeUnit, double expected) {
assertEquals(expected, FormatUtils.getPreciseTimeDuration("1.5 week", timeUnit));
}
private static Stream<Arguments> getOneAndAHalfWeeksInOtherUnits() {
final double oneAndAHalf = 1.5;
return Stream.of(Arguments.of(TimeUnit.HOURS, 7 * 24 * oneAndAHalf),
Arguments.of(TimeUnit.MINUTES, 7 * 24 * 60 * oneAndAHalf),
Arguments.of(TimeUnit.SECONDS, 7 * 24 * 60 * 60 * oneAndAHalf),
Arguments.of(TimeUnit.MILLISECONDS, 7 * 24 * 60 * 60 * 1000 * oneAndAHalf),
Arguments.of(TimeUnit.MICROSECONDS, 7 * 24 * 60 * 60 * (1000 * 1000L) * oneAndAHalf),
Arguments.of(TimeUnit.NANOSECONDS, 7 * 24 * 60 * 60 * (1000 * 1000 * 1000L) * oneAndAHalf));
}
@ParameterizedTest
@ValueSource(strings={"10 ms", "10 millis", "10 milliseconds"})
public void testGetPreciseTimeDurationWithWholeNumbers(String whole) {
assertEquals(10.0, FormatUtils.getPreciseTimeDuration(whole, TimeUnit.MILLISECONDS));
}
/**
* Positive flow test for decimal time inputs
*/
@ParameterizedTest
@ValueSource(strings={"0.010 s", "0.010 seconds"})
public void testGetPreciseTimeDurationWithDecimalNumbers(String decimal) {
assertEquals(10.0, FormatUtils.getPreciseTimeDuration(decimal, TimeUnit.MILLISECONDS));
}
/**
* Positive flow test for decimal inputs that are extremely small
*/
@ParameterizedTest
@MethodSource("getTinyDecimalValues")
public void testGetPreciseTimeDurationShouldHandleSmallDecimalValues(String originalValue, TimeUnit desiredUnit, double expectedValue) {
assertEquals(expectedValue, FormatUtils.getPreciseTimeDuration(originalValue, desiredUnit));
}
private static Stream<Arguments> getTinyDecimalValues() {
return Stream.of(Arguments.of("123.4 " + TimeUnit.NANOSECONDS.name(), TimeUnit.NANOSECONDS, 123.0),
Arguments.of("0.9 " + TimeUnit.NANOSECONDS.name(), TimeUnit.NANOSECONDS, 1.0),
Arguments.of("0.9 " + TimeUnit.NANOSECONDS.name(), TimeUnit.MILLISECONDS, 0.0),
Arguments.of("123.4 " + TimeUnit.MILLISECONDS.name(), TimeUnit.NANOSECONDS, 123_400_000.0));
}
/**
* Positive flow test for decimal inputs that can be converted (all equal values),
*/
@ParameterizedTest
@MethodSource("getDecimalsForMakeWholeNumber")
public void testMakeWholeNumberTimeShouldHandleDecimals(double decimal, TimeUnit timeUnit) {
assertEquals(Arrays.asList(10L, TimeUnit.NANOSECONDS), FormatUtils.makeWholeNumberTime(decimal, timeUnit));
}
private static Stream<Arguments> getDecimalsForMakeWholeNumber() {
return Stream.of(Arguments.of(0.000_000_010, TimeUnit.SECONDS),
Arguments.of(0.000_010, TimeUnit.MILLISECONDS),
Arguments.of(0.010, TimeUnit.MICROSECONDS)
);
}
/**
* Positive flow test for decimal inputs that can be converted (metric values)
*/
@ParameterizedTest
@MethodSource("getDecimalsForMetricConversions")
public void testMakeWholeNumberTimeShouldHandleMetricConversions(double originalValue, TimeUnit originalUnits, long expectedValue, TimeUnit expectedUnits) {
assertEquals(Arrays.asList(expectedValue, expectedUnits),
FormatUtils.makeWholeNumberTime(originalValue, originalUnits));
}
private static Stream<Arguments> getDecimalsForMetricConversions() {
return Stream.of(Arguments.of(123.4, TimeUnit.SECONDS, 123_400L, TimeUnit.MILLISECONDS),
Arguments.of(1.000_345, TimeUnit.SECONDS, 1_000_345L, TimeUnit.MICROSECONDS),
Arguments.of(0.75, TimeUnit.MILLISECONDS, 750L, TimeUnit.MICROSECONDS),
Arguments.of(123.4, TimeUnit.NANOSECONDS, 123L, TimeUnit.NANOSECONDS),
Arguments.of(0.123, TimeUnit.NANOSECONDS, 1L, TimeUnit.NANOSECONDS));
}
/**
* Positive flow test for decimal inputs that can be converted (non-metric values)
*/
@ParameterizedTest
@MethodSource("getDecimalsForNonMetricConversions")
public void testMakeWholeNumberTimeShouldHandleNonMetricConversions(double originalValue, TimeUnit originalUnits, long expectedValue, TimeUnit expectedUnits) {
assertEquals(Arrays.asList(expectedValue, expectedUnits),
FormatUtils.makeWholeNumberTime(originalValue, originalUnits));
}
private static Stream<Arguments> getDecimalsForNonMetricConversions() {
return Stream.of(Arguments.of(1.5, TimeUnit.DAYS, 36L, TimeUnit.HOURS),
Arguments.of(1.5, TimeUnit.HOURS, 90L, TimeUnit.MINUTES),
Arguments.of(.75, TimeUnit.HOURS, 45L, TimeUnit.MINUTES));
}
/**
* Positive flow test for whole inputs
*/
@ParameterizedTest
@EnumSource(TimeUnit.class)
public void testMakeWholeNumberTimeShouldHandleWholeNumbers(TimeUnit timeUnit) {
assertEquals(Arrays.asList(10L, timeUnit), FormatUtils.makeWholeNumberTime(10.0, timeUnit));
}
/**
* Negative flow test for nanosecond inputs (regardless of value, the unit cannot be converted)
*/
@ParameterizedTest
@MethodSource("getNanoSecondsForMakeWholeNumber")
public void testMakeWholeNumberTimeShouldHandleNanoseconds(double original, long expected) {
assertEquals(Arrays.asList(expected, TimeUnit.NANOSECONDS),
FormatUtils.makeWholeNumberTime(original, TimeUnit.NANOSECONDS));
}
private static Stream<Arguments> getNanoSecondsForMakeWholeNumber() {
return Stream.of(Arguments.of(1100.0, 1100L),
Arguments.of(2.1, 2L),
Arguments.of(1.0, 1L),
Arguments.of(0.1, 1L));
}
@ParameterizedTest
@NullSource
public void testGetSmallerTimeUnitWithNull(TimeUnit timeUnit) {
IllegalArgumentException iae = assertThrows(IllegalArgumentException.class,
() -> FormatUtils.getSmallerTimeUnit(timeUnit));
assertEquals("Cannot determine a smaller time unit than 'null'", iae.getMessage());
}
@Test
public void testGetSmallerTimeUnitWithNanoseconds() {
IllegalArgumentException iae = assertThrows(IllegalArgumentException.class,
() -> FormatUtils.getSmallerTimeUnit(TimeUnit.NANOSECONDS));
assertEquals("Cannot determine a smaller time unit than 'NANOSECONDS'", iae.getMessage());
}
/**
* Positive flow test for whole inputs
*/
@ParameterizedTest
@MethodSource("getSmallerUnits")
public void testShouldGetSmallerTimeUnit(TimeUnit original, TimeUnit expected) {
assertEquals(expected, FormatUtils.getSmallerTimeUnit(original));
}
private static Stream<Arguments> getSmallerUnits() {
return Stream.of(Arguments.of(TimeUnit.MICROSECONDS, TimeUnit.NANOSECONDS),
Arguments.of(TimeUnit.MILLISECONDS, TimeUnit.MICROSECONDS),
Arguments.of(TimeUnit.SECONDS, TimeUnit.MILLISECONDS),
Arguments.of(TimeUnit.MINUTES, TimeUnit.SECONDS),
Arguments.of(TimeUnit.HOURS, TimeUnit.MINUTES),
Arguments.of(TimeUnit.DAYS, TimeUnit.HOURS));
}
/**
* Positive flow test for multipliers based on valid time units
*/
@ParameterizedTest
@MethodSource("getMultipliers")
void testShouldCalculateMultiplier(TimeUnit original, TimeUnit newTimeUnit, long expected) {
assertEquals(expected, FormatUtils.calculateMultiplier(original, newTimeUnit));
}
private static Stream<Arguments> getMultipliers() {
return Stream.of(Arguments.of(TimeUnit.DAYS, TimeUnit.NANOSECONDS, 24 * 60 * 60 * 1_000_000_000L),
Arguments.of(TimeUnit.MICROSECONDS, TimeUnit.NANOSECONDS, 1_000L),
Arguments.of(TimeUnit.MILLISECONDS, TimeUnit.NANOSECONDS, 1_000_000L),
Arguments.of(TimeUnit.MILLISECONDS, TimeUnit.MICROSECONDS, 1_000L),
Arguments.of(TimeUnit.DAYS, TimeUnit.HOURS, 24L),
Arguments.of(TimeUnit.DAYS, TimeUnit.SECONDS, 24 * 60 * 60L));
}
/**
* Negative flow test for multipliers based on incorrectly-ordered time units
*/
@ParameterizedTest
@MethodSource("getIncorrectUnits")
public void testCalculateMultiplierShouldHandleIncorrectUnits(TimeUnit original, TimeUnit newTimeUnit) {
IllegalArgumentException iae = assertThrows(IllegalArgumentException.class,
() -> FormatUtils.calculateMultiplier(original, newTimeUnit));
assertTrue(iae.getMessage().matches("The original time unit '.*' must be larger than the new time unit '.*'"));
}
private static Stream<Arguments> getIncorrectUnits() {
return Stream.of(Arguments.of(TimeUnit.NANOSECONDS, TimeUnit.DAYS),
Arguments.of(TimeUnit.NANOSECONDS, TimeUnit.MICROSECONDS),
Arguments.of(TimeUnit.HOURS, TimeUnit.DAYS));
}
}