src/testcases/org/apache/poi/ss/formula/atp/TestWorkdayCalculator.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.atp;

import static java.util.Calendar.SATURDAY;
import static org.junit.jupiter.api.Assertions.assertEquals;

import java.util.Calendar;
import java.util.Date;

import org.apache.poi.ss.usermodel.DateUtil;
import org.apache.poi.util.LocaleUtil;
import org.junit.jupiter.api.Test;

class TestWorkdayCalculator {

    @Test
    void testCalculateWorkdaysShouldReturnJustWeekdaysWhenNoWeekend() {
        final double A_MONDAY = DateUtil.getExcelDate(d(2011, 12, 12));
        final double A_FRIDAY = DateUtil.getExcelDate(d(2011, 12, 16));
        assertEquals(5, WorkdayCalculator.instance.calculateWorkdays(A_MONDAY, A_FRIDAY, new double[0]));
    }

    @Test
    void testCalculateWorkdaysShouldReturnAllDaysButNoSaturdays() {
        final double A_WEDNESDAY = DateUtil.getExcelDate(d(2011, 12, 14));
        final double A_SATURDAY = DateUtil.getExcelDate(d(2011, 12, 18));
        assertEquals(3, WorkdayCalculator.instance.calculateWorkdays(A_WEDNESDAY, A_SATURDAY, new double[0]));
    }

    @Test
    void testCalculateWorkdaysShouldReturnAllDaysButNoSundays() {
        final double A_SUNDAY = DateUtil.getExcelDate(d(2011, 12, 11));
        final double A_THURSDAY = DateUtil.getExcelDate(d(2011, 12, 15));
        assertEquals(4, WorkdayCalculator.instance.calculateWorkdays(A_SUNDAY, A_THURSDAY, new double[0]));
    }

    @Test
    void testCalculateWorkdaysShouldReturnAllDaysButNoHolidays() {
        final double A_MONDAY = DateUtil.getExcelDate(d(2011, 12, 12));
        final double A_FRIDAY = DateUtil.getExcelDate(d(2011, 12, 16));
        final double A_WEDNESDAY = DateUtil.getExcelDate(d(2011, 12, 14));
        assertEquals(4, WorkdayCalculator.instance.calculateWorkdays(A_MONDAY, A_FRIDAY, new double[]{ A_WEDNESDAY }));
    }

    @Test
    void testCalculateWorkdaysShouldIgnoreWeekendHolidays() {
        final double A_FRIDAY = DateUtil.getExcelDate(d(2011, 12, 16));
        final double A_SATURDAY = DateUtil.getExcelDate(d(2011, 12, 17));
        final double A_SUNDAY = DateUtil.getExcelDate(d(2011, 12, 18));
        final double A_WEDNESDAY = DateUtil.getExcelDate(d(2011, 12, 21));
        assertEquals(4, WorkdayCalculator.instance.calculateWorkdays(A_FRIDAY, A_WEDNESDAY, new double[]{ A_SATURDAY, A_SUNDAY }));
    }

	@Test
	void testCalculateWorkdaysOnSameDayShouldReturn1ForWeekdays() {
		final double A_MONDAY = DateUtil.getExcelDate(d(2017, 1, 2));
		assertEquals(1, WorkdayCalculator.instance.calculateWorkdays(A_MONDAY, A_MONDAY, new double[0]));
	}

	@Test
	void testCalculateWorkdaysOnSameDayShouldReturn0ForHolidays() {
		final double A_MONDAY = DateUtil.getExcelDate(d(2017, 1, 2));
		assertEquals(0, WorkdayCalculator.instance.calculateWorkdays(A_MONDAY, A_MONDAY, new double[]{ A_MONDAY }));
	}

	@Test
	void testCalculateWorkdaysOnSameDayShouldReturn0ForWeekends() {
		final double A_SUNDAY = DateUtil.getExcelDate(d(2017, 1, 1));
		assertEquals(0, WorkdayCalculator.instance.calculateWorkdays(A_SUNDAY, A_SUNDAY, new double[0]));
	}

