/**
    * Copyright 2005-2006 the original author or authors.
    *
    * Licensed under the Gnu General Pubic 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.opensource.org/licenses/gpl-license.php
    *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   * See the Gnu General Public License for more details.
   */
  package org.figure8.join.businessobjects.environment.persistence;
  
  import org.figure8.join.util.SpringTestCase;
  import org.figure8.join.businessobjects.environment.ResourceVersion;
  import org.figure8.join.businessobjects.environment.VersionedResource;
  import org.figure8.join.businessobjects.environment.VersionedResourceType;
  import org.figure8.join.businessobjects.environment.VersionedResourceUpdate;
  
  import java.util.List;
  import java.util.Calendar;
  /**
   * JUnit test case for testing VersionedResourceUpdateDao implementation.
   * @author  <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   */
  public class VersionedResourceUpdateDaoTest extends SpringTestCase{
  
     // Static -------------------------------------------------------------------
  
     /** Spring configuration files */
     private String[] configLocations = new String[]{"classpath:/org/figure8/join/businessobjects/environment/persistence/spring.xml"};
  
  
     // Attributes ---------------------------------------------------------------
  
     /** The resource dao we need */
     private ResourceDao resourceDao = null;
     /** The resource type dao we need */
     private ResourceTypeDao resourceTypeDao = null;
     /** The resource version dao we need */
     private ResourceVersionDao resourceVersionDao = null;
     /** The resource update dao we test */
     private VersionedResourceUpdateDao dao = null;
  
  
     // Override of SpringTestCase -----------------------------------------------
  
     /** Retrieve the daos we need after having initialized context */
     public void setUp(){
        super.setUp();
        // Get the required daos.
        resourceDao = (ResourceDao)context.getBean("resourceDao");
        resourceTypeDao = (ResourceTypeDao)context.getBean("resourceTypeDao");
        resourceVersionDao = (ResourceVersionDao)context.getBean("resourceVersionDao");
        dao = (VersionedResourceUpdateDao)context.getBean("resourceUpdateDao");
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** Test the creation of resource udpate */
     public void testResourceUpdateCreation(){
        // Save objects we need.
        VersionedResourceType resType = new VersionedResourceType("resUpdTypeKey", "resUpdTypeLabel");
        resourceTypeDao.save(resType);
        VersionedResource res = new VersionedResource("resUpdKey", resType);
        resourceDao.save(res);
        ResourceVersion version = new ResourceVersion("verUpdName", "verUpdDescription", resType);
        resourceVersionDao.save(version);
        // Now create and save a resource update.
        VersionedResourceUpdate update = new VersionedResourceUpdate(version, res);
        int size = getResourceUpdateListSize();
        dao.save(update);
        // Assert there's one more resource update.
        assertEquals("ResourceUpdate is successfully created", size + 1, dao.findAll().size());
  
        // Remove and assert.
        dao.remove(update);
        assertEquals("ResourceUpdate is successfully removed", size, dao.findAll().size());
     }
  
     /** Test the retrieval of resource updates */
     public void testResourceUpdateRetrieval(){
        // Save objects we need.
        VersionedResourceType resType = new VersionedResourceType("resUpdRetTypeKey", "resUpdRetTypeLabel");
        resourceTypeDao.save(resType);
        VersionedResource res = new VersionedResource("resUpdRetKey", resType);
        resourceDao.save(res);
        ResourceVersion version1 = new ResourceVersion("verUpdRetName1", "verUpdRetDescription", resType);
        ResourceVersion version2 = new ResourceVersion("verUpdRetName2", "verUpdRetDescription", resType);
        resourceVersionDao.save(version1);
        resourceVersionDao.save(version2);
        // Now save a bunch of updates for resource.
        int size = getResourceUpdateListSize();
        VersionedResourceUpdate update1 = new VersionedResourceUpdate(version1, res);
       dao.save(update1);
       // Wait here to avoid end date == start date.
       Object semaphore = new Object();
       try {synchronized (semaphore) {semaphore.wait(1000);}}
       catch (Exception e) {}
       // Now close current update and create a new one.
       update1.close();
       dao.save(update1);
       VersionedResourceUpdate update2 = new VersionedResourceUpdate(version2, res);
       dao.save(update2);
       // Assert there's two more resource updates.
       assertEquals("ResourceUpdates are successfully created", size + 2, dao.findAll().size());
 
       // Retrieve updates of the day.
       Calendar startDate = Calendar.getInstance();
       startDate.set(Calendar.HOUR_OF_DAY, 0);
       startDate.set(Calendar.MINUTE, 1);
       Calendar endDate = Calendar.getInstance();
       endDate.set(Calendar.HOUR_OF_DAY, 23);
       endDate.set(Calendar.MINUTE, 59);
       List updates = dao.getVersionedResourceUpdatesForResource(res, startDate.getTime(), endDate.getTime());
       // Assert there's 2 updates done.
       assertEquals("Two ResourceUpdates done this day", 2, updates.size());
 
       // Retrieve updates from now till midnight (only one)
       updates = dao.getVersionedResourceUpdatesForResource(res, Calendar.getInstance().getTime(), endDate.getTime());
       assertEquals("One ResourceUpdate from now to midnight", 1, updates.size());
       assertEquals("Correct ResourceUpdate from now to midnight", update2.getId(), ((VersionedResourceUpdate)updates.get(0)).getId());
 
       // Retrieve update active at a special
       Calendar sd = Calendar.getInstance();
       sd.setTime(update1.getStartDate());
       sd.add(Calendar.MILLISECOND, 500);
       VersionedResourceUpdate foundUpdate = dao.getVersionedResourceUpdateForResource(res, sd.getTime());
       assertNotNull("One ResourceUpdate active some seconds ago", foundUpdate);
       assertEquals("Correct ResourceUpdate active some seconds ago", update1.getId(), foundUpdate.getId());
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /** Test the findAll() on dao */
    protected int getResourceUpdateListSize(){
       return dao.findAll().size();
    }
 
 
    // Implementation of SpringTestCase -----------------------------------------
 
    /** @return configLocations inner field */
    public String[] getConfigLocations(){
       return configLocations;
    }
 }