test/jalview/datamodel/SearchResultsTest.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.datamodel;
  22
  23 import static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertFalse;
  25 import static org.testng.AssertJUnit.assertSame;
  26 import static org.testng.AssertJUnit.assertTrue;
  27
  28 import java.util.BitSet;
  29 import java.util.List;
  30
  31 import org.junit.Assert;
  32 import org.testng.annotations.BeforeClass;
  33 import org.testng.annotations.Test;
  34
  35 import jalview.gui.JvOptionPane;
  36
  37 public class SearchResultsTest
  38 {
  39
  40   @BeforeClass(alwaysRun = true)
  41   public void setUpJvOptionPane()
  42   {
  43     JvOptionPane.setInteractiveMode(false);
  44     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  45   }
  46
  47   @Test(groups = { "Functional" })
  48   public void testToString()
  49   {
  50     SequenceI seq = new Sequence("Seq1", "abcdefghijklm");
  51     SearchResultsI sr = new SearchResults();
  52     sr.addResult(seq, 1, 1);
  53     assertEquals("[Seq1/1-1]", sr.toString());
  54     sr.addResult(seq, 3, 5);
  55     assertEquals("[Seq1/1-1, Seq1/3-5]", sr.toString());
  56
  57     seq = new Sequence("Seq2", "pqrstuvwxy");
  58     sr.addResult(seq, 6, 7);
  59     assertEquals("[Seq1/1-1, Seq1/3-5, Seq2/6-7]", sr.toString());
  60   }
  61
  62   @Test(groups = { "Functional" })
  63   public void testEquals()
  64   {
  65     SequenceI seq1 = new Sequence("", "abcdefghijklm");
  66     SearchResultsI sr1 = new SearchResults();
  67     SearchResultsI sr2 = new SearchResults();
  68
  69     assertFalse(sr1.equals(null)); // null object
  70     assertFalse(sr1.equals(seq1)); // wrong type
  71     assertTrue(sr1.equals(sr1)); // self
  72     assertTrue(sr1.equals(sr2)); // empty
  73     assertTrue(sr2.equals(sr1)); // reflexive
  74
  75     /*
  76      * if only one result is not empty
  77      */
  78     sr1.addResult(seq1, 1, 1);
  79     assertTrue(sr1.equals(sr1));
  80     assertFalse(sr1.equals(sr2));
  81     assertFalse(sr2.equals(sr1));
  82
  83     /*
  84      * both the same
  85      */
  86     sr2.addResult(seq1, 1, 1);
  87     assertTrue(sr1.equals(sr2));
  88     assertTrue(sr2.equals(sr1));
  89
  90     /*
  91      * both have three matches
  92      */
  93     sr1.addResult(seq1, 3, 4);
  94     sr1.addResult(seq1, 6, 8);
  95     sr2.addResult(seq1, 3, 4);
  96     sr2.addResult(seq1, 6, 8);
  97     assertTrue(sr1.equals(sr1));
  98     assertTrue(sr2.equals(sr2));
  99     assertTrue(sr1.equals(sr2));
 100     assertTrue(sr2.equals(sr1));
 101   }
 102
 103   /**
 104    * Matches that are similar but for distinct sequences are not equal
 105    */
 106   @Test(groups = { "Functional" })
 107   public void testEquals_distinctSequences()
 108   {
 109     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 110     SequenceI seq2 = new Sequence("", "abcdefghijklm");
 111     SearchResultsI sr1 = new SearchResults();
 112     SearchResultsI sr2 = new SearchResults();
 113
 114     sr1.addResult(seq1, 1, 1);
 115     sr2.addResult(seq2, 1, 1);
 116     assertFalse(sr1.equals(sr2));
 117     assertFalse(sr2.equals(sr1));
 118   }
 119
 120   /**
 121    * Matches that are the same except for ordering are not equal
 122    */
 123   @Test(groups = { "Functional" })
 124   public void testEquals_orderDiffers()
 125   {
 126     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 127     SearchResultsI sr1 = new SearchResults();
 128     SearchResultsI sr2 = new SearchResults();
 129
 130     sr1.addResult(seq1, 1, 1);
 131     sr1.addResult(seq1, 2, 2);
 132     sr2.addResult(seq1, 2, 2);
 133     sr2.addResult(seq1, 1, 1);
 134     assertFalse(sr1.equals(sr2));
 135     assertFalse(sr2.equals(sr1));
 136   }
 137
 138   /**
 139    * Verify that hashCode matches for equal objects
 140    */
 141   @Test(groups = { "Functional" })
 142   public void testHashcode()
 143   {
 144     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 145     SearchResultsI sr1 = new SearchResults();
 146     SearchResultsI sr2 = new SearchResults();
 147
 148     /*
 149      * both empty
 150      */
 151     assertEquals(sr1.hashCode(), sr2.hashCode());
 152
 153     /*
 154      * both one match
 155      */
 156     sr1.addResult(seq1, 1, 1);
 157     sr2.addResult(seq1, 1, 1);
 158     assertEquals(sr1.hashCode(), sr2.hashCode());
 159
 160     /*
 161      * both three matches
 162      */
 163     sr1.addResult(seq1, 3, 4);
 164     sr1.addResult(seq1, 6, 8);
 165     sr2.addResult(seq1, 3, 4);
 166     sr2.addResult(seq1, 6, 8);
 167     assertEquals(sr1.hashCode(), sr2.hashCode());
 168   }
 169
 170   /**
 171    * Verify that SearchResults$Match constructor normalises start/end to the
 172    * 'forwards' direction
 173    */
 174   @Test(groups = { "Functional" })
 175   public void testMatchConstructor()
 176   {
 177     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 178     SearchResultMatchI m = new SearchResults().new Match(seq1, 2, 5);
 179     assertSame(seq1, m.getSequence());
 180     assertEquals(2, m.getStart());
 181     assertEquals(5, m.getEnd());
 182
 183     // now a reverse mapping:
 184     m = new SearchResults().new Match(seq1, 5, 2);
 185     assertSame(seq1, m.getSequence());
 186     assertEquals(2, m.getStart());
 187     assertEquals(5, m.getEnd());
 188   }
 189
 190   @Test(groups = { "Functional" })
 191   public void testMatchContains()
 192   {
 193     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 194     SequenceI seq2 = new Sequence("", "abcdefghijklm");
 195     SearchResultMatchI m = new SearchResults().new Match(seq1, 2, 5);
 196
 197     assertTrue(m.contains(seq1, 2, 5));
 198     assertTrue(m.contains(seq1, 3, 5));
 199     assertTrue(m.contains(seq1, 2, 4));
 200     assertTrue(m.contains(seq1, 3, 3));
 201
 202     assertFalse(m.contains(seq1, 2, 6));
 203     assertFalse(m.contains(seq1, 1, 5));
 204     assertFalse(m.contains(seq1, 1, 8));
 205     assertFalse(m.contains(seq2, 3, 3));
 206     assertFalse(m.contains(null, 3, 3));
 207   }
 208
 209   @Test(groups = { "Functional" })
 210   public void testMatchAdjacent()
 211   {
 212     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 213     SequenceI seq2 = new Sequence("", "abcdefghijklm");
 214     SearchResultMatchI m = new SearchResults().new Match(seq1, 2, 5);
 215
 216     assertTrue(m.adjacent(seq1, 2, 5));
 217     assertTrue(m.adjacent(seq1, 3, 5));
 218     assertTrue(m.adjacent(seq1, 2, 4));
 219     assertTrue(m.adjacent(seq1, 3, 3));
 220
 221     assertTrue(m.adjacent(seq1, 2, 6));
 222     assertTrue(m.adjacent(seq1, 1, 5));
 223     assertTrue(m.adjacent(seq1, 1, 8));
 224     assertFalse(m.adjacent(seq1, 0, 0));
 225     assertFalse(m.adjacent(seq1, 7, 8));
 226     assertTrue(m.adjacent(seq1, 6, 8));
 227     assertTrue(m.adjacent(seq1, 5, 8));
 228     assertTrue(m.adjacent(seq1, 0, 1));
 229
 230
 231     assertFalse(m.adjacent(seq2, 3, 3));
 232     assertFalse(m.adjacent(null, 3, 3));
 233   }
 234
 235   /**
 236    * test markColumns for creating column selections
 237    */
 238   @Test(groups = { "Functional" })
 239   public void testMarkColumns()
 240   {
 241     int marked = 0;
 242     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 243     SequenceI seq2 = new Sequence("", "abcdefghijklm");
 244     SequenceGroup s1g = new SequenceGroup(), s2g = new SequenceGroup(),
 245             sallg = new SequenceGroup();
 246     s1g.addSequence(seq1, false);
 247     s2g.addSequence(seq2, false);
 248     sallg.addSequence(seq1, false);
 249     sallg.addSequence(seq2, false);
 250
 251     SearchResultsI sr = new SearchResults();
 252     BitSet bs = new BitSet();
 253
 254     SearchResultMatchI srm = null;
 255     srm = sr.addResult(seq1, 1, 1);
 256     Assert.assertNotNull("addResult didn't return Match", srm);
 257     srm = sr.addResult(seq2, 1, 2);
 258     assertEquals("Sequence reference not set", seq2, srm.getSequence());
 259     assertEquals("match start incorrect", 1, srm.getStart());
 260     assertEquals("match end incorrect", 2, srm.getEnd());
 261
 262     // set start/end range for groups to cover matches
 263
 264     s1g.setStartRes(0);
 265     s1g.setEndRes(5);
 266     s2g.setStartRes(0);
 267     s2g.setEndRes(5);
 268     sallg.setStartRes(0);
 269     sallg.setEndRes(5);
 270
 271     /*
 272      * just seq1
 273      */
 274     marked = sr.markColumns(s1g, bs);
 275     // check the bitset cardinality before checking the return value
 276     assertEquals("Didn't mark expected number", 1, bs.cardinality());
 277     assertEquals("Didn't return count of number of bits marked", 1, marked);
 278     assertTrue("Didn't mark expected position", bs.get(0));
 279     // now check return value for marking the same again
 280     assertEquals(
 281             "Didn't count number of bits marked for existing marked set", 0,
 282             sr.markColumns(s1g, bs));
 283     bs.clear();
 284
 285     /*
 286      * just seq2
 287      */
 288     marked = sr.markColumns(s2g, bs);
 289     assertEquals("Didn't mark expected number", 2, bs.cardinality());
 290     assertEquals("Didn't return count of number of bits marked", 2, marked);
 291     assertTrue("Didn't mark expected position (1)", bs.get(0));
 292     assertTrue("Didn't mark expected position (2)", bs.get(1));
 293
 294     /*
 295      * both seq1 and seq2
 296      * should be same as seq2
 297      */
 298     BitSet allbs = new BitSet();
 299     assertEquals(2, sr.markColumns(sallg, allbs));
 300     assertEquals(bs, allbs);
 301
 302     // now check range selection
 303
 304     /*
 305      * limit s2g to just the second column, sallg to the first column
 306      */
 307     s2g.setStartRes(1);
 308     s2g.setEndRes(1);
 309     sallg.setEndRes(0);
 310     BitSet tbs = new BitSet();
 311     assertEquals("Group start/end didn't select columns to mark", 1,
 312             sr.markColumns(s2g, tbs));
 313     assertEquals("Group start/end didn't select columns to mark", 1,
 314             sr.markColumns(sallg, tbs));
 315     assertEquals(
 316             "Didn't set expected number of columns in total for two successive marks",
 317             2, tbs.cardinality());
 318   }
 319
 320   /**
 321    * Test to verify adding doesn't create duplicate results
 322    */
 323   @Test(groups = { "Functional" })
 324   public void testAddResult()
 325   {
 326     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 327     SearchResultsI sr = new SearchResults();
 328     sr.addResult(seq1, 3, 5);
 329     assertEquals(1, sr.getCount());
 330     sr.addResult(seq1, 3, 5);
 331     assertEquals(1, sr.getCount());
 332     sr.addResult(seq1, 3, 6);
 333     assertEquals(2, sr.getCount());
 334   }
 335
 336   /**
 337    * Test to verify appending creates a minimal set of results
 338    */
 339   @Test(groups = { "Functional" })
 340   public void testAppendResult()
 341   {
 342     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 343     SearchResultsI sr = new SearchResults();
 344     sr.appendResult(seq1, 3, 5);
 345     assertEquals(1, sr.getCount());
 346     sr.appendResult(seq1, 3, 6);
 347     assertEquals(1, sr.getCount());
 348     sr.appendResult(seq1, 8, 8);
 349     assertEquals(2, sr.getCount());
 350     sr.appendResult(seq1, 7, 7);
 351     assertEquals(1, sr.getCount());
 352   }
 353   /**
 354    * Test for method that checks if search results matches a sequence region
 355    */
 356   @Test(groups = { "Functional" })
 357   public void testInvolvesSequence()
 358   {
 359     SequenceI dataset = new Sequence("genome", "ATGGCCCTTTAAGCAACATTT");
 360     // first 'exon':
 361     SequenceI cds1 = new Sequence("cds1/1-12", "ATGGCCCTTTAA");
 362     cds1.setDatasetSequence(dataset);
 363     // overlapping second 'exon':
 364     SequenceI cds2 = new Sequence("cds2/7-18", "CTTTAAGCAACA");
 365     cds2.setDatasetSequence(dataset);
 366     // unrelated sequence
 367     SequenceI cds3 = new Sequence("cds3", "ATGGCCCTTTAAGCAACA");
 368
 369     SearchResults sr = new SearchResults();
 370     assertFalse(sr.involvesSequence(cds1));
 371
 372     /*
 373      * cds1 and cds2 share the same dataset sequence, but
 374      * only cds1 overlaps match 4:6 (fixes bug JAL-3613)
 375      */
 376     sr.addResult(dataset, 4, 6);
 377     assertTrue(sr.involvesSequence(cds1));
 378     assertFalse(sr.involvesSequence(cds2));
 379     assertFalse(sr.involvesSequence(cds3));
 380
 381     /*
 382      * search results overlap cds2 only
 383      */
 384     sr = new SearchResults();
 385     sr.addResult(dataset, 18, 18);
 386     assertFalse(sr.involvesSequence(cds1));
 387     assertTrue(sr.involvesSequence(cds2));
 388
 389     /*
 390      * add a search result overlapping cds1
 391      */
 392     sr.addResult(dataset, 1, 1);
 393     assertTrue(sr.involvesSequence(cds1));
 394     assertTrue(sr.involvesSequence(cds2));
 395
 396     /*
 397      * single search result overlapping both
 398      */
 399     sr = new SearchResults();
 400     sr.addResult(dataset, 10, 12);
 401     assertTrue(sr.involvesSequence(cds1));
 402     assertTrue(sr.involvesSequence(cds2));
 403
 404     /*
 405      * search results matching aligned sequence
 406      */
 407     sr = new SearchResults();
 408     sr.addResult(cds1, 10, 12);
 409     assertTrue(sr.involvesSequence(cds1));
 410     assertFalse(sr.involvesSequence(cds2));
 411     sr.addResult(cds2, 1, 3); // no start-end overlap
 412     assertFalse(sr.involvesSequence(cds2));
 413     sr.addResult(cds2, 7, 9); // start-end overlap
 414     assertTrue(sr.involvesSequence(cds2));
 415   }
 416
 417   /**
 418    * Test extraction of Sequence objects for matched ranges on a sequence
 419    */
 420   @Test(groups = { "Functional" })
 421   public void testGetSequences()
 422   {
 423     SequenceI seq1 = new Sequence("", "abcdefghijklm");
 424     SequenceI seq2 = new Sequence("", "nopqrstuvwxyz");
 425     seq2.setStart(23);
 426     seq2.setEnd(35);
 427     List<SequenceI> seqres = null;
 428
 429     SearchResultsI sr = new SearchResults();
 430     seqres = sr.getMatchingSubSequences();
 431     assertEquals(0, seqres.size());
 432
 433     sr.addResult(seq1, 3, 5);
 434     seqres = sr.getMatchingSubSequences();
 435
 436     assertEquals(1, seqres.size());
 437     assertEquals("cde", seqres.get(0).getSequenceAsString());
 438     assertEquals(3, seqres.get(0).getStart());
 439     assertEquals(seq1, seqres.get(0).getDatasetSequence());
 440
 441     sr.addResult(seq1, 3, 6);
 442     seqres = sr.getMatchingSubSequences();
 443
 444     assertEquals(2, seqres.size());
 445     assertEquals("cdef", seqres.get(1).getSequenceAsString());
 446     assertEquals(3, seqres.get(1).getStart());
 447
 448     // this is a quirk - match on 26-29 yields subsequence 27-30
 449     sr.addResult(seq2, 26, 29);
 450     seqres = sr.getMatchingSubSequences();
 451     assertEquals(3, seqres.size());
 452     assertEquals("qrst", seqres.get(2).getSequenceAsString());
 453     assertEquals(26, seqres.get(2).getStart());
 454   }
 455
 456 }