    @Test
    void testCalculateWorkdaysNumberOfDays() {
    	double start = 41553.0;
    	int days = 1;
        assertEquals(d(2013, 10, 7), WorkdayCalculator.instance.calculateWorkdays(start, days, new double[0]));
    }

    @Test
    void testPastDaysOfWeekShouldReturn0Past0Saturdays() {
        final double A_WEDNESDAY = DateUtil.getExcelDate(d(2011, 12, 7));
        final double A_FRIDAY = DateUtil.getExcelDate(d(2011, 12, 9));
        assertEquals(0, WorkdayCalculator.instance.pastDaysOfWeek(A_WEDNESDAY, A_FRIDAY, SATURDAY));
    }

    @Test
    void testPastDaysOfWeekShouldReturn1Past1Saturdays() {
        final double A_WEDNESDAY = DateUtil.getExcelDate(d(2011, 12, 7));
        final double A_SUNDAY = DateUtil.getExcelDate(d(2011, 12, 11));
        assertEquals(1, WorkdayCalculator.instance.pastDaysOfWeek(A_WEDNESDAY, A_SUNDAY, SATURDAY));
    }

    @Test
    void testPastDaysOfWeekShouldReturn2Past2Saturdays() {
        final double A_THURSDAY = DateUtil.getExcelDate(d(2011, 12, 8));
        final double A_MONDAY = DateUtil.getExcelDate(d(2011, 12, 19));
        assertEquals(2, WorkdayCalculator.instance.pastDaysOfWeek(A_THURSDAY, A_MONDAY, SATURDAY));
    }

    @Test
    void testPastDaysOfWeekShouldReturn1BeginningFromASaturday() {
        final double A_SATURDAY = DateUtil.getExcelDate(d(2011, 12, 10));
        final double A_SUNDAY = DateUtil.getExcelDate(d(2011, 12, 11));
        assertEquals(1, WorkdayCalculator.instance.pastDaysOfWeek(A_SATURDAY, A_SUNDAY, SATURDAY));
    }

    @Test
    void testPastDaysOfWeekShouldReturn1EndingAtASaturday() {
        final double A_THURSDAY = DateUtil.getExcelDate(d(2011, 12, 8));
        final double A_SATURDAY = DateUtil.getExcelDate(d(2011, 12, 10));
        assertEquals(1, WorkdayCalculator.instance.pastDaysOfWeek(A_THURSDAY, A_SATURDAY, SATURDAY));
    }

    private static Date d(int year, int month, int day) {
        Calendar cal = LocaleUtil.getLocaleCalendar(year, month-1, day, 0, 0, 0);
        return cal.getTime();
    }

    @Test
    void testCalculateNonWeekendHolidays() {
        final double start = DateUtil.getExcelDate(d(2016, 12, 24));
        final double end = DateUtil.getExcelDate(d(2016, 12, 31));
        final double holiday1 = DateUtil.getExcelDate(d(2016, 12, 25));
        final double holiday2 = DateUtil.getExcelDate(d(2016, 12, 26));
        int count = WorkdayCalculator.instance.calculateNonWeekendHolidays(start, end, new double[]{holiday1, holiday2});
        assertEquals(1, count, "Expected 1 non-weekend-holiday for " + start + " to " + end + " and " + holiday1 + " and " + holiday2);
    }

    @Test
    void testCalculateNonWeekendHolidaysOneDay() {
        final double start = DateUtil.getExcelDate(d(2016, 12, 26));
        final double end = DateUtil.getExcelDate(d(2016, 12, 26));
        final double holiday1 = DateUtil.getExcelDate(d(2016, 12, 25));
        final double holiday2 = DateUtil.getExcelDate(d(2016, 12, 26));
        int count = WorkdayCalculator.instance.calculateNonWeekendHolidays(start, end, new double[]{holiday1, holiday2});
        assertEquals(1, count, "Expected 1 non-weekend-holiday for " + start + " to " + end + " and " + holiday1 + " and " + holiday2);
    }
}