TestOperandResolver.java

/* ====================================================================
   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.poi.ss.formula.eval;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.fail;

import java.util.LinkedHashMap;
import java.util.Map;

import org.junit.jupiter.api.Test;

/**
 * Tests for {@code OperandResolver}
 */
final class TestOperandResolver {
    @Test
    void testParseDouble_bug48472() {
        // bug 48472 - StringIndexOutOfBoundsException
        Double resolvedValue = OperandResolver.parseDouble("-");
        assertNull(resolvedValue);
    }

    @Test
    void testParseDouble_bug49723() {
        String value = ".1";
        Double resolvedValue = OperandResolver.parseDouble(value);

        assertNotNull(resolvedValue, "Identified bug 49723");
    }

    /**
     * Tests that a list of valid strings all return a non null value from {@link OperandResolver#parseDouble(String)}
     */
    @Test
    void testParseDoubleValidStrings() {
        String[] values = new String[]{".19", "0.19", "1.9", "1E4", "-.19", "-0.19",
                "8.5","-1E4", ".5E6","+1.5","+1E5", "  +1E5  ", " 123 ", "1E4", "-123" };

        for (String value : values) {
            Double act = OperandResolver.parseDouble(value);
            assertNotNull(act);
            assertEquals(act, Double.parseDouble(value), 0);
        }
    }

    /**
     * Tests that a list of invalid strings all return null from {@link OperandResolver#parseDouble(String)}
     */
    @Test
    void testParseDoubleInvalidStrings() {
        String[] values = new String[]{"-", "ABC", "-X", "1E5a", "Infinity", "NaN", ".5F", "1,000"};

        for (String value : values) {
            assertNull(OperandResolver.parseDouble(value));
        }
    }

    @Test
    void testCoerceDateStringToNumber() throws EvaluationException {
        Map<String, Double> values = new LinkedHashMap<>();
        values.put("2019/1/18", 43483.);
        values.put("01/18/2019", 43483.);
        values.put("18 Jan 2019", 43483.);
        values.put("18-Jan-2019", 43483.);

        for (String str : values.keySet()) {
            try {
                assertEquals(OperandResolver.coerceValueToDouble(new StringEval(str)), values.get(str), 0.00001);
            } catch (EvaluationException e) {
                fail("While handling: " + str + ". "
                        + "This failure can indicate that the wrong locale is used during test-execution, "
                        + "ensure you run with english/US via -Duser.language=en -Duser.country=US. "
                        + "Having: " + System.getProperty("user.language") + "/" + System.getProperty("user.country"), e);
            }
        }
    }

    @Test
    void testCoerceDateTimeStringToNumber() throws EvaluationException {
        Map<String, Double> values = new LinkedHashMap<>();
        values.put("2019/1/18 12:00", 43483.5);
        values.put("2019/1/18 6:00 AM", 43483.25);
        values.put("18-Jan-2019 6:00 PM", 43483.75);
        values.put("2019/1/18 15:15:15", 43483.63559027778);
        values.put("18-Jan-2019 6:15:15 PM", 43483.76059027778);

        for (String str : values.keySet()) {
            try {
                assertEquals(OperandResolver.coerceValueToDouble(new StringEval(str)), values.get(str), 0.00001);
            } catch (EvaluationException e) {
                fail("While handling: " + str + ". "
                        + "This failure can indicate that the wrong locale is used during test-execution, "
                        + "ensure you run with english/US via -Duser.language=en -Duser.country=US. "
                        + "Having: " + System.getProperty("user.language") + "/" + System.getProperty("user.country"), e);
            }
        }
    }

    @Test
    void testCoerceTimeStringToNumber() throws EvaluationException {
        Map<String, Double> values = new LinkedHashMap<>();
        values.put("00:00", 0.0);
        values.put("12:00", 0.5);
        values.put("15:43:09", 0.654965278);
        values.put("15:43", 0.654861111);
        values.put("3:43 PM", 0.654861111);

        for (String str : values.keySet()) {
            assertEquals(OperandResolver.coerceValueToDouble(new StringEval(str)), values.get(str), 0.00001);
        }
    }
}