EDIT

/**

* Copyright (C) 2019 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.api.service.description;

import java.io.FileNotFoundException;

import java.math.BigDecimal;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.UUID;

import java.util.function.Function;

import java.util.stream.Collectors;

import org.apache.log4j.Logger;

import org.junit.Assert;

import org.junit.Before;

import org.junit.Test;

import org.unitils.dbunit.annotation.DataSet;

import org.unitils.dbunit.annotation.DataSets;

import org.unitils.spring.annotation.SpringBeanByType;

import eu.etaxonomy.cdm.api.application.ICdmRepository;

import eu.etaxonomy.cdm.api.service.IClassificationService;

import eu.etaxonomy.cdm.api.service.IDescriptionService;

import eu.etaxonomy.cdm.api.service.IDescriptiveDataSetService;

import eu.etaxonomy.cdm.api.service.IOccurrenceService;

import eu.etaxonomy.cdm.api.service.IReferenceService;

import eu.etaxonomy.cdm.api.service.ITaxonNodeService;

import eu.etaxonomy.cdm.api.service.ITaxonService;

import eu.etaxonomy.cdm.api.service.ITermService;

import eu.etaxonomy.cdm.api.service.ITermTreeService;

import eu.etaxonomy.cdm.api.service.IVocabularyService;

import eu.etaxonomy.cdm.api.service.UpdateResult;

import eu.etaxonomy.cdm.common.monitor.DefaultProgressMonitor;

import eu.etaxonomy.cdm.common.monitor.IProgressMonitor;

import eu.etaxonomy.cdm.filter.TaxonNodeFilter;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import eu.etaxonomy.cdm.model.occurrence.DerivedUnit;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;

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.Taxon;

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

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

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

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

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

import eu.etaxonomy.cdm.test.integration.CdmTransactionalIntegrationTest;

import eu.etaxonomy.cdm.test.unitils.CleanSweepInsertLoadStrategy;

/**

 * @author a.mueller

 * @since 21.11.2019

 */

public class StructuredDescriptionAggregationTest extends CdmTransactionalIntegrationTest {

    @SuppressWarnings("unused")

    private static Logger logger = Logger.getLogger(StructuredDescriptionAggregationTest.class);

    private static final UUID T_LAPSANA_UUID = UUID.fromString("f65d47bd-4f49-4ab1-bc4a-bc4551eaa1a8");

    private static final UUID TN_LAPSANA_UUID = UUID.fromString("f4d29e9f-6484-4184-af2e-9704e96a17e3");

    private static final UUID T_LAPSANA_COMMUNIS_UUID = UUID.fromString("2a5ceebb-4830-4524-b330-78461bf8cb6b");

    private static final UUID T_LAPSANA_COMMUNIS_COMMUNIS_UUID = UUID.fromString("441a3c40-0c84-11de-8c30-0800200c9a66");

    private static final UUID T_LAPSANA_COMMUNIS_ADENOPHORA_UUID = UUID.fromString("e4acf200-63b6-11dd-ad8b-0800200c9a66");

    private static final UUID T_LAPSANA_COMMUNIS_ALPINA_UUID = UUID.fromString("596b1325-be50-4b0a-9aa2-3ecd610215f2");

    private static final UUID CLASSIFICATION_UUID = UUID.fromString("4b266053-a841-4980-b548-3f21d8d7d712");

    private static final UUID T_LAPSANA_COMMUNIS_ALPINA_SPEC1_UUID = UUID.fromString("0de17403-aeef-4138-a220-9914e7c46f5a");

    private static final UUID T_LAPSANA_COMMUNIS_ALPINA_SPEC2_UUID = UUID.fromString("9e680e26-9e12-47a9-807c-743525c9171e");

    private static final UUID T_LAPSANA_COMMUNIS_ALPINA_SPEC3_UUID = UUID.fromString("3cdaa12f-7508-4073-b8d7-afca77a6be34");

    private static final UUID T_LAPSANA_COMMUNIS_ADENOPHORA_SPEC1_UUID = UUID.fromString("83788037-7a03-4e46-98ca-e8801096b216");

    private static final UUID uuidFeatureLeafPA = UUID.fromString("c4dfd16f-f2ed-45e0-8f4d-7fe1ae880510");

    private static UUID uuidFeatureLeafLength = UUID.fromString("3c19b50b-4a8e-467e-b7d4-89ebc05a33e1");

    private static UUID uuidFeatureLeafColor = UUID.fromString("1e8f503c-5aeb-4788-b4f9-84128f7141c7");

    private static UUID uuidFeatureLeafAdd = UUID.fromString("774b52a5-c16c-43e5-94e7-3946b506554d");

    private static UUID uuidLeafColorBlue = UUID.fromString("9b4df19d-f89d-4788-9d71-d1f6f7cae910");

    private static UUID uuidLeafColorYellow = UUID.fromString("4cf0881b-0e7b-489a-9fdb-adbe6ae4e0ae");

