/**
    * 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.commons.persistence;
  
  import org.figure8.join.util.SpringTestCase;
  import org.figure8.join.businessobjects.commons.Step;
  /**
   * JUnit test case for testing StepDao implementation.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.3 $
   */
  public class StepDaoTest extends SpringTestCase{
  
     // Static -------------------------------------------------------------------
  
     /** Spring configuration files */
     private String[] configLocations = new String[]{"classpath:/org/figure8/join/businessobjects/commons/persistence/spring.xml"};
  
  
     // Attributes ---------------------------------------------------------------
  
     /** The step dao implementation to test */
     protected StepDao dao = null;
  
  
     // Override of SpringTestCase -----------------------------------------------
  
     /** Retrieve Step dao after having initialized context */
     public void setUp(){
        super.setUp();
        // Get step dao.
        dao = (StepDao)context.getBean("stepDao");
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** Test Step creation */
     public void testStepCreation(){
        // Save a new step.
        Step step = new Step("firstStep", 1);
        int size = getStepListSize();
        dao.save(step);
        // Assert there's one step.
        assertEquals("Step is successfully created", size + 1, dao.findAll().size());
     }
  
     /** Test the getByPosition() method */
     public void testFindByPosition(){
        // Save a new step.
        Step step = new Step("secondStep", 2);
        int size = getStepListSize();
        dao.save(step);
        // Assert there's one step.
        assertEquals("Step is successfully created", size + 1, dao.findAll().size());
        // Retrieve step using position.
        Step foundStep = dao.getStepByPosition(2);
        assertNotNull("Found a step",  foundStep);
        assertEquals("Found a step with correct position", 2, foundStep.getPosition());
        assertEquals("Found a step with correct label", "secondStep", foundStep.getLabel());
     }
  
     /**
      * Test the pseudo definition of an integration cycle
      * and the enabling of cascade feature on DAO.
      */
     public void testCycleCreation(){
        int size = getStepListSize();
        // Save some associated steps.
        Step step3 = new Step("thirdStep", 3);
        Step step4 = new Step("fourthStep", 4);
        Step step5 = new Step("fithStep", 5);
        //step3.setNextStep(step4);
        //step4.setNextStep(step5);
        step4.setPreviousStep(step3);
        step5.setPreviousStep(step4);
        dao.save(step3);
        // Assert there's three more steps.
        assertEquals("Steps are successfully created", size + 3, dao.findAll().size());
        // Retrieve a step using its position.
        Step foundStep = dao.getStepByPosition(4);
        assertNotNull("Found a step",  foundStep);
        assertEquals("Found a step with correct position", 4, foundStep.getPosition());
        assertEquals("Found a step with correct next step", 5, foundStep.getNextStep().getPosition());
        assertEquals("Found a step with correct previous step", 3, foundStep.getPreviousStep().getPosition());
     }
  
    /** Test step insertion into a cycle */
    public void testStepInsertionInCycle(){
       int size = getStepListSize();
       // Save some associated steps.
       Step step7 = new Step("seventhStep", 7);
       Step step8 = new Step("eightStep", 8);
       Step step9 = new Step("ninethStep", 9);
       //step7.setNextStep(step8);
       //step8.setNextStep(step9);
       step8.setPreviousStep(step7);
       step9.setPreviousStep(step8);
       dao.save(step7);
       // Assert there's three more steps.
       assertEquals("Steps are successfully created", size + 3, dao.findAll().size());
       size = getStepListSize();
       // Insert step 7a before step 8.
       Step step7a = new Step("seventhStepA", 8);
       Step other = dao.getStepByPosition(8);
       other.shiftPosition();
       dao.save(other);      // 1/3
       dao.save(step7a);     // 2/3
       step7a.setPreviousStep(other.getPreviousStep());
       //step7a.setNextStep(other);
       other.setPreviousStep(step7a);
       dao.save(other);      // 3/3
       // Assert.
       assertEquals("Step is successfully created", size + 1, dao.findAll().size());
       assertEquals("Step has correct next step", "eightStep", step7a.getNextStep().getLabel());
       assertEquals("Step has correct next step", 9, step7a.getNextStep().getPosition());
       assertEquals("Step has correct previous step", "seventhStep", step7a.getPreviousStep().getLabel());
       assertEquals("Step has correct previous step", 7, step7a.getPreviousStep().getPosition());
    }
 
    /** Test the removal of a step */
    public void testStepRemoval(){
       // Save a new step.
       Step step = new Step("sixthStep", 6);
       int size = getStepListSize();
       dao.save(step);
       // Assert there's one step.
       assertEquals("Step is successfully created", size + 1, dao.findAll().size());
       // Remove and assert.
       dao.remove(step);
       assertEquals("Step is successfully removed", size, dao.findAll().size());
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /** Test the findAll on step */
    protected int getStepListSize(){
       return dao.findAll().size();
    }
 
 
    // Implementation of SpringTestCase -----------------------------------------
 
    /** @return configLocations inner field */
    public String[] getConfigLocations(){
       return configLocations;
    }
 }