Skip to content

Fix #595 : Numeric operator overflow #596

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

Open
codesplode wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Fix #595 : Numeric operator overflow #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6c44a6c
Testing : ExpressionTest : Add overload for test with context
codesplode Jun 16, 2021
26e50cb
Testing : Create NumericComparisonExpressionTest
codesplode Jun 16, 2021
c8a4ce2
Issue #595 : Initial fix for numeric comparisons
codesplode Jun 16, 2021
2db88d5
Issue #595 : Refactor OperatorUtils with Type Checking and Conversion
codesplode Jun 17, 2021
fac2553
OperatorUtils : Simplify equals condition for Objects
codesplode Jun 17, 2021
dc3ad04
OperatorUtils : Correct Implicit Cast Warning
codesplode Jun 17, 2021
a5d9195
Issue #595 : Refactor OperatorUtils Binary Operation to Type Checking
codesplode Jun 17, 2021
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
148 changes: 113 additions & 35 deletions pebble/src/main/java/io/pebbletemplates/pebble/utils/OperatorUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,11 @@
import io.pebbletemplates.pebble.extension.escaper.SafeString;

import java.math.BigDecimal;
import java.math.BigInteger;
import java.math.MathContext;
import java.util.Collection;
import java.util.List;
import java.util.Objects;

/**
* This class acts as a sort of wrapper around Java's built in operators. This is necessary because
Expand Down Expand Up @@ -73,7 +75,7 @@ public static boolean equals(Object op1, Object op2) {
} else if (op2 instanceof Enum<?> && op1 instanceof String) {
return compareEnum((Enum<?>) op2, (String) op1);
} else {
return ((op1 == op2) || ((op1 != null) && op1.equals(op2)));
return Objects.equals(op1, op2);
}
}

Expand Down Expand Up @@ -140,8 +142,7 @@ private static Object subtractFromList(List<?> op1, Object op2) {
return op1;
}

private static Object wideningConversionBinaryOperation(Object op1, Object op2,
Operation operation) {
private static Object wideningConversionBinaryOperation(Object op1, Object op2, Operation operation) {

if (!(op1 instanceof Number) || !(op2 instanceof Number)) {
throw new RuntimeException(
Expand All @@ -151,29 +152,56 @@ private static Object wideningConversionBinaryOperation(Object op1, Object op2,
Number num1 = (Number) op1;
Number num2 = (Number) op2;

if (num1 instanceof BigDecimal || num2 instanceof BigDecimal) {
return bigDecimalOperation(BigDecimal.valueOf(num1.doubleValue()),
BigDecimal.valueOf(num2.doubleValue()),
operation);
// Simplify checks if both operands are the same type
if (num1.getClass().equals(num2.getClass())) {
if (num1 instanceof Integer) {
return integerOperation((int) num1, (int) num2, operation);
}
if (num1 instanceof Double) {
return doubleOperation((double) num1, (double) num2, operation);
}
if (num1 instanceof Long) {
return longOperation((long) num1, (long) num2, operation);
}
if (num1 instanceof BigDecimal) {
return bigDecimalOperation((BigDecimal) num1, (BigDecimal) num2, operation);
}
if (num1 instanceof BigInteger) {
return bigIntegerOperation((BigInteger) num1, (BigInteger) num2, operation);
}
}

if (num1 instanceof Double || num2 instanceof Double) {
return doubleOperation(num1.doubleValue(), num2.doubleValue(), operation);
/*
* Convert and compare operands based on the complexity / scale of the values.
*/
if (num1 instanceof BigDecimal) {
Copy link
Member

@ebussieres ebussieres Oct 28, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to add tests when both operands are not the same type

Copy link
Member

@ebussieres ebussieres Oct 28, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should also add tests for numeric operation (add, subtract, multiply, etc.)

return bigDecimalOperation((BigDecimal) num1, new BigDecimal(num2.toString()), operation);
}
if (num2 instanceof BigDecimal) {
return bigDecimalOperation(new BigDecimal(num1.toString()), (BigDecimal) num2, operation);
}

if (num1 instanceof Float || num2 instanceof Float) {
return floatOperation(num1.floatValue(), num2.floatValue(), operation);
// Handle remaining decimal numbers by converting to BigDecimal since we know the classes differ
if (num1 instanceof Double || num2 instanceof Double || num1 instanceof Float || num2 instanceof Float) {
return bigDecimalOperation(new BigDecimal(num1.toString()), new BigDecimal(num2.toString()), operation);
}

// From here we only have whole number types to check
if (num1 instanceof BigInteger) {
return bigIntegerOperation((BigInteger) num1, new BigInteger(num2.toString()), operation);
}
if (num2 instanceof BigInteger) {
return bigIntegerOperation(new BigInteger(num1.toString()), (BigInteger) num2, operation);
}
if (num1 instanceof Long || num2 instanceof Long) {
return longOperation(num1.longValue(), num2.longValue(), operation);
}

// Compare remaining integer types using intValue()
return integerOperation(num1.intValue(), num2.intValue(), operation);
}

