test/jalview/datamodel/AlignmentTest.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.assertNotNull;
  26 import static org.testng.AssertJUnit.assertNull;
  27 import static org.testng.AssertJUnit.assertSame;
  28 import static org.testng.AssertJUnit.assertTrue;
  29
  30 import jalview.datamodel.AlignedCodonFrame.SequenceToSequenceMapping;
  31 import jalview.io.AppletFormatAdapter;
  32 import jalview.io.FormatAdapter;
  33 import jalview.util.MapList;
  34
  35 import java.io.IOException;
  36 import java.util.ArrayList;
  37 import java.util.Arrays;
  38 import java.util.Iterator;
  39 import java.util.List;
  40
  41 import org.testng.Assert;
  42 import org.testng.annotations.BeforeMethod;
  43 import org.testng.annotations.Test;
  44
  45 /**
  46  * Unit tests for Alignment datamodel.
  47  *
  48  * @author gmcarstairs
  49  *
  50  */
  51 public class AlignmentTest
  52 {
  53   // @formatter:off
  54   private static final String TEST_DATA =
  55           "# STOCKHOLM 1.0\n" +
  56           "#=GS D.melanogaster.1 AC AY119185.1/838-902\n" +
  57           "#=GS D.melanogaster.2 AC AC092237.1/57223-57161\n" +
  58           "#=GS D.melanogaster.3 AC AY060611.1/560-627\n" +
  59           "D.melanogaster.1          G.AGCC.CU...AUGAUCGA\n" +
  60           "#=GR D.melanogaster.1 SS  ................((((\n" +
  61           "D.melanogaster.2          C.AUUCAACU.UAUGAGGAU\n" +
  62           "#=GR D.melanogaster.2 SS  ................((((\n" +
  63           "D.melanogaster.3          G.UGGCGCU..UAUGACGCA\n" +
  64           "#=GR D.melanogaster.3 SS  (.(((...(....(((((((\n" +
  65           "//";
  66
  67   private static final String AA_SEQS_1 =
  68           ">Seq1Name/5-8\n" +
  69           "K-QY--L\n" +
  70           ">Seq2Name/12-15\n" +
  71           "-R-FP-W-\n";
  72
  73   private static final String CDNA_SEQS_1 =
  74           ">Seq1Name/100-111\n" +
  75           "AC-GG--CUC-CAA-CT\n" +
  76           ">Seq2Name/200-211\n" +
  77           "-CG-TTA--ACG---AAGT\n";
  78
  79   private static final String CDNA_SEQS_2 =
  80           ">Seq1Name/50-61\n" +
  81           "GCTCGUCGTACT\n" +
  82           ">Seq2Name/60-71\n" +
  83           "GGGTCAGGCAGT\n";
  84   // @formatter:on
  85
  86   private AlignmentI al;
  87
  88   /**
  89    * Helper method to load an alignment and ensure dataset sequences are set up.
  90    *
  91    * @param data
  92    * @param format
  93    *          TODO
  94    * @return
  95    * @throws IOException
  96    */
  97   protected AlignmentI loadAlignment(final String data, String format)
  98           throws IOException
  99   {
 100     AlignmentI a = new FormatAdapter().readFile(data,
 101             AppletFormatAdapter.PASTE, format);
 102     a.setDataset(null);
 103     return a;
 104   }
 105
 106   /**
 107    * assert wrapper: tests all references in the given alignment are consistent
 108    *
 109    * @param alignment
 110    */
 111   public static void assertAlignmentDatasetRefs(AlignmentI alignment)
 112   {
 113     verifyAlignmentDatasetRefs(alignment, true, null);
 114   }
 115
 116   /**
 117    * assert wrapper: tests all references in the given alignment are consistent
 118    *
 119    * @param alignment
 120    * @param message
 121    *          - prefixed to any assert failed messages
 122    */
 123   public static void assertAlignmentDatasetRefs(AlignmentI alignment,
 124           String message)
 125   {
 126     verifyAlignmentDatasetRefs(alignment, true, message);
 127   }
 128
 129   /**
 130    * verify sequence and dataset references are properly contained within
 131    * dataset
 132    *
 133    * @param alignment
 134    *          - the alignmentI object to verify (either alignment or dataset)
 135    * @param raiseAssert
 136    *          - when set, testng assertions are raised.
 137    *          @param message
 138    *          - null or a string message to prepend to the assert failed messages.
 139    * @return true if alignment references were in order, otherwise false.
 140    */
 141   public static boolean verifyAlignmentDatasetRefs(AlignmentI alignment,
 142           boolean raiseAssert, String message)
 143   {
 144     if (message==null) { message = ""; }
 145     if (alignment == null)
 146     {
 147       if (raiseAssert)
 148       {
 149         Assert.fail(message+"Alignment for verification was null.");
 150       }
 151       return false;
 152     }
 153     if (alignment.getDataset() != null)
 154     {
 155       AlignmentI dataset = alignment.getDataset();
 156       // check all alignment sequences have their dataset within the dataset
 157       for (SequenceI seq : alignment.getSequences())
 158       {
 159         SequenceI seqds = seq.getDatasetSequence();
 160         if (seqds.getDatasetSequence() != null)
 161         {
 162           if (raiseAssert)
 163           {
 164             Assert.fail(message+" Alignment contained a sequence who's dataset sequence has a second dataset reference.");
 165           }
 166           return false;
 167         }
 168         if (dataset.findIndex(seqds) == -1)
 169         {
 170           if (raiseAssert)
 171           {
 172             Assert.fail(message+" Alignment contained a sequence who's dataset sequence was not in the dataset.");
 173           }
 174           return false;
 175         }
 176       }
 177       return verifyAlignmentDatasetRefs(alignment.getDataset(), raiseAssert, message);
 178     }
 179     else
 180     {
 181       int dsp = -1;
 182       // verify all dataset sequences
 183       for (SequenceI seqds : alignment.getSequences())
 184       {
 185         dsp++;
 186         if (seqds.getDatasetSequence() != null)
 187         {
 188           if (raiseAssert)
 189           {
 190             Assert.fail(message+" Dataset contained a sequence with non-null dataset reference (ie not a dataset sequence!)");
 191           }
 192           return false;
 193         }
 194         int foundp = alignment.findIndex(seqds);
 195         if (foundp != dsp)
 196         {
 197           if (raiseAssert)
 198           {
 199             Assert.fail(message
 200                     + " Dataset sequence array contains a reference at "
 201                     + dsp + " to a sequence first seen at " + foundp + " ("
 202                     + seqds.toString() + ")");
 203           }
 204           return false;
 205         }
 206         if (seqds.getDBRefs() != null)
 207         {
 208           for (DBRefEntry dbr : seqds.getDBRefs())
 209           {
 210             if (dbr.getMap() != null)
 211             {
 212               SequenceI seqdbrmapto = dbr.getMap().getTo();
 213               if (seqdbrmapto != null)
 214               {
 215                 if (seqdbrmapto.getDatasetSequence() != null)
 216                 {
 217                   if (raiseAssert)
 218                   {
 219                     Assert.fail(message+" DBRefEntry for sequence in alignment had map to sequence which was not a dataset sequence");
 220                   }
 221                   return false;
 222
 223                 }
 224                 if (alignment.findIndex(dbr.getMap().getTo()) == -1)
 225                 {
 226                   if (raiseAssert)
 227                   {
 228                     Assert.fail(message+" DBRefEntry for sequence in alignment had map to sequence not in dataset");
 229                   }
 230                   return false;
 231                 }
 232               }
 233             }
 234           }
 235         }
 236       }
 237       // finally, verify codonmappings involve only dataset sequences.
 238       if (alignment.getCodonFrames() != null)
 239       {
 240         for (AlignedCodonFrame alc : alignment.getCodonFrames())
 241         {
 242           for (SequenceToSequenceMapping ssm : alc.getMappings())
 243           {
 244             if (ssm.getFromSeq().getDatasetSequence() != null)
 245             {
 246               if (raiseAssert)
 247               {
 248                 Assert.fail(message+" CodonFrame-SSM-FromSeq is not a dataset sequence");
 249               }
 250               return false;
 251             }
 252             if (alignment.findIndex(ssm.getFromSeq()) == -1)
 253             {
 254
 255               if (raiseAssert)
 256               {
 257                 Assert.fail(message+" CodonFrame-SSM-FromSeq is not contained in dataset");
 258               }
 259               return false;
 260             }
 261             if (ssm.getMapping().getTo().getDatasetSequence() != null)
 262             {
 263               if (raiseAssert)
 264               {
 265                 Assert.fail(message+" CodonFrame-SSM-Mapping-ToSeq is not a dataset sequence");
 266               }
 267               return false;
 268             }
 269             if (alignment.findIndex(ssm.getMapping().getTo()) == -1)
 270             {
 271
 272               if (raiseAssert)
 273               {
 274                 Assert.fail(message+" CodonFrame-SSM-Mapping-ToSeq is not contained in dataset");
 275               }
 276               return false;
 277             }
 278           }
 279         }
 280       }
 281     }
 282     return true; // all relationships verified!
 283   }
 284
 285   /**
 286    * call verifyAlignmentDatasetRefs with and without assertion raising enabled,
 287    * to check expected pass/fail actually occurs in both conditions
 288    *
 289    * @param al
 290    * @param expected
 291    * @param msg
 292    */
 293   private void assertVerifyAlignment(AlignmentI al, boolean expected,
 294           String msg)
 295   {
 296     if (expected)
 297     {
 298       try
 299       {
 300
 301         Assert.assertTrue(verifyAlignmentDatasetRefs(al, true, null),
 302                 "Valid test alignment failed when raiseAsserts enabled:"
 303                         + msg);
 304       } catch (AssertionError ae)
 305       {
 306         ae.printStackTrace();
 307         Assert.fail(
 308                 "Valid test alignment raised assertion errors when raiseAsserts enabled: "
 309                         + msg, ae);
 310       }
 311       // also check validation passes with asserts disabled
 312       Assert.assertTrue(verifyAlignmentDatasetRefs(al, false, null),
 313               "Valid test alignment tested false when raiseAsserts disabled:"
 314                       + msg);
 315     }
 316     else
 317     {
 318       boolean assertRaised = false;
 319       try
 320       {
 321         verifyAlignmentDatasetRefs(al, true, null);
 322       } catch (AssertionError ae)
 323       {
 324         // expected behaviour
 325         assertRaised = true;
 326       }
 327       if (!assertRaised)
 328       {
 329         Assert.fail("Invalid test alignment passed when raiseAsserts enabled:"
 330                 + msg);
 331       }
 332       // also check validation passes with asserts disabled
 333       Assert.assertFalse(verifyAlignmentDatasetRefs(al, false, null),
 334               "Invalid test alignment tested true when raiseAsserts disabled:"
 335                       + msg);
 336     }
 337   }
 338   @Test(groups = { "Functional" })
 339   public void testVerifyAlignmentDatasetRefs()
 340   {
 341     SequenceI sq1 = new Sequence("sq1", "ASFDD"), sq2 = new Sequence("sq2",
 342             "TTTTTT");
 343
 344     // construct simple valid alignment dataset
 345     Alignment al = new Alignment(new SequenceI[] {
 346         sq1, sq2 });
 347     // expect this to pass
 348     assertVerifyAlignment(al, true, "Simple valid alignment didn't verify");
 349
 350     // check test for sequence->datasetSequence validity
 351     sq1.setDatasetSequence(sq2);
 352     assertVerifyAlignment(
 353             al,
 354             false,
 355             "didn't detect dataset sequence with a dataset sequence reference.");
 356
 357     sq1.setDatasetSequence(null);
 358     assertVerifyAlignment(
 359             al,
 360             true,
 361             "didn't reinstate validity after nulling dataset sequence dataset reference");
 362
 363     // now create dataset and check again
 364     al.createDatasetAlignment();
 365     assertNotNull(al.getDataset());
 366
 367     assertVerifyAlignment(al, true,
 368             "verify failed after createDatasetAlignment");
 369
 370     // create a dbref on sq1 with a sequence ref to sq2
 371     DBRefEntry dbrs1tos2 = new DBRefEntry("UNIPROT", "1", "Q111111");
 372     dbrs1tos2.setMap(new Mapping(sq2.getDatasetSequence(),
 373             new int[] { 1, 5 }, new int[] { 2, 6 }, 1, 1));
 374     sq1.getDatasetSequence().addDBRef(dbrs1tos2);
 375     assertVerifyAlignment(al, true,
 376             "verify failed after addition of valid DBRefEntry/map");
 377     // now create a dbref on a new sequence which maps to another sequence
 378     // outside of the dataset
 379     SequenceI sqout = new Sequence("sqout", "ututututucagcagcag"), sqnew = new Sequence(
 380             "sqnew", "EEERRR");
 381     DBRefEntry sqnewsqout = new DBRefEntry("ENAFOO", "1", "R000001");
 382     sqnewsqout.setMap(new Mapping(sqout, new int[] { 1, 6 }, new int[] { 1,
 383         18 }, 1, 3));
 384     al.getDataset().addSequence(sqnew);
 385
 386     assertVerifyAlignment(al, true,
 387             "verify failed after addition of new sequence to dataset");
 388     // now start checking exception conditions
 389     sqnew.addDBRef(sqnewsqout);
 390     assertVerifyAlignment(
 391             al,
 392             false,
 393             "verify passed when a dbref with map to sequence outside of dataset was added");
 394     // make the verify pass by adding the outsider back in
 395     al.getDataset().addSequence(sqout);
 396     assertVerifyAlignment(al, true,
 397             "verify should have passed after adding dbref->to sequence in to dataset");
 398     // and now the same for a codon mapping...
 399     SequenceI sqanotherout = new Sequence("sqanotherout",
 400             "aggtutaggcagcagcag");
 401
 402     AlignedCodonFrame alc = new AlignedCodonFrame();
 403     alc.addMap(sqanotherout, sqnew, new MapList(new int[] { 1, 6 },
 404             new int[] { 1, 18 }, 3, 1));
 405
 406     al.addCodonFrame(alc);
 407     Assert.assertEquals(al.getDataset().getCodonFrames().size(), 1);
 408
 409     assertVerifyAlignment(
 410             al,
 411             false,
 412             "verify passed when alCodonFrame mapping to sequence outside of dataset was added");
 413     // make the verify pass by adding the outsider back in
 414     al.getDataset().addSequence(sqanotherout);
 415     assertVerifyAlignment(
 416             al,
 417             true,
 418             "verify should have passed once all sequences involved in alCodonFrame were added to dataset");
 419     al.getDataset().addSequence(sqanotherout);
 420     assertVerifyAlignment(al, false,
 421             "verify should have failed when a sequence was added twice to the dataset");
 422     al.getDataset().deleteSequence(sqanotherout);
 423     assertVerifyAlignment(al, true,
 424             "verify should have passed after duplicate entry for sequence was removed");
 425   }
 426
 427   /**
 428    * checks that the sequence data for an alignment's dataset is non-redundant.
 429    * Fails if there are sequences with same id, sequence, start, and.
 430    */
 431   public static void assertDatasetIsNormalised(AlignmentI al)
 432   {
 433     if (al.getDataset()!=null)
 434     {
 435       assertDatasetIsNormalised(al.getDataset());
 436       return;
 437     }
 438     /*
 439      * look for pairs of sequences with same ID, start, end, and sequence
 440      */
 441     List<SequenceI> seqSet = al.getSequences();
 442     for (int p=0;p<seqSet.size(); p++)
 443     {
 444       SequenceI pSeq = seqSet.get(p);
 445       for (int q=p+1; q<seqSet.size(); q++)
 446       {
 447         SequenceI qSeq = seqSet.get(q);
 448         if (pSeq.getStart()!=qSeq.getStart())
 449         {
 450           continue;
 451         }
 452         if (pSeq.getEnd()!=qSeq.getEnd())
 453         {
 454           continue;
 455         }
 456         if (!pSeq.getName().equals(qSeq.getName()))
 457         {
 458           continue;
 459         }
 460         if (!Arrays.equals(pSeq.getSequence(), qSeq.getSequence()))
 461         {
 462           continue;
 463         }
 464         Assert.fail("Found similar sequences at position "+p+" and "+q+"\n"+pSeq.toString());
 465       }
 466     }
 467   }
 468
 469   @Test(groups = { "Functional", "Asserts" })
 470   public void testAssertDatasetIsNormalised()
 471   {
 472     Sequence sq1 = new Sequence("s1/1-4", "asdf");
 473     Sequence sq1shift = new Sequence("s1/2-5", "asdf");
 474     Sequence sq1seqd = new Sequence("s1/1-4", "asdt");
 475     Sequence sq2 = new Sequence("s2/1-4", "asdf");
 476     Sequence sq1dup = new Sequence("s1/1-4", "asdf");
 477
 478     Alignment al = new Alignment(new SequenceI[] { sq1 });
 479     al.setDataset(null);
 480
 481     try
 482     {
 483       assertDatasetIsNormalised(al);
 484     } catch (AssertionError ae)
 485     {
 486       Assert.fail("Single sequence should be valid normalised dataset.");
 487     }
 488     al.addSequence(sq2);
 489     try
 490     {
 491       assertDatasetIsNormalised(al);
 492     } catch (AssertionError ae)
 493     {
 494       Assert.fail("Two different sequences should be valid normalised dataset.");
 495     }
 496     /*
 497      * now change sq2's name in the alignment. should still be valid
 498      */
 499     al.findName(sq2.getName()).setName("sq1");
 500     try
 501     {
 502       assertDatasetIsNormalised(al);
 503     } catch (AssertionError ae)
 504     {
 505       Assert.fail("Two different sequences in dataset, but same name in alignment, should be valid normalised dataset.");
 506     }
 507
 508     al.addSequence(sq1seqd);
 509     try
 510     {
 511       assertDatasetIsNormalised(al);
 512     } catch (AssertionError ae)
 513     {
 514       Assert.fail("sq1 and sq1 with different sequence should be distinct.");
 515     }
 516
 517     al.addSequence(sq1shift);
 518     try
 519     {
 520       assertDatasetIsNormalised(al);
 521     } catch (AssertionError ae)
 522     {
 523       Assert.fail("sq1 and sq1 with different start/end should be distinct.");
 524     }
 525     /*
 526      * finally, the failure case
 527      */
 528     al.addSequence(sq1dup);
 529     boolean ssertRaised = false;
 530     try
 531     {
 532       assertDatasetIsNormalised(al);
 533
 534     } catch (AssertionError ae)
 535     {
 536       ssertRaised = true;
 537     }
 538     if (!ssertRaised)
 539     {
 540       Assert.fail("Expected identical sequence to raise exception.");
 541     }
 542   }
 543   /*
 544    * Read in Stockholm format test data including secondary structure
 545    * annotations.
 546    */
 547   @BeforeMethod(alwaysRun = true)
 548   public void setUp() throws IOException
 549   {
 550     al = loadAlignment(TEST_DATA, "STH");
 551     int i = 0;
 552     for (AlignmentAnnotation ann : al.getAlignmentAnnotation())
 553     {
 554       ann.setCalcId("CalcIdFor" + al.getSequenceAt(i).getName());
 555       i++;
 556     }
 557   }
 558
 559   /**
 560    * Test method that returns annotations that match on calcId.
 561    */
 562   @Test(groups = { "Functional" })
 563   public void testFindAnnotation_byCalcId()
 564   {
 565     Iterable<AlignmentAnnotation> anns = al
 566             .findAnnotation("CalcIdForD.melanogaster.2");
 567     Iterator<AlignmentAnnotation> iter = anns.iterator();
 568     assertTrue(iter.hasNext());
 569     AlignmentAnnotation ann = iter.next();
 570     assertEquals("D.melanogaster.2", ann.sequenceRef.getName());
 571     assertFalse(iter.hasNext());
 572   }
 573
 574   @Test(groups = { "Functional" })
 575   public void testDeleteAllAnnotations_includingAutocalculated()
 576   {
 577     AlignmentAnnotation aa = new AlignmentAnnotation("Consensus",
 578             "Consensus", 0.5);
 579     aa.autoCalculated = true;
 580     al.addAnnotation(aa);
 581     AlignmentAnnotation[] anns = al.getAlignmentAnnotation();
 582     assertEquals("Wrong number of annotations before deleting", 4,
 583             anns.length);
 584     al.deleteAllAnnotations(true);
 585     assertEquals("Not all deleted", 0, al.getAlignmentAnnotation().length);
 586   }
 587
 588   @Test(groups = { "Functional" })
 589   public void testDeleteAllAnnotations_excludingAutocalculated()
 590   {
 591     AlignmentAnnotation aa = new AlignmentAnnotation("Consensus",
 592             "Consensus", 0.5);
 593     aa.autoCalculated = true;
 594     al.addAnnotation(aa);
 595     AlignmentAnnotation[] anns = al.getAlignmentAnnotation();
 596     assertEquals("Wrong number of annotations before deleting", 4,
 597             anns.length);
 598     al.deleteAllAnnotations(false);
 599     assertEquals("Not just one annotation left", 1,
 600             al.getAlignmentAnnotation().length);
 601   }
 602
 603   /**
 604    * Tests for realigning as per a supplied alignment: Dna as Dna.
 605    *
 606    * Note: AlignedCodonFrame's state variables are named for protein-to-cDNA
 607    * mapping, but can be exploited for a general 'sequence-to-sequence' mapping
 608    * as here.
 609    *
 610    * @throws IOException
 611    */
 612   @Test(groups = { "Functional" })
 613   public void testAlignAs_dnaAsDna() throws IOException
 614   {
 615     // aligned cDNA:
 616     AlignmentI al1 = loadAlignment(CDNA_SEQS_1, "FASTA");
 617     // unaligned cDNA:
 618     AlignmentI al2 = loadAlignment(CDNA_SEQS_2, "FASTA");
 619
 620     /*
 621      * Make mappings between sequences. The 'aligned cDNA' is playing the role
 622      * of what would normally be protein here.
 623      */
 624     makeMappings(al1, al2);
 625
 626     ((Alignment) al2).alignAs(al1, false, true);
 627     assertEquals("GC-TC--GUC-GTACT", al2.getSequenceAt(0)
 628             .getSequenceAsString());
 629     assertEquals("-GG-GTC--AGG--CAGT", al2.getSequenceAt(1)
 630             .getSequenceAsString());
 631   }
 632
 633   /**
 634    * Aligning protein from cDNA.
 635    *
 636    * @throws IOException
 637    */
 638   @Test(groups = { "Functional" })
 639   public void testAlignAs_proteinAsCdna() throws IOException
 640   {
 641     // see also AlignmentUtilsTests
 642     AlignmentI al1 = loadAlignment(CDNA_SEQS_1, "FASTA");
 643     AlignmentI al2 = loadAlignment(AA_SEQS_1, "FASTA");
 644     makeMappings(al1, al2);
 645
 646     // Fudge - alignProteinAsCdna expects mappings to be on protein
 647     al2.getCodonFrames().addAll(al1.getCodonFrames());
 648
 649     ((Alignment) al2).alignAs(al1, false, true);
 650     assertEquals("K-Q-Y-L-", al2.getSequenceAt(0).getSequenceAsString());
 651     assertEquals("-R-F-P-W", al2.getSequenceAt(1).getSequenceAsString());
 652   }
 653
 654   /**
 655    * Test aligning cdna as per protein alignment.
 656    *
 657    * @throws IOException
 658    */
 659   @Test(groups = { "Functional" }, enabled = true)
 660   // TODO review / update this test after redesign of alignAs method
 661   public void testAlignAs_cdnaAsProtein() throws IOException
 662   {
 663     /*
 664      * Load alignments and add mappings for cDNA to protein
 665      */
 666     AlignmentI al1 = loadAlignment(CDNA_SEQS_1, "FASTA");
 667     AlignmentI al2 = loadAlignment(AA_SEQS_1, "FASTA");
 668     makeMappings(al1, al2);
 669
 670     /*
 671      * Realign DNA; currently keeping existing gaps in introns only
 672      */
 673     ((Alignment) al1).alignAs(al2, false, true);
 674     assertEquals("ACG---GCUCCA------ACT---", al1.getSequenceAt(0)
 675             .getSequenceAsString());
 676     assertEquals("---CGT---TAACGA---AGT---", al1.getSequenceAt(1)
 677             .getSequenceAsString());
 678   }
 679
 680   /**
 681    * Test aligning cdna as per protein - single sequences
 682    *
 683    * @throws IOException
 684    */
 685   @Test(groups = { "Functional" }, enabled = true)
 686   // TODO review / update this test after redesign of alignAs method
 687   public void testAlignAs_cdnaAsProtein_singleSequence() throws IOException
 688   {
 689     /*
 690      * simple case insert one gap
 691      */
 692     verifyAlignAs(">dna\nCAAaaa\n", ">protein\nQ-K\n", "CAA---aaa");
 693
 694     /*
 695      * simple case but with sequence offsets
 696      */
 697     verifyAlignAs(">dna/5-10\nCAAaaa\n", ">protein/20-21\nQ-K\n",
 698             "CAA---aaa");
 699
 700     /*
 701      * insert gaps as per protein, drop gaps within codons
 702      */
 703     verifyAlignAs(">dna/10-18\nCA-Aa-aa--AGA\n", ">aa/6-8\n-Q-K--R\n",
 704             "---CAA---aaa------AGA");
 705   }
 706
 707   /**
 708    * Helper method that makes mappings and then aligns the first alignment as
 709    * the second
 710    *
 711    * @param fromSeqs
 712    * @param toSeqs
 713    * @param expected
 714    * @throws IOException
 715    */
 716   public void verifyAlignAs(String fromSeqs, String toSeqs, String expected)
 717           throws IOException
 718   {
 719     /*
 720      * Load alignments and add mappings from nucleotide to protein (or from
 721      * first to second if both the same type)
 722      */
 723     AlignmentI al1 = loadAlignment(fromSeqs, "FASTA");
 724     AlignmentI al2 = loadAlignment(toSeqs, "FASTA");
 725     makeMappings(al1, al2);
 726
 727     /*
 728      * Realign DNA; currently keeping existing gaps in introns only
 729      */
 730     ((Alignment) al1).alignAs(al2, false, true);
 731     assertEquals(expected, al1.getSequenceAt(0).getSequenceAsString());
 732   }
 733
 734   /**
 735    * Helper method to make mappings between sequences, and add the mappings to
 736    * the 'mapped from' alignment
 737    *
 738    * @param alFrom
 739    * @param alTo
 740    */
 741   public void makeMappings(AlignmentI alFrom, AlignmentI alTo)
 742   {
 743     int ratio = (alFrom.isNucleotide() == alTo.isNucleotide() ? 1 : 3);
 744
 745     AlignedCodonFrame acf = new AlignedCodonFrame();
 746
 747     for (int i = 0; i < alFrom.getHeight(); i++)
 748     {
 749       SequenceI seqFrom = alFrom.getSequenceAt(i);
 750       SequenceI seqTo = alTo.getSequenceAt(i);
 751       MapList ml = new MapList(new int[] { seqFrom.getStart(),
 752           seqFrom.getEnd() },
 753               new int[] { seqTo.getStart(), seqTo.getEnd() }, ratio, 1);
 754       acf.addMap(seqFrom, seqTo, ml);
 755     }
 756
 757     /*
 758      * not sure whether mappings 'belong' or protein or nucleotide
 759      * alignment, so adding to both ;~)
 760      */
 761     alFrom.addCodonFrame(acf);
 762     alTo.addCodonFrame(acf);
 763   }
 764
 765   /**
 766    * Test aligning dna as per protein alignment, for the case where there are
 767    * introns (i.e. some dna sites have no mapping from a peptide).
 768    *
 769    * @throws IOException
 770    */
 771   @Test(groups = { "Functional" }, enabled = false)
 772   // TODO review / update this test after redesign of alignAs method
 773   public void testAlignAs_dnaAsProtein_withIntrons() throws IOException
 774   {
 775     /*
 776      * Load alignments and add mappings for cDNA to protein
 777      */
 778     String dna1 = "A-Aa-gG-GCC-cT-TT";
 779     String dna2 = "c--CCGgg-TT--T-AA-A";
 780     AlignmentI al1 = loadAlignment(">Dna1/6-17\n" + dna1
 781             + "\n>Dna2/20-31\n" + dna2 + "\n", "FASTA");
 782     AlignmentI al2 = loadAlignment(
 783             ">Pep1/7-9\n-P--YK\n>Pep2/11-13\nG-T--F\n", "FASTA");
 784     AlignedCodonFrame acf = new AlignedCodonFrame();
 785     // Seq1 has intron at dna positions 3,4,9 so splice is AAG GCC TTT
 786     // Seq2 has intron at dna positions 1,5,6 so splice is CCG TTT AAA
 787     MapList ml1 = new MapList(new int[] { 6, 7, 10, 13, 15, 17 }, new int[]
 788     { 7, 9 }, 3, 1);
 789     acf.addMap(al1.getSequenceAt(0), al2.getSequenceAt(0), ml1);
 790     MapList ml2 = new MapList(new int[] { 21, 23, 26, 31 }, new int[] { 11,
 791         13 }, 3, 1);
 792     acf.addMap(al1.getSequenceAt(1), al2.getSequenceAt(1), ml2);
 793     al2.addCodonFrame(acf);
 794
 795     /*
 796      * Align ignoring gaps in dna introns and exons
 797      */
 798     ((Alignment) al1).alignAs(al2, false, false);
 799     assertEquals("---AAagG------GCCcTTT", al1.getSequenceAt(0)
 800             .getSequenceAsString());
 801     // note 1 gap in protein corresponds to 'gg-' in DNA (3 positions)
 802     assertEquals("cCCGgg-TTT------AAA", al1.getSequenceAt(1)
 803             .getSequenceAsString());
 804
 805     /*
 806      * Reset and realign, preserving gaps in dna introns and exons
 807      */
 808     al1.getSequenceAt(0).setSequence(dna1);
 809     al1.getSequenceAt(1).setSequence(dna2);
 810     ((Alignment) al1).alignAs(al2, true, true);
 811     // String dna1 = "A-Aa-gG-GCC-cT-TT";
 812     // String dna2 = "c--CCGgg-TT--T-AA-A";
 813     // assumption: we include 'the greater of' protein/dna gap lengths, not both
 814     assertEquals("---A-Aa-gG------GCC-cT-TT", al1.getSequenceAt(0)
 815             .getSequenceAsString());
 816     assertEquals("c--CCGgg-TT--T------AA-A", al1.getSequenceAt(1)
 817             .getSequenceAsString());
 818   }
 819
 820   @Test(groups = "Functional")
 821   public void testCopyConstructor() throws IOException
 822   {
 823     AlignmentI protein = loadAlignment(AA_SEQS_1, FormatAdapter.PASTE);
 824     // create sequence and alignment datasets
 825     protein.setDataset(null);
 826     AlignedCodonFrame acf = new AlignedCodonFrame();
 827     List<AlignedCodonFrame> acfList = Arrays.asList(new AlignedCodonFrame[]
 828     { acf });
 829     protein.getDataset().setCodonFrames(acfList);
 830     AlignmentI copy = new Alignment(protein);
 831
 832     /*
 833      * copy has different aligned sequences but the same dataset sequences
 834      */
 835     assertFalse(copy.getSequenceAt(0) == protein.getSequenceAt(0));
 836     assertFalse(copy.getSequenceAt(1) == protein.getSequenceAt(1));
 837     assertSame(copy.getSequenceAt(0).getDatasetSequence(), protein
 838             .getSequenceAt(0).getDatasetSequence());
 839     assertSame(copy.getSequenceAt(1).getDatasetSequence(), protein
 840             .getSequenceAt(1).getDatasetSequence());
 841
 842     // TODO should the copy constructor copy the dataset?
 843     // or make a new one referring to the same dataset sequences??
 844     assertNull(copy.getDataset());
 845     // TODO test metadata is copied when AlignmentI is a dataset
 846
 847     // assertArrayEquals(copy.getDataset().getSequencesArray(), protein
 848     // .getDataset().getSequencesArray());
 849   }
 850
 851   /**
 852    * Test behaviour of createDataset
 853    *
 854    * @throws IOException
 855    */
 856   @Test(groups = "Functional")
 857   public void testCreateDatasetAlignment() throws IOException
 858   {
 859     AlignmentI protein = new FormatAdapter().readFile(AA_SEQS_1,
 860             AppletFormatAdapter.PASTE, "FASTA");
 861     /*
 862      * create a dataset sequence on first sequence
 863      * leave the second without one
 864      */
 865     protein.getSequenceAt(0).createDatasetSequence();
 866     assertNotNull(protein.getSequenceAt(0).getDatasetSequence());
 867     assertNull(protein.getSequenceAt(1).getDatasetSequence());
 868
 869     /*
 870      * add a mapping to the alignment
 871      */
 872     AlignedCodonFrame acf = new AlignedCodonFrame();
 873     protein.addCodonFrame(acf);
 874     assertNull(protein.getDataset());
 875     assertTrue(protein.getCodonFrames().contains(acf));
 876
 877     /*
 878      * create the alignment dataset
 879      * note this creates sequence datasets where missing
 880      * as a side-effect (in this case, on seq2
 881      */
 882     // TODO promote this method to AlignmentI
 883     ((Alignment) protein).createDatasetAlignment();
 884
 885     AlignmentI ds = protein.getDataset();
 886
 887     // side-effect: dataset created on second sequence
 888     assertNotNull(protein.getSequenceAt(1).getDatasetSequence());
 889     // dataset alignment has references to dataset sequences
 890     assertEquals(ds.getSequenceAt(0), protein.getSequenceAt(0)
 891             .getDatasetSequence());
 892     assertEquals(ds.getSequenceAt(1), protein.getSequenceAt(1)
 893             .getDatasetSequence());
 894
 895     // codon frames should have been moved to the dataset
 896     // getCodonFrames() should delegate to the dataset:
 897     assertTrue(protein.getCodonFrames().contains(acf));
 898     // prove the codon frames are indeed on the dataset:
 899     assertTrue(ds.getCodonFrames().contains(acf));
 900   }
 901
 902   /**
 903    * tests the addition of *all* sequences referred to by a sequence being added
 904    * to the dataset
 905    */
 906   @Test(groups = "Functional")
 907   public void testCreateDatasetAlignmentWithMappedToSeqs()
 908   {
 909     // Alignment with two sequences, gapped.
 910     SequenceI sq1 = new Sequence("sq1", "A--SDF");
 911     SequenceI sq2 = new Sequence("sq2", "G--TRQ");
 912
 913     // cross-references to two more sequences.
 914     DBRefEntry dbr = new DBRefEntry("SQ1", "", "sq3");
 915     SequenceI sq3 = new Sequence("sq3", "VWANG");
 916     dbr.setMap(new Mapping(sq3, new MapList(new int[] { 1, 4 }, new int[] {
 917         2, 5 }, 1, 1)));
 918     sq1.addDBRef(dbr);
 919
 920     SequenceI sq4 = new Sequence("sq4", "ERKWI");
 921     DBRefEntry dbr2 = new DBRefEntry("SQ2", "", "sq4");
 922     dbr2.setMap(new Mapping(sq4, new MapList(new int[] { 1, 4 }, new int[] {
 923         2, 5 }, 1, 1)));
 924     sq2.addDBRef(dbr2);
 925     // and a 1:1 codonframe mapping between them.
 926     AlignedCodonFrame alc = new AlignedCodonFrame();
 927     alc.addMap(sq1, sq2, new MapList(new int[] { 1, 4 },
 928             new int[] { 1, 4 }, 1, 1));
 929
 930     AlignmentI protein = new Alignment(new SequenceI[] { sq1, sq2 });
 931
 932     /*
 933      * create the alignment dataset
 934      * note this creates sequence datasets where missing
 935      * as a side-effect (in this case, on seq2
 936      */
 937
 938     // TODO promote this method to AlignmentI
 939     ((Alignment) protein).createDatasetAlignment();
 940
 941     AlignmentI ds = protein.getDataset();
 942
 943     // should be 4 sequences in dataset - two materialised, and two propagated
 944     // from dbref
 945     assertEquals(4, ds.getHeight());
 946     assertTrue(ds.getSequences().contains(sq1.getDatasetSequence()));
 947     assertTrue(ds.getSequences().contains(sq2.getDatasetSequence()));
 948     assertTrue(ds.getSequences().contains(sq3));
 949     assertTrue(ds.getSequences().contains(sq4));
 950     // Should have one codon frame mapping between sq1 and sq2 via dataset
 951     // sequences
 952     assertEquals(ds.getCodonFrame(sq1.getDatasetSequence()),
 953             ds.getCodonFrame(sq2.getDatasetSequence()));
 954   }
 955
 956   @Test(groups = "Functional")
 957   public void testAddCodonFrame()
 958   {
 959     AlignmentI align = new Alignment(new SequenceI[] {});
 960     AlignedCodonFrame acf = new AlignedCodonFrame();
 961     align.addCodonFrame(acf);
 962     assertEquals(1, align.getCodonFrames().size());
 963     assertTrue(align.getCodonFrames().contains(acf));
 964     // can't add the same object twice:
 965     align.addCodonFrame(acf);
 966     assertEquals(1, align.getCodonFrames().size());
 967
 968     // create dataset alignment - mappings move to dataset
 969     ((Alignment) align).createDatasetAlignment();
 970     assertSame(align.getCodonFrames(), align.getDataset().getCodonFrames());
 971     assertEquals(1, align.getCodonFrames().size());
 972
 973     AlignedCodonFrame acf2 = new AlignedCodonFrame();
 974     align.addCodonFrame(acf2);
 975     assertTrue(align.getDataset().getCodonFrames().contains(acf));
 976   }
 977
 978   @Test(groups = "Functional")
 979   public void testAddSequencePreserveDatasetIntegrity()
 980   {
 981     Sequence seq = new Sequence("testSeq", "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
 982     Alignment align = new Alignment(new SequenceI[] { seq });
 983     align.createDatasetAlignment();
 984     AlignmentI ds = align.getDataset();
 985     SequenceI copy = new Sequence(seq);
 986     copy.insertCharAt(3, 5, '-');
 987     align.addSequence(copy);
 988     Assert.assertEquals(align.getDataset().getHeight(), 1,
 989             "Dataset shouldn't have more than one sequence.");
 990
 991     Sequence seq2 = new Sequence("newtestSeq", "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
 992     align.addSequence(seq2);
 993     Assert.assertEquals(align.getDataset().getHeight(), 2,
 994             "Dataset should now have two sequences.");
 995
 996     assertAlignmentDatasetRefs(align,
 997             "addSequence broke dataset reference integrity");
 998   }
 999   @Test(groups = "Functional")
1000   public void getVisibleStartAndEndIndexTest()
1001   {
1002     Sequence seq = new Sequence("testSeq", "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
1003     AlignmentI align = new Alignment(new SequenceI[] { seq });
1004     ArrayList<int[]> hiddenCols = new ArrayList<int[]>();
1005
1006     int[] startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
1007     assertEquals(0, startEnd[0]);
1008     assertEquals(25, startEnd[1]);
1009
1010     hiddenCols.add(new int[] { 0, 0 });
1011     startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
1012     assertEquals(1, startEnd[0]);
1013     assertEquals(25, startEnd[1]);
1014
1015     hiddenCols.add(new int[] { 6, 9 });
1016     hiddenCols.add(new int[] { 11, 12 });
1017     startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
1018     assertEquals(1, startEnd[0]);
1019     assertEquals(25, startEnd[1]);
1020
1021     hiddenCols.add(new int[] { 24, 25 });
1022     startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
1023     System.out.println(startEnd[0] + " : " + startEnd[1]);
1024     assertEquals(1, startEnd[0]);
1025     assertEquals(23, startEnd[1]);
1026   }
1027 }