undefect. CWE-407 — 63 sites patched across 27 ecosystems

Authors: russell@unturf.com · brackishbert@gmail.com · foxhop.net · TimeHexOn.com

Patches, unit tests, benchmarks, whitepaper, and outreach briefs.
Public domain — no copyright claimed. Use freely.
This commit is contained in:
russell@unturf.com 2026-03-26 17:11:57 -04:00
commit 0a580b313d
70422 changed files with 17213626 additions and 0 deletions

View file

@ -0,0 +1,309 @@
/*
* Copyright (c) 2009, 2022, 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.
*
* 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.
*/
/*
* @test
* @bug 6797535 6889858 6891113 8013712 8011800 8014365 8280168
* @summary Basic tests for methods in java.util.Objects
*/
import java.util.*;
import java.util.function.*;
public class BasicObjectsTest {
public static void main(String... args) {
int errors = 0;
errors += testEquals();
errors += testDeepEquals();
errors += testHashCode();
errors += testHash();
errors += testToString();
errors += testToString2();
errors += testToIdentityString();
errors += testCompare();
errors += testRequireNonNull();
errors += testIsNull();
errors += testNonNull();
errors += testNonNullOf();
if (errors > 0 )
throw new RuntimeException();
}
private static int testEquals() {
int errors = 0;
Object[] values = {null, "42", 42};
for(int i = 0; i < values.length; i++)
for(int j = 0; j < values.length; j++) {
boolean expected = (i == j);
Object a = values[i];
Object b = values[j];
boolean result = Objects.equals(a, b);
if (result != expected) {
errors++;
System.err.printf("When equating %s to %s, got %b instead of %b%n.",
a, b, result, expected);
}
}
return errors;
}
private static int testDeepEquals() {
int errors = 0;
Object[] values = {null,
null, // Change to values later
new byte[] {(byte)1},
new short[] {(short)1},
new int[] {1},
new long[] {1L},
new char[] {(char)1},
new float[] {1.0f},
new double[]{1.0d},
new String[]{"one"}};
values[1] = values;
for(int i = 0; i < values.length; i++)
for(int j = 0; j < values.length; j++) {
boolean expected = (i == j);
Object a = values[i];
Object b = values[j];
boolean result = Objects.deepEquals(a, b);
if (result != expected) {
errors++;
System.err.printf("When equating %s to %s, got %b instead of %b%n.",
a, b, result, expected);
}
}
return errors;
}
private static int testHashCode() {
int errors = 0;
errors += (Objects.hashCode(null) == 0 ) ? 0 : 1;
String s = "42";
errors += (Objects.hashCode(s) == s.hashCode() ) ? 0 : 1;
return errors;
}
private static int testHash() {
int errors = 0;
Object[] data = new String[]{"perfect", "ham", "THC"};
errors += ((Objects.hash((Object[])null) == 0) ? 0 : 1);
errors += (Objects.hash("perfect", "ham", "THC") ==
Arrays.hashCode(data)) ? 0 : 1;
return errors;
}
private static int testToString() {
int errors = 0;
errors += ("null".equals(Objects.toString(null)) ) ? 0 : 1;
String s = "Some string";
errors += (s.equals(Objects.toString(s)) ) ? 0 : 1;
return errors;
}
private static int testToString2() {
int errors = 0;
String s = "not the default";
errors += (s.equals(Objects.toString(null, s)) ) ? 0 : 1;
errors += (s.equals(Objects.toString(s, "another string")) ) ? 0 : 1;
return errors;
}
private static int testToIdentityString() {
int errors = 0;
// Test null behavior
try {
Objects.toIdentityString(null);
errors++;
} catch (NullPointerException npe) {
; // Expected
}
// Behavior on typical objects
Object o = new Object(){};
errors += (Objects.toIdentityString(o).equals(o.toString()))? 0 : 1;
// Verify object's toString *not* called
Object badToString = new Object() {
@Override
public String toString() {
throw new RuntimeException();
}
};
Objects.toIdentityString(badToString);
// Verify object's hashCode *not* called
Object badHashCode = new Object() {
@Override
public int hashCode() {
throw new RuntimeException("0xDEADBEFF");
}
};
Objects.toIdentityString(badHashCode);
return errors;
}
private static int testCompare() {
int errors = 0;
String[] values = {"e. e. cummings", "zzz"};
String[] VALUES = {"E. E. Cummings", "ZZZ"};
errors += compareTest(null, null, 0);
for(int i = 0; i < values.length; i++) {
String a = values[i];
errors += compareTest(a, a, 0);
for(int j = 0; j < VALUES.length; j++) {
int expected = Integer.compare(i, j);
String b = VALUES[j];
errors += compareTest(a, b, expected);
}
}
return errors;
}
private static int compareTest(String a, String b, int expected) {
int errors = 0;
int result = Objects.compare(a, b, String.CASE_INSENSITIVE_ORDER);
if (Integer.signum(result) != Integer.signum(expected)) {
errors++;
System.err.printf("When comparing %s to %s, got %d instead of %d%n.",
a, b, result, expected);
}
return errors;
}
private static int testRequireNonNull() {
int errors = 0;
final String RNN_1 = "1-arg requireNonNull";
final String RNN_2 = "2-arg requireNonNull";
final String RNN_3 = "Supplier requireNonNull";
Function<String, String> rnn1 = s -> Objects.requireNonNull(s);
Function<String, String> rnn2 = s -> Objects.requireNonNull(s, "trousers");
Function<String, String> rnn3 = s -> Objects.requireNonNull(s, () -> "trousers");
errors += testRNN_NonNull(rnn1, RNN_1);
errors += testRNN_NonNull(rnn2, RNN_2);
errors += testRNN_NonNull(rnn3, RNN_3);
errors += testRNN_Null(rnn1, RNN_1, null);
errors += testRNN_Null(rnn2, RNN_2, "trousers");
errors += testRNN_Null(rnn3, RNN_3, "trousers");
return errors;
}
private static int testRNN_NonNull(Function<String, String> testFunc,
String testFuncName) {
int errors = 0;
try {
String s = testFunc.apply("pants");
if (s != "pants") {
System.err.printf(testFuncName + " failed to return its arg");
errors++;
}
} catch (NullPointerException e) {
System.err.printf(testFuncName + " threw unexpected NPE");
errors++;
}
return errors;
}
private static int testRNN_Null(Function<String, String> testFunc,
String testFuncName,
String expectedMessage) {
int errors = 0;
try {
String s = testFunc.apply(null);
System.err.printf(testFuncName + " failed to throw NPE");
errors++;
} catch (NullPointerException e) {
if (e.getMessage() != expectedMessage) {
System.err.printf(testFuncName + " threw NPE w/ bad detail msg");
errors++;
}
}
return errors;
}
private static int testIsNull() {
int errors = 0;
errors += Objects.isNull(null) ? 0 : 1;
errors += Objects.isNull(Objects.class) ? 1 : 0;
return errors;
}
private static int testNonNull() {
int errors = 0;
errors += Objects.nonNull(null) ? 1 : 0;
errors += Objects.nonNull(Objects.class) ? 0 : 1;
return errors;
}
private static int testNonNullOf() {
int errors = 0;
String defString = new String("default");
String nullString = null;
String nonNullString = "non-null";
// Confirm the compile time return type matches
String result = Objects.requireNonNullElse(nullString, defString);
errors += (result == defString) ? 0 : 1;
errors += (Objects.requireNonNullElse(nonNullString, defString) == nonNullString) ? 0 : 1;
errors += (Objects.requireNonNullElse(nonNullString, null) == nonNullString) ? 0 : 1;
try {
Objects.requireNonNullElse(null, null);
errors += 1;
} catch (NullPointerException npe) {
// expected
errors += npe.getMessage().equals("defaultObj") ? 0 : 1;
}
// Test requireNonNullElseGet with a supplier
errors += (Objects.requireNonNullElseGet(nullString, () -> defString) == defString) ? 0 : 1;
errors += (Objects.requireNonNullElseGet(nonNullString, () -> defString) == nonNullString) ? 0 : 1;
errors += (Objects.requireNonNullElseGet(nonNullString, () -> null) == nonNullString) ? 0 : 1;
try {
Objects.requireNonNullElseGet(null, () -> null);
errors += 1;
} catch (NullPointerException npe) {
// expected
errors += npe.getMessage().equals("supplier.get()") ? 0 : 1;
}
try { // supplier is null
Objects.requireNonNullElseGet(null, null);
errors += 1;
} catch (NullPointerException npe) {
// expected
errors += npe.getMessage().equals("supplier") ? 0 : 1;
}
return errors;
}
}

