Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensures the binary IonReader throws when a value method that returns a primitive type is invoked on a null value. #693

Merged
merged 1 commit into from
Jan 17, 2024
Merged

Ensures the binary IonReader throws when a value method that returns a primitive type is invoked on a null value. #693

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions src/main/java/com/amazon/ion/impl/IonReaderContinuableCoreBinary.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,9 @@
value = minorVersion == 0 ? readBigDecimal_1_0() : readBigDecimal_1_1();
}
} else if (valueTid.type == IonType.INT) {
if (valueTid.isNull) {
return null;
}
prepareToConvertIntValue();
scalarConverter.cast(scalarConverter.get_conversion_fnid(_Private_ScalarConversions.AS_TYPE.decimal_value));
value = scalarConverter.getBigDecimal();
Expand All @@ -612,6 +615,9 @@
value = minorVersion == 0 ? readDecimal_1_0() : readDecimal_1_1();
}
} else if (valueTid.type == IonType.INT) {
if (valueTid.isNull) {
return null;
}
prepareToConvertIntValue();
scalarConverter.cast(scalarConverter.get_conversion_fnid(_Private_ScalarConversions.AS_TYPE.decimal_value));
value = scalarConverter.getDecimal();
Expand All @@ -625,7 +631,10 @@
@Override
public long longValue() {
long value;
if (valueTid.type == IonType.INT && !valueTid.isNull) {
if (valueTid.isNull) {
throwDueToInvalidType(IonType.INT);

Check warning on line 635 in src/main/java/com/amazon/ion/impl/IonReaderContinuableCoreBinary.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/com/amazon/ion/impl/IonReaderContinuableCoreBinary.java#L635 

Added line #L635 was not covered by tests
}
if (valueTid.type == IonType.INT) {
if (valueTid.length == 0) {
return 0;
}
Expand All @@ -644,7 +653,7 @@
value = scalarConverter.getLong();
scalarConverter.clear();
} else {
throw new IllegalStateException("longValue() may only be called on values of type int, float, or decimal.");
throw new IllegalStateException("longValue() may only be called on non-null values of type int, float, or decimal.");
}
return value;
}
Expand Down Expand Up @@ -687,7 +696,10 @@
@Override
public double doubleValue() {
double value;
if (valueTid.type == IonType.FLOAT && !valueTid.isNull) {
if (valueTid.isNull) {
throwDueToInvalidType(IonType.FLOAT);

Check warning on line 700 in src/main/java/com/amazon/ion/impl/IonReaderContinuableCoreBinary.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/com/amazon/ion/impl/IonReaderContinuableCoreBinary.java#L700 

Added line #L700 was not covered by tests
}
if (valueTid.type == IonType.FLOAT) {
prepareScalar();
int length = (int) (valueMarker.endIndex - valueMarker.startIndex);
if (length == 0) {
Expand All @@ -712,7 +724,7 @@
value = scalarConverter.getDouble();
scalarConverter.clear();
} else {
throw new IllegalStateException("doubleValue() may only be called on values of type float or decimal.");
throw new IllegalStateException("doubleValue() may only be called on non-null values of type float or decimal.");

Check warning on line 727 in src/main/java/com/amazon/ion/impl/IonReaderContinuableCoreBinary.java

View check run for this annotation

Codecov / codecov/patch

src/main/java/com/amazon/ion/impl/IonReaderContinuableCoreBinary.java#L727 

Added line #L727 was not covered by tests
}
return value;
}
Expand Down
89 changes: 89 additions & 0 deletions src/test/java/com/amazon/ion/impl/IonReaderContinuableCoreBinaryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import static com.amazon.ion.impl.IonCursorTestUtilities.startContainer;
import static com.amazon.ion.impl.IonCursorTestUtilities.fillStringValue;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class IonReaderContinuableCoreBinaryTest {
Expand Down Expand Up @@ -391,4 +392,92 @@ public void expectMissingTimestampBodyToFailCleanly() {
assertThrows(IonException.class, reader::timestampValue);
reader.close();
}

private static void assertReaderThrowsForAllPrimitives(IonReaderContinuableCoreBinary reader) {
// Note: ideally these would throw IonException instead of IllegalStateException, but there is long-standing
// precedent in IonJava for throwing IllegalStateException when these methods are used improperly. We maintain
// that convention for consistency.
assertThrows(IllegalStateException.class, reader::booleanValue);
assertThrows(IllegalStateException.class, reader::intValue);
assertThrows(IllegalStateException.class, reader::longValue);
assertThrows(IllegalStateException.class, reader::doubleValue);
}

@Test
public void expectAttemptToParseNullNullAsJavaPrimitiveToFailCleanly() {
IonReaderContinuableCoreBinary reader = initializeReader(
true,
0xE0, 0x01, 0x00, 0xEA,
0x0F // null.null
);
reader.nextValue();
assertEquals(IonType.NULL, reader.getType());
assertReaderThrowsForAllPrimitives(reader);
reader.close();
}

@Test
public void expectAttemptToParseNullBoolAsJavaPrimitiveToFailCleanly() {
IonReaderContinuableCoreBinary reader = initializeReader(
true,
0xE0, 0x01, 0x00, 0xEA,
0x1F // null.bool
);
reader.nextValue();
assertEquals(IonType.BOOL, reader.getType());
assertReaderThrowsForAllPrimitives(reader);
reader.close();
}

@Test
public void expectAttemptToParseNullIntAsJavaPrimitiveToFailCleanly() {
IonReaderContinuableCoreBinary reader = initializeReader(
true,
0xE0, 0x01, 0x00, 0xEA,
0x2F, // null.int
0x3F // null.int
);
reader.nextValue();
assertEquals(IonType.INT, reader.getType());
assertReaderThrowsForAllPrimitives(reader);
assertNull(reader.bigIntegerValue());
assertNull(reader.decimalValue());
assertNull(reader.bigDecimalValue());
reader.nextValue();
assertEquals(IonType.INT, reader.getType());
assertReaderThrowsForAllPrimitives(reader);
assertNull(reader.bigIntegerValue());
assertNull(reader.decimalValue());
assertNull(reader.bigDecimalValue());
reader.close();
}

@Test
public void expectAttemptToParseNullFloatAsJavaPrimitiveToFailCleanly() {
IonReaderContinuableCoreBinary reader = initializeReader(
true,
0xE0, 0x01, 0x00, 0xEA,
0x4F // null.float
);
reader.nextValue();
assertEquals(IonType.FLOAT, reader.getType());
assertReaderThrowsForAllPrimitives(reader);
assertNull(reader.bigIntegerValue());
reader.close();
}

@Test
public void expectAttemptToParseNullDecimalAsJavaPrimitiveToFailCleanly() {
IonReaderContinuableCoreBinary reader = initializeReader(
true,
0xE0, 0x01, 0x00, 0xEA,
0x5F // null.decimal
);
reader.nextValue();
assertEquals(IonType.DECIMAL, reader.getType());
assertNull(reader.decimalValue());
assertNull(reader.bigDecimalValue());
assertReaderThrowsForAllPrimitives(reader);
reader.close();
}
}
Loading