test/jalview/workers/AlignCalcManagerTest.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.workers;
  22
  23 import static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertFalse;
  25 import static org.testng.AssertJUnit.assertTrue;
  26
  27 import jalview.api.AlignCalcManagerI;
  28 import jalview.api.AlignCalcWorkerI;
  29 import jalview.api.FeatureRenderer;
  30 import jalview.datamodel.Alignment;
  31 import jalview.datamodel.AlignmentAnnotation;
  32 import jalview.datamodel.AlignmentI;
  33 import jalview.datamodel.Annotation;
  34 import jalview.datamodel.Sequence;
  35 import jalview.datamodel.SequenceI;
  36 import jalview.gui.AlignFrame;
  37 import jalview.gui.JvOptionPane;
  38
  39 import java.util.Collections;
  40 import java.util.List;
  41
  42 import org.testng.annotations.BeforeClass;
  43 import org.testng.annotations.BeforeMethod;
  44 import org.testng.annotations.Test;
  45
  46 public class AlignCalcManagerTest
  47 {
  48
  49   @BeforeClass(alwaysRun = true)
  50   public void setUpJvOptionPane()
  51   {
  52     JvOptionPane.setInteractiveMode(false);
  53     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  54   }
  55
  56   private AlignFrame alignFrame;
  57
  58   /**
  59    * Test the method that removes a worker associated with an annotation,
  60    * provided the worker is marked as 'deletable' (some workers should continue
  61    * to run even when their results are no longer displayed)
  62    */
  63   @Test(groups = "Functional")
  64   public void testRemoveWorkerForAnnotation()
  65   {
  66     AlignCalcManagerI acm = alignFrame.getViewport().getCalcManager();
  67     final AlignmentAnnotation ann1 = new AlignmentAnnotation("Ann1", "desc",
  68             new Annotation[] {});
  69     final AlignmentAnnotation ann2 = new AlignmentAnnotation("Ann2", "desc",
  70             new Annotation[] {});
  71
  72     /*
  73      * make two workers for ann1, one deletable, one not
  74      * and no worker for ann2
  75      */
  76     AlignCalcWorkerI worker1 = makeWorker(ann1, true);
  77     AlignCalcWorkerI worker2 = makeWorker(ann1, false);
  78
  79     /*
  80      * The new workers will get run each in their own thread.
  81      * We can't tell here whether they have finished, or not yet started.
  82      * They have to finish to be 'seen' by getRegisteredWorkersOfClass()
  83      *   registerWorker adds to the 'restartable' list but
  84      *   getRegisteredWorkers reads from the 'canUpdate' list
  85      *   (which is only updated after a worker has run) - why?
  86      * So just give workers time to start and finish
  87      */
  88     synchronized (this)
  89     {
  90       try
  91       {
  92         wait(100);
  93       } catch (InterruptedException e)
  94       {
  95         //
  96       }
  97     }
  98
  99     List<AlignCalcWorkerI> workers = acm
 100             .getRegisteredWorkersOfClass(worker1.getClass());
 101     assertEquals(2, workers.size());
 102     assertTrue(workers.contains(worker1));
 103     assertTrue(workers.contains(worker2));
 104     assertFalse(acm.isDisabled(worker1));
 105     assertFalse(acm.isDisabled(worker2));
 106
 107     /*
 108      * remove workers for ann2 (there aren't any)
 109      */
 110     acm.removeWorkerForAnnotation(ann2);
 111     assertTrue(acm.getRegisteredWorkersOfClass(worker1.getClass())
 112             .contains(worker1));
 113     assertTrue(acm.getRegisteredWorkersOfClass(worker1.getClass())
 114             .contains(worker2));
 115     assertFalse(acm.isDisabled(worker1));
 116     assertFalse(acm.isDisabled(worker2));
 117
 118     /*
 119      * remove worker2 for ann1
 120      * - should delete worker1 but not worker2
 121      */
 122     acm.removeWorkerForAnnotation(ann1);
 123     assertEquals(1,
 124             acm.getRegisteredWorkersOfClass(worker1.getClass()).size());
 125     assertTrue(acm.getRegisteredWorkersOfClass(worker1.getClass())
 126             .contains(worker2));
 127     assertFalse(acm.isDisabled(worker1));
 128     assertFalse(acm.isDisabled(worker2));
 129   }
 130
 131   /**
 132    * Make a worker linked to the given annotation
 133    *
 134    * @param ann
 135    * @param deletable
 136    * @return
 137    */
 138   AnnotationWorker makeWorker(final AlignmentAnnotation ann,
 139           final boolean deletable)
 140   {
 141     AnnotationProviderI annotationProvider = new AnnotationProviderI()
 142     {
 143       @Override
 144       public List<AlignmentAnnotation> calculateAnnotation(AlignmentI al,
 145               FeatureRenderer fr)
 146       {
 147         return Collections.singletonList(ann);
 148       }
 149     };
 150     return new AnnotationWorker(alignFrame.getViewport(),
 151             alignFrame.alignPanel, annotationProvider)
 152     {
 153       @Override
 154       public boolean isDeletable()
 155       {
 156         return deletable;
 157       }
 158
 159       @Override
 160       public boolean involves(AlignmentAnnotation ann1)
 161       {
 162         return ann == ann1;
 163       }
 164     };
 165   }
 166
 167   @BeforeMethod(alwaysRun = true)
 168   public void setUp()
 169   {
 170     AlignmentI al = new Alignment(
 171             new SequenceI[]
 172             { new Sequence("Seq1", "ABC") });
 173     al.setDataset(null);
 174     alignFrame = new AlignFrame(al, 3, 1);
 175   }
 176 }