private static boolean wideningConversionBinaryComparison(Object op1, Object op2,
Comparison comparison) {
private static boolean wideningConversionBinaryComparison(Object op1, Object op2, Comparison comparison) {
if (op1 == null || op2 == null) {
return false;
}
Expand All @@ -184,12 +212,63 @@ private static boolean wideningConversionBinaryComparison(Object op1, Object op2
num1 = (Number) op1;
num2 = (Number) op2;
} catch (ClassCastException ex) {
throw new RuntimeException(
String
.format("invalid operands for mathematical comparison [%s]", comparison.toString()));
throw new RuntimeException(String.format("invalid operands for mathematical comparison [%s]", comparison.toString()));
}

/*
* If the two operands are the same class, we will run the appropriate compare with casts.
* If not, we will work from the highest range downward to check types and convert the numbers
* for comparison in a way that will not lose values.
*/
int result = 0;

if (num1.getClass().equals(num2.getClass())) {
if (num1 instanceof Integer) {
result = ((Integer) num1).compareTo((Integer) num2);
} else if (num1 instanceof Double) {
result = ((Double) num1).compareTo((Double) num2);
} else if (num1 instanceof Long) {
result = ((Long) num1).compareTo((Long) num2);
} else if (num1 instanceof BigDecimal) {
result = ((BigDecimal) num1).compareTo((BigDecimal) num2);
} else if (num1 instanceof BigInteger) {
result = ((BigInteger) num1).compareTo((BigInteger) num2);
}
} else {
if (num1 instanceof BigDecimal) {
result = ((BigDecimal) num1).compareTo(new BigDecimal(num2.toString()));
} else if (num2 instanceof BigDecimal) {
result = (new BigDecimal(num1.toString())).compareTo((BigDecimal) num2);
// Handle remaining decimal numbers by converting to BigDecimal since we know the classes differ
} else if (num1 instanceof Double || num2 instanceof Double || num1 instanceof Float || num2 instanceof Float) {
result = (new BigDecimal(num1.toString())).compareTo(new BigDecimal(num2.toString()));
// From here we only have whole number types to check
} else if (num1 instanceof BigInteger) {
result = ((BigInteger) num1).compareTo(new BigInteger(num2.toString()));
} else if (num2 instanceof BigInteger) {
result = (new BigInteger(num1.toString())).compareTo((BigInteger) num2);
} else if (num1 instanceof Long || num2 instanceof Long) {
result = Long.compare(num1.longValue(), num2.longValue());
// Compare remaining integer types using intValue()
} else {
result = Integer.compare(num1.intValue(), num2.intValue());
}
}

return doubleComparison(num1.doubleValue(), num2.doubleValue(), comparison);
switch (comparison) {
case GREATER_THAN:
return result == 1;
case GREATER_THAN_EQUALS:
return result >= 0;
case LESS_THAN:
return result < 0;
case LESS_THAN_EQUALS:
return result <= 0;
case EQUALS:
return result == 0;
default:
throw new RuntimeException("Bug in OperatorUtils in pebble library");
}
}

private static double doubleOperation(double op1, double op2, Operation operation) {
Expand All @@ -209,36 +288,35 @@ private static double doubleOperation(double op1, double op2, Operation operatio
}
}

private static boolean doubleComparison(double op1, double op2, Comparison comparison) {
switch (comparison) {
case GREATER_THAN:
return op1 > op2;
case GREATER_THAN_EQUALS:
return op1 >= op2;
case LESS_THAN:
return op1 < op2;
case LESS_THAN_EQUALS:
return op1 <= op2;
case EQUALS:
return op1 == op2;
private static BigDecimal bigDecimalOperation(BigDecimal op1, BigDecimal op2, Operation operation) {
switch (operation) {
case ADD:
return op1.add(op2);
case SUBTRACT:
return op1.subtract(op2);
case MULTIPLICATION:
return op1.multiply(op2, MathContext.DECIMAL128);
case DIVISION:
return op1.divide(op2, MathContext.DECIMAL128);
case MODULUS:
return op1.remainder(op2, MathContext.DECIMAL128);
default:
throw new RuntimeException("Bug in OperatorUtils in pebble library");
}
}

private static BigDecimal bigDecimalOperation(BigDecimal op1, BigDecimal op2,
Operation operation) {
private static BigInteger bigIntegerOperation(BigInteger op1, BigInteger op2, Operation operation) {
switch (operation) {
case ADD:
return op1.add(op2);
case SUBTRACT:
return op1.subtract(op2);
case MULTIPLICATION:
return op1.multiply(op2, MathContext.DECIMAL128);
return op1.multiply(op2);
case DIVISION:
return op1.divide(op2, MathContext.DECIMAL128);
return op1.divide(op2);
case MODULUS:
return op1.remainder(op2, MathContext.DECIMAL128);
return op1.remainder(op2);
default:
throw new RuntimeException("Bug in OperatorUtils in pebble library");
}
Expand Down Expand Up @@ -285,7 +363,7 @@ private static long integerOperation(int op1, int op2, Operation operation) {
case SUBTRACT:
return op1 - op2;
case MULTIPLICATION:
return op1 * op2;
return (long) op1 * op2;
case DIVISION:
return op1 / op2;
case MODULUS:
Expand Down
9 changes: 9 additions & 0 deletions pebble/src/test/java/io/pebbletemplates/pebble/node/expression/ExpressionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

import java.io.IOException;
import java.io.StringWriter;
import java.util.Map;

import static org.junit.jupiter.api.Assertions.assertEquals;

Expand All @@ -20,4 +21,12 @@ protected void testExpression(String templateName, String expected) throws IOExc
template.evaluate(writer);
assertEquals(expected, writer.toString());
}

protected void testExpression(String templateName, String expected, Map<String, Object> context) throws IOException {
PebbleTemplate template = this.pebble.getTemplate(templateName);
StringWriter writer = new StringWriter();
template.evaluate(writer, context);
assertEquals(expected, writer.toString());
}

}
68 changes: 68 additions & 0 deletions .../test/java/io/pebbletemplates/pebble/node/expression/NumericComparisonExpressionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
package io.pebbletemplates.pebble.node.expression;

import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.HashMap;
import java.util.Map;

public class NumericComparisonExpressionTest extends ExpressionTest {

@Test
void testEqualsWithVaryingNumericTypes() throws IOException {
testAllNumericTypes("{{ left == right }}", "==");
}

@Test
void testGreaterThanWithVaryingNumericTypes() throws IOException {
testAllNumericTypes("{{ left > right }}", ">");
}

@Test
void testLessThanWithVaryingNumericTypes() throws IOException {
testAllNumericTypes("{{ left < right }}", "<");
}

private void testAllNumericTypes(String template, String operator) throws IOException {
String shouldBeEqual = "false";
String shouldBeLessThan = "false";
String shouldBeGreaterThan = "false";

switch (operator) {
case "==": shouldBeEqual = "true"; break;
case "<": shouldBeLessThan = "true"; break;
case ">": shouldBeGreaterThan = "true"; break;
}

this.testExpression(template, shouldBeEqual, contextOf(579541, 579541));
this.testExpression(template, shouldBeLessThan, contextOf(579541, 579542));
this.testExpression(template, shouldBeGreaterThan, contextOf(579542, 579541));

this.testExpression(template, shouldBeEqual, contextOf(579541.4524, 579541.4524));
this.testExpression(template, shouldBeLessThan, contextOf(579541.4524, 579541.4525));
this.testExpression(template, shouldBeGreaterThan, contextOf(579541.4525, 579541.4524));

this.testExpression(template, shouldBeEqual, contextOf(325055142682428416L, 325055142682428416L));
this.testExpression(template, shouldBeLessThan, contextOf(325055142682428416L, 325055142682428417L));
this.testExpression(template, shouldBeGreaterThan, contextOf(325055142682428417L, 325055142682428416L));

this.testExpression(template, shouldBeEqual, contextOf(new BigInteger("325055142682428416"), new BigInteger("325055142682428416")));
this.testExpression(template, shouldBeLessThan, contextOf(new BigInteger("325055142682428416"), new BigInteger("325055142682428417")));
this.testExpression(template, shouldBeGreaterThan, contextOf(new BigInteger("325055142682428417"), new BigInteger("325055142682428416")));

this.testExpression(template, shouldBeEqual, contextOf(new BigDecimal("325055142682428416.325055142682428416"), new BigDecimal("325055142682428416.325055142682428416")));
this.testExpression(template, shouldBeLessThan, contextOf(new BigDecimal("325055142682428416.325055142682428416"), new BigDecimal("325055142682428416.325055142682428417")));
this.testExpression(template, shouldBeGreaterThan, contextOf(new BigDecimal("325055142682428416.325055142682428417"), new BigDecimal("325055142682428416.325055142682428416")));
}

private Map<String, Object> contextOf(Object left, Object right) {
HashMap<String, Object> context = new HashMap(2);
context.put("left", left);
context.put("right", right);

return context;
}

}