EDIT

/**

* Copyright (C) 2010 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

*

* The contents of this file are subject to the Mozilla Public License Version 1.1

* See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.remote.dto.assembler.lsid;

import static org.junit.Assert.assertEquals;

import static org.junit.Assert.assertNotNull;

import static org.junit.Assert.assertNull;

import java.io.Serializable;

import java.lang.reflect.Field;

import java.lang.reflect.Method;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collection;

import java.util.HashSet;

import java.util.List;

import java.util.Set;

import java.util.UUID;

import org.apache.logging.log4j.LogManager;

import org.apache.logging.log4j.Logger;

import org.hibernate.Hibernate;

import org.hibernate.HibernateException;

import org.hibernate.LazyInitializationException;

import org.hibernate.collection.spi.PersistentCollection;

import org.hibernate.engine.spi.SessionImplementor;

import org.hibernate.engine.spi.SharedSessionContractImplementor;

import org.hibernate.proxy.HibernateProxy;

import org.hibernate.proxy.LazyInitializer;

import org.joda.time.DateTime;

import org.joda.time.DateTimeFieldType;

import org.joda.time.Partial;

import org.junit.Assert;

import org.junit.Before;

import org.junit.BeforeClass;

import org.junit.Test;

import org.unitils.UnitilsJUnit4;

import org.unitils.spring.annotation.SpringApplicationContext;

import org.unitils.spring.annotation.SpringBeanByType;

import com.github.dozermapper.core.Mapper;

import com.ibm.lsid.MalformedLSIDException;

import eu.etaxonomy.cdm.common.URI;

import eu.etaxonomy.cdm.model.agent.Person;

import eu.etaxonomy.cdm.model.agent.TeamOrPersonBase;

import eu.etaxonomy.cdm.model.common.Credit;

import eu.etaxonomy.cdm.model.common.IdentifiableSource;

import eu.etaxonomy.cdm.model.common.LSID;

import eu.etaxonomy.cdm.model.common.Language;

import eu.etaxonomy.cdm.model.common.LanguageString;

import eu.etaxonomy.cdm.model.common.VerbatimTimePeriod;

import eu.etaxonomy.cdm.model.description.Distribution;

import eu.etaxonomy.cdm.model.description.PresenceAbsenceTerm;

import eu.etaxonomy.cdm.model.description.TaxonDescription;

import eu.etaxonomy.cdm.model.description.TextData;

import eu.etaxonomy.cdm.model.location.NamedArea;

import eu.etaxonomy.cdm.model.name.INonViralName;

import eu.etaxonomy.cdm.model.name.Rank;

import eu.etaxonomy.cdm.model.name.TaxonNameFactory;

import eu.etaxonomy.cdm.model.reference.IBook;

import eu.etaxonomy.cdm.model.reference.INomenclaturalReference;

import eu.etaxonomy.cdm.model.reference.OriginalSourceBase;

import eu.etaxonomy.cdm.model.reference.Reference;

import eu.etaxonomy.cdm.model.reference.ReferenceFactory;

import eu.etaxonomy.cdm.model.taxon.Classification;

import eu.etaxonomy.cdm.model.taxon.SecundumSource;

import eu.etaxonomy.cdm.model.taxon.Synonym;

import eu.etaxonomy.cdm.model.taxon.SynonymType;

import eu.etaxonomy.cdm.model.taxon.Taxon;

import eu.etaxonomy.cdm.model.taxon.TaxonNode;

import eu.etaxonomy.cdm.model.taxon.TaxonRelationship;

import eu.etaxonomy.cdm.model.taxon.TaxonRelationshipType;

import eu.etaxonomy.cdm.model.term.DefaultTermInitializer;

import eu.etaxonomy.cdm.remote.dto.dwc.SimpleDarwinRecord;

import eu.etaxonomy.cdm.remote.dto.oaipmh.OaiDc;

import eu.etaxonomy.cdm.remote.dto.tdwg.voc.Relationship;

import eu.etaxonomy.cdm.remote.dto.tdwg.voc.SpeciesProfileModel;

import eu.etaxonomy.cdm.remote.dto.tdwg.voc.TaxonConcept;

import eu.etaxonomy.cdm.remote.dto.tdwg.voc.TaxonRelationshipTerm;

import eu.etaxonomy.cdm.remote.view.OaiPmhViewTest;

import net.sf.cglib.proxy.Enhancer;

import net.sf.cglib.proxy.MethodInterceptor;

import net.sf.cglib.proxy.MethodProxy;

@SpringApplicationContext("file:./target/test-classes/eu/etaxonomy/cdm/applicationContext-test.xml")

public class AssemblerTest extends UnitilsJUnit4 {

    public static final Logger logger = LogManager.getLogger(AssemblerTest.class);

    @SpringBeanByType

    private Mapper mapper;

    private Taxon taxon;

    private IBook sec;

    private IBook book;

    private Reference bookSection;

    private TeamOrPersonBase<?> authorship;

    private INonViralName name;

    private LSID lsid;

    private TaxonDescription taxonDescription;

    @BeforeClass

    public static void onSetUp() {

        DefaultTermInitializer defaultTermInitializer = new DefaultTermInitializer();

        defaultTermInitializer.initialize();

    }

    @Before

    public void setUp() throws Exception {

        lsid = new LSID("urn:lsid:example.org:taxonconcepts:1");

        authorship = Person.NewInstance();

        authorship.setTitleCache("authorship.titleCache", true);

        authorship.setLsid(new LSID("urn:lsid:dagg.org:agents:2"));

        name = TaxonNameFactory.NewBotanicalInstance(null);

        name.setNameCache("nameCache");

        INomenclaturalReference nomenclaturalReference = ReferenceFactory.newArticle();

        nomenclaturalReference.setTitleCache("nomenclaturalReference", true);

        name.setNomenclaturalReference(nomenclaturalReference);

        name.setNomenclaturalMicroReference("1");

        name.setAuthorshipCache("authorshipCache");

        name.setRank(Rank.SPECIES());

        sec = ReferenceFactory.newBook();

        sec.setAuthorship(authorship);

        sec.setTitleCache("sec.titleCache", true);

        sec.setLsid(new LSID("urn:lsid:example.org:references:1"));

        taxon = Taxon.NewInstance(name, (Reference)sec);

        taxon.setCreated(new DateTime(2004, 12, 25, 12, 0, 0, 0));

        taxon.setUpdated(new DateTime(2005, 12, 25, 12, 0, 0, 0));

        taxon.setTitleCache("titleCache", true);

        taxon.setLsid(lsid);

        for(int i = 2; i < 2+1; i++) {

            Taxon child = Taxon.NewInstance(name, (Reference)sec);

            child.setLsid(new LSID("urn:lsid:example.org:taxonconcepts:r0" + i ));

            child.addTaxonRelation(taxon, TaxonRelationshipType.TAXONOMICALLY_INCLUDED_IN(), null, null);

        }

        taxonDescription = TaxonDescription.NewInstance();

        taxon.addDescription(taxonDescription);

        TextData textData = TextData.NewInstance();

        Language english = Language.NewInstance();

        english.setIso639_1("en");

        Language french = Language.NewInstance();

        french.setIso639_1("fr");

        textData.getMultilanguageText().put(english, LanguageString.NewInstance("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce justo leo, tempus ultricies bibendum eu, interdum sit amet ipsum. Suspendisse eu odio in sem iaculis euismod. Suspendisse sed metus ante, in sodales risus. In sit amet magna sit amet risus elementum dapibus. Nullam in magna at mauris placerat sagittis. Proin urna nisl, porta at venenatis in, tristique tempus nisl. Proin vel arcu blandit velit vestibulum blandit. In at diam libero, vel malesuada mauris. Duis a enim diam. Donec urna dui, dictum at suscipit vel, consectetur quis est. In venenatis bibendum diam nec laoreet. ", english));

        textData.getMultilanguageText().put(french, LanguageString.NewInstance("Mauris elementum malesuada orci, non eleifend metus placerat ut. Aenean ornare felis sed lectus cursus id cursus nulla consectetur. Mauris magna justo, placerat id pretium posuere, ultrices et libero. Aliquam erat volutpat. Ut libero diam, interdum commodo fringilla sollicitudin, faucibus vel nisl. Fusce mattis justo interdum enim rhoncus eget sollicitudin dolor lobortis. Morbi mauris odio, tempus eget egestas eu, ornare vel ante. In quis placerat mi. Aliquam blandit tristique dictum. Donec pretium dui lacinia magna ornare eu venenatis ante dignissim. Integer ullamcorper tempus nisl et tincidunt. Curabitur vel nulla eu dolor faucibus porta. Mauris pulvinar est at est porta molestie. Nam varius nunc nec ipsum lacinia non egestas turpis congue. In at ipsum augue. Nulla mollis lobortis mauris ac sagittis. Nullam et facilisis lacus. Nam euismod sapien pellentesque lacus hendrerit dapibus. Aenean blandit rhoncus feugiat.", french));

        taxonDescription.addElement(textData);

        Distribution distribution = Distribution.NewInstance();

        NamedArea namedArea = NamedArea.NewInstance("Africa", "Africa", "Africa");

        namedArea.setTitleCache("Africa", true);

        distribution.setArea(namedArea);

        distribution.setStatus(PresenceAbsenceTerm.NATIVE());

        taxonDescription.addElement(distribution);

        // ------------------------------------------------------

        book = ReferenceFactory.newBook();

        book.setTitle("Book.title");

        book.setAuthorship(authorship);

        book.setCreated(new DateTime(2004, 12, 25, 12, 0, 0, 0));

        book.setDatePublished(VerbatimTimePeriod.NewVerbatimInstance(new Partial(DateTimeFieldType.year(), 1800)));

        book.setEdition("1st Edition");

        book.setEditor("Editor");

        book.setIsbn("isbn");

        book.setPlacePublished("placePublished");

        book.setPublisher("publisher");

        book.setReferenceAbstract("referenceAbstract");

        book.setUri(new URI("http://persitent.books.foo/myBook"));

        book.setUuid(UUID.randomUUID());

        book.setVolume("Volume 1");

        book.addSource(IdentifiableSource.NewDataImportInstance("http://persitent.IdentifiableSources.foo/1"));

        bookSection = ReferenceFactory.newBookSection();

        bookSection.setInReference((Reference)book);

        bookSection.setPages("999 ff.");

        bookSection.setTitle("BookSection.title");

        bookSection.setAuthorship(authorship);

        bookSection.setCreated(new DateTime(2004, 12, 25, 12, 0, 0, 0));

        bookSection.setDatePublished(VerbatimTimePeriod.NewVerbatimInstance(new Partial(DateTimeFieldType.year(), 1800)));

        bookSection.setReferenceAbstract("referenceAbstract");

        bookSection.setUri(new URI("http://persitent.books.foo/myBookSection"));

        bookSection.setUuid(UUID.randomUUID());

        bookSection.addCredit(Credit.NewInstance(authorship, null, "Credits to the authorship"));

        bookSection.addSource(IdentifiableSource.NewDataImportInstance("http://persitent.IdentifiableSources.foo/2"));

    }

    @Test

    public void testDeepMapping() throws MalformedLSIDException {

        if(!OaiPmhViewTest.dozerXsdIsAvailable()){

            return;

        }

        //synonyms

        for(int i = 1; i < 1+3; i++) {

            Synonym synonym = Synonym.NewInstance(name,(Reference)sec);

            synonym.setLsid(new LSID("urn:lsid:example.org:synyonms:" + i ));

            taxon.addSynonym(synonym, SynonymType.SYNONYM_OF());

        }

        //taxon nodes

        TaxonNode rootNode = Classification.NewInstance("Classification").getRootNode();

        TaxonNode parentNode = rootNode.addChildTaxon(taxon, null);

        for(int i = 11; i < 11+2; i++) {

            Taxon child = Taxon.NewInstance(name, (Reference)sec);

            child.setLsid(new LSID("urn:lsid:example.org:taxonconcepts:p" + i ));

            parentNode.addChildTaxon(child, null);

        }

        TaxonConcept taxonConcept = mapper.map(taxon, TaxonConcept.class);

        assertNotNull("map() should return an object", taxonConcept);

        assertEquals("IdentifiableEntity.titleCache should be copied into BaseThing.title",taxon.getTitleCache(),taxonConcept.getTitle());

        assertEquals("IdentifiableEntity.lsid should be copied into BaseThing.identifier",taxon.getLsid().toString(),taxonConcept.getIdentifier().toString());

        assertEquals("BaseThing.sameAs should refer to the proxy version of the lsid","http://lsid.example.org/" + taxon.getLsid().toString(),taxonConcept.getSameAs());

        assertEquals("CdmBase.created should be copied into BaseThing.created",new DateTime(2004, 12, 25, 12, 0, 0, 0),taxonConcept.getCreated());

        assertNotNull("TaxonBase.sec should be mapped into BaseThing.publishedInCitation",taxonConcept.getPublishedInCitation());

        assertEquals("TaxonBase.sec.titleCache should be mapped into BaseThing.publishedInCitation.title",sec.getTitleCache(),taxonConcept.getPublishedInCitation().getTitle());

        assertNotNull("TaxonBase.sec.authorship should be mapped into TaxonConcept.accordingTo",taxonConcept.getAccordingTo());

        assertEquals("TaxonBase.sec.authorship.titleCache should be mapped into TaxonConcept.accordingTo.title",authorship.getTitleCache(),taxonConcept.getAccordingTo().getTitle());

        assertNotNull("TaxonBase.name should be mapped to TaxonConcept.hasName",taxonConcept.getHasName());

        assertEquals("NonViralName.nameCache should be mapped to TaxonName.nameComplete",name.getNameCache(),taxonConcept.getHasName().getNameComplete());

        assertNotNull("Taxon.relationsToThisTaxon should be copied into TaxonConcept.hasRelationship",taxonConcept.getHasRelationship());

        assertEquals("There should be 6 relations in TaxonConcept.hasRelationship",

                6, taxonConcept.getHasRelationship().size());

        int nSynonyms = 0;

        int nIncludedInTaxa = 0;

        int pnParentTaxa = 0;

        for (Relationship rel : taxonConcept.getHasRelationship()){

            Assert.assertNotNull(rel.getFromTaxon());

//            System.out.println(rel.getFromTaxon().getIdentifier().toString());

            if (rel.getFromTaxon().getIdentifier().toString().startsWith("urn:lsid:example.org:synyonms:")){

                nSynonyms++;

            }else if (rel.getFromTaxon().getIdentifier().toString().startsWith("urn:lsid:example.org:taxonconcepts:r")){

                nIncludedInTaxa++;

            }else if (rel.getFromTaxon().getIdentifier().toString().startsWith("urn:lsid:example.org:taxonconcepts:p")){

                TaxonRelationshipTerm category = rel.getRelationshipCategory();

                Assert.assertEquals("is taxonomically included in", category.getTitle());

                pnParentTaxa++;

            }

//            System.out.println(rel);

        }

        Assert.assertEquals(3, nSynonyms);

        Assert.assertEquals(1, nIncludedInTaxa);

        Assert.assertEquals(2, pnParentTaxa);

    }

    @Test

    public void testLazyInitializationExceptionWithProxy() throws Exception {

        if(!OaiPmhViewTest.dozerXsdIsAvailable()){

            return;

        }

        IBook proxy = getUninitializedDetachedProxy(Reference.class,(Reference)sec);

        assert !Hibernate.isInitialized(proxy);

        SecundumSource source = taxon.getSecSource();

        Field secField = OriginalSourceBase.class.getDeclaredField("citation");

        secField.setAccessible(true);

        secField.set(source, proxy);

        TaxonConcept taxonConcept = mapper.map(taxon, TaxonConcept.class);

        assertNull("TaxonBase.sec was uninitialized, so TaxonConcept.publishedInCitation should be null",taxonConcept.getPublishedInCitation());

        assertNull("TaxonBase.sec was uninitialized, so TaxonConcept.accordingTo should be null",taxonConcept.getAccordingTo());

    }

    @Test

    public void testLazyInitializationExceptionWithPersistentCollection() throws Exception {

        if(!OaiPmhViewTest.dozerXsdIsAvailable()){

            return;

        }

        @SuppressWarnings("unchecked")

        Set<TaxonRelationship> proxy = getUninitializedPersistentCollection(

                HashSet.class,(HashSet<TaxonRelationship>)taxon.getRelationsToThisTaxon());

        assert !Hibernate.isInitialized(proxy);

        Field relationsToThisTaxonField = Taxon.class.getDeclaredField("relationsToThisTaxon");

        relationsToThisTaxonField.setAccessible(true);

        relationsToThisTaxonField.set(taxon, proxy);

        TaxonConcept taxonConcept = mapper.map(taxon, TaxonConcept.class);

        Assert.assertTrue("TaxonBase.relationsToThisTaxon was uninitialized, so TaxonConcept.hasRelationship should be null",

                taxonConcept.getHasRelationship() == null || taxonConcept.getHasRelationship().isEmpty()); //with taxonNode mapping included this results in null, otherwise empty, not yet checked why

    }

    @Test

    public void testSpeciesProfileModelMapping() {

        if(!OaiPmhViewTest.dozerXsdIsAvailable()){

            return;

        }

        SpeciesProfileModel speciesProfileModel = mapper.map(taxonDescription, SpeciesProfileModel.class);

        assertEquals(speciesProfileModel.getHasInformation().size(),2);

    }

    @Test

    public void testSimpleDarwinCoreMapping() {

        if(!OaiPmhViewTest.dozerXsdIsAvailable()){

            return;

        }

        SimpleDarwinRecord simpleDarwinRecord = mapper.map(taxon, SimpleDarwinRecord.class);

        mapper.map(taxon.getName(), simpleDarwinRecord);

        assertNotNull(simpleDarwinRecord.getModified());

        assertEquals(taxon.getName().getTitleCache(), simpleDarwinRecord.getScientificName());

        assertEquals(taxon.getName().getAuthorshipCache(), simpleDarwinRecord.getScientificNameAuthorship());

        assertEquals(taxon.getName().getCitationString(), simpleDarwinRecord.getNamePublishedIn());

        assertEquals(Rank.SPECIES().getLabel(), simpleDarwinRecord.getTaxonRank());

    }

    @Test

    public void testOAIDublinCoreMapping() {

        if(!OaiPmhViewTest.dozerXsdIsAvailable()){

            return;

        }

        OaiDc oaiDcRecordBook = mapper.map(book, OaiDc.class);

        assertEquals(book.getTitle(), oaiDcRecordBook.getTitle());

        OaiDc oaiDcRecordBookSection = mapper.map(bookSection, OaiDc.class);

        assertNotNull(oaiDcRecordBookSection.getRelation());

    }

    private <T extends Collection> T getUninitializedPersistentCollection(final Class<T> clazz, final T wrappedCollection) {

        final Enhancer enhancer = new Enhancer();

        List<Class> interfaces = new ArrayList<>();

        interfaces.addAll(Arrays.asList(clazz.getInterfaces()));

        interfaces.add(PersistentCollection.class);

        enhancer.setSuperclass(clazz);

        enhancer.setInterfaces(interfaces.toArray(new Class[interfaces.size()]));

        enhancer.setCallback( new MethodInterceptor() {

            @Override

            public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {

                if("wasInitialized".equals(method.getName())) {

                  return false;

                } else if(clazz.getDeclaredConstructor().equals(method)){

                     return proxy.invoke(obj, args);

                } else if("finalize".equals(method.getName())){

                     return proxy.invoke(obj, args);

                } else if("toString".equals(method.getName())) {

                    return wrappedCollection.toString();

                } else if("getClass".equals(method.getName())) {

                    return proxy.invoke(obj, args);

                } else if("hashCode".equals(method.getName())) {

                    return wrappedCollection.hashCode();

                }else if("initListener".equals(method.getName())) {

                    return null;

                } else {

                    throw new LazyInitializationException(null);

                }

            }

        });

        @SuppressWarnings("unchecked")

        T proxy = (T)enhancer.create();

        return proxy;

    }

    private <T> T getUninitializedDetachedProxy(final Class<T> clazz,final T wrappedClass) {

        final Enhancer enhancer = new Enhancer();

        List<Class> interfaces = new ArrayList<>();

        interfaces.addAll(Arrays.asList(clazz.getInterfaces()));

        interfaces.add(HibernateProxy.class);

        enhancer.setSuperclass(clazz);

        enhancer.setInterfaces(interfaces.toArray(new Class[interfaces.size()]));

        enhancer.setCallback( new MethodInterceptor() {

            @Override

            public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {

                if("getHibernateLazyInitializer".equals(method.getName())) {

                  return new UninitializedLazyInitializer();

                } else if(clazz.getDeclaredConstructor().equals(method)){

                     return proxy.invoke(obj, args);

                } else if("finalize".equals(method.getName())){

                     return proxy.invoke(obj, args);

                } else if("toString".equals(method.getName())) {

                    return wrappedClass.toString();

                } else if("getClass".equals(method.getName())) {

                    return proxy.invoke(obj, args);

                } else if("hashCode".equals(method.getName())) {

                    return wrappedClass.hashCode();

                } else if("initListener".equals(method.getName())) {

                    return null;

                } else {

                    throw new LazyInitializationException(null);

                }

            }

        });

        @SuppressWarnings("unchecked")

        T proxy = (T)enhancer.create();

        return proxy;

    }

    class UninitializedLazyInitializer implements LazyInitializer {

        @Override

        public  boolean isUninitialized() {

            return true;

        }

        @Override

        public String getEntityName() {

            // TODO Auto-generated method stub

            return null;

        }

        @Override

        public Serializable getIdentifier() {

            // TODO Auto-generated method stub

            return null;

        }

        @Override

        public Object getImplementation() {

            // TODO Auto-generated method stub

            return null;

        }

        @Override

        public Class<?> getPersistentClass() {

            // TODO Auto-generated method stub

            return null;

        }

        @Override

        public SessionImplementor getSession() {

            // TODO Auto-generated method stub

            return null;

        }

        @Override

        public void initialize() throws HibernateException {

            // TODO Auto-generated method stub

        }

        @Override

        public boolean isUnwrap() {

            // TODO Auto-generated method stub

            return false;

        }

        @Override

        public void setIdentifier(Serializable arg0) {

            // TODO Auto-generated method stub

        }

        @Override

        public void setImplementation(Object arg0) {

            // TODO Auto-generated method stub

        }

        @Override

        public void setUnwrap(boolean arg0) {

            // TODO Auto-generated method stub

        }

		@Override

		public Object getImplementation(

		        SharedSessionContractImplementor session)

				throws HibernateException {

			// TODO Auto-generated method stub

			return null;

		}

		@Override

		public boolean isReadOnlySettingAvailable() {

			// TODO Auto-generated method stub

			return false;

		}

		@Override

		public boolean isReadOnly() {

			// TODO Auto-generated method stub

			return false;

		}

		@Override

		public void setReadOnly(boolean readOnly) {

			// TODO Auto-generated method stub

		}

		@Override

		public void setSession(

		        SharedSessionContractImplementor session)

				throws HibernateException {

			// TODO Auto-generated method stub

		}

		@Override

		public void unsetSession() {

			// TODO Auto-generated method stub

		}

    }

}