poi/src/test/java/org/apache/poi/ss/formula/functions/TestDateValue.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.functions;

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

import java.time.LocalDate;
import java.time.Month;
import java.time.Year;
import java.time.temporal.ChronoUnit;
import java.util.Locale;

import org.apache.poi.ss.formula.eval.*;
import org.apache.poi.util.LocaleUtil;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

/**
 * Tests for Excel function DATEVALUE()
 */
final class TestDateValue {

    @BeforeAll
    public static void init() {
        LocaleUtil.setUserLocale(Locale.US);
    }

    @AfterAll
    public static void clear() {
        LocaleUtil.setUserLocale(null);
    }

    @Test
    void testDateValue() {
        int days1900 = (int)ChronoUnit.DAYS.between(
            LocalDate.of(1899, Month.DECEMBER, 31),
            LocalDate.of(Year.now(LocaleUtil.getUserTimeZone().toZoneId()).getValue(), Month.FEBRUARY, 1)
        )+1;
        confirmDateValue(new StringEval("2020-02-01"), 43862);
        confirmDateValue(new StringEval("01-02-2020"), 43862);
        confirmDateValue(new StringEval("2020-FEB-01"), 43862);
        confirmDateValue(new StringEval("2020-Feb-01"), 43862);
        confirmDateValue(new StringEval("2020-FEBRUARY-01"), 43862);
        confirmDateValue(new StringEval("FEB-01"), days1900);
        confirmDateValue(new StringEval("2/1/2020"), 43862);
        confirmDateValue(new StringEval("2/1"), days1900);
        confirmDateValue(new StringEval("2020/2/1"), 43862);
        confirmDateValue(new StringEval("2020/FEB/1"), 43862);
        confirmDateValue(new StringEval("FEB/1/2020"), 43862);
        confirmDateValue(new StringEval("2020/02/01"), 43862);

        confirmDateValueError(new StringEval(""));
        confirmDateValueError(BlankEval.instance);

        confirmDateValueError(new StringEval("non-date text"));
        confirmDateValueError(new StringEval("2/32/2020"));
        confirmDateValueError(new StringEval("32/2/2020"));
        confirmDateValueError(new StringEval("32/32/2020"));

        confirmDateValueError(new StringEval("non-date text"));

        // // EXCEL
        confirmDateValue(new StringEval("8/22/2011"), 40777); // Serial number of a date entered as text.
        confirmDateValue(new StringEval("22-MAY-2011"), 40685); // Serial number of a date entered as text.
        confirmDateValue(new StringEval("2011/02/23"), 40597); // Serial number of a date entered as text.

        //ignore time parts
        confirmDateValue(new StringEval("8/22/2011 12:00"), 40777); // Serial number of a date entered as text.
        confirmDateValue(new StringEval("8/22/2011 6:02:23 PM"), 40777); // Serial number of a date entered as text.
        confirmDateValue(new StringEval("22-AUG-2011 6:02:23PM"), 40777); // Serial number of a date entered as text.
        confirmDateValue(new StringEval("22-AUG-2011 6:02:23AM"), 40777); // Serial number of a date entered as text.

        // LibreOffice compatibility
        confirmDateValue(new StringEval("1954-07-20"), 19925);
    }

    @Test
    void testInvalidDateValue() {
        assertEquals(ErrorEval.VALUE_INVALID, invokeDateValue(new StringEval("not-date")),
                "not-date evals to invalid");
        assertEquals(ErrorEval.VALUE_INVALID, invokeDateValue(BoolEval.FALSE),
                "false evals to invalid");
        assertEquals(ErrorEval.VALUE_INVALID, invokeDateValue(new NumberEval(Math.E)),
                "Math.E evals to invalid");
    }

    private ValueEval invokeDateValue(ValueEval text) {
        return new DateValue().evaluate(0, 0, text);
    }

    private void confirmDateValue(ValueEval text, double expected) {
        ValueEval result = invokeDateValue(text);
        assertEquals(NumberEval.class, result.getClass());
        assertEquals(expected, ((NumberEval) result).getNumberValue(), 0.0001);
    }

    private void confirmDateValueError(ValueEval text) {
        ValueEval result = invokeDateValue(text);
        assertEquals(ErrorEval.class, result.getClass());
        assertEquals(ErrorEval.VALUE_INVALID.getErrorCode(), ((ErrorEval) result).getErrorCode());
    }
}