    private static UUID uuidFeatureTree = UUID.fromString("c8a29a94-2754-4d78-9faa-dff3e1387b2d");

    @SpringBeanByType

    private ICdmRepository repository;

    @SpringBeanByType

    private ITermService termService;

    @SpringBeanByType

    private ITermTreeService termTreeService;

    @SpringBeanByType

    private IVocabularyService vocabularyService;

    @SpringBeanByType

    private IDescriptionService descriptionService;

    @SpringBeanByType

    private ITaxonService taxonService;

    @SpringBeanByType

    private IOccurrenceService occurrenceService;

    @SpringBeanByType

    private ITaxonNodeService taxonNodeService;

    @SpringBeanByType

    private IClassificationService classificationService;

    @SpringBeanByType

    private IReferenceService referenceService;

    @SpringBeanByType

    private IDescriptiveDataSetService datasetService;

    private StructuredDescriptionAggregation engine;

    private IProgressMonitor monitor;

    @Before

    public void setUp() {

        engine = new StructuredDescriptionAggregation();

        engine.setBatchMinFreeHeap(35 * 1024 * 1024);

        monitor = DefaultProgressMonitor.NewInstance();

    }

    @Test

    @DataSets({

        @DataSet(loadStrategy=CleanSweepInsertLoadStrategy.class, value="/eu/etaxonomy/cdm/database/ClearDB_with_Terms_DataSet.xml"),

        @DataSet(value="/eu/etaxonomy/cdm/database/TermsDataSet-with_auditing_info.xml"),

        @DataSet(value="StructuredDescriptionAggregationTest.xml"),

    })

