JAL-2571 Missed (alwaysRun=true) for @BeforeMethod
[jalview.git] / test / jalview / viewmodel / ViewportRangesTest.java
index 2465c4d..636f8dd 100644 (file)
@@ -5,12 +5,16 @@ import static org.testng.Assert.assertTrue;
 
 import jalview.analysis.AlignmentGenerator;
 import jalview.datamodel.AlignmentI;
+import jalview.datamodel.ColumnSelection;
+import jalview.datamodel.HiddenColumns;
+import jalview.datamodel.HiddenSequences;
 
 import java.beans.PropertyChangeEvent;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
+import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 
 public class ViewportRangesTest {
@@ -19,6 +23,18 @@ public class ViewportRangesTest {
 
   AlignmentI al = gen.generate(20, 30, 1, 5, 5);
 
+  AlignmentI smallAl = gen.generate(7, 2, 2, 5, 5);
+
+  @BeforeMethod(alwaysRun = true)
+  public void cleanUp()
+  {
+    ColumnSelection sel = new ColumnSelection();
+    al.getHiddenColumns().revealAllHiddenColumns(sel);
+    al.getHiddenSequences().showAll(null);
+    smallAl.getHiddenColumns().revealAllHiddenColumns(sel);
+    smallAl.getHiddenSequences().showAll(null);
+  }
+
   @Test(groups = { "Functional" })
   public void testViewportRanges() 
   {
@@ -94,11 +110,11 @@ public class ViewportRangesTest {
     vr.setStartSeq(-1);
     assertEquals(vr.getStartSeq(), 0);
 
-    vr.setStartSeq(al.getHeight());
-    assertEquals(vr.getStartSeq(), al.getHeight() - 1);
+    vr.setStartSeq(al.getHeight() - vr.getViewportHeight() + 1);
+    assertEquals(vr.getStartSeq(), al.getHeight() - vr.getViewportHeight());
 
-    vr.setStartSeq(al.getHeight() - 1);
-    assertEquals(vr.getStartSeq(), al.getHeight() - 1);
+    vr.setStartSeq(al.getHeight() - vr.getViewportHeight());
+    assertEquals(vr.getStartSeq(), al.getHeight() - vr.getViewportHeight());
   }
 
   @Test(groups = { "Functional" })
@@ -114,7 +130,17 @@ public class ViewportRangesTest {
     assertEquals(vr.getEndRes(), 19);
 
     vr.setStartEndRes(al.getWidth(), al.getWidth());
-    assertEquals(vr.getEndRes(), al.getWidth());
+    assertEquals(vr.getEndRes(), al.getWidth() - 1);
+
+    ViewportRanges vrsmall = new ViewportRanges(smallAl);
+    vrsmall.setStartEndRes(al.getWidth(), al.getWidth());
+    assertEquals(vrsmall.getEndRes(), 6);
+
+    // make visible alignment width = 0
+    smallAl.getHiddenColumns().hideColumns(0, 6);
+    vrsmall.setStartEndRes(0, 4);
+    assertEquals(vrsmall.getStartRes(), 0);
+    assertEquals(vrsmall.getEndRes(), 0);
   }
 
   @Test(groups = { "Functional" })
@@ -131,6 +157,14 @@ public class ViewportRangesTest {
 
     vr.setStartEndSeq(al.getHeight(), al.getHeight());
     assertEquals(vr.getEndSeq(), al.getHeight() - 1);
+
+    // make visible alignment height = 0
+    smallAl.getHiddenSequences().hideSequence(smallAl.getSequenceAt(0));
+    smallAl.getHiddenSequences().hideSequence(smallAl.getSequenceAt(0));
+    ViewportRanges vrsmall = new ViewportRanges(smallAl);
+    vrsmall.setStartEndSeq(0, 3);
+    assertEquals(vrsmall.getStartSeq(), 0);
+    assertEquals(vrsmall.getEndSeq(), 0);
   }
 
   @Test(groups = { "Functional" })
@@ -184,7 +218,13 @@ public class ViewportRangesTest {
     // reset out of bounds start values to within bounds
     vr.setViewportStartAndWidth(35, 5);
     assertEquals(vr.getViewportWidth(), 5);
-    assertEquals(vr.getStartRes(), 20);
+    assertEquals(vr.getStartRes(), 16);
+
+    // small alignment doesn't get bounds reset
+    ViewportRanges vrsmall = new ViewportRanges(smallAl);
+    vrsmall.setViewportStartAndWidth(0, 63);
+    assertEquals(vrsmall.getViewportWidth(), 7);
+    assertEquals(vrsmall.getStartRes(), 0);
   }
 
   @Test(groups = { "Functional" })
@@ -213,7 +253,7 @@ public class ViewportRangesTest {
     vr.pageDown();
 
     // pagedown to bottom does not go beyond end, and height stays same
-    assertEquals(vr.getStartSeq(), 23);
+    assertEquals(vr.getStartSeq(), 24);
     assertEquals(vr.getViewportHeight(), 6);
   }
 
@@ -228,6 +268,30 @@ public class ViewportRangesTest {
     vr.scrollUp(true);
     assertEquals(vr.getStartSeq(), 0);
 
+    vr.setViewportStartAndHeight(24, 5);
+    vr.scrollUp(false);
+    assertEquals(vr.getStartSeq(), 25);
+    // can't scroll beyond bottom
+    vr.scrollUp(false);
+    assertEquals(vr.getStartSeq(), 25);
+  }
+
+  @Test(groups = { "Functional" })
+  public void testScrollUpWithHidden()
+  {
+    ViewportRanges vr = new ViewportRanges(al);
+
+    // hide last sequence
+    HiddenSequences hidden = new HiddenSequences(al);
+    hidden.hideSequence(al.getSequenceAt(29));
+
+    vr.setViewportStartAndHeight(1, 5);
+    vr.scrollUp(true);
+    assertEquals(vr.getStartSeq(), 0);
+    // can't scroll above top
+    vr.scrollUp(true);
+    assertEquals(vr.getStartSeq(), 0);
+
     vr.setViewportStartAndHeight(23, 5);
     vr.scrollUp(false);
     assertEquals(vr.getStartSeq(), 24);
@@ -247,12 +311,37 @@ public class ViewportRangesTest {
     vr.scrollRight(false);
     assertEquals(vr.getStartRes(), 0);
 
-    vr.setViewportStartAndWidth(19, 5);
+    vr.setViewportStartAndWidth(15, 5);
     vr.scrollRight(true);
-    assertEquals(vr.getStartRes(), 20);
+    assertEquals(vr.getStartRes(), 16);
     // can't scroll right past end
     vr.scrollRight(true);
-    assertEquals(vr.getStartRes(), 20);
+    assertEquals(vr.getStartRes(), 16);
+  }
+
+  @Test(groups = { "Functional" })
+  public void testScrollRightWithHidden()
+  {
+    ViewportRanges vr = new ViewportRanges(al);
+
+    // hide last 2 columns
+    HiddenColumns cols = new HiddenColumns();
+    cols.hideColumns(19, 20);
+    al.setHiddenColumns(cols);
+
+    vr.setViewportStartAndWidth(1, 5);
+    vr.scrollRight(false);
+    assertEquals(vr.getStartRes(), 0);
+    // can't scroll left past start
+    vr.scrollRight(false);
+    assertEquals(vr.getStartRes(), 0);
+
+    vr.setViewportStartAndWidth(13, 5);
+    vr.scrollRight(true);
+    assertEquals(vr.getStartRes(), 14);
+    // can't scroll right past last visible col
+    vr.scrollRight(true);
+    assertEquals(vr.getStartRes(), 14);
   }
 
   @Test(groups = { "Functional" })
@@ -296,7 +385,11 @@ public class ViewportRangesTest {
   {
     ViewportRanges vr = new ViewportRanges(al);
     MockPropChangeListener l = new MockPropChangeListener(vr);
-    List<String> emptylist = new ArrayList<String>();
+    List<String> emptylist = new ArrayList<>();
+
+    vr.setViewportWidth(5);
+    vr.setViewportHeight(5);
+    l.reset();
 
     // one event fired when startRes is called with new value
     vr.setStartRes(4);
@@ -341,6 +434,16 @@ public class ViewportRangesTest {
     assertTrue(l.verify(0, emptylist));
     l.reset();
 
+    // check new value fired by event is corrected startres
+    vr.setStartEndRes(-1, 5);
+    assertTrue(l.verify(1, Arrays.asList("startres"), Arrays.asList(0)));
+    l.reset();
+
+    // check new value fired by event is corrected endres
+    vr.setStartEndRes(0, -1);
+    assertTrue(l.verify(1, Arrays.asList("endres"), Arrays.asList(0)));
+    l.reset();
+
     vr.setStartEndSeq(2, 15);
     assertTrue(l.verify(1, Arrays.asList("startseq")));
     l.reset();
@@ -349,6 +452,24 @@ public class ViewportRangesTest {
     assertTrue(l.verify(0, emptylist));
     l.reset();
 
+    vr.setStartEndRes(2, 2); // so seq and res values should be different, in
+                             // case of transposing in code
+    l.reset();
+
+    // check new value fired by event is corrected startseq
+    vr.setStartEndSeq(-1, 5);
+    assertTrue(l.verify(1, Arrays.asList("startseq"), Arrays.asList(0)));
+    l.reset();
+
+    // check new value fired by event is corrected endseq
+    vr.setStartEndSeq(0, -1);
+    assertTrue(l.verify(1, Arrays.asList("endseq"), Arrays.asList(0)));
+    l.reset();
+
+    // reset for later tests
+    vr.setStartEndSeq(2, 15);
+    l.reset();
+
     // test viewport height and width setting triggers event
     vr.setViewportHeight(10);
     assertTrue(l.verify(1, Arrays.asList("endseq")));
@@ -393,11 +514,10 @@ public class ViewportRangesTest {
     assertTrue(l.verify(1, Arrays.asList("startres")));
     l.reset();
 
-    // TODO test scrollToVisibble once hidden columns JAL-2388 merged in
-    // to avoid somersaults with align viewport
-    /*vr.scrollToVisible(10, 10);
-    assertTrue(l.verify(1, Arrays.asList("startres")));
-    l.reset();*/
+    vr.scrollToVisible(10, 10);
+    assertTrue(l.verify(4,
+            Arrays.asList("startseq", "startseq", "startseq", "startseq")));
+    l.reset();
 
     vr.scrollToWrappedVisible(5);
     assertTrue(l.verify(1, Arrays.asList("startres")));
@@ -410,7 +530,9 @@ class MockPropChangeListener implements ViewportListenerI
 {
   private int firecount = 0;
 
-  private List<String> events = new ArrayList<String>();
+  private List<String> events = new ArrayList<>();
+
+  private List<Integer> newvalues = new ArrayList<>();
 
   public MockPropChangeListener(ViewportRanges vr)
   {
@@ -422,6 +544,14 @@ class MockPropChangeListener implements ViewportListenerI
   {
     firecount++;
     events.add(evt.getPropertyName());
+    newvalues.add((Integer) evt.getNewValue());
+  }
+
+  public boolean verify(int count, List<String> eventslist,
+          List<Integer> valueslist)
+  {
+    return (count == firecount) && events.equals(eventslist)
+            && newvalues.equals(valueslist);
   }
 
   public boolean verify(int count, List<String> eventslist)
@@ -433,5 +563,6 @@ class MockPropChangeListener implements ViewportListenerI
   {
     firecount = 0;
     events.clear();
+    newvalues.clear();
   }
 }