CalendarEventDaoTest.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.jasig.portlet.calendar.adapter;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;

import java.io.IOException;
import java.net.URISyntaxException;
import java.text.ParseException;
import java.util.Locale;
import java.util.Set;
import net.fortuna.ical4j.model.TimeZoneRegistry;
import net.fortuna.ical4j.model.TimeZoneRegistryImpl;
import net.fortuna.ical4j.model.component.VEvent;
import org.jasig.portlet.calendar.mvc.CalendarDisplayEvent;
import org.joda.time.DateMidnight;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.Interval;
import org.joda.time.format.DateTimeFormatter;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.MockitoAnnotations;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.MessageSource;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "/testContext.xml")
public class CalendarEventDaoTest {

  CalendarEventsDao eventDao;
  TimeZoneRegistry tzRegistry = new TimeZoneRegistryImpl();

  @Autowired(required = true)
  ApplicationContext context;

  @Before
  public void setUp() {
    MockitoAnnotations.initMocks(this);

    eventDao = new CalendarEventsDao();
    eventDao.setMessageSource((MessageSource) context.getBean("messageSource"));
  }

  @Test
  public void testGetTimeFormatter() {
    DateTimeZone tz1 = DateTimeZone.forID("America/Los_Angeles");
    DateTimeZone tz2 = DateTimeZone.forID("America/Chicago");

    DateTimeFormatter timeFormatter1 = eventDao.getTimeFormatter(Locale.US, tz1);
    DateTimeFormatter timeFormatter2 = eventDao.getTimeFormatter(Locale.US, tz2);

    assertNotNull(timeFormatter1);
    assertNotNull(timeFormatter2);

    assertSame(timeFormatter1, eventDao.getTimeFormatter(Locale.US, tz1));
    assertSame(timeFormatter2, eventDao.getTimeFormatter(Locale.US, tz2));
  }

  @Test
  public void testGetDateFormatter() {
    DateTimeZone tz1 = DateTimeZone.forID("America/Los_Angeles");
    DateTimeZone tz2 = DateTimeZone.forID("America/Chicago");

    DateTimeFormatter dateFormatter1 = eventDao.getDateFormatter(Locale.US, tz1);
    DateTimeFormatter dateFormatter2 = eventDao.getDateFormatter(Locale.US, tz2);

    assertNotNull(dateFormatter1);
    assertNotNull(dateFormatter2);

    assertSame(dateFormatter1, eventDao.getDateFormatter(Locale.US, tz1));
    assertSame(dateFormatter2, eventDao.getDateFormatter(Locale.US, tz2));
  }

  @Test
  public void testGetDisplayEvents() throws IOException, URISyntaxException, ParseException {

    DateTimeZone tz = DateTimeZone.forID("America/Los_Angeles");

    DateTime eventStart = new DateTime(2012, 1, 4, 17, 0, tz);
    DateTime eventEnd = new DateTime(2012, 1, 4, 18, 0, tz);

    VEvent event =
        new VEvent(getICal4jDate(eventStart, tz), getICal4jDate(eventEnd, tz), "Test Event");

    DateMidnight intervalStart = new DateMidnight(2012, 1, 3, tz);
    DateMidnight intervalStop = new DateMidnight(2012, 1, 5, tz);
    Interval interval = new Interval(intervalStart, intervalStop);

    Set<CalendarDisplayEvent> events = eventDao.getDisplayEvents(event, interval, Locale.US, tz);

    assertEquals(1, events.size());
  }

  /*
   * Test for CAP-182.  Test boundary case where start time == end time and
   * no TZ is associated with the event.  Defect was occurring because the
   * specific day checks were not checking the actual day-of the event because
   * end time was equal to, not before the start of the day being checked.
   */
  @Test
  public void testGetDisplayEventsSameStartEnd() throws Exception {
    DateTimeZone tz = DateTimeZone.forID("America/Los_Angeles");

    DateTime eventStart = new DateTime(2012, 1, 4, 17, 0);
    DateTime eventEnd = new DateTime(2012, 1, 4, 17, 0);

    VEvent event =
        new VEvent(getICal4jDate(eventStart, null), getICal4jDate(eventEnd, null), "Test Event");

    DateMidnight intervalStart = new DateMidnight(2012, 1, 1, tz);
    DateMidnight intervalStop = new DateMidnight(2012, 1, 31, tz);
    Interval interval = new Interval(intervalStart, intervalStop);

    Set<CalendarDisplayEvent> events = eventDao.getDisplayEvents(event, interval, Locale.US, tz);

    assertEquals(1, events.size());
  }

  @Test
  public void testGetDisplayEventsForLongEvent()
      throws IOException, URISyntaxException, ParseException {

    DateTimeZone tz = DateTimeZone.forID("America/Los_Angeles");

    DateTime eventStart = new DateTime(2012, 1, 2, 17, 0, tz);
    DateTime eventEnd = new DateTime(2012, 1, 6, 2, 0, tz);

    VEvent event =
        new VEvent(getICal4jDate(eventStart, tz), getICal4jDate(eventEnd, tz), "Test Event");

    DateMidnight intervalStart = new DateMidnight(2012, 1, 3, tz);
    DateMidnight intervalStop = new DateMidnight(2012, 1, 5, tz);
    Interval interval = new Interval(intervalStart, intervalStop);

    Set<CalendarDisplayEvent> events = eventDao.getDisplayEvents(event, interval, Locale.US, tz);

    assertEquals(2, events.size());
  }

  @Test
  public void testGetDisplayEventsForNoEndDate()
      throws IOException, URISyntaxException, ParseException {

    DateTimeZone tz = DateTimeZone.forID("America/Los_Angeles");

    DateTime eventStart = new DateTime(2012, 1, 4, 17, 0, tz);

    VEvent event = new VEvent(getICal4jDate(eventStart, tz), "Test Event");

    DateMidnight intervalStart = new DateMidnight(2012, 1, 3, tz);
    DateMidnight intervalStop = new DateMidnight(2012, 1, 5, tz);
    Interval interval = new Interval(intervalStart, intervalStop);

    Set<CalendarDisplayEvent> events = eventDao.getDisplayEvents(event, interval, Locale.US, tz);

    assertEquals(1, events.size());
  }

  @Test
  public void testGetDisplayEventsForNoEndDateStartAbutment()
      throws IOException, URISyntaxException, ParseException {

    DateTimeZone tz = DateTimeZone.forID("America/Los_Angeles");

    DateTime eventStart = new DateTime(2012, 1, 3, 0, 0, tz);

    VEvent event = new VEvent(getICal4jDate(eventStart, tz), "Test Event");

    DateMidnight intervalStart = new DateMidnight(2012, 1, 3, tz);
    DateMidnight intervalStop = new DateMidnight(2012, 1, 5, tz);
    Interval interval = new Interval(intervalStart, intervalStop);

    Set<CalendarDisplayEvent> events = eventDao.getDisplayEvents(event, interval, Locale.US, tz);

    assertEquals(1, events.size());
  }

  public net.fortuna.ical4j.model.DateTime getICal4jDate(DateTime date, DateTimeZone timezone) {
    net.fortuna.ical4j.model.DateTime ical = new net.fortuna.ical4j.model.DateTime(date.toDate());
    if (timezone != null) {
      ical.setTimeZone(tzRegistry.getTimeZone(timezone.getID()));
    }
    return ical;
  }
}