    public void testReaggregation(){

        createDefaultFeatureTree();

        DescriptiveDataSet dataSet = createTestData();

        commitAndStartNewTransaction();

        StructuredDescriptionAggregationConfiguration config = createConfig(dataSet);

        // 1st aggregation

        UpdateResult result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        addSomeDataToFirstAggregation();

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config).setWithAddedData());

        // 2nd aggregation => should be same as originally as data was only added to aggregation to see if it is correctly deleted

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        // reaggregate with an element having a feature not yet in the existing descriptions

        addNewFeature();

        commitAndStartNewTransaction();

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config).setWithFeature());

    }

    private void addSomeDataToFirstAggregation() {

        Taxon taxLapsanaCommunisAlpina = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ALPINA_UUID);

        TaxonDescription taxonDescription = taxLapsanaCommunisAlpina.getDescriptions().stream()

                .filter(desc->desc.getTypes().contains(DescriptionType.AGGREGATED_STRUC_DESC))

                .filter(desc->!desc.getTypes().contains(DescriptionType.CLONE_FOR_SOURCE))

                .findFirst().get();

        addCategoricalData(taxonDescription, uuidFeatureLeafPA, State.uuidPresent);

    }

    private void addNewFeature() {

        SpecimenOrObservationBase<?> spec1 = occurrenceService.find(T_LAPSANA_COMMUNIS_ADENOPHORA_SPEC1_UUID);

        SpecimenDescription specimenDescription = (SpecimenDescription)spec1.getDescriptions().stream()

                .filter(desc->!desc.getTypes().contains(DescriptionType.AGGREGATED_STRUC_DESC))

                .filter(desc->!desc.getTypes().contains(DescriptionType.CLONE_FOR_SOURCE))

                .findFirst().get();

        addQuantitativeData(specimenDescription, uuidFeatureLeafAdd, new BigDecimal("2.5"), new BigDecimal("3.6"));

    }

    @Test

    @DataSets({

        @DataSet(loadStrategy=CleanSweepInsertLoadStrategy.class, value="/eu/etaxonomy/cdm/database/ClearDB_with_Terms_DataSet.xml"),

        @DataSet(value="/eu/etaxonomy/cdm/database/TermsDataSet-with_auditing_info.xml"),

        @DataSet(value="StructuredDescriptionAggregationTest.xml"),

    })

    public void testDeleteTest() {

        createDefaultFeatureTree();

        DescriptiveDataSet dataSet = createTestData();

        commitAndStartNewTransaction();

        StructuredDescriptionAggregationConfiguration config = createConfig(dataSet);

        // 1st aggregation

        UpdateResult result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        removeSomeDataFromFirstAggregation();

        commitAndStartNewTransaction();

        Assert.assertEquals("Should have 3 specimen desc, 1 literature desc, 2 individual association holder, "

                + "4 aggregated descriptions, 4 cloned specimen descriptions (still not deleted), (0(3) cloned aggregated descriptions?) = 14",

                14, descriptionService.count(null));

        // 2nd aggregation

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config).setWithRemoved());

    }

    private void removeSomeDataFromFirstAggregation() {

        SpecimenOrObservationBase<?> spec3 = occurrenceService.find(T_LAPSANA_COMMUNIS_ALPINA_SPEC3_UUID);

        DescriptionBase<?> spec3Desc = spec3.getDescriptions().stream()

                .filter(desc->!desc.getTypes().contains(DescriptionType.CLONE_FOR_SOURCE))

                .findFirst().get();

        spec3.removeDescription(spec3Desc);

        descriptionService.delete(spec3Desc);

    }

    @Test

    @DataSets({

        @DataSet(loadStrategy=CleanSweepInsertLoadStrategy.class, value="/eu/etaxonomy/cdm/database/ClearDB_with_Terms_DataSet.xml"),

        @DataSet(value="/eu/etaxonomy/cdm/database/TermsDataSet-with_auditing_info.xml"),

        @DataSet(value="StructuredDescriptionAggregationTest.xml"),

    })

    public void testIncompleteQuantitativeData() {

        createDefaultFeatureTree();

        DescriptiveDataSet dataSet = DescriptiveDataSet.NewInstance();

        datasetService.save(dataSet);

        SpecimenDescription specDescAlpina1 = createSpecimenDescription(dataSet, T_LAPSANA_COMMUNIS_ALPINA_UUID, "alpina specimen1", T_LAPSANA_COMMUNIS_ALPINA_SPEC1_UUID);

        addQuantitativeData(specDescAlpina1, uuidFeatureLeafLength, StatisticalMeasure.MIN(), new BigDecimal("5.0"));

        SpecimenDescription specDescAlpina2 = createSpecimenDescription(dataSet, T_LAPSANA_COMMUNIS_ALPINA_UUID, "alpina specimen2", T_LAPSANA_COMMUNIS_ALPINA_SPEC2_UUID);

        addQuantitativeData(specDescAlpina2, uuidFeatureLeafLength, StatisticalMeasure.MAX(), new BigDecimal("7.0"));

        TaxonNode tnLapsana = taxonNodeService.find(TN_LAPSANA_UUID);

        Assert.assertNotNull(tnLapsana);

        dataSet.addTaxonSubtree(tnLapsana);

        @SuppressWarnings("unchecked")

        TermTree<Feature> descriptiveSystem = termTreeService.find(uuidFeatureTree);

        dataSet.setDescriptiveSystem(descriptiveSystem);

        commitAndStartNewTransaction();

        StructuredDescriptionAggregationConfiguration config = createConfig(dataSet);

        UpdateResult result = engine.invoke(config, repository);

        verifyStatusOk(result);

        Taxon taxLapsanaCommunisAlpina = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ALPINA_UUID);

        TaxonDescription aggrDescLapsanaCommunisAlpina = verifyTaxonDescriptions(taxLapsanaCommunisAlpina, 1);

        verifyQuantitativeData(uuidFeatureLeafLength, null, new BigDecimal("0.0"), new BigDecimal("7.0"), null, aggrDescLapsanaCommunisAlpina);

    }

    @Test

    @DataSets({

        @DataSet(loadStrategy=CleanSweepInsertLoadStrategy.class, value="/eu/etaxonomy/cdm/database/ClearDB_with_Terms_DataSet.xml"),

        @DataSet(value="/eu/etaxonomy/cdm/database/TermsDataSet-with_auditing_info.xml"),

        @DataSet(value="StructuredDescriptionAggregationTest.xml"),

    })

    public void testIncompleteCategoricalData() {

        //create data

        createDefaultFeatureTree();

        DescriptiveDataSet dataSet = DescriptiveDataSet.NewInstance();

        datasetService.save(dataSet);

        SpecimenDescription specDescAlpina1 = createSpecimenDescription(dataSet, T_LAPSANA_COMMUNIS_ALPINA_UUID, "alpina specimen1", T_LAPSANA_COMMUNIS_ALPINA_SPEC1_UUID);

        //create empty categorical data

        addCategoricalData(specDescAlpina1, uuidFeatureLeafColor, null);

        TaxonNode tnLapsana = taxonNodeService.find(TN_LAPSANA_UUID);

        Assert.assertNotNull(tnLapsana);

        dataSet.addTaxonSubtree(tnLapsana);

        @SuppressWarnings("unchecked")

        TermTree<Feature> descriptiveSystem = termTreeService.find(uuidFeatureTree);

        dataSet.setDescriptiveSystem(descriptiveSystem);

        commitAndStartNewTransaction();

        //aggregate

        StructuredDescriptionAggregationConfiguration config = createConfig(dataSet);

        UpdateResult result = engine.invoke(config, repository);

        //test aggregation with categorical data without states (empty categorical data)

        verifyStatusOk(result);

        Taxon taxLapsanaCommunisAlpina = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ALPINA_UUID);

        //if no state at all exists in description even the description is not created (this was different before but changed with xxx)

        verifyNumberTaxonDescriptions(taxLapsanaCommunisAlpina, 0);

        //add data for another feature

        specDescAlpina1 = (SpecimenDescription)descriptionService.find(specDescAlpina1.getUuid());

        addCategoricalData(specDescAlpina1, uuidFeatureLeafPA, State.uuidPresent);

        commitAndStartNewTransaction();

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        taxLapsanaCommunisAlpina = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ALPINA_UUID);

        TaxonDescription aggrDescLapsanaCommunisAlpina = verifyTaxonDescriptions(taxLapsanaCommunisAlpina, 1);

        verifyNumberDescriptionElements(aggrDescLapsanaCommunisAlpina, uuidFeatureLeafColor, 0);