View file

@ -0,0 +1,293 @@
/*
* Copyright (c) 2015, 2020, 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.
*
* 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.
*/
/**
* @test
* @summary Objects.checkIndex/jdk.internal.util.Preconditions.checkIndex tests for int values
* @run testng CheckIndex
* @bug 8135248 8142493 8155794
* @modules java.base/jdk.internal.util
*/
import jdk.internal.util.Preconditions;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.IntSupplier;
import static org.testng.Assert.*;
public class CheckIndex {
static class AssertingOutOfBoundsException extends RuntimeException {
public AssertingOutOfBoundsException(String message) {
super(message);
}
}
static BiFunction<String, List<Number>, AssertingOutOfBoundsException> assertingOutOfBounds(
String message, String expCheckKind, Integer... expArgs) {
return (checkKind, args) -> {
assertEquals(checkKind, expCheckKind);
assertEquals(args, List.of(expArgs));
try {
args.clear();
fail("Out of bounds List<Integer> argument should be unmodifiable");
} catch (Exception e) {
}
return new AssertingOutOfBoundsException(message);
};
}
static BiFunction<String, List<Number>, AssertingOutOfBoundsException> assertingOutOfBoundsReturnNull(
String expCheckKind, Integer... expArgs) {
return (checkKind, args) -> {
assertEquals(checkKind, expCheckKind);
assertEquals(args, List.of(expArgs));
return null;
};
}
static final int[] VALUES = {0, 1, Integer.MAX_VALUE - 1, Integer.MAX_VALUE, -1, Integer.MIN_VALUE + 1, Integer.MIN_VALUE};
@DataProvider
static Object[][] checkIndexProvider() {
List<Object[]> l = new ArrayList<>();
for (int index : VALUES) {
for (int length : VALUES) {
boolean withinBounds = index >= 0 &&
length >= 0 &&
index < length;
l.add(new Object[]{index, length, withinBounds});
}
}
return l.toArray(Object[][]::new);
}
@Test(dataProvider = "checkIndexProvider")
public void testCheckIndex(int index, int length, boolean withinBounds) {
String expectedMessage = withinBounds
? null
: Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new).
apply("checkIndex", List.of(index, length)).getMessage();
BiConsumer<Class<? extends RuntimeException>, IntSupplier> checker = (ec, s) -> {
try {
int rIndex = s.getAsInt();
if (!withinBounds)
fail(String.format(
"Index %d is out of bounds of [0, %d), but was reported to be within bounds", index, length));
assertEquals(rIndex, index);
}
catch (RuntimeException e) {
assertTrue(ec.isInstance(e));
if (withinBounds)
fail(String.format(
"Index %d is within bounds of [0, %d), but was reported to be out of bounds", index, length));
else
assertEquals(e.getMessage(), expectedMessage);
}
};
checker.accept(AssertingOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
assertingOutOfBounds(expectedMessage, "checkIndex", index, length)));
checker.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
assertingOutOfBoundsReturnNull("checkIndex", index, length)));
checker.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length, null));
checker.accept(IndexOutOfBoundsException.class,
() -> Objects.checkIndex(index, length));
checker.accept(ArrayIndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
Preconditions.outOfBoundsExceptionFormatter(ArrayIndexOutOfBoundsException::new)));
checker.accept(StringIndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
Preconditions.outOfBoundsExceptionFormatter(StringIndexOutOfBoundsException::new)));
}
@DataProvider
static Object[][] checkFromToIndexProvider() {
List<Object[]> l = new ArrayList<>();
for (int fromIndex : VALUES) {
for (int toIndex : VALUES) {
for (int length : VALUES) {
boolean withinBounds = fromIndex >= 0 &&
toIndex >= 0 &&
length >= 0 &&
fromIndex <= toIndex &&
toIndex <= length;
l.add(new Object[]{fromIndex, toIndex, length, withinBounds});
}
}
}
return l.toArray(Object[][]::new);
}
@Test(dataProvider = "checkFromToIndexProvider")
public void testCheckFromToIndex(int fromIndex, int toIndex, int length, boolean withinBounds) {
String expectedMessage = withinBounds
? null
: Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new).
apply("checkFromToIndex", List.of(fromIndex, toIndex, length)).getMessage();
BiConsumer<Class<? extends RuntimeException>, IntSupplier> check = (ec, s) -> {
try {
int rIndex = s.getAsInt();
if (!withinBounds)
fail(String.format(
"Range [%d, %d) is out of bounds of [0, %d), but was reported to be withing bounds", fromIndex, toIndex, length));
assertEquals(rIndex, fromIndex);
}
catch (RuntimeException e) {
assertTrue(ec.isInstance(e));
if (withinBounds)
fail(String.format(
"Range [%d, %d) is within bounds of [0, %d), but was reported to be out of bounds", fromIndex, toIndex, length));
else
assertEquals(e.getMessage(), expectedMessage);
}
};
check.accept(AssertingOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
assertingOutOfBounds(expectedMessage, "checkFromToIndex", fromIndex, toIndex, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
assertingOutOfBoundsReturnNull("checkFromToIndex", fromIndex, toIndex, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length, null));
check.accept(IndexOutOfBoundsException.class,
() -> Objects.checkFromToIndex(fromIndex, toIndex, length));
check.accept(ArrayIndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
Preconditions.outOfBoundsExceptionFormatter(ArrayIndexOutOfBoundsException::new)));
check.accept(StringIndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
Preconditions.outOfBoundsExceptionFormatter(StringIndexOutOfBoundsException::new)));
}
@DataProvider
static Object[][] checkFromIndexSizeProvider() {
List<Object[]> l = new ArrayList<>();
for (int fromIndex : VALUES) {
for (int size : VALUES) {
for (int length : VALUES) {
// Explicitly convert to long
long lFromIndex = fromIndex;
long lSize = size;
long lLength = length;
// Avoid overflow
long lToIndex = lFromIndex + lSize;
boolean withinBounds = lFromIndex >= 0L &&
lSize >= 0L &&
lLength >= 0L &&
lFromIndex <= lToIndex &&
lToIndex <= lLength;
l.add(new Object[]{fromIndex, size, length, withinBounds});
}
}
}
return l.toArray(Object[][]::new);
}
@Test(dataProvider = "checkFromIndexSizeProvider")
public void testCheckFromIndexSize(int fromIndex, int size, int length, boolean withinBounds) {
String expectedMessage = withinBounds
? null
: Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new).
apply("checkFromIndexSize", List.of(fromIndex, size, length)).getMessage();
BiConsumer<Class<? extends RuntimeException>, IntSupplier> check = (ec, s) -> {
try {
int rIndex = s.getAsInt();
if (!withinBounds)
fail(String.format(
"Range [%d, %d + %d) is out of bounds of [0, %d), but was reported to be withing bounds", fromIndex, fromIndex, size, length));
assertEquals(rIndex, fromIndex);
}
catch (RuntimeException e) {
assertTrue(ec.isInstance(e));
if (withinBounds)
fail(String.format(
"Range [%d, %d + %d) is within bounds of [0, %d), but was reported to be out of bounds", fromIndex, fromIndex, size, length));
else
assertEquals(e.getMessage(), expectedMessage);
}
};
check.accept(AssertingOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
assertingOutOfBounds(expectedMessage, "checkFromIndexSize", fromIndex, size, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
assertingOutOfBoundsReturnNull("checkFromIndexSize", fromIndex, size, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length, null));
check.accept(IndexOutOfBoundsException.class,
() -> Objects.checkFromIndexSize(fromIndex, size, length));
check.accept(ArrayIndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
Preconditions.outOfBoundsExceptionFormatter(ArrayIndexOutOfBoundsException::new)));
check.accept(StringIndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
Preconditions.outOfBoundsExceptionFormatter(StringIndexOutOfBoundsException::new)));
}
@Test
public void uniqueMessagesForCheckKinds() {
BiFunction<String, List<Number>, IndexOutOfBoundsException> f =
Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new);
List<String> messages = new ArrayList<>();
// Exact arguments
messages.add(f.apply("checkIndex", List.of(-1, 0)).getMessage());
messages.add(f.apply("checkFromToIndex", List.of(-1, 0, 0)).getMessage());
messages.add(f.apply("checkFromIndexSize", List.of(-1, 0, 0)).getMessage());
// Unknown check kind
messages.add(f.apply("checkUnknown", List.of(-1, 0, 0)).getMessage());
// Known check kind with more arguments
messages.add(f.apply("checkIndex", List.of(-1, 0, 0)).getMessage());
messages.add(f.apply("checkFromToIndex", List.of(-1, 0, 0, 0)).getMessage());
messages.add(f.apply("checkFromIndexSize", List.of(-1, 0, 0, 0)).getMessage());
// Known check kind with fewer arguments
messages.add(f.apply("checkIndex", List.of(-1)).getMessage());
messages.add(f.apply("checkFromToIndex", List.of(-1, 0)).getMessage());
messages.add(f.apply("checkFromIndexSize", List.of(-1, 0)).getMessage());
// Null arguments
messages.add(f.apply(null, null).getMessage());
messages.add(f.apply("checkNullArguments", null).getMessage());
messages.add(f.apply(null, List.of(-1)).getMessage());
assertEquals(messages.size(), messages.stream().distinct().count());
}
}

