eu.etaxonomy.taxeditor.test/src/test/java/eu/etaxonomy/taxeditor/session/CdmEntitySessionAwareTest.java

   1 // $Id$
   2 /**
   3  * Copyright (C) 2014 EDIT
   4  * European Distributed Institute of Taxonomy
   5  * http://www.e-taxonomy.eu
   6  *
   7  * The contents of this file are subject to the Mozilla Public License Version 1.1
   8  * See LICENSE.TXT at the top of this package for the full license terms.
   9  */
  10 package eu.etaxonomy.taxeditor.session;
  11
  12 import java.util.ArrayList;
  13 import java.util.Iterator;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.Set;
  17 import java.util.UUID;
  18
  19 import org.apache.log4j.Logger;
  20 import org.hibernate.collection.spi.PersistentCollection;
  21 import org.junit.Assert;
  22 import org.junit.BeforeClass;
  23 import org.junit.Ignore;
  24 import org.junit.Test;
  25 import org.unitils.dbunit.annotation.DataSet;
  26
  27 import eu.etaxonomy.cdm.api.application.CdmApplicationState;
  28 import eu.etaxonomy.cdm.api.service.ICommonService;
  29 import eu.etaxonomy.cdm.api.service.IPolytomousKeyNodeService;
  30 import eu.etaxonomy.cdm.api.service.IPolytomousKeyService;
  31 import eu.etaxonomy.cdm.api.service.ITaxonService;
  32 import eu.etaxonomy.cdm.api.service.ITermService;
  33 import eu.etaxonomy.cdm.api.service.IUserService;
  34 import eu.etaxonomy.cdm.api.service.IVocabularyService;
  35 import eu.etaxonomy.cdm.model.agent.AgentBase;
  36 import eu.etaxonomy.cdm.model.agent.Person;
  37 import eu.etaxonomy.cdm.model.common.CdmBase;
  38 import eu.etaxonomy.cdm.model.common.Credit;
  39 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
  40 import eu.etaxonomy.cdm.model.common.Extension;
  41 import eu.etaxonomy.cdm.model.common.IdentifiableSource;
  42 import eu.etaxonomy.cdm.model.common.Language;
  43 import eu.etaxonomy.cdm.model.common.LanguageString;
  44 import eu.etaxonomy.cdm.model.common.TermType;
  45 import eu.etaxonomy.cdm.model.common.TermVocabulary;
  46 import eu.etaxonomy.cdm.model.description.KeyStatement;
  47 import eu.etaxonomy.cdm.model.description.PolytomousKey;
  48 import eu.etaxonomy.cdm.model.description.PolytomousKeyNode;
  49 import eu.etaxonomy.cdm.model.media.Rights;
  50 import eu.etaxonomy.cdm.model.taxon.Taxon;
  51 import eu.etaxonomy.taxeditor.httpinvoker.RemotingSessionAwareTest;
  52
  53 /**
  54  * @author cmathew
  55  * @date 7 Oct 2014
  56  *
  57  */
  58 @DataSet
  59 public class CdmEntitySessionAwareTest extends RemotingSessionAwareTest {
  60
  61     private static final Logger logger = Logger.getLogger(CdmEntitySessionAwareTest.class);
  62
  63     UUID polytomousKeyUuid = UUID.fromString("0d53ba20-7de4-4baa-bd8a-401048447d66");
  64     UUID subKeyUuid = UUID.fromString("9d8bf4f6-a70a-4b80-8556-2ccfb436ff01");
  65     //UUID polytomousKeyUuid = UUID.fromString("bab66772-2c83-428a-bb6d-655d12ac6097");
  66     UUID taxon1Uuid = UUID.fromString("2b336df7-29e8-4f79-985f-66502739d22f");
  67     UUID personUuid = UUID.fromString("945d08f2-eb92-45b6-9252-6275ea6d338b");
  68
  69
  70
  71     IPolytomousKeyService polytomousKeyService = getRemoteApplicationController().getPolytomousKeyService();
  72     IPolytomousKeyNodeService polytomousKeyNodeService = getRemoteApplicationController().getPolytomousKeyNodeService();
  73     ICommonService commonService = getRemoteApplicationController().getCommonService();
  74     ITaxonService taxonService = getRemoteApplicationController().getTaxonService();
  75     IVocabularyService vocabularyService = getRemoteApplicationController().getVocabularyService();
  76     ITermService termService = getRemoteApplicationController().getTermService();
  77     IUserService userService = getRemoteApplicationController().getUserService();
  78
  79     //Language english = Language.getLanguageFromUuid(Language.uuidEnglish);
  80
  81
  82
  83     @BeforeClass
  84     public static void initializePolytomousKeyTest() {
  85     }
  86
  87
  88     @Test
  89     public void readAllPolytomousKeys() {
  90         List<PolytomousKey> pKeys = polytomousKeyService.list(PolytomousKey.class, null, null, null, null);
  91         Iterator<PolytomousKey> pKeysItr = pKeys.iterator();
  92         Assert.assertEquals(pKeysItr.next().getUuid(),UUID.fromString("9d8bf4f6-a70a-4b80-8556-2ccfb436ff01"));
  93         Assert.assertEquals(pKeysItr.next().getUuid(),UUID.fromString("0d53ba20-7de4-4baa-bd8a-401048447d66"));
  94     }
  95
  96
  97     @Test
  98     //@DataSet("PolytomousKeyTest.readPolytmousKeyData.xml")
  99     public void readPolytmousKeyData() {
 100         PolytomousKey pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 101         Set<Taxon> taxonomicScope = pKey.getTaxonomicScope();
 102         Iterator<Taxon> tsItr = taxonomicScope.iterator();
 103         Taxon taxon = tsItr.next();
 104
 105         Assert.assertEquals("Achillea sec. Cyprus", taxon.getTitleCache());
 106         Assert.assertEquals(tsItr.hasNext(), false);
 107
 108         List<Credit> credits = pKey.getCredits();
 109         AgentBase agent = credits.get(0).getAgent();
 110         Assert.assertEquals(agent.getId(),4809);
 111         Assert.assertEquals(agent.getTitleCache(),"R. A. Graham");
 112         Assert.assertEquals(credits.get(0).getText(),"Credits Text Test");
 113
 114         Set<Extension> exts = pKey.getExtensions();
 115         Iterator<Extension> extItr = exts.iterator();
 116         Extension ext = extItr.next();
 117         Assert.assertEquals(ext.getValue(), "http://test.com");
 118
 119         Set<Rights> rights = pKey.getRights();
 120         Iterator<Rights> rightsItr = rights.iterator();
 121         Rights right = rightsItr.next();
 122         Assert.assertEquals(right.getText(),"Rights Text Test");
 123
 124         Set<IdentifiableSource> sources = pKey.getSources();
 125         Iterator<IdentifiableSource> sourcesItr = sources.iterator();
 126         IdentifiableSource source = sourcesItr.next();
 127         Assert.assertEquals(source.getId(), 23710);
 128         source = sourcesItr.next();
 129         Assert.assertEquals(source.getId(), 23711);
 130
 131         // TO DO : Added tests for Annotations , Markers
 132     }
 133
 134
 135
 136     @Test
 137     public void readPolytomousKeyDataFromNodes() {
 138         PolytomousKey pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 139         PolytomousKeyNode rootNode = pKey.getRoot();
 140
 141
 142         Assert.assertEquals(rootNode.getId(), 2750);
 143
 144         Assert.assertEquals(rootNode.getChildAt(0).getId(), 2751);
 145         Assert.assertEquals(rootNode.getChildAt(0).getParent().getId(), rootNode.getId());
 146         Assert.assertEquals(rootNode.getKey().getId(), pKey.getId());
 147         Integer sortIndex = (Integer)getFieldValueViaReflection(rootNode.getChildAt(0), "sortIndex");
 148         Assert.assertEquals(sortIndex, new Integer(0));
 149         String statement = "Capitula without ligulate ray-florets; leaves entire or subentire";
 150         Assert.assertEquals(rootNode.getChildAt(0).getStatement().getLabelText(Language.ENGLISH()), statement);
 151
 152         Assert.assertEquals(rootNode.getChildAt(1).getId(), 2753);
 153         Assert.assertEquals(rootNode.getChildAt(1).getParent().getId(), rootNode.getId());
 154         Assert.assertEquals(rootNode.getChildAt(1).getKey().getId(), pKey.getId());
 155         sortIndex = (Integer)getFieldValueViaReflection(rootNode.getChildAt(1), "sortIndex");
 156         Assert.assertEquals(sortIndex, new Integer(1));
 157         statement = "Capitula with ligulate ray-florets; leaves pinnatisect";
 158         Assert.assertEquals(rootNode.getChildAt(1).getStatement().getLabelText(Language.ENGLISH()), statement);
 159
 160         Assert.assertEquals(rootNode.getChildAt(1).getChildAt(0).getId(), 2754);
 161         Assert.assertEquals(rootNode.getChildAt(1).getChildAt(0).getParent().getId(), rootNode.getChildAt(1).getId());
 162         Assert.assertEquals(rootNode.getChildAt(1).getChildAt(0).getKey().getId(), pKey.getId());
 163         sortIndex = (Integer)getFieldValueViaReflection(rootNode.getChildAt(1).getChildAt(0), "sortIndex");
 164         Assert.assertEquals(sortIndex, new Integer(0));
 165         statement = "Ray-florets yellow";
 166         Assert.assertEquals(rootNode.getChildAt(1).getChildAt(0).getStatement().getLabelText(Language.ENGLISH()), statement);
 167         Assert.assertEquals(rootNode.getChildAt(1).getChildAt(0).getChildAt(0).getTaxon().getTitleCache(), "Achillea arabica Kotschy sec. Cyprus");
 168     }
 169
 170     @Test
 171     public void addGreatGrandChildPolytomousKeyNode() {
 172
 173         PolytomousKey pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 174         PolytomousKeyNode rootChildNode = pKey.getRoot().getChildAt(0);
 175         PolytomousKeyNode grandChildNode = PolytomousKeyNode.NewInstance();
 176         rootChildNode.addChild(grandChildNode);
 177
 178         grandChildNode = polytomousKeyNodeService.merge(grandChildNode);
 179
 180         PolytomousKeyNode greatGrandChildNode = PolytomousKeyNode.NewInstance();
 181         grandChildNode.addChild(greatGrandChildNode);
 182
 183         Assert.assertFalse(pKey.getRoot().getChildAt(0).getChildAt(0).getId() == 0);
 184     }
 185
 186     @Test
 187     public void savePolytomousKeyNodeData() {
 188         PolytomousKey pkey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 189
 190         PolytomousKeyNode pkeynode = pkey.getRoot();
 191         String newQuestion = "New Question";
 192         String newStatement = "New Statement";
 193
 194         Assert.assertEquals("Question 1",pkeynode.getQuestion().getLabel().get(Language.ENGLISH()).getText());
 195         for(PolytomousKeyNode node : pkeynode.getChildren()) {
 196
 197             node.setQuestion(null);
 198             node.setStatement(null);
 199         }
 200         //FIXME:Remoting Add tests for feature after fixing problem
 201
 202         //Feature feature = pkeynode.getFeature();
 203         //Assert.assertEquals(feature.getTitleCache(),"Systematics");
 204         //pkeynode.setFeature(null);
 205
 206         Assert.assertEquals(pkeynode.getChildAt(0).getModifyingText().get(Language.ENGLISH()).getText(),"Modifying Text 1a");
 207         String modifyingText = "Modifying Text 1a updated";
 208
 209         //pkeynode.getChildAt(0).putModifyingText(Language.ENGLISH(), modifyingText);
 210
 211         Assert.assertEquals(pkeynode.getChildAt(0).getSubkey().getId(),751);
 212         Assert.assertEquals("Asphodeline", pkeynode.getChildAt(0).getSubkey().getTitleCache());
 213         Assert.assertNull(pkeynode.getChildAt(1).getTaxon());
 214         Taxon taxon = CdmBase.deproxy(taxonService.find(taxon1Uuid),Taxon.class);
 215         pkeynode.getChildAt(1).setTaxon(taxon);
 216
 217         polytomousKeyService.merge(pkey);
 218
 219         pkey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 220
 221
 222         pkeynode = pkey.getRoot();
 223         for(PolytomousKeyNode node : pkeynode.getChildren()) {
 224             Assert.assertNull(node.getQuestion());
 225             node.setQuestion(KeyStatement.NewInstance(Language.ENGLISH(),newQuestion));
 226             Assert.assertNull(node.getStatement());
 227             node.setStatement(KeyStatement.NewInstance(Language.ENGLISH(),newStatement));
 228         }
 229
 230         Assert.assertEquals(pkeynode.getChildAt(1).getTaxon(), taxon);
 231
 232         polytomousKeyService.merge(pkey);
 233
 234         pkey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 235
 236         pkeynode = pkey.getRoot();
 237         for(PolytomousKeyNode node : pkeynode.getChildren()) {
 238             Assert.assertNotNull(node.getQuestion());
 239             Map<Language, LanguageString> label = node.getQuestion().getLabel();
 240             Assert.assertEquals(newQuestion, label.get(Language.ENGLISH()).getText());
 241             Assert.assertNotNull(node.getStatement());
 242             Assert.assertEquals(newStatement, node.getStatement().getLabel(Language.ENGLISH()).getText());
 243         }
 244         //Assert.assertEquals(pkeynode.getFeature().getId(), feature.getId());
 245
 246     }
 247
 248
 249     @Test
 250     public void savePolytomousKeyNodeDataWithSameSubKey() {
 251
 252         PolytomousKey pkey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 253
 254
 255         PolytomousKeyNode pkeynode = pkey.getRoot();
 256
 257         PolytomousKey subkey1 = CdmBase.deproxy(pkeynode.getChildAt(0).getSubkey(), PolytomousKey.class);
 258         String subkey1title = subkey1.getTitleCache();
 259         subkey1.setTitleCache(subkey1title + "test", true);
 260
 261
 262         PolytomousKey subkey2 = CdmBase.deproxy(pkeynode.getChildAt(1).getChildAt(0).getSubkey(), PolytomousKey.class);
 263         String subkey2title = subkey2.getTitleCache();
 264         subkey2.setTitleCache(subkey2title + "test", true);
 265
 266         Assert.assertSame(subkey1, subkey2);
 267
 268         polytomousKeyService.merge(pkey);
 269     }
 270
 271     @Test
 272     public void savePolytomousKeyNodeDataWithSameSubKeyUsingService() {
 273
 274         PolytomousKey pkey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 275
 276
 277         PolytomousKeyNode pkeynode = pkey.getRoot();
 278
 279         PersistentCollection children = (PersistentCollection) pkeynode.getChildren();
 280         PolytomousKeyNode childNode0 = (PolytomousKeyNode)commonService.get(pkeynode.getUuid(), "children", 0);
 281         PolytomousKey subkey1 = CdmBase.deproxy(childNode0.getSubkey(),PolytomousKey.class);
 282         String subkey1title = subkey1.getTitleCache();
 283         subkey1.setTitleCache(subkey1title + "test", true);
 284
 285         PolytomousKeyNode childNode1 = (PolytomousKeyNode)commonService.get(pkeynode.getUuid(), "children", 1);
 286         PolytomousKey subkey2 = CdmBase.deproxy(childNode1.getSubkey(),PolytomousKey.class);
 287         String subkey2title = subkey2.getTitleCache();
 288         subkey2.setTitleCache(subkey2title + "test", true);
 289
 290         Assert.assertNotSame(childNode0, childNode1);
 291
 292         Assert.assertSame(subkey1, subkey2);
 293
 294         polytomousKeyService.merge(pkey);
 295     }
 296
 297
 298
 299     @Test
 300     public void savePolytomousKeyNodeDataWithSameLanguageInLabel() {
 301
 302         PolytomousKey pkey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 303         PolytomousKeyNode pkeynode = pkey.getRoot();
 304
 305         Map<Language, LanguageString> label1 = pkeynode.getQuestion().getLabel();
 306         label1.size();
 307
 308
 309         Map<Language, LanguageString> label2 = pkeynode.getChildAt(0).getStatement().getLabel();
 310         label2.size();
 311
 312
 313         polytomousKeyService.merge(pkey);
 314     }
 315
 316     @Test
 317     public void deleteSubKeyInPolytomousSubKeyWithoutInitializing() {
 318         PolytomousKey pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 319
 320
 321         PolytomousKeyNode rootNode = pKey.getRoot();
 322         PolytomousKeyNode child = rootNode.getChildAt(0);
 323         PolytomousKey subKey = child.getSubkey();
 324
 325         polytomousKeyService.delete(subKey.getUuid());
 326
 327         // retrieving subkey shows its null
 328         subKey = CdmBase.deproxy(polytomousKeyService.find(subKeyUuid),PolytomousKey.class);
 329         Assert.assertNull(subKey);
 330
 331         pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 332
 333
 334         rootNode = pKey.getRoot();
 335         child = rootNode.getChildAt(0);
 336         subKey = child.getSubkey();
 337         // subkey will not be null, because the delete functionality of the subkey
 338         // does not currently delete it from a polytomous key node
 339
 340         // FIXME: With the new delete functionality this should be null, shouldn't it ?
 341         Assert.assertNotNull(subKey);
 342     }
 343
 344
 345     @Test
 346     public void deleteSubKeyInPolytomousNode() {
 347         PolytomousKey pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 348
 349
 350         PolytomousKeyNode rootNode = pKey.getRoot();
 351         List<PolytomousKeyNode> children = rootNode.getChildren();
 352         PolytomousKeyNode child = rootNode.getChildAt(0);
 353         polytomousKeyNodeService.delete(child.getUuid(), true);
 354
 355         pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 356
 357         rootNode = pKey.getRoot();
 358         children = rootNode.getChildren();
 359         Assert.assertFalse(children.contains(child));
 360     }
 361
 362     @Test
 363     public void deleteSubKeyInPolytomousSubKeyAfterInitializing() {
 364         PolytomousKey pKey = CdmBase.deproxy(polytomousKeyService.find(polytomousKeyUuid),PolytomousKey.class);
 365
 366
 367         PolytomousKeyNode rootNode = pKey.getRoot();
 368         PolytomousKeyNode child = rootNode.getChildAt(0);
 369         PolytomousKey subKey = child.getSubkey();
 370         // this call initializes the subkey
 371         subKey.getRoot();
 372
 373         polytomousKeyService.delete(subKey);
 374
 375         // since subKey was initialized before the delete, it will be
 376         // accesible even after the delete. This behaviour is similar
 377         // to hibernate session delete where the deleted object is
 378         // made transient, but not deleted from the object graph
 379
 380         PolytomousKeyNode subKeyRootNode = subKey.getRoot();
 381         Assert.assertNotNull(subKey);
 382     }
 383
 384     @Test
 385     public void saveNewTermVocabulary() {
 386         TermVocabulary termVocabulary =
 387                 TermVocabulary.NewInstance(TermType.Feature,
 388                         null,
 389                         "Untitled",
 390                         null,
 391                         null);
 392         try {
 393             List<TermVocabulary<DefinedTermBase>> vocabularies = vocabularyService.findByTermType(TermType.Feature);
 394
 395             for(TermVocabulary vocab : vocabularies) {
 396                 vocab.getTermsOrderedByLabels(Language.ENGLISH());
 397             }
 398
 399             termVocabulary = vocabularyService.merge(termVocabulary);
 400             vocabularies.add(termVocabulary);
 401             termVocabulary.setLabel("Test");
 402             vocabularyService.merge(new ArrayList<TermVocabulary>(vocabularies));
 403         } finally {
 404             vocabularyService.delete(termVocabulary);
 405         }
 406     }
 407
 408     @Ignore // should be enabled once resolution of #5066 is merged into cdmlib main branch
 409     @Test
 410     public void saveNewTerm() {
 411         UUID vocNameFeatureUuid = UUID.fromString("fa7ca3eef-4092-49e1-beec-ed5096193e5e");
 412         UUID vocFeatureUuid = UUID.fromString("b187d555-f06f-4d65-9e53-da7c93f8eaa8");
 413         DefinedTermBase newTerm = TermType.Feature.getEmptyDefinedTermBase();
 414         newTerm.setLabel("CreateTest");
 415
 416         try {
 417
 418             Assert.assertNotNull(newTerm);
 419             TermVocabulary vocNameFeature = vocabularyService.find(vocNameFeatureUuid);
 420             TermVocabulary vocFeature = vocabularyService.find(vocFeatureUuid);
 421
 422             List<TermVocabulary> vocs = new ArrayList<TermVocabulary>();
 423
 424             vocs.add(vocNameFeature);
 425             vocs.add(vocFeature);
 426
 427             vocNameFeature.addTerm(newTerm);
 428
 429             vocs = vocabularyService.merge(vocs);
 430             for(TermVocabulary voc : vocs) {
 431                 if(voc.getUuid().equals(vocNameFeatureUuid)) {
 432                     vocNameFeature = voc;
 433                 }
 434             }
 435
 436             Assert.assertTrue(vocNameFeature.getTerms().contains(newTerm));
 437
 438             for(Object obj : vocNameFeature.getTerms()) {
 439                 DefinedTermBase dtb = (DefinedTermBase)obj;
 440                 if("CreateTest".equals(dtb.getLabel())) {
 441                     newTerm = dtb;
 442                     Assert.assertNotNull(dtb.getCreatedBy());
 443                     Assert.assertNotNull(dtb.getCreated());
 444                 } else {
 445                     Assert.assertNull(dtb.getCreatedBy());
 446                 }
 447             }
 448             newTerm.setLabel("UpdateTest");
 449             newTerm = termService.merge(newTerm);
 450             Assert.assertNotNull(newTerm.getUpdatedBy());
 451             Assert.assertNotNull(newTerm.getUpdated());
 452
 453             Assert.assertNull(vocNameFeature.getCreatedBy());
 454             Assert.assertNull(vocFeature.getCreatedBy());
 455         } finally {
 456             if(termService.find(newTerm.getUuid()) != null) {
 457                 termService.delete(newTerm.getUuid());
 458             }
 459         }
 460     }
 461
 462     @Ignore // activate after fixing #5138
 463     @Test
 464     public void updatePerson() {
 465         Person person = (Person) CdmApplicationState.getCurrentAppConfig().getAgentService().load(personUuid);
 466         // Note : at this point the contact field in Person (AgentBase) is initialized even though no
 467         //        data related to the Contact class exists in the database.
 468         person.setFirstname("Me");
 469         CdmApplicationState.getCurrentAppConfig().getAgentService().merge(person);
 470
 471     }
 472
 473     @Ignore // activate after fixing #5138
 474     @Test
 475     public void createPerson() {
 476
 477         Person person = Person.NewInstance();
 478         //person.setTitleCache("New Person", true);
 479         person = (Person) CdmApplicationState.getCurrentAppConfig().getAgentService().merge(person);
 480         //Note : at this point the contact field in Person (AgentBase) is set to null which is
 481         //       different behaviour as compared to a load call on an existing Person entity.
 482         //       The fact that the contact is null will lead to the all-delete-orphan error.
 483         person = (Person) CdmApplicationState.getCurrentAppConfig().getAgentService().load(person.getUuid());
 484         person.setFirstname("Some");
 485         CdmApplicationState.getCurrentAppConfig().getAgentService().merge(person);
 486     }
 487 }