//        List<StateData> sdAlpinaLeafColor = verifyCategoricalData(uuidFeatureLeafColor, 0, aggrDescLapsanaCommunisAlpina, false);

//        verifyState(sdAlpinaLeafColor, uuidLeafColorBlue, 0);

//        verifyState(sdAlpinaLeafColor, uuidLeafColorYellow, 0);

        //test duplicates

        specDescAlpina1 = (SpecimenDescription)descriptionService.find(specDescAlpina1.getUuid());

        addCategoricalData(specDescAlpina1, uuidFeatureLeafColor, uuidLeafColorBlue);

        addCategoricalData(specDescAlpina1, uuidFeatureLeafColor, uuidLeafColorBlue);

        commitAndStartNewTransaction();

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        taxLapsanaCommunisAlpina = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ALPINA_UUID);

        aggrDescLapsanaCommunisAlpina = verifyTaxonDescriptions(taxLapsanaCommunisAlpina, 2);  //for leafPA and for color

        List<StateData> sdAlpinaLeafColor = verifyCategoricalData(uuidFeatureLeafColor, 1, aggrDescLapsanaCommunisAlpina, false);

        verifyState(sdAlpinaLeafColor, uuidLeafColorBlue, 2);

        verifyState(sdAlpinaLeafColor, uuidLeafColorYellow, 0);

    }

    @Test

    @DataSets({

        @DataSet(loadStrategy=CleanSweepInsertLoadStrategy.class, value="/eu/etaxonomy/cdm/database/ClearDB_with_Terms_DataSet.xml"),

        @DataSet(value="/eu/etaxonomy/cdm/database/TermsDataSet-with_auditing_info.xml"),

        @DataSet(value="StructuredDescriptionAggregationTest.xml"),

    })

    public void testSourceModes() {

        createDefaultFeatureTree();

        DescriptiveDataSet dataSet = createTestData();

        commitAndStartNewTransaction();

        StructuredDescriptionAggregationConfiguration config = createConfig(dataSet);

        config.setWithinTaxonSourceMode(AggregationSourceMode.NONE);

        config.setToParentSourceMode(AggregationSourceMode.NONE);

        // 1st aggregation

        UpdateResult result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        config.setWithinTaxonSourceMode(AggregationSourceMode.DESCRIPTION);

        config.setToParentSourceMode(AggregationSourceMode.NONE);

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        config.setWithinTaxonSourceMode(AggregationSourceMode.NONE);

        config.setToParentSourceMode(AggregationSourceMode.DESCRIPTION);

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        config.setWithinTaxonSourceMode(AggregationSourceMode.DESCRIPTION);

        config.setToParentSourceMode(AggregationSourceMode.TAXON);

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        config.setWithinTaxonSourceMode(AggregationSourceMode.NONE);

        config.setToParentSourceMode(AggregationSourceMode.TAXON);

        result = engine.invoke(config, repository);

        verifyStatusOk(result);

        commitAndStartNewTransaction();

        verifyAggregatedDescription(new TestConfig(config));

        config.setWithinTaxonSourceMode(AggregationSourceMode.ALL);

        config.setToParentSourceMode(AggregationSourceMode.DESCRIPTION);

        result = engine.invoke(config, repository);

        verifyStatusError(result, "Unsupported source mode for within-taxon aggregation: ALL");

        commitAndStartNewTransaction();

        config.setWithinTaxonSourceMode(AggregationSourceMode.DESCRIPTION);

        config.setToParentSourceMode(AggregationSourceMode.ALL);

        result = engine.invoke(config, repository);

        verifyStatusError(result, "Unsupported source mode for to-parent aggregation: ALL");

        commitAndStartNewTransaction();

        config.setWithinTaxonSourceMode(AggregationSourceMode.ALL_SAMEVALUE);

        config.setToParentSourceMode(AggregationSourceMode.DESCRIPTION);

        result = engine.invoke(config, repository);

        verifyStatusError(result, "Unsupported source mode for within-taxon aggregation: ALL_SAMEVALUE");

        commitAndStartNewTransaction();

//        removeSomeDataFromFirstAggregation();

//        commitAndStartNewTransaction();

//        Assert.assertEquals("Should have 3 specimen desc, 1 literature desc, 2 individual association holder, "

//                + "4 aggregated descriptions, 4 cloned specimen descriptions (still not deleted), (3 cloned aggregated descriptions?) = 17",

//                17, descriptionService.count(null));

//

//        // 2nd aggregation

//        result = engine.invoke(config, repository);

//        testStatusOk(result);

//        commitAndStartNewTransaction();

//        testAggregatedDescription(false, false, true);

    }

    @Test

    @DataSets({

        @DataSet(loadStrategy=CleanSweepInsertLoadStrategy.class, value="/eu/etaxonomy/cdm/database/ClearDB_with_Terms_DataSet.xml"),

        @DataSet(value="/eu/etaxonomy/cdm/database/TermsDataSet-with_auditing_info.xml"),

        @DataSet(value="StructuredDescriptionAggregationTest.xml"),

    })

    public void testAggregation() {

        createDefaultFeatureTree();

        DescriptiveDataSet dataSet = createTestData();

        commitAndStartNewTransaction();

        StructuredDescriptionAggregationConfiguration config = createConfig(dataSet);

        UpdateResult result = engine.invoke(config, repository);

        commitAndStartNewTransaction();

        verifyStatusOk(result);

        verifyAggregatedDescription(new TestConfig(config));

        config.setIncludeLiterature(true);

        result = engine.invoke(config, repository);

        commitAndStartNewTransaction();

        verifyStatusOk(result);

        verifyAggregatedDescription(new TestConfig(config));

    }

    private void verifyStatusOk(UpdateResult result) {

        if (result.getStatus() != UpdateResult.Status.OK){

            Assert.fail("Aggregation should have status OK but was " + result.toString());

            for (Exception ex : result.getExceptions()){

                ex.printStackTrace();

            }

        }

    }

    private void verifyStatusError(UpdateResult result, String expectedMessage) {

        if (result.getStatus() != UpdateResult.Status.ERROR){

            Assert.fail("Aggregation should fail with status error " + result.toString());

        }

        if (result.getExceptions().isEmpty()){

            Assert.fail("Failing aggregation include exception " + result.toString());

        }

        Exception e = result.getExceptions().iterator().next();

        if (! (e instanceof AggregationException)){

            Assert.fail("Exception should be of type AggregationException " + result.toString());

        }else if (expectedMessage != null){

            Assert.assertEquals(expectedMessage, e.getMessage());

        }

    }

    private void addLiterature(DescriptiveDataSet dataSet) {

        //literature description

        Taxon taxon = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ALPINA_UUID);

        TaxonDescription literatureDescription = TaxonDescription.NewInstance(taxon);

        literatureDescription.addType(DescriptionType.SECONDARY_DATA);

        addQuantitativeData(literatureDescription, uuidFeatureLeafLength, new BigDecimal("4.5"), new BigDecimal("6.5"));

        addCategoricalData(literatureDescription, uuidFeatureLeafColor, uuidLeafColorBlue);

        dataSet.addDescription(literatureDescription);

    }

    private class TestConfig{

        boolean withAddedData;

        boolean withRemovedData;

        boolean withFeature;

        final boolean withLiterature;

        final boolean cloneAggSourceDesc;

        final AggregationSourceMode withinTaxonSourceMode;

        final AggregationSourceMode toParentSourceMode;

        private TestConfig(StructuredDescriptionAggregationConfiguration config) {

            withinTaxonSourceMode = config.getWithinTaxonSourceMode();

            toParentSourceMode = config.getToParentSourceMode();

            cloneAggSourceDesc = config.isCloneAggregatedSourceDescriptions();

            withLiterature = config.isIncludeLiterature();

        }

        private TestConfig setWithAddedData() {withAddedData = true; return this;}

        private TestConfig setWithRemoved() {withRemovedData = true; return this;}

        private TestConfig setWithFeature() {withFeature = true; return this;}

    }

    private void verifyAggregatedDescription(TestConfig config) {

        boolean withRemovedData = config.withRemovedData;

        boolean withLiterature = config.withLiterature;

        boolean withAddedData = config.withAddedData;

        boolean isWithinNone = config.withinTaxonSourceMode.isNone();

        boolean withFeature = config.withFeature;

        boolean isToParentNone = config.toParentSourceMode.isNone();

        boolean isToParentTaxon = config.toParentSourceMode.isTaxon();

        boolean cloneAggSourceDesc = config.cloneAggSourceDesc;

        int intDel = withRemovedData? -1 : 0;

        int intLit = withLiterature? 1 : 0;

        //L. communis alpina

        Taxon taxLapsanaCommunisAlpina = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ALPINA_UUID);

        int nElement = withAddedData ? 4 : 3;

        TaxonDescription aggrDescLapsanaCommunisAlpina = verifyTaxonDescriptions(taxLapsanaCommunisAlpina, nElement);

        List<StateData> stateData = verifyCategoricalData(uuidFeatureLeafPA, 1, aggrDescLapsanaCommunisAlpina, withAddedData);

        verifyState(stateData, State.uuidPresent, 3+intDel);

        List<StateData> sdAlpinaLeafColor = verifyCategoricalData(uuidFeatureLeafColor, 1, aggrDescLapsanaCommunisAlpina, false);

        int litLeafColorBlue = withLiterature? 1: 0;

        verifyState(sdAlpinaLeafColor, uuidLeafColorBlue, 2+litLeafColorBlue);

        verifyState(sdAlpinaLeafColor, uuidLeafColorYellow, 0);

        BigDecimal count = withLiterature? null : withRemovedData ? new BigDecimal("2"): new BigDecimal("3");

        BigDecimal avg = withLiterature? null : withRemovedData ? new BigDecimal("6"): new BigDecimal("6.666667");

        BigDecimal min = withLiterature? new BigDecimal("4.5") : new BigDecimal("5.0");

        BigDecimal max = withRemovedData ? new BigDecimal("7.0") : new BigDecimal("8.0");

        verifyQuantitativeData(uuidFeatureLeafLength, count, min, max, avg, aggrDescLapsanaCommunisAlpina);

        //... sources

        int nWithinSources = isWithinNone ? 0 : 3+intLit+intDel;

        Assert.assertEquals(nWithinSources, aggrDescLapsanaCommunisAlpina.getSources().size());

        SpecimenOrObservationBase<?> specLcommunisAlpina1 = CdmBase.deproxy(occurrenceService.find(T_LAPSANA_COMMUNIS_ALPINA_SPEC1_UUID));

        int nCloned = isWithinNone ? 0 : 1;

        Assert.assertEquals("Spec1 must have 2 descriptions now. The primary one and the cloned.", 1+nCloned, specLcommunisAlpina1.getSpecimenDescriptions().size());

        Assert.assertEquals(nCloned, specLcommunisAlpina1.getSpecimenDescriptions().stream().filter(d->d.isCloneForSource()).count());

        if (nCloned > 0){

            DescriptionBase<?> clonedDesc = specLcommunisAlpina1.getDescriptions().stream().filter(d->d.isCloneForSource()).findFirst().get();

            DescriptionBase<?> sourceDescription = getSingleSpecimenDescriptionSource(aggrDescLapsanaCommunisAlpina, T_LAPSANA_COMMUNIS_ALPINA_SPEC1_UUID);

            Assert.assertEquals(clonedDesc, sourceDescription);

        }

        //L. communis adenophora

        Taxon taxLapsanaCommunisAdenophora = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_ADENOPHORA_UUID);

        int nEl = withFeature ? 4 : 3;

        TaxonDescription aggrDescLapsanaCommunisAdenophora = verifyTaxonDescriptions(taxLapsanaCommunisAdenophora, nEl);

        verifyState(verifyCategoricalData(uuidFeatureLeafPA, 1, aggrDescLapsanaCommunisAdenophora, false), State.uuidPresent, 1);

        List<StateData> sdAdenophoraLeafColor = verifyCategoricalData(uuidFeatureLeafColor, 1, aggrDescLapsanaCommunisAdenophora, false);

        verifyState(sdAdenophoraLeafColor, uuidLeafColorBlue, 0);

        verifyState(sdAdenophoraLeafColor, uuidLeafColorYellow, 1);

        verifyQuantitativeData(uuidFeatureLeafLength, new BigDecimal("1"), new BigDecimal("10.0"),

                new BigDecimal("10.0"), new BigDecimal("10.0"), aggrDescLapsanaCommunisAdenophora);

        //L. communis

        Taxon taxLapsanaCommunis = (Taxon)taxonService.find(T_LAPSANA_COMMUNIS_UUID);

        TaxonDescription aggrDescLapsanaCommunis = verifyTaxonDescriptions(taxLapsanaCommunis, nEl);

        verifyState(verifyCategoricalData(uuidFeatureLeafPA, 1, aggrDescLapsanaCommunis, false), State.uuidPresent, 4+intDel);

        List<StateData> sdCommunisLeafColor = verifyCategoricalData(uuidFeatureLeafColor, 2, aggrDescLapsanaCommunis, false);

        verifyState(sdCommunisLeafColor, uuidLeafColorBlue, 2 + intLit);

        verifyState(sdCommunisLeafColor, uuidLeafColorYellow, 1);

        count = withLiterature? null : withRemovedData ? new BigDecimal("3") : new BigDecimal("4");

        avg = withLiterature? null : withRemovedData ? new BigDecimal("7.333333") : new BigDecimal("7.5");

        verifyQuantitativeData(uuidFeatureLeafLength, count, min,

                new BigDecimal("10.0"), avg, aggrDescLapsanaCommunis);

        //... sources

        int nToParent = isToParentNone ? 0 : 2;

        Assert.assertEquals(nToParent, aggrDescLapsanaCommunis.getSources().size());

        Map<UUID, List<TaxonDescription>> taxonDescriptionMap = getSourceTaxonDescriptionMap(aggrDescLapsanaCommunis);

        int nToParentDescs = isToParentTaxon? 0 : nToParent;

        Assert.assertEquals(nToParentDescs, taxonDescriptionMap.size());

        if (nToParentDescs > 0){

            Assert.assertEquals(1, taxonDescriptionMap.get(T_LAPSANA_COMMUNIS_ALPINA_UUID).size());

            Assert.assertEquals(1, taxonDescriptionMap.get(T_LAPSANA_COMMUNIS_ADENOPHORA_UUID).size());

            if (cloneAggSourceDesc){

                Assert.assertNotEquals(aggrDescLapsanaCommunisAlpina, taxonDescriptionMap.get(T_LAPSANA_COMMUNIS_ALPINA_UUID).get(0));

            }else{

                Assert.assertEquals(aggrDescLapsanaCommunisAlpina, taxonDescriptionMap.get(T_LAPSANA_COMMUNIS_ALPINA_UUID).get(0));

            }

        }else if (isToParentTaxon){

            Map<UUID, List<Taxon>> taxonToTaxonSourceMap = getSourceTaxonMap(aggrDescLapsanaCommunis);

            Assert.assertEquals(1, taxonToTaxonSourceMap.get(T_LAPSANA_COMMUNIS_ALPINA_UUID).size());

            Assert.assertEquals(1, taxonToTaxonSourceMap.get(T_LAPSANA_COMMUNIS_ADENOPHORA_UUID).size());

            Assert.assertEquals(taxLapsanaCommunisAlpina, taxonToTaxonSourceMap.get(T_LAPSANA_COMMUNIS_ALPINA_UUID).get(0));

        }

        //Lapsana

        Taxon taxLapsana = (Taxon)taxonService.find(T_LAPSANA_UUID);

        TaxonDescription aggrDescLapsana = verifyTaxonDescriptions(taxLapsana, nEl);

        verifyState(verifyCategoricalData(uuidFeatureLeafPA, 1, aggrDescLapsana, false), State.uuidPresent, 4+intDel);

        List<StateData> sdLapsanLeafColor = verifyCategoricalData(uuidFeatureLeafColor, 2, aggrDescLapsana, false);

        verifyState(sdLapsanLeafColor, uuidLeafColorBlue, 2 + intLit);

        verifyState(sdLapsanLeafColor, uuidLeafColorYellow, 1);

        verifyQuantitativeData(uuidFeatureLeafLength, count, min,

                new BigDecimal("10.0"), avg, aggrDescLapsana);

        //... sources

        nToParent = isToParentNone ? 0 : 1;

        Assert.assertEquals(nToParent, aggrDescLapsana.getSources().size());

        nToParentDescs = isToParentTaxon? 0 : nToParent;

        taxonDescriptionMap = getSourceTaxonDescriptionMap(aggrDescLapsana);

        Assert.assertEquals(nToParentDescs, taxonDescriptionMap.size());

        if (nToParentDescs > 0){

            Assert.assertEquals(1, taxonDescriptionMap.get(T_LAPSANA_COMMUNIS_UUID).size());

            if (cloneAggSourceDesc){

                Assert.assertNotEquals(aggrDescLapsanaCommunis, taxonDescriptionMap.get(T_LAPSANA_COMMUNIS_UUID).get(0));

            }else{

                Assert.assertEquals(aggrDescLapsanaCommunis, taxonDescriptionMap.get(T_LAPSANA_COMMUNIS_UUID).get(0));

            }

        }else if (isToParentTaxon){

            Map<UUID, List<Taxon>> taxonToTaxonSourceMap = getSourceTaxonMap(aggrDescLapsana);

            Assert.assertEquals(1, taxonToTaxonSourceMap.get(T_LAPSANA_COMMUNIS_UUID).size());

            Assert.assertEquals(taxLapsanaCommunis, taxonToTaxonSourceMap.get(T_LAPSANA_COMMUNIS_UUID).get(0));

        }

        //total description count

        nCloned = (isToParentNone || isToParentTaxon || !cloneAggSourceDesc ? 0 : 3) + (isWithinNone ? 0 : 4);

        Assert.assertEquals("Should have 4 specimen desc, 1 literature desc, 2 individual association holder, "

                + "4 aggregated descriptions, 4/0 cloned specimen descriptions, (3/4/0 cloned aggregated descriptions?) = 18/19",

                11+nCloned+intLit+(intDel*2), descriptionService.count(null));

    }

    //a map of the taxon uuid to the attached source descriptions

    private Map<UUID, List<TaxonDescription>> getSourceTaxonDescriptionMap(TaxonDescription desc) {

        return desc.getSources().stream().filter(s->(s.getCdmSource() instanceof TaxonDescription))

            .map(s->CdmBase.deproxy(s.getCdmSource(), TaxonDescription.class))

            .collect(Collectors.groupingBy(fDescToDescribedUuid));

    }

    private static Function<DescriptionBase<?>, UUID> fDescToDescribedUuid =

            ((Function<DescriptionBase<?>, IDescribable<?>>)(d->d.isInstanceOf(SpecimenDescription.class)? d.getDescribedSpecimenOrObservation(): CdmBase.deproxy(d, TaxonDescription.class).getTaxon()))

            .andThen(IDescribable::getUuid);

    //a map of the taxon to the attached taxon (source link)

    private Map<UUID, List<Taxon>> getSourceTaxonMap(TaxonDescription desc) {

        return desc.getSources().stream().filter(s->(s.getCdmSource() instanceof Taxon))

            .map(s->CdmBase.deproxy(s.getCdmSource(), Taxon.class))

            .collect(Collectors.groupingBy(t->t.getUuid()));

    }

    private DescriptionBase<?> getSingleSpecimenDescriptionSource(

            TaxonDescription aggrDescLapsanaCommunisAlpina, UUID specimenUuid) {

        Map<UUID, List<DescriptionBase<?>>> map = aggrDescLapsanaCommunisAlpina.getSources().stream()

            .map(src->(DescriptionBase<?>)src.getCdmSource())

            .filter(o-> o != null)

            .collect(Collectors.groupingBy(fDescToDescribedUuid));

        Assert.assertEquals(1, map.get(specimenUuid).size());

        return map.get(specimenUuid).get(0);

    }

    private StructuredDescriptionAggregationConfiguration createConfig(DescriptiveDataSet dataSet) {

        TaxonNodeFilter filter = TaxonNodeFilter.NewSubtreeInstance(TN_LAPSANA_UUID);

        StructuredDescriptionAggregationConfiguration config =

                StructuredDescriptionAggregationConfiguration.NewInstance(filter, monitor);

        config.setDatasetUuid(dataSet.getUuid());

        config.setAggregationMode(AggregationMode.byWithinTaxonAndToParent());

        config.setIncludeLiterature(false);

        config.setToParentSourceMode(AggregationSourceMode.DESCRIPTION);  //test where written against DESCRIPTION at the beginning so we use this as default for the tests

        return config;

    }

    private DescriptiveDataSet createTestData() {

        DescriptiveDataSet dataSet = DescriptiveDataSet.NewInstance();

        dataSet.setLabel("Test dataset");

        datasetService.save(dataSet);

        //L. communis alpina spec1

        SpecimenDescription specDescAlpina1 = createSpecimenDescription(dataSet, T_LAPSANA_COMMUNIS_ALPINA_UUID, "alpina specimen1", T_LAPSANA_COMMUNIS_ALPINA_SPEC1_UUID);

        addCategoricalData(specDescAlpina1, uuidFeatureLeafPA, State.uuidPresent);

        addQuantitativeData(specDescAlpina1, uuidFeatureLeafLength, StatisticalMeasure.EXACT_VALUE(), new BigDecimal("5.0"));

        addCategoricalData(specDescAlpina1, uuidFeatureLeafColor, uuidLeafColorBlue);

        //L. communis alpina spec2

        SpecimenDescription specDescAlpina2 = createSpecimenDescription(dataSet, T_LAPSANA_COMMUNIS_ALPINA_UUID, "alpina specimen2", T_LAPSANA_COMMUNIS_ALPINA_SPEC2_UUID);

        addCategoricalData(specDescAlpina2, uuidFeatureLeafPA, State.uuidPresent);

        addQuantitativeData(specDescAlpina2, uuidFeatureLeafLength, StatisticalMeasure.EXACT_VALUE(), new BigDecimal("7.0"));

        addCategoricalData(specDescAlpina2, uuidFeatureLeafColor, uuidLeafColorBlue);

        //L. communis alpina spec3

        SpecimenDescription specDescAlpina3 = createSpecimenDescription(dataSet, T_LAPSANA_COMMUNIS_ALPINA_UUID, "alpina specimen3", T_LAPSANA_COMMUNIS_ALPINA_SPEC3_UUID);

        addCategoricalData(specDescAlpina3, uuidFeatureLeafPA, State.uuidPresent);

        addQuantitativeData(specDescAlpina3, uuidFeatureLeafLength, StatisticalMeasure.EXACT_VALUE(), new BigDecimal("8.0"));

        //L. communis adenophora

        SpecimenDescription specDescAdenophora = createSpecimenDescription(dataSet, T_LAPSANA_COMMUNIS_ADENOPHORA_UUID, "adenophora specimen", T_LAPSANA_COMMUNIS_ADENOPHORA_SPEC1_UUID);

        addCategoricalData(specDescAdenophora, uuidFeatureLeafPA, State.uuidPresent);

        addQuantitativeData(specDescAdenophora, uuidFeatureLeafLength, StatisticalMeasure.EXACT_VALUE(), new BigDecimal("10.0"));

        addCategoricalData(specDescAdenophora, uuidFeatureLeafColor, uuidLeafColorYellow);

        TaxonNode tnLapsana = taxonNodeService.find(TN_LAPSANA_UUID);

        Assert.assertNotNull(tnLapsana);

        dataSet.addTaxonSubtree(tnLapsana);

        @SuppressWarnings("unchecked")

        TermTree<Feature> descriptiveSystem = termTreeService.find(uuidFeatureTree);

        dataSet.setDescriptiveSystem(descriptiveSystem);

        addLiterature(dataSet);

        return dataSet;

    }

    private TaxonDescription verifyTaxonDescriptions(Taxon taxon, int elementCount){