View file

@ -0,0 +1,287 @@
/*
* Copyright (c) 2020, 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.
*
* 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.
*/
/**
* @test
* @summary Objects.checkIndex/jdk.internal.util.Preconditions.checkIndex tests for long values
* @run testng CheckLongIndex
* @modules java.base/jdk.internal.util
*/
import jdk.internal.util.Preconditions;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.function.LongSupplier;
import static org.testng.Assert.*;
public class CheckLongIndex {
static class AssertingOutOfBoundsException extends RuntimeException {
public AssertingOutOfBoundsException(String message) {
super(message);
}
}
static BiFunction<String, List<Number>, AssertingOutOfBoundsException> assertingOutOfBounds(
String message, String expCheckKind, Long... expArgs) {
return (checkKind, args) -> {
assertEquals(checkKind, expCheckKind);
assertEquals(args, List.of(expArgs));
try {
args.clear();
fail("Out of bounds List<Long> argument should be unmodifiable");
} catch (Exception e) {
}
return new AssertingOutOfBoundsException(message);
};
}
static BiFunction<String, List<Number>, AssertingOutOfBoundsException> assertingOutOfBoundsReturnNull(
String expCheckKind, Long... expArgs) {
return (checkKind, args) -> {
assertEquals(checkKind, expCheckKind);
assertEquals(args, List.of(expArgs));
return null;
};
}
static final long[] VALUES = {0, 1, Long.MAX_VALUE - 1, Long.MAX_VALUE, -1, Long.MIN_VALUE + 1, Long.MIN_VALUE};
@DataProvider
static Object[][] checkIndexProvider() {
List<Object[]> l = new ArrayList<>();
for (long index : VALUES) {
for (long length : VALUES) {
boolean withinBounds = index >= 0 &&
length >= 0 &&
index < length;
l.add(new Object[]{index, length, withinBounds});
}
}
return l.toArray(Object[][]::new);
}
@Test(dataProvider = "checkIndexProvider")
public void testCheckIndex(long index, long length, boolean withinBounds) {
String expectedMessage = withinBounds
? null
: Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new).
apply("checkIndex", List.of(index, length)).getMessage();
BiConsumer<Class<? extends RuntimeException>, LongSupplier> checker = (ec, s) -> {
try {
long rIndex = s.getAsLong();
if (!withinBounds)
fail(String.format(
"Index %d is out of bounds of [0, %d), but was reported to be within bounds", index, length));
assertEquals(rIndex, index);
}
catch (RuntimeException e) {
assertTrue(ec.isInstance(e));
if (withinBounds)
fail(String.format(
"Index %d is within bounds of [0, %d), but was reported to be out of bounds", index, length));
else
assertEquals(e.getMessage(), expectedMessage);
}
};
checker.accept(AssertingOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
assertingOutOfBounds(expectedMessage, "checkIndex", index, length)));
checker.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
assertingOutOfBoundsReturnNull("checkIndex", index, length)));
checker.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length, null));
checker.accept(IndexOutOfBoundsException.class,
() -> Objects.checkIndex(index, length));
checker.accept(ArrayIndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
Preconditions.outOfBoundsExceptionFormatter(ArrayIndexOutOfBoundsException::new)));
checker.accept(StringIndexOutOfBoundsException.class,
() -> Preconditions.checkIndex(index, length,
Preconditions.outOfBoundsExceptionFormatter(StringIndexOutOfBoundsException::new)));
}
@DataProvider
static Object[][] checkFromToIndexProvider() {
List<Object[]> l = new ArrayList<>();
for (long fromIndex : VALUES) {
for (long toIndex : VALUES) {
for (long length : VALUES) {
boolean withinBounds = fromIndex >= 0 &&
toIndex >= 0 &&
length >= 0 &&
fromIndex <= toIndex &&
toIndex <= length;
l.add(new Object[]{fromIndex, toIndex, length, withinBounds});
}
}
}
return l.toArray(Object[][]::new);
}
@Test(dataProvider = "checkFromToIndexProvider")
public void testCheckFromToIndex(long fromIndex, long toIndex, long length, boolean withinBounds) {
String expectedMessage = withinBounds
? null
: Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new).
apply("checkFromToIndex", List.of(fromIndex, toIndex, length)).getMessage();
BiConsumer<Class<? extends RuntimeException>, LongSupplier> check = (ec, s) -> {
try {
long rIndex = s.getAsLong();
if (!withinBounds)
fail(String.format(
"Range [%d, %d) is out of bounds of [0, %d), but was reported to be withing bounds", fromIndex, toIndex, length));
assertEquals(rIndex, fromIndex);
}
catch (RuntimeException e) {
assertTrue(ec.isInstance(e));
if (withinBounds)
fail(String.format(
"Range [%d, %d) is within bounds of [0, %d), but was reported to be out of bounds", fromIndex, toIndex, length));
else
assertEquals(e.getMessage(), expectedMessage);
}
};
check.accept(AssertingOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
assertingOutOfBounds(expectedMessage, "checkFromToIndex", fromIndex, toIndex, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
assertingOutOfBoundsReturnNull("checkFromToIndex", fromIndex, toIndex, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length, null));
check.accept(IndexOutOfBoundsException.class,
() -> Objects.checkFromToIndex(fromIndex, toIndex, length));
check.accept(ArrayIndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
Preconditions.outOfBoundsExceptionFormatter(ArrayIndexOutOfBoundsException::new)));
check.accept(StringIndexOutOfBoundsException.class,
() -> Preconditions.checkFromToIndex(fromIndex, toIndex, length,
Preconditions.outOfBoundsExceptionFormatter(StringIndexOutOfBoundsException::new)));
}
@DataProvider
static Object[][] checkFromIndexSizeProvider() {
List<Object[]> l = new ArrayList<>();
for (long fromIndex : VALUES) {
for (long size : VALUES) {
for (long length : VALUES) {
long toIndex = fromIndex + size;
boolean withinBounds = fromIndex >= 0L &&
size >= 0L &&
length >= 0L &&
fromIndex <= toIndex && // overflow
toIndex <= length;
l.add(new Object[]{fromIndex, size, length, withinBounds});
}
}
}
return l.toArray(Object[][]::new);
}
@Test(dataProvider = "checkFromIndexSizeProvider")
public void testCheckFromIndexSize(long fromIndex, long size, long length, boolean withinBounds) {
String expectedMessage = withinBounds
? null
: Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new).
apply("checkFromIndexSize", List.of(fromIndex, size, length)).getMessage();
BiConsumer<Class<? extends RuntimeException>, LongSupplier> check = (ec, s) -> {
try {
long rIndex = s.getAsLong();
if (!withinBounds)
fail(String.format(
"Range [%d, %d + %d) is out of bounds of [0, %d), but was reported to be withing bounds", fromIndex, fromIndex, size, length));
assertEquals(rIndex, fromIndex);
}
catch (RuntimeException e) {
assertTrue(ec.isInstance(e));
if (withinBounds)
fail(String.format(
"Range [%d, %d + %d) is within bounds of [0, %d), but was reported to be out of bounds", fromIndex, fromIndex, size, length));
else
assertEquals(e.getMessage(), expectedMessage);
}
};
check.accept(AssertingOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
assertingOutOfBounds(expectedMessage, "checkFromIndexSize", fromIndex, size, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
assertingOutOfBoundsReturnNull("checkFromIndexSize", fromIndex, size, length)));
check.accept(IndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length, null));
check.accept(IndexOutOfBoundsException.class,
() -> Objects.checkFromIndexSize(fromIndex, size, length));
check.accept(ArrayIndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
Preconditions.outOfBoundsExceptionFormatter(ArrayIndexOutOfBoundsException::new)));
check.accept(StringIndexOutOfBoundsException.class,
() -> Preconditions.checkFromIndexSize(fromIndex, size, length,
Preconditions.outOfBoundsExceptionFormatter(StringIndexOutOfBoundsException::new)));
}
@Test
public void uniqueMessagesForCheckKinds() {
BiFunction<String, List<Number>, IndexOutOfBoundsException> f =
Preconditions.outOfBoundsExceptionFormatter(IndexOutOfBoundsException::new);
List<String> messages = new ArrayList<>();
// Exact arguments
messages.add(f.apply("checkIndex", List.of(-1L, 0L)).getMessage());
messages.add(f.apply("checkFromToIndex", List.of(-1L, 0L, 0L)).getMessage());
messages.add(f.apply("checkFromIndexSize", List.of(-1L, 0L, 0L)).getMessage());
// Unknown check kind
messages.add(f.apply("checkUnknown", List.of(-1L, 0L, 0L)).getMessage());
// Known check kind with more arguments
messages.add(f.apply("checkIndex", List.of(-1L, 0L, 0L)).getMessage());
messages.add(f.apply("checkFromToIndex", List.of(-1L, 0L, 0L, 0L)).getMessage());
messages.add(f.apply("checkFromIndexSize", List.of(-1L, 0L, 0L, 0L)).getMessage());
// Known check kind with fewer arguments
messages.add(f.apply("checkIndex", List.of(-1L)).getMessage());
messages.add(f.apply("checkFromToIndex", List.of(-1L, 0L)).getMessage());
messages.add(f.apply("checkFromIndexSize", List.of(-1L, 0L)).getMessage());
// Null arguments
messages.add(f.apply(null, null).getMessage());
messages.add(f.apply("checkNullArguments", null).getMessage());
messages.add(f.apply(null, List.of(-1L)).getMessage());
assertEquals(messages.size(), messages.stream().distinct().count());
}
}