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       // verify all dataset sequences
 182       for (SequenceI seqds : alignment.getSequences())
 183       {
 184         if (seqds.getDatasetSequence() != null)
 185         {
 186           if (raiseAssert)
 187           {
 188             Assert.fail(message+" Dataset contained a sequence with non-null dataset reference (ie not a dataset sequence!)");
 189           }
 190           return false;
 191         }
 192         if (seqds.getDBRefs() != null)
 193         {
 194           for (DBRefEntry dbr : seqds.getDBRefs())
 195           {
 196             if (dbr.getMap() != null)
 197             {
 198               SequenceI seqdbrmapto = dbr.getMap().getTo();
 199               if (seqdbrmapto != null)
 200               {
 201                 if (seqdbrmapto.getDatasetSequence() != null)
 202                 {
 203                   if (raiseAssert)
 204                   {
 205                     Assert.fail(message+" DBRefEntry for sequence in alignment had map to sequence which was not a dataset sequence");
 206                   }
 207                   return false;
 208
 209                 }
 210                 if (alignment.findIndex(dbr.getMap().getTo()) == -1)
 211                 {
 212                   if (raiseAssert)
 213                   {
 214                     Assert.fail(message+" DBRefEntry for sequence in alignment had map to sequence not in dataset");
 215                   }
 216                   return false;
 217                 }
 218               }
 219             }
 220           }
 221         }
 222       }
 223       // finally, verify codonmappings involve only dataset sequences.
 224       if (alignment.getCodonFrames() != null)
 225       {
 226         for (AlignedCodonFrame alc : alignment.getCodonFrames())
 227         {
 228           for (SequenceToSequenceMapping ssm : alc.getMappings())
 229           {
 230             if (ssm.getFromSeq().getDatasetSequence() != null)
 231             {
 232               if (raiseAssert)
 233               {
 234                 Assert.fail(message+" CodonFrame-SSM-FromSeq is not a dataset sequence");
 235               }
 236               return false;
 237             }
 238             if (alignment.findIndex(ssm.getFromSeq()) == -1)
 239             {
 240
 241               if (raiseAssert)
 242               {
 243                 Assert.fail(message+" CodonFrame-SSM-FromSeq is not contained in dataset");
 244               }
 245               return false;
 246             }
 247             if (ssm.getMapping().getTo().getDatasetSequence() != null)
 248             {
 249               if (raiseAssert)
 250               {
 251                 Assert.fail(message+" CodonFrame-SSM-Mapping-ToSeq is not a dataset sequence");
 252               }
 253               return false;
 254             }
 255             if (alignment.findIndex(ssm.getMapping().getTo()) == -1)
 256             {
 257
 258               if (raiseAssert)
 259               {
 260                 Assert.fail(message+" CodonFrame-SSM-Mapping-ToSeq is not contained in dataset");
 261               }
 262               return false;
 263             }
 264           }
 265         }
 266       }
 267     }
 268     return true; // all relationships verified!
 269   }
 270
 271   /**
 272    * call verifyAlignmentDatasetRefs with and without assertion raising enabled,
 273    * to check expected pass/fail actually occurs in both conditions
 274    *
 275    * @param al
 276    * @param expected
 277    * @param msg
 278    */
 279   private void assertVerifyAlignment(AlignmentI al, boolean expected,
 280           String msg)
 281   {
 282     if (expected)
 283     {
 284       try
 285       {
 286
 287         Assert.assertTrue(verifyAlignmentDatasetRefs(al, true, null),
 288                 "Valid test alignment failed when raiseAsserts enabled:"
 289                         + msg);
 290       } catch (AssertionError ae)
 291       {
 292         ae.printStackTrace();
 293         Assert.fail(
 294                 "Valid test alignment raised assertion errors when raiseAsserts enabled: "
 295                         + msg, ae);
 296       }
 297       // also check validation passes with asserts disabled
 298       Assert.assertTrue(verifyAlignmentDatasetRefs(al, false, null),
 299               "Valid test alignment failed when raiseAsserts disabled:"
 300                       + msg);
 301     }
 302     else
 303     {
 304       try
 305       {
 306         Assert.assertFalse(verifyAlignmentDatasetRefs(al, true, null));
 307         Assert.fail("Invalid test alignment passed but no assertion raised when raiseAsserts enabled:"
 308                 + msg);
 309       } catch (AssertionError ae)
 310       {
 311         // expected behaviour
 312       }
 313       // also check validation passes with asserts disabled
 314       Assert.assertFalse(verifyAlignmentDatasetRefs(al, false, null),
 315               "Invalid test alignment passed when raiseAsserts disabled:"
 316                       + msg);
 317     }
 318   }
 319   @Test(groups = { "Functional" })
 320   public void testVerifyAlignmentDatasetRefs()
 321   {
 322     SequenceI sq1 = new Sequence("sq1", "ASFDD"), sq2 = new Sequence("sq2",
 323             "TTTTTT");
 324
 325     // construct simple valid alignment dataset
 326     Alignment al = new Alignment(new SequenceI[] {
 327         sq1, sq2 });
 328     // expect this to pass
 329     assertVerifyAlignment(al, true, "Simple valid alignment didn't verify");
 330
 331     // check test for sequence->datasetSequence validity
 332     sq1.setDatasetSequence(sq2);
 333     assertVerifyAlignment(
 334             al,
 335             false,
 336             "didn't detect dataset sequence with a dataset sequence reference.");
 337
 338     sq1.setDatasetSequence(null);
 339     assertVerifyAlignment(
 340             al,
 341             true,
 342             "didn't reinstate validity after nulling dataset sequence dataset reference");
 343
 344     // now create dataset and check again
 345     al.createDatasetAlignment();
 346     assertNotNull(al.getDataset());
 347
 348     assertVerifyAlignment(al, true,
 349             "verify failed after createDatasetAlignment");
 350
 351     // create a dbref on sq1 with a sequence ref to sq2
 352     DBRefEntry dbrs1tos2 = new DBRefEntry("UNIPROT", "1", "Q111111");
 353     dbrs1tos2.setMap(new Mapping(sq2.getDatasetSequence(),
 354             new int[] { 1, 5 }, new int[] { 2, 6 }, 1, 1));
 355     sq1.getDatasetSequence().addDBRef(dbrs1tos2);
 356     assertVerifyAlignment(al, true,
 357             "verify failed after addition of valid DBRefEntry/map");
 358     // now create a dbref on a new sequence which maps to another sequence
 359     // outside of the dataset
 360     SequenceI sqout = new Sequence("sqout", "ututututucagcagcag"), sqnew = new Sequence(
 361             "sqnew", "EEERRR");
 362     DBRefEntry sqnewsqout = new DBRefEntry("ENAFOO", "1", "R000001");
 363     sqnewsqout.setMap(new Mapping(sqout, new int[] { 1, 6 }, new int[] { 1,
 364         18 }, 1, 3));
 365     al.getDataset().addSequence(sqnew);
 366
 367     assertVerifyAlignment(al, true,
 368             "verify failed after addition of new sequence to dataset");
 369     // now start checking exception conditions
 370     sqnew.addDBRef(sqnewsqout);
 371     assertVerifyAlignment(
 372             al,
 373             false,
 374             "verify passed when a dbref with map to sequence outside of dataset was added");
 375     // make the verify pass by adding the outsider back in
 376     al.getDataset().addSequence(sqout);
 377     assertVerifyAlignment(al, true,
 378             "verify should have passed after adding dbref->to sequence in to dataset");
 379     // and now the same for a codon mapping...
 380     SequenceI sqanotherout = new Sequence("sqanotherout",
 381             "aggtutaggcagcagcag");
 382
 383     AlignedCodonFrame alc = new AlignedCodonFrame();
 384     alc.addMap(sqanotherout, sqnew, new MapList(new int[] { 1, 6 },
 385             new int[] { 1, 18 }, 3, 1));
 386
 387     al.addCodonFrame(alc);
 388     Assert.assertEquals(al.getDataset().getCodonFrames().size(), 1);
 389
 390     assertVerifyAlignment(
 391             al,
 392             false,
 393             "verify passed when alCodonFrame mapping to sequence outside of dataset was added");
 394     // make the verify pass by adding the outsider back in
 395     al.getDataset().addSequence(sqanotherout);
 396     assertVerifyAlignment(
 397             al,
 398             true,
 399             "verify should have passed once all sequences involved in alCodonFrame were added to dataset");
 400     al.getDataset().addSequence(sqanotherout);
 401     assertVerifyAlignment(al, false,
 402             "verify should have failed when a sequence was added twice to the dataset");
 403
 404   }
 405   /*
 406    * Read in Stockholm format test data including secondary structure
 407    * annotations.
 408    */
 409   @BeforeMethod(alwaysRun = true)
 410   public void setUp() throws IOException
 411   {
 412     al = loadAlignment(TEST_DATA, "STH");
 413     int i = 0;
 414     for (AlignmentAnnotation ann : al.getAlignmentAnnotation())
 415     {
 416       ann.setCalcId("CalcIdFor" + al.getSequenceAt(i).getName());
 417       i++;
 418     }
 419   }
 420
 421   /**
 422    * Test method that returns annotations that match on calcId.
 423    */
 424   @Test(groups = { "Functional" })
 425   public void testFindAnnotation_byCalcId()
 426   {
 427     Iterable<AlignmentAnnotation> anns = al
 428             .findAnnotation("CalcIdForD.melanogaster.2");
 429     Iterator<AlignmentAnnotation> iter = anns.iterator();
 430     assertTrue(iter.hasNext());
 431     AlignmentAnnotation ann = iter.next();
 432     assertEquals("D.melanogaster.2", ann.sequenceRef.getName());
 433     assertFalse(iter.hasNext());
 434   }
 435
 436   @Test(groups = { "Functional" })
 437   public void testDeleteAllAnnotations_includingAutocalculated()
 438   {
 439     AlignmentAnnotation aa = new AlignmentAnnotation("Consensus",
 440             "Consensus", 0.5);
 441     aa.autoCalculated = true;
 442     al.addAnnotation(aa);
 443     AlignmentAnnotation[] anns = al.getAlignmentAnnotation();
 444     assertEquals("Wrong number of annotations before deleting", 4,
 445             anns.length);
 446     al.deleteAllAnnotations(true);
 447     assertEquals("Not all deleted", 0, al.getAlignmentAnnotation().length);
 448   }
 449
 450   @Test(groups = { "Functional" })
 451   public void testDeleteAllAnnotations_excludingAutocalculated()
 452   {
 453     AlignmentAnnotation aa = new AlignmentAnnotation("Consensus",
 454             "Consensus", 0.5);
 455     aa.autoCalculated = true;
 456     al.addAnnotation(aa);
 457     AlignmentAnnotation[] anns = al.getAlignmentAnnotation();
 458     assertEquals("Wrong number of annotations before deleting", 4,
 459             anns.length);
 460     al.deleteAllAnnotations(false);
 461     assertEquals("Not just one annotation left", 1,
 462             al.getAlignmentAnnotation().length);
 463   }
 464
 465   /**
 466    * Tests for realigning as per a supplied alignment: Dna as Dna.
 467    *
 468    * Note: AlignedCodonFrame's state variables are named for protein-to-cDNA
 469    * mapping, but can be exploited for a general 'sequence-to-sequence' mapping
 470    * as here.
 471    *
 472    * @throws IOException
 473    */
 474   @Test(groups = { "Functional" })
 475   public void testAlignAs_dnaAsDna() throws IOException
 476   {
 477     // aligned cDNA:
 478     AlignmentI al1 = loadAlignment(CDNA_SEQS_1, "FASTA");
 479     // unaligned cDNA:
 480     AlignmentI al2 = loadAlignment(CDNA_SEQS_2, "FASTA");
 481
 482     /*
 483      * Make mappings between sequences. The 'aligned cDNA' is playing the role
 484      * of what would normally be protein here.
 485      */
 486     makeMappings(al1, al2);
 487
 488     ((Alignment) al2).alignAs(al1, false, true);
 489     assertEquals("GC-TC--GUC-GTACT", al2.getSequenceAt(0)
 490             .getSequenceAsString());
 491     assertEquals("-GG-GTC--AGG--CAGT", al2.getSequenceAt(1)
 492             .getSequenceAsString());
 493   }
 494
 495   /**
 496    * Aligning protein from cDNA.
 497    *
 498    * @throws IOException
 499    */
 500   @Test(groups = { "Functional" })
 501   public void testAlignAs_proteinAsCdna() throws IOException
 502   {
 503     // see also AlignmentUtilsTests
 504     AlignmentI al1 = loadAlignment(CDNA_SEQS_1, "FASTA");
 505     AlignmentI al2 = loadAlignment(AA_SEQS_1, "FASTA");
 506     makeMappings(al1, al2);
 507
 508     // Fudge - alignProteinAsCdna expects mappings to be on protein
 509     al2.getCodonFrames().addAll(al1.getCodonFrames());
 510
 511     ((Alignment) al2).alignAs(al1, false, true);
 512     assertEquals("K-Q-Y-L-", al2.getSequenceAt(0).getSequenceAsString());
 513     assertEquals("-R-F-P-W", al2.getSequenceAt(1).getSequenceAsString());
 514   }
 515
 516   /**
 517    * Test aligning cdna as per protein alignment.
 518    *
 519    * @throws IOException
 520    */
 521   @Test(groups = { "Functional" }, enabled = true)
 522   // TODO review / update this test after redesign of alignAs method
 523   public void testAlignAs_cdnaAsProtein() throws IOException
 524   {
 525     /*
 526      * Load alignments and add mappings for cDNA to protein
 527      */
 528     AlignmentI al1 = loadAlignment(CDNA_SEQS_1, "FASTA");
 529     AlignmentI al2 = loadAlignment(AA_SEQS_1, "FASTA");
 530     makeMappings(al1, al2);
 531
 532     /*
 533      * Realign DNA; currently keeping existing gaps in introns only
 534      */
 535     ((Alignment) al1).alignAs(al2, false, true);
 536     assertEquals("ACG---GCUCCA------ACT---", al1.getSequenceAt(0)
 537             .getSequenceAsString());
 538     assertEquals("---CGT---TAACGA---AGT---", al1.getSequenceAt(1)
 539             .getSequenceAsString());
 540   }
 541
 542   /**
 543    * Test aligning cdna as per protein - single sequences
 544    *
 545    * @throws IOException
 546    */
 547   @Test(groups = { "Functional" }, enabled = true)
 548   // TODO review / update this test after redesign of alignAs method
 549   public void testAlignAs_cdnaAsProtein_singleSequence() throws IOException
 550   {
 551     /*
 552      * simple case insert one gap
 553      */
 554     verifyAlignAs(">dna\nCAAaaa\n", ">protein\nQ-K\n", "CAA---aaa");
 555
 556     /*
 557      * simple case but with sequence offsets
 558      */
 559     verifyAlignAs(">dna/5-10\nCAAaaa\n", ">protein/20-21\nQ-K\n",
 560             "CAA---aaa");
 561
 562     /*
 563      * insert gaps as per protein, drop gaps within codons
 564      */
 565     verifyAlignAs(">dna/10-18\nCA-Aa-aa--AGA\n", ">aa/6-8\n-Q-K--R\n",
 566             "---CAA---aaa------AGA");
 567   }
 568
 569   /**
 570    * Helper method that makes mappings and then aligns the first alignment as
 571    * the second
 572    *
 573    * @param fromSeqs
 574    * @param toSeqs
 575    * @param expected
 576    * @throws IOException
 577    */
 578   public void verifyAlignAs(String fromSeqs, String toSeqs, String expected)
 579           throws IOException
 580   {
 581     /*
 582      * Load alignments and add mappings from nucleotide to protein (or from
 583      * first to second if both the same type)
 584      */
 585     AlignmentI al1 = loadAlignment(fromSeqs, "FASTA");
 586     AlignmentI al2 = loadAlignment(toSeqs, "FASTA");
 587     makeMappings(al1, al2);
 588
 589     /*
 590      * Realign DNA; currently keeping existing gaps in introns only
 591      */
 592     ((Alignment) al1).alignAs(al2, false, true);
 593     assertEquals(expected, al1.getSequenceAt(0).getSequenceAsString());
 594   }
 595
 596   /**
 597    * Helper method to make mappings between sequences, and add the mappings to
 598    * the 'mapped from' alignment
 599    *
 600    * @param alFrom
 601    * @param alTo
 602    */
 603   public void makeMappings(AlignmentI alFrom, AlignmentI alTo)
 604   {
 605     int ratio = (alFrom.isNucleotide() == alTo.isNucleotide() ? 1 : 3);
 606
 607     AlignedCodonFrame acf = new AlignedCodonFrame();
 608
 609     for (int i = 0; i < alFrom.getHeight(); i++)
 610     {
 611       SequenceI seqFrom = alFrom.getSequenceAt(i);
 612       SequenceI seqTo = alTo.getSequenceAt(i);
 613       MapList ml = new MapList(new int[] { seqFrom.getStart(),
 614           seqFrom.getEnd() },
 615               new int[] { seqTo.getStart(), seqTo.getEnd() }, ratio, 1);
 616       acf.addMap(seqFrom, seqTo, ml);
 617     }
 618
 619     /*
 620      * not sure whether mappings 'belong' or protein or nucleotide
 621      * alignment, so adding to both ;~)
 622      */
 623     alFrom.addCodonFrame(acf);
 624     alTo.addCodonFrame(acf);
 625   }
 626
 627   /**
 628    * Test aligning dna as per protein alignment, for the case where there are
 629    * introns (i.e. some dna sites have no mapping from a peptide).
 630    *
 631    * @throws IOException
 632    */
 633   @Test(groups = { "Functional" }, enabled = false)
 634   // TODO review / update this test after redesign of alignAs method
 635   public void testAlignAs_dnaAsProtein_withIntrons() throws IOException
 636   {
 637     /*
 638      * Load alignments and add mappings for cDNA to protein
 639      */
 640     String dna1 = "A-Aa-gG-GCC-cT-TT";
 641     String dna2 = "c--CCGgg-TT--T-AA-A";
 642     AlignmentI al1 = loadAlignment(">Dna1/6-17\n" + dna1
 643             + "\n>Dna2/20-31\n" + dna2 + "\n", "FASTA");
 644     AlignmentI al2 = loadAlignment(
 645             ">Pep1/7-9\n-P--YK\n>Pep2/11-13\nG-T--F\n", "FASTA");
 646     AlignedCodonFrame acf = new AlignedCodonFrame();
 647     // Seq1 has intron at dna positions 3,4,9 so splice is AAG GCC TTT
 648     // Seq2 has intron at dna positions 1,5,6 so splice is CCG TTT AAA
 649     MapList ml1 = new MapList(new int[] { 6, 7, 10, 13, 15, 17 }, new int[]
 650     { 7, 9 }, 3, 1);
 651     acf.addMap(al1.getSequenceAt(0), al2.getSequenceAt(0), ml1);
 652     MapList ml2 = new MapList(new int[] { 21, 23, 26, 31 }, new int[] { 11,
 653         13 }, 3, 1);
 654     acf.addMap(al1.getSequenceAt(1), al2.getSequenceAt(1), ml2);
 655     al2.addCodonFrame(acf);
 656
 657     /*
 658      * Align ignoring gaps in dna introns and exons
 659      */
 660     ((Alignment) al1).alignAs(al2, false, false);
 661     assertEquals("---AAagG------GCCcTTT", al1.getSequenceAt(0)
 662             .getSequenceAsString());
 663     // note 1 gap in protein corresponds to 'gg-' in DNA (3 positions)
 664     assertEquals("cCCGgg-TTT------AAA", al1.getSequenceAt(1)
 665             .getSequenceAsString());
 666
 667     /*
 668      * Reset and realign, preserving gaps in dna introns and exons
 669      */
 670     al1.getSequenceAt(0).setSequence(dna1);
 671     al1.getSequenceAt(1).setSequence(dna2);
 672     ((Alignment) al1).alignAs(al2, true, true);
 673     // String dna1 = "A-Aa-gG-GCC-cT-TT";
 674     // String dna2 = "c--CCGgg-TT--T-AA-A";
 675     // assumption: we include 'the greater of' protein/dna gap lengths, not both
 676     assertEquals("---A-Aa-gG------GCC-cT-TT", al1.getSequenceAt(0)
 677             .getSequenceAsString());
 678     assertEquals("c--CCGgg-TT--T------AA-A", al1.getSequenceAt(1)
 679             .getSequenceAsString());
 680   }
 681
 682   @Test(groups = "Functional")
 683   public void testCopyConstructor() throws IOException
 684   {
 685     AlignmentI protein = loadAlignment(AA_SEQS_1, FormatAdapter.PASTE);
 686     // create sequence and alignment datasets
 687     protein.setDataset(null);
 688     AlignedCodonFrame acf = new AlignedCodonFrame();
 689     List<AlignedCodonFrame> acfList = Arrays.asList(new AlignedCodonFrame[]
 690     { acf });
 691     protein.getDataset().setCodonFrames(acfList);
 692     AlignmentI copy = new Alignment(protein);
 693
 694     /*
 695      * copy has different aligned sequences but the same dataset sequences
 696      */
 697     assertFalse(copy.getSequenceAt(0) == protein.getSequenceAt(0));
 698     assertFalse(copy.getSequenceAt(1) == protein.getSequenceAt(1));
 699     assertSame(copy.getSequenceAt(0).getDatasetSequence(), protein
 700             .getSequenceAt(0).getDatasetSequence());
 701     assertSame(copy.getSequenceAt(1).getDatasetSequence(), protein
 702             .getSequenceAt(1).getDatasetSequence());
 703
 704     // TODO should the copy constructor copy the dataset?
 705     // or make a new one referring to the same dataset sequences??
 706     assertNull(copy.getDataset());
 707     // TODO test metadata is copied when AlignmentI is a dataset
 708
 709     // assertArrayEquals(copy.getDataset().getSequencesArray(), protein
 710     // .getDataset().getSequencesArray());
 711   }
 712
 713   /**
 714    * Test behaviour of createDataset
 715    *
 716    * @throws IOException
 717    */
 718   @Test(groups = "Functional")
 719   public void testCreateDatasetAlignment() throws IOException
 720   {
 721     AlignmentI protein = new FormatAdapter().readFile(AA_SEQS_1,
 722             AppletFormatAdapter.PASTE, "FASTA");
 723     /*
 724      * create a dataset sequence on first sequence
 725      * leave the second without one
 726      */
 727     protein.getSequenceAt(0).createDatasetSequence();
 728     assertNotNull(protein.getSequenceAt(0).getDatasetSequence());
 729     assertNull(protein.getSequenceAt(1).getDatasetSequence());
 730
 731     /*
 732      * add a mapping to the alignment
 733      */
 734     AlignedCodonFrame acf = new AlignedCodonFrame();
 735     protein.addCodonFrame(acf);
 736     assertNull(protein.getDataset());
 737     assertTrue(protein.getCodonFrames().contains(acf));
 738
 739     /*
 740      * create the alignment dataset
 741      * note this creates sequence datasets where missing
 742      * as a side-effect (in this case, on seq2
 743      */
 744     // TODO promote this method to AlignmentI
 745     ((Alignment) protein).createDatasetAlignment();
 746
 747     AlignmentI ds = protein.getDataset();
 748
 749     // side-effect: dataset created on second sequence
 750     assertNotNull(protein.getSequenceAt(1).getDatasetSequence());
 751     // dataset alignment has references to dataset sequences
 752     assertEquals(ds.getSequenceAt(0), protein.getSequenceAt(0)
 753             .getDatasetSequence());
 754     assertEquals(ds.getSequenceAt(1), protein.getSequenceAt(1)
 755             .getDatasetSequence());
 756
 757     // codon frames should have been moved to the dataset
 758     // getCodonFrames() should delegate to the dataset:
 759     assertTrue(protein.getCodonFrames().contains(acf));
 760     // prove the codon frames are indeed on the dataset:
 761     assertTrue(ds.getCodonFrames().contains(acf));
 762   }
 763
 764   /**
 765    * tests the addition of *all* sequences referred to by a sequence being added
 766    * to the dataset
 767    */
 768   @Test(groups = "Functional")
 769   public void testCreateDatasetAlignmentWithMappedToSeqs()
 770   {
 771     // Alignment with two sequences, gapped.
 772     SequenceI sq1 = new Sequence("sq1", "A--SDF");
 773     SequenceI sq2 = new Sequence("sq2", "G--TRQ");
 774
 775     // cross-references to two more sequences.
 776     DBRefEntry dbr = new DBRefEntry("SQ1", "", "sq3");
 777     SequenceI sq3 = new Sequence("sq3", "VWANG");
 778     dbr.setMap(new Mapping(sq3, new MapList(new int[] { 1, 4 }, new int[] {
 779         2, 5 }, 1, 1)));
 780     sq1.addDBRef(dbr);
 781
 782     SequenceI sq4 = new Sequence("sq4", "ERKWI");
 783     DBRefEntry dbr2 = new DBRefEntry("SQ2", "", "sq4");
 784     dbr2.setMap(new Mapping(sq4, new MapList(new int[] { 1, 4 }, new int[] {
 785         2, 5 }, 1, 1)));
 786     sq2.addDBRef(dbr2);
 787     // and a 1:1 codonframe mapping between them.
 788     AlignedCodonFrame alc = new AlignedCodonFrame();
 789     alc.addMap(sq1, sq2, new MapList(new int[] { 1, 4 },
 790             new int[] { 1, 4 }, 1, 1));
 791
 792     AlignmentI protein = new Alignment(new SequenceI[] { sq1, sq2 });
 793
 794     /*
 795      * create the alignment dataset
 796      * note this creates sequence datasets where missing
 797      * as a side-effect (in this case, on seq2
 798      */
 799
 800     // TODO promote this method to AlignmentI
 801     ((Alignment) protein).createDatasetAlignment();
 802
 803     AlignmentI ds = protein.getDataset();
 804
 805     // should be 4 sequences in dataset - two materialised, and two propagated
 806     // from dbref
 807     assertEquals(4, ds.getHeight());
 808     assertTrue(ds.getSequences().contains(sq1.getDatasetSequence()));
 809     assertTrue(ds.getSequences().contains(sq2.getDatasetSequence()));
 810     assertTrue(ds.getSequences().contains(sq3));
 811     assertTrue(ds.getSequences().contains(sq4));
 812     // Should have one codon frame mapping between sq1 and sq2 via dataset
 813     // sequences
 814     assertEquals(ds.getCodonFrame(sq1.getDatasetSequence()),
 815             ds.getCodonFrame(sq2.getDatasetSequence()));
 816   }
 817
 818   @Test(groups = "Functional")
 819   public void testAddCodonFrame()
 820   {
 821     AlignmentI align = new Alignment(new SequenceI[] {});
 822     AlignedCodonFrame acf = new AlignedCodonFrame();
 823     align.addCodonFrame(acf);
 824     assertEquals(1, align.getCodonFrames().size());
 825     assertTrue(align.getCodonFrames().contains(acf));
 826     // can't add the same object twice:
 827     align.addCodonFrame(acf);
 828     assertEquals(1, align.getCodonFrames().size());
 829
 830     // create dataset alignment - mappings move to dataset
 831     ((Alignment) align).createDatasetAlignment();
 832     assertSame(align.getCodonFrames(), align.getDataset().getCodonFrames());
 833     assertEquals(1, align.getCodonFrames().size());
 834
 835     AlignedCodonFrame acf2 = new AlignedCodonFrame();
 836     align.addCodonFrame(acf2);
 837     assertTrue(align.getDataset().getCodonFrames().contains(acf));
 838   }
 839
 840   @Test(groups = "Functional")
 841   public void getVisibleStartAndEndIndexTest()
 842   {
 843     Sequence seq = new Sequence("testSeq", "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
 844     AlignmentI align = new Alignment(new SequenceI[] { seq });
 845     ArrayList<int[]> hiddenCols = new ArrayList<int[]>();
 846
 847     int[] startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
 848     assertEquals(0, startEnd[0]);
 849     assertEquals(25, startEnd[1]);
 850
 851     hiddenCols.add(new int[] { 0, 0 });
 852     startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
 853     assertEquals(1, startEnd[0]);
 854     assertEquals(25, startEnd[1]);
 855
 856     hiddenCols.add(new int[] { 6, 9 });
 857     hiddenCols.add(new int[] { 11, 12 });
 858     startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
 859     assertEquals(1, startEnd[0]);
 860     assertEquals(25, startEnd[1]);
 861
 862     hiddenCols.add(new int[] { 24, 25 });
 863     startEnd = align.getVisibleStartAndEndIndex(hiddenCols);
 864     System.out.println(startEnd[0] + " : " + startEnd[1]);
 865     assertEquals(1, startEnd[0]);
 866     assertEquals(23, startEnd[1]);
 867   }
 868 }