/**
    * Copyright 2005-2008 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.commons.Target;
  import org.figure8.join.businessobjects.commons.persistence.TargetDao;
  import org.figure8.join.businessobjects.environment.Parameter;
  import org.figure8.join.businessobjects.environment.ParameterValue;
  import org.figure8.join.businessobjects.environment.PhysicalEnvironment;
  
  import java.util.List;
  /**
   * JUnit test case for testing ParameterValueDao implementation.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   */
  public class ParameterValueDaoTest extends SpringTestCase{
  
     // Static -------------------------------------------------------------------
  
     /** Spring configuration files */
     private String[] configLocations = new String[]{
        "classpath:/org/figure8/join/businessobjects/environment/persistence/spring.xml"};
  
  
     // Attributes ---------------------------------------------------------------
  
     /** The TargetDao we need for test fixture */
     protected TargetDao targetDao = null;
     /** The ParameterDao we need for test fixture */
     protected ParameterDao parameterDao = null;
     /** The PhysicalEnvDao we need for test fixture */
     protected PhysicalEnvironmentDao environmentDao = null;
  
     /** The ParameterValueDao implementation to test. */
     protected ParameterValueDao dao = null;
  
  
     // Override of SpringTestCase -----------------------------------------------
  
     /** Retrieve the daos we need after having initialized context */
     public void setUp(){
        super.setUp();
        // Get the DAOs we need.
        targetDao = (TargetDao)context.getBean("targetDao");
        parameterDao = (ParameterDao)context.getBean("parameterDao");
        environmentDao = (PhysicalEnvironmentDao)context.getBean("physicalEnvironmentDao");
        dao = (ParameterValueDao)context.getBean("parameterValueDao");
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** Test the ParameterValue creation */
     public void testParameterValueCreation(){
        // Create the objects we need.
        Target target = new Target("PVCreation", "description");
        Parameter param = new Parameter("PVCreation", "description");
        PhysicalEnvironment env = new PhysicalEnvironment("PVCreation", "PVCreation Env Name");
        targetDao.save(target);
        parameterDao.save(param);
        environmentDao.save(env);
        // Save a new ParameterValue.
        ParameterValue value = new ParameterValue("creation", param, target, env);
        int size = getParameterValueListSize();
        dao.save(value);
        // Assert there's one value.
        assertEquals("ParameterValue is successfully created", size + 1, dao.findAll().size());
     }
  
     /** Test the retrieval of current parameter values */
     public void testFindCurrentParameterValues(){
        // Create the objects we need.
        Target target = new Target("PVFindCurrent", "description");
        Parameter param1 = new Parameter("PVFindCurrent1", "description");
        Parameter param2 = new Parameter("PVFindCurrent2", "description");
        PhysicalEnvironment env = new PhysicalEnvironment("PVFindCurrent", "PVFindCurrent Env Name");
        targetDao.save(target);
        parameterDao.save(param1);
        parameterDao.save(param2);
        environmentDao.save(env);
        // Save some new ParameterValues.
        ParameterValue value1 = new ParameterValue("findCurrent1", param1, target, env);
        ParameterValue value2 = new ParameterValue("findCurrent2", param2, target, env);
        int size = getParameterValueListSize();
        dao.save(value1);
       dao.save(value2);
       // Assert there's two more values.
       assertEquals("ParameterValue are successfully created", size + 2, dao.findAll().size());
       // Retrieve current values.
       List values = dao.getCurrentParameterValues(env.getKey(), target.getName());
       assertNotNull("Found some current values", values);
       assertFalse("Found some non empty values", values.isEmpty());
       assertEquals("Found the two current values", 2, values.size());
 
       // Update a value and check currents.
       value2.setValue("findCurrent2-updated");
       dao.save(value2);
 
       // Retrieve current values.
       values = dao.getCurrentParameterValues(env.getKey(), target.getName());
       assertNotNull("Found some current values", values);
       assertFalse("Found some non empty values", values.isEmpty());
       assertEquals("Found the two current values", 2, values.size());
       for (int i=0; i < values.size(); i++){
          ParameterValue value = (ParameterValue)values.get(i);
          assertTrue("Value is one of current ones",
                  "findCurrent1".equals(value.getValue()) || "findCurrent2-updated".equals(value.getValue()));
       }
    }
 
    /** Test the retrieval of historical parameter values */
    public void testFindHistoricalParameterValues(){
       // Create the objects we need.
       Target target = new Target("PVFindHistorical", "description");
       Parameter param = new Parameter("PVFindHistorical", "description");
       PhysicalEnvironment env = new PhysicalEnvironment("PVFindHistorical", "PVFindHistorical Env Name");
       targetDao.save(target);
       parameterDao.save(param);
       environmentDao.save(env);
       // Save a new ParameterValue.
       ParameterValue value = new ParameterValue("findHistorical", param, target, env);
       int size = getParameterValueListSize();
       dao.save(value);
       // Assert there's one more values.
       assertEquals("ParameterValue is successfully created", size + 1, dao.findAll().size());
 
       // Simulate the update of the value and check historical.
       value.deprecate();
       dao.save(value);
       ParameterValue value2 = new ParameterValue("findHistorical-updated", param, target, env);
       dao.save(value2);
 
       // Retrieve current values.
       List values = dao.getHistoricalParameterValues(param, env.getKey());
       assertNotNull("Found some historical values", values);
       assertFalse("Found some non empty values", values.isEmpty());
       assertEquals("Found the historical values", 2, values.size());
       for (int i=0; i < values.size(); i++){
          ParameterValue foundValue = (ParameterValue)values.get(i);
          assertTrue("Value is one of historical ones", "findHistorical".equals(foundValue.getValue())
                                                          || "findHistorical-updated".equals(foundValue.getValue()));
       }
    }
 
    /** Test the removal of a ParameterValue */
    public void testParameterValueRemoval(){
 
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /** Test the findAll on parameter values */
    protected int getParameterValueListSize(){
       return dao.findAll().size();
    }
 
 
    // Implementation of SpringTestCase -----------------------------------------
 
    /** @return An array of Spring configuration files location. */
    public String[] getConfigLocations(){
       return configLocations;
    }
 }