JAL-147 unit tests added, unused setEndRes removed
[jalview.git] / test / jalview / viewmodel / ViewportRangesTest.java
index 4e15b80..86f0d62 100644 (file)
@@ -5,12 +5,17 @@ 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.BeforeClass;
+import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 
 public class ViewportRangesTest {
@@ -19,6 +24,26 @@ public class ViewportRangesTest {
 
   AlignmentI al = gen.generate(20, 30, 1, 5, 5);
 
+  AlignmentI smallAl = gen.generate(7, 2, 2, 5, 5);
+
+  @BeforeClass(alwaysRun = true)
+  public void setUp()
+  {
+    gen = new AlignmentGenerator(false);
+    al = gen.generate(20, 30, 1, 5, 5);
+    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() 
   {
@@ -49,17 +74,6 @@ public class ViewportRangesTest {
   }
 
   @Test(groups = { "Functional" })
-  public void testSetEndRes()
-  {
-    ViewportRanges vr = new ViewportRanges(al);
-    vr.setEndRes(-1);
-    assertEquals(vr.getEndRes(), 0);
-
-    vr.setEndRes(al.getWidth() - 1);
-    assertEquals(vr.getEndRes(), al.getWidth() - 1);
-  }
-
-  @Test(groups = { "Functional" })
   public void testSetEndSeq()
   {
     ViewportRanges vr = new ViewportRanges(al);
@@ -69,7 +83,8 @@ public class ViewportRangesTest {
     vr.setEndSeq(al.getHeight());
     assertEquals(vr.getEndSeq(), al.getHeight() - 1);
 
-    vr.setEndRes(al.getHeight() - 1);
+    // vr.setEndRes(al.getHeight() - 1);
+    vr.setEndSeq(al.getHeight() - 1);
     assertEquals(vr.getEndSeq(), al.getHeight() - 1);
   }
 
@@ -94,11 +109,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 +129,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 +156,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 +217,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 +252,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 +267,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 +310,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,24 +384,19 @@ public class ViewportRangesTest {
   {
     ViewportRanges vr = new ViewportRanges(al);
     MockPropChangeListener l = new MockPropChangeListener(vr);
-    List<String> emptylist = new ArrayList<String>();
+    List<String> emptylist = new ArrayList<>();
 
-    // one event fired when startRes is called with new value
-    vr.setStartRes(4);
-    assertTrue(l.verify(1, Arrays.asList("startres")));
+    vr.setViewportWidth(5);
+    vr.setViewportHeight(5);
     l.reset();
 
-    // no event fired for same value
+    // one event fired when startRes is called with new value
     vr.setStartRes(4);
-    assertTrue(l.verify(0, emptylist));
-    l.reset();
-
-    vr.setEndRes(10);
     assertTrue(l.verify(1, Arrays.asList("startres")));
     l.reset();
 
     // no event fired for same value
-    vr.setEndRes(10);
+    vr.setStartRes(4);
     assertTrue(l.verify(0, emptylist));
     l.reset();
 
@@ -421,16 +504,201 @@ 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")));
     l.reset();
   }
+
+  @Test(groups = { "Functional" })
+  public void testGetWrappedScrollPosition()
+  {
+    AlignmentI al2 = gen.generate(157, 15, 1, 5, 5);
+    ViewportRanges vr = new ViewportRanges(al2);
+    vr.setStartEndRes(0, 39);
+    int width = vr.getViewportWidth(); // 40
+
+    /*
+     * scroll is 0 at column 0 (only)
+     */
+    assertEquals(vr.getWrappedScrollPosition(0), 0);
+
+    /*
+     * scroll is 1 at columns 1-40
+     */
+    int i = 1;
+    int j = width;
+    for (; i <= j; i++)
+    {
+      assertEquals(1, vr.getWrappedScrollPosition(i));
+    }
+
+    /*
+     * scroll is 2 at columns 41-80, etc
+     */
+    j += width;
+    for (; i <= j; i++)
+    {
+      assertEquals(2, vr.getWrappedScrollPosition(i), "For " + i);
+    }
+  }
+
+  @Test(groups = { "Functional" })
+  public void testPageUpDownWrapped()
+  {
+    /*
+     * 15 sequences, 110 residues wide (+gaps)
+     */
+    AlignmentI al2 = gen.generate(110, 15, 1, 5, 5);
+
+    ViewportRanges vr = new ViewportRanges(al2);
+    vr.setWrappedMode(true);
+
+    // first row
+    vr.setViewportStartAndWidth(0, 40);
+    int width = vr.getViewportWidth();
+    assertEquals(width, 40);
+    assertEquals(vr.getStartRes(), 0);
+    assertEquals(vr.getEndRes(), 39);
+    assertEquals(vr.getStartSeq(), 0);
+    assertEquals(vr.getEndSeq(), 14);
+
+    // second row
+    vr.pageDown();
+    assertEquals(vr.getStartRes(), 40);
+    assertEquals(vr.getEndRes(), 79);
+    assertEquals(vr.getStartSeq(), 0);
+    assertEquals(vr.getEndSeq(), 14);
+
+    // third and last row
+    // note endRes is nominal (>width) to preserve viewport width
+    vr.pageDown();
+    assertEquals(vr.getStartRes(), 80);
+    assertEquals(vr.getEndRes(), 119);
+    assertEquals(vr.getStartSeq(), 0);
+    assertEquals(vr.getEndSeq(), 14);
+
+    // another pageDown should do nothing
+    vr.pageDown();
+    assertEquals(vr.getStartRes(), 80);
+    assertEquals(vr.getEndRes(), 119);
+    assertEquals(vr.getStartSeq(), 0);
+    assertEquals(vr.getEndSeq(), 14);
+
+    // back to second row
+    vr.pageUp();
+    assertEquals(vr.getStartRes(), 40);
+    assertEquals(vr.getEndRes(), 79);
+    assertEquals(vr.getStartSeq(), 0);
+    assertEquals(vr.getEndSeq(), 14);
+
+    // back to first row
+    vr.pageUp();
+    assertEquals(vr.getStartRes(), 0);
+    assertEquals(vr.getEndRes(), 39);
+    assertEquals(vr.getStartSeq(), 0);
+    assertEquals(vr.getEndSeq(), 14);
+
+    // another pageUp should do nothing
+    vr.pageUp();
+    assertEquals(vr.getStartRes(), 0);
+    assertEquals(vr.getEndRes(), 39);
+    assertEquals(vr.getStartSeq(), 0);
+    assertEquals(vr.getEndSeq(), 14);
+
+    /*
+     * simulate scroll right a few positions
+     */
+    vr.setStartRes(5);
+    assertEquals(vr.getStartRes(), 5);
+    assertEquals(vr.getEndRes(), 5 + width - 1); // 44
+
+    vr.pageDown(); // 5-44 shifts to 45-84
+    assertEquals(vr.getStartRes(), 45);
+    assertEquals(vr.getEndRes(), 84);
+
+    vr.pageDown(); // 45-84 shifts to 85-124
+    assertEquals(vr.getStartRes(), 85);
+    assertEquals(vr.getEndRes(), 124);
+
+    vr.pageDown(); // no change - at end already
+    assertEquals(vr.getStartRes(), 85);
+    assertEquals(vr.getEndRes(), 124);
+
+    vr.pageUp(); // back we go
+    assertEquals(vr.getStartRes(), 45);
+    assertEquals(vr.getEndRes(), 84);
+
+    vr.pageUp();
+    assertEquals(vr.getStartRes(), 5);
+    assertEquals(vr.getEndRes(), 44);
+
+    vr.pageUp(); // back to the start
+    assertEquals(vr.getStartRes(), 0);
+    assertEquals(vr.getEndRes(), 39);
+  }
+
+  @Test(groups = { "Functional" })
+  public void testSetStartEndResWrapped()
+  {
+    ViewportRanges vr = new ViewportRanges(al);
+    vr.setWrappedMode(true);
+    vr.setStartEndRes(-1, -1);
+    assertEquals(vr.getStartRes(), 0);
+    assertEquals(vr.getEndRes(), 0);
+  
+    vr.setStartEndRes(5, 19);
+    assertEquals(vr.getStartRes(), 5);
+    assertEquals(vr.getEndRes(), 19);
+  
+    // bounds are not constrained to alignment width
+    // when in wrapped mode
+    vr.setStartEndRes(88, 888);
+    assertEquals(vr.getStartRes(), 88);
+    assertEquals(vr.getEndRes(), 888);
+  
+    ViewportRanges vrsmall = new ViewportRanges(smallAl);
+    vrsmall.setWrappedMode(true);
+    vrsmall.setStartEndRes(88, 888);
+    assertEquals(vrsmall.getStartRes(), 88);
+    assertEquals(vrsmall.getEndRes(), 888);
+  
+    // make visible alignment width = 0
+    smallAl.getHiddenColumns().hideColumns(0, 6);
+    vrsmall.setStartEndRes(0, 4);
+    assertEquals(vrsmall.getStartRes(), 0);
+    assertEquals(vrsmall.getEndRes(), 4);
+  }
+
+  @Test(groups = { "Functional" })
+  public void testSetViewportStartAndWidthWrapped()
+  {
+    ViewportRanges vr = new ViewportRanges(al);
+    vr.setWrappedMode(true);
+    vr.setViewportStartAndWidth(2, 6);
+    assertEquals(vr.getViewportWidth(), 6);
+    assertEquals(vr.getStartRes(), 2);
+  
+    // reset -ve values of start to 0
+    vr.setViewportStartAndWidth(-1, 7);
+    assertEquals(vr.getViewportWidth(), 7);
+    assertEquals(vr.getStartRes(), 0);
+  
+    // out of bounds values are not forced to within bounds
+    vr.setViewportStartAndWidth(35, 5);
+    assertEquals(vr.getViewportWidth(), 5);
+    assertEquals(vr.getStartRes(), 35);
+  
+    // small alignment doesn't get bounds reset
+    ViewportRanges vrsmall = new ViewportRanges(smallAl);
+    vrsmall.setViewportStartAndWidth(0, 63);
+    assertEquals(vrsmall.getViewportWidth(), 7);
+    assertEquals(vrsmall.getStartRes(), 0);
+  }
 }
 
 // mock listener for property change events
@@ -438,9 +706,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<Integer>();
+  private List<Integer> newvalues = new ArrayList<>();
 
   public MockPropChangeListener(ViewportRanges vr)
   {