/**
    * 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.core.persistence;
  
  import org.figure8.join.util.SpringTestCase;
  import org.figure8.join.businessobjects.commons.Release;
  import org.figure8.join.businessobjects.commons.persistence.ReleaseDao;
  import org.figure8.join.businessobjects.artifact.Assembly;
  import org.figure8.join.businessobjects.artifact.Deliverable;
  import org.figure8.join.businessobjects.artifact.DeliverableType;
  import org.figure8.join.businessobjects.artifact.persistence.AssemblyDao;
  import org.figure8.join.businessobjects.artifact.persistence.DeliverableDao;
  import org.figure8.join.businessobjects.artifact.persistence.DeliverableTypeDao;
  
  import java.util.Date;
  import java.util.List;
  import java.util.Collection;
  import java.util.Iterator;
  import java.io.StringWriter;
  import java.io.InputStream;
  /**
   * JUnit test case for XmlDatabinder implementations
   * @author  <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   */
  public class XmlDatabinderTest extends SpringTestCase{
  
     // Static -------------------------------------------------------------------
  
     /** Spring configuration files */
     private String[] configLocations = new String[]{"classpath:/org/figure8/join/core/persistence/spring.xml"};
  
  
     // Attributes ---------------------------------------------------------------
  
     /** A ReleaseDao implementation that we need */
     protected ReleaseDao releDao = null;
     /** The DeliverableDao implementation to test */
     protected DeliverableDao delDao = null;
     /** A DeliverableTypeDao implementation that we need */
     protected DeliverableTypeDao typeDao = null;
     /** The AssemblyDao implementation that we need */
     protected AssemblyDao assemblyDao = null;
     /** The GenericHibernateObjectDao that we need */
     protected GenericHibernateObjectDao dao = null;
     /** The XmlDatadinder to test */
     protected XmlDatabinder binder = null;
  
  
     // Override of SpringTestCase -----------------------------------------------
  
     /** Retrieve daos after having initialized context */
     public void setUp(){
        super.setUp();
        // Get daos.
        releDao = (ReleaseDao)context.getBean("releaseDao");
        delDao = (DeliverableDao)context.getBean("deliverableDao");
        typeDao = (DeliverableTypeDao)context.getBean("deliverableTypeDao");
        assemblyDao = (AssemblyDao)context.getBean("assemblyDao");
        dao = (GenericHibernateObjectDao)context.getBean("genericObjectDao");
        binder = (XmlDatabinder)context.getBean("xmlDatabinder");
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** Test the export method of XmlDatabinder */
     public void testWriteToXml(){
        // Save a release, deliverables and a bunch of assemblies.
        Release release = new Release("101.0", 101, 0, new Date());
        DeliverableType foo = new DeliverableType("foo2Type", "Foo 2 Label", "foo2-{0}.{1}", true, true);
        DeliverableType bar = new DeliverableType("bar2Type", "Bar 2 Label", "bar2-{0}.{1}", true, false);
        Deliverable foo1 = new Deliverable("01", "comments", "supplier", release, foo);
        Deliverable bar1 = new Deliverable("01", "comments", "supplier", release, bar);
        releDao.save(release);
        typeDao.save(foo);
        typeDao.save(bar);
        delDao.save(foo1);
        delDao.save(bar1);
        Assembly assembly1 = new Assembly("1.0", "comments1", "fooId", release);
        assembly1.addDeliverable(foo1);
        assemblyDao.save(assembly1);
        Assembly assembly2 = new Assembly("2.0", "comments2", "barId", release);
        assembly2.addDeliverable(foo1);
        assembly2.addDeliverable(bar1);
        assemblyDao.save(assembly2);
        // Retrieve objects and assert.
       List objects = dao.findAll();
       assertEquals("All persistent objects are found", 7, objects.size());
       // Export objects as Xml.
       StringWriter writer = new StringWriter();
       try {binder.writeToXml(writer, dao);}
       catch (Exception e){
          fail("No exception should be thrown");
       }
       // Output and assert.
       String export = writer.toString();
       System.out.println(export);
       assertNotNull("Export string is not null", export);
       assertTrue("Export string is not empty", export.length() > 0);
    }
 
    /** Test the import method of XmlDatabinder */
    public void testLoadFromXml(){
       Collection entityObjects = null;
       InputStream is = getClass().getResourceAsStream("entities.xml");
       // Load entities.
       try {entityObjects = binder.loadFromXml(is);}
       catch (Exception e){
          fail("No exception shoud be thrown");
       }
       // Assert.
       assertNotNull("Imported collection is not null", entityObjects);
       assertEquals("Imported collection contains 4 entities", 4, entityObjects.size());
       // Try replicating each object.
       Iterator iterator = entityObjects.iterator();
       while (iterator.hasNext()){
          Object entity = iterator.next();
          dao.replicate(entity);
       }
       /*
       iterator = entityObjects.iterator();
       while (iterator.hasNext()){
          EntityObject entity = (EntityObject)iterator.next();
          System.err.println(entity.getClass() + " : " + entity.getId());
          if (entity instanceof Deliverable){
             System.err.println("\t Type: " + ((Deliverable)entity).getDeliverableType().getId());
             System.err.println("\t Assemblies: " + ((Assembly)((Deliverable)entity).getAssemblies().get(0)).getId());
          }
          if (entity instanceof Assembly){
             System.err.println("\t Release: " + ((Assembly)entity).getRelease().getId());
             System.err.println("\t Deliverables: " + ((Deliverable)((Assembly)entity).getDeliverables().values().iterator().next()).getId());
          }
       }
       */
    }
 
    /** Test the import method of XmlDatabinder for entities without ids */
    public void testLoadFromXmlWithoutId(){
       Collection entityObjects = null;
       InputStream is = getClass().getResourceAsStream("entities-woid.xml");
       // Load entities.
       try {entityObjects = binder.loadFromXml(is);}
       catch (Exception e){
          e.printStackTrace();
       }
       // Assert.
       assertNotNull("Imported collection is not null", entityObjects);
       assertEquals("Imported collection contains 2 entities", 2, entityObjects.size());
       // Try replicating each objects.
       Iterator iterator = entityObjects.iterator();
       while (iterator.hasNext()){
          Object entity = iterator.next();
          dao.replicate(entity);
       }
    }
 
 
    // Implementation of SpringTestCase -----------------------------------------
 
    /** @return configLocations inner field */
    public String[] getConfigLocations(){
       return configLocations;
    }
 }