test/jalview/analysis/DnaTest.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.analysis;
  22
  23 import static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertNotNull;
  25 import static org.testng.AssertJUnit.assertTrue;
  26
  27 import jalview.api.AlignViewportI;
  28 import jalview.datamodel.AlignedCodon;
  29 import jalview.datamodel.Alignment;
  30 import jalview.datamodel.AlignmentI;
  31 import jalview.datamodel.HiddenColumns;
  32 import jalview.datamodel.Sequence;
  33 import jalview.datamodel.SequenceI;
  34 import jalview.gui.AlignViewport;
  35 import jalview.gui.JvOptionPane;
  36 import jalview.io.DataSourceType;
  37 import jalview.io.FileFormat;
  38 import jalview.io.FormatAdapter;
  39
  40 import java.io.IOException;
  41 import java.util.ArrayList;
  42 import java.util.List;
  43
  44 import org.testng.annotations.BeforeClass;
  45 import org.testng.annotations.Test;
  46
  47 public class DnaTest
  48 {
  49   @BeforeClass(alwaysRun = true)
  50   public void setUpJvOptionPane()
  51   {
  52     JvOptionPane.setInteractiveMode(false);
  53     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  54   }
  55
  56   // @formatter:off
  57   // AA encoding codons as ordered on the Jalview help page Amino Acid Table
  58   private static String fasta = ">B\n" + "GCT" + "GCC" + "GCA" + "GCG"
  59           + "TGT" + "TGC" + "GAT" + "GAC" + "GAA" + "GAG" + "TTT" + "TTC"
  60           + "GGT" + "GGC" + "GGA" + "GGG" + "CAT" + "CAC" + "ATT" + "ATC"
  61           + "ATA" + "AAA" + "AAG" + "TTG" + "TTA" + "CTT" + "CTC" + "CTA"
  62           + "CTG" + "ATG" + "AAT" + "AAC" + "CCT" + "CCC" + "CCA" + "CCG"
  63           + "CAA" + "CAG" + "CGT" + "CGC" + "CGA" + "CGG" + "AGA" + "AGG"
  64           + "TCT" + "TCC" + "TCA" + "TCG" + "AGT" + "AGC" + "ACT" + "ACC"
  65           + "ACA" + "ACG" + "GTT" + "GTC" + "GTA" + "GTG" + "TGG" + "TAT"
  66           + "TAC" + "TAA" + "TAG" + "TGA";
  67
  68   private static String JAL_1312_example_align_fasta = ">B.FR.83.HXB2_LAI_IIIB_BRU_K03455/45-306\n"
  69           + "ATGGGAAAAAATTCGGTTAAGGCCAGGGGGAAAGAAAAAATATAAATTAAAACATATAGTATGGGCAAGCAG\n"
  70           + "GGAGCTAGAACGATTCGCAGTTAATCCTGGCCTGTTAGAAACATCAGAAGGCTGTAGACAAATACTGGGACA\n"
  71           + "GCTACAACCATCCCTTCAGACAGGATCAGAAGAACTTAGATCATTATATAATACAGTAGCAACCCTCTATTG\n"
  72           + "TGTGCATCAAAGGATAGAGATAAAAGACACCAAGGAAGCTTTAGAC\n"
  73           + ">gi|27804621|gb|AY178912.1|/1-259\n"
  74           + "-TGGGAGAA-ATTCGGTT-CGGCCAGGGGGAAAGAAAAAATATCAGTTAAAACATATAGTATGGGCAAGCAG\n"
  75           + "AGAGCTAGAACGATTCGCAGTTAACCCTGGCCTTTTAGAGACATCACAAGGCTGTAGACAAATACTGGGACA\n"
  76           + "GCTACAACCATCCCTTCAGACAGGATCAGAAGAACTTAAATCATTATATAATACAGTAGCAACCCTCTATTG\n"
  77           + "TGTTCATCAAAGGATAGATATAAAAGACACCAAGGAAGCTTTAGAT\n"
  78           + ">gi|27804623|gb|AY178913.1|/1-259\n"
  79           + "-TGGGAGAA-ATTCGGTT-CGGCCAGGGGGAAAGAAAAAATATCAGTTAAAACATATAGTATGGGCAAGCAG\n"
  80           + "AGAGCTAGAACGATTCGCAGTTAACCCTGGCCTTTTAGAGACATCACAAGGCTGTAGACAAATACTGGAACA\n"
  81           + "GCTACAACCATCCCTTCAGACAGGATCAGAAGAACTTAAATCATTATATAATACAGTAGCAACCCTCTATTG\n"
  82           + "TGTTCATCAAAGGATAGATGTAAAAGACACCAAGGAAGCTTTAGAT\n"
  83           + ">gi|27804627|gb|AY178915.1|/1-260\n"
  84           + "-TGGGAAAA-ATTCGGTTAAGGCCAGGGGGAAAGAAAAAATATAAGTTAAAACATATAGTATGGGCAAGCAG\n"
  85           + "GGAGCTAGAACGATTCGCAGTTAACCCTGGCCTGTTAGAAACATCAGAAGGTTGTAGACAAATATTGGGACA\n"
  86           + "GCTACAACCATCCCTTGAGACAGGATCAGAAGAACTTAAATCATTATWTAATACCATAGCAGTCCTCTATTG\n"
  87           + "TGTACATCAAAGGATAGATATAAAAGACACCAAGGAAGCTTTAGAG\n"
  88           + ">gi|27804631|gb|AY178917.1|/1-261\n"
  89           + "-TGGGAAAAAATTCGGTTGAGGCCAGGGGGAAAGAAAAAATATAAGTTAAAACATATAGTATGGGCAAGCAG\n"
  90           + "GGAGCTAGAACGATTCGCAGTCAACCCTGGCCTGTTAGAAACACCAGAAGGCTGTAGACAAATACTGGGACA\n"
  91           + "GCTACAACCGTCCCTTCAGACAGGATCGGAAGAACTTAAATCATTATATAATACAGTAGCAACCCTCTATTG\n"
  92           + "TGTGCATCAAAGGATAGATGTAAAAGACACCAAGGAGGCTTTAGAC\n"
  93           + ">gi|27804635|gb|AY178919.1|/1-261\n"
  94           + "-TGGGAGAGAATTCGGTTACGGCCAGGAGGAAAGAAAAAATATAAATTGAAACATATAGTATGGGCAGGCAG\n"
  95           + "AGAGCTAGATCGATTCGCAGTCAATCCTGGCCTGTTAGAAACATCAGAAGGCTGCAGACAGATATTGGGACA\n"
  96           + "GCTACAACCGTCCCTTAAGACAGGATCAGAAGAACTTAAATCATTATATAATACAGTAGCAACCCTCTATTG\n"
  97           + "TGTACATCAAAGGATAGATGTAAAAGACACCAAGGAAGCTTTAGAT\n"
  98           + ">gi|27804641|gb|AY178922.1|/1-261\n"
  99           + "-TGGGAGAAAATTCGGTTACGGCCAGGGGGAAAGAAAAGATATAAGTTAAAACATATAGTATGGGCAAGCAG\n"
 100           + "GGAGCTAGAACGATTCGCAGTCAACCCTGGCCTGTTAGAAACATCAGAAGGCTGCAGACAAATACTGGGACA\n"
 101           + "GTTACACCCATCCCTTCATACAGGATCAGAAGAACTTAAATCATTATATAATACAGTAGCAACCCTCTATTG\n"
 102           + "TGTGCATCAAAGGATAGAAGTAAAAGACACCAAGGAAGCTTTAGAC\n"
 103           + ">gi|27804647|gb|AY178925.1|/1-261\n"
 104           + "-TGGGAAAAAATTCGGTTAAGGCCAGGGGGAAAGAAAAAATATCAATTAAAACATGTAGTATGGGCAAGCAG\n"
 105           + "GGAACTAGAACGATTCGCAGTTAATCCTGGCCTGTTAGAAACATCAGAAGGCTGTAGACAAATATTGGGACA\n"
 106           + "GCTACAACCATCCCTTCAGACAGGATCAGAGGAACTTAAATCATTATTTAATACAGTAGCAGTCCTCTATTG\n"
 107           + "TGTACATCAAAGAATAGATGTAAAAGACACCAAGGAAGCTCTAGAA\n"
 108           + ">gi|27804649|gb|AY178926.1|/1-261\n"
 109           + "-TGGGAAAAAATTCGGTTAAGGCCAGGGGGAAAGAAAAAATATAAGTTAAAACATATAGTATGGGCAAGCAG\n"
 110           + "GGAGCTAGAACGATTCGCGGTCAATCCTGGCCTGTTAGAAACATCAGAAGGCTGTAGACAACTACTGGGACA\n"
 111           + "GTTACAACCATCCCTTCAGACAGGATCAGAAGAACTCAAATCATTATATAATACAATAGCAACCCTCTATTG\n"
 112           + "TGTGCATCAAAGGATAGAGATAAAAGACACCAAGGAAGCCTTAGAT\n"
 113           + ">gi|27804653|gb|AY178928.1|/1-261\n"
 114           + "-TGGGAAAGAATTCGGTTAAGGCCAGGGGGAAAGAAACAATATAAATTAAAACATATAGTATGGGCAAGCAG\n"
 115           + "GGAGCTAGACCGATTCGCACTTAACCCCGGCCTGTTAGAAACATCAGAAGGCTGTAGACAAATATTGGGACA\n"
 116           + "GCTACAATCGTCCCTTCAGACAGGATCAGAAGAACTTAGATCACTATATAATACAGTAGCAGTCCTCTATTG\n"
 117           + "TGTGCATCAAAAGATAGATGTAAAAGACACCAAGGAAGCCTTAGAC\n"
 118           + ">gi|27804659|gb|AY178931.1|/1-261\n"
 119           + "-TGGGAAAAAATTCGGTTACGGCCAGGAGGAAAGAAAAGATATAAATTAAAACATATAGTATGGGCAAGCAG\n"
 120           + "GGAGCTAGAACGATTYGCAGTTAATCCTGGCCTTTTAGAAACAGCAGAAGGCTGTAGACAAATACTGGGACA\n"
 121           + "GCTACAACCATCCCTTCAGACAGGATCAGAAGAACTTAAATCATTATATAATACAGTAGCAACCCTCTATTG\n"
 122           + "TGTACATCAAAGGATAGAGATAAAAGACACCAAGGAAGCTTTAGAA\n";
 123   // @formatter:on
 124
 125   /**
 126    * Corner case for this test is the presence of codons after codons that were
 127    * not translated.
 128    *
 129    * @throws IOException
 130    */
 131   @Test(groups = { "Functional" })
 132   public void testTranslateCdna_withUntranslatableCodons()
 133           throws IOException
 134   {
 135     AlignmentI alf = new FormatAdapter().readFile(
 136             JAL_1312_example_align_fasta, DataSourceType.PASTE,
 137             FileFormat.Fasta);
 138     HiddenColumns cs = new HiddenColumns();
 139     AlignViewportI av = new AlignViewport(alf, cs);
 140     int[] contig = new int[] { 0, alf.getWidth() - 1 };
 141     List<int[]> contigs = new ArrayList<>();
 142     contigs.add(contig);
 143     Dna dna = new Dna(av, contigs);
 144     AlignmentI translated = dna.translateCdna();
 145     assertNotNull("Couldn't do a full width translation of test data.",
 146             translated);
 147   }
 148
 149   /**
 150    * Test variant in which 15 column blocks at a time are translated (the rest
 151    * hidden).
 152    *
 153    * @throws IOException
 154    */
 155   @Test(groups = { "Functional" })
 156   public void testTranslateCdna_withUntranslatableCodonsAndHiddenColumns()
 157           throws IOException
 158   {
 159     AlignmentI alf = new FormatAdapter().readFile(
 160             JAL_1312_example_align_fasta, DataSourceType.PASTE,
 161             FileFormat.Fasta);
 162     int vwidth = 15;
 163     for (int ipos = 0; ipos + vwidth < alf.getWidth(); ipos += vwidth)
 164     {
 165       HiddenColumns cs = new HiddenColumns();
 166       if (ipos > 0)
 167       {
 168         cs.hideColumns(0, ipos - 1);
 169       }
 170       cs.hideColumns(ipos + vwidth, alf.getWidth());
 171       List<int[]> vcontigs = cs.getVisibleContigs(0, alf.getWidth());
 172       AlignViewportI av = new AlignViewport(alf, cs);
 173       Dna dna = new Dna(av, vcontigs);
 174       AlignmentI transAlf = dna.translateCdna();
 175
 176       assertTrue("Translation failed (ipos=" + ipos
 177               + ") No alignment data.", transAlf != null);
 178       assertTrue("Translation failed (ipos=" + ipos + ") Empty alignment.",
 179               transAlf.getHeight() > 0);
 180       assertTrue("Translation failed (ipos=" + ipos + ") Translated "
 181               + transAlf.getHeight() + " sequences from " + alf.getHeight()
 182               + " sequences", alf.getHeight() == transAlf.getHeight());
 183     }
 184   }
 185
 186   /**
 187    * Test simple translation to Amino Acids (with STOP codons translated to *).
 188    *
 189    * @throws IOException
 190    */
 191   @Test(groups = { "Functional" })
 192   public void testTranslateCdna_simple() throws IOException
 193   {
 194     AlignmentI alf = new FormatAdapter().readFile(fasta,
 195             DataSourceType.PASTE, FileFormat.Fasta);
 196     HiddenColumns cs = new HiddenColumns();
 197     AlignViewportI av = new AlignViewport(alf, cs);
 198     int[] contig = new int[] { 0, alf.getWidth() - 1 };
 199     List<int[]> contigs = new ArrayList<>();
 200     contigs.add(contig);
 201     Dna dna = new Dna(av, contigs);
 202     AlignmentI translated = dna.translateCdna();
 203     String aa = translated.getSequenceAt(0).getSequenceAsString();
 204     assertEquals(
 205             "AAAACCDDEEFFGGGGHHIIIKKLLLLLLMNNPPPPQQRRRRRRSSSSSSTTTTVVVVWYY***",
 206             aa);
 207   }
 208
 209   /**
 210    * Test translation excluding hidden columns.
 211    *
 212    * @throws IOException
 213    */
 214   @Test(groups = { "Functional" })
 215   public void testTranslateCdna_hiddenColumns() throws IOException
 216   {
 217     AlignmentI alf = new FormatAdapter().readFile(fasta,
 218             DataSourceType.PASTE, FileFormat.Fasta);
 219     HiddenColumns cs = new HiddenColumns();
 220     cs.hideColumns(6, 14); // hide codons 3/4/5
 221     cs.hideColumns(24, 35); // hide codons 9-12
 222     cs.hideColumns(177, 191); // hide codons 60-64
 223     AlignViewportI av = new AlignViewport(alf, cs);
 224     int[] contig = new int[] { 0, alf.getWidth() - 1 };
 225     List<int[]> contigs = new ArrayList<>();
 226     contigs.add(contig);
 227     Dna dna = new Dna(av, contigs);
 228     AlignmentI translated = dna.translateCdna();
 229     String aa = translated.getSequenceAt(0).getSequenceAsString();
 230     assertEquals("AACDDGGGGHHIIIKKLLLLLLMNNPPPPQQRRRRRRSSSSSSTTTTVVVVW", aa);
 231   }
 232
 233   /**
 234    * Use this test to help debug into any cases of interest.
 235    */
 236   @Test(groups = { "Functional" })
 237   public void testCompareCodonPos_oneOnly()
 238   {
 239     assertFollows("-AA--A", "G--GG"); // 2 shifted seq2, 3 shifted seq1
 240   }
 241
 242   /**
 243    * Tests for method that compares 'alignment' of two codon position triplets.
 244    */
 245   @Test(groups = { "Functional" })
 246   public void testCompareCodonPos()
 247   {
 248     /*
 249      * Returns 0 for any null argument
 250      */
 251     assertEquals(0, Dna.compareCodonPos(new AlignedCodon(1, 2, 3), null));
 252     assertEquals(0, Dna.compareCodonPos(null, new AlignedCodon(1, 2, 3)));
 253
 254     /*
 255      * Work through 27 combinations. First 9 cases where first position matches.
 256      */
 257     assertMatches("AAA", "GGG"); // 2 and 3 match
 258     assertFollows("AA-A", "GGG"); // 2 matches, 3 shifted seq1
 259     assertPrecedes("AAA", "GG-G"); // 2 matches, 3 shifted seq2
 260     assertFollows("A-AA", "GG-G"); // 2 shifted seq1, 3 matches
 261     assertFollows("A-A-A", "GG-G"); // 2 shifted seq1, 3 shifted seq1
 262     assertPrecedes("A-AA", "GG--G"); // 2 shifted seq1, 3 shifted seq2
 263     assertPrecedes("AA-A", "G-GG"); // 2 shifted seq2, 3 matches
 264     assertFollows("AA--A", "G-GG"); // 2 shifted seq2, 3 shifted seq1
 265     assertPrecedes("AAA", "G-GG"); // 2 shifted seq2, 3 shifted seq2
 266
 267     /*
 268      * 9 cases where first position is shifted in first sequence.
 269      */
 270     assertFollows("-AAA", "G-GG"); // 2 and 3 match
 271     assertFollows("-AA-A", "G-GG"); // 2 matches, 3 shifted seq1
 272     // 'enclosing' case: pick first to start precedes
 273     assertFollows("-AAA", "G-G-G"); // 2 matches, 3 shifted seq2
 274     assertFollows("-A-AA", "G-G-G"); // 2 shifted seq1, 3 matches
 275     assertFollows("-A-A-A", "G-G-G"); // 2 shifted seq1, 3 shifted seq1
 276     // 'enclosing' case: pick first to start precedes
 277     assertFollows("-A-AA", "G-G--G"); // 2 shifted seq1, 3 shifted seq2
 278     assertFollows("-AA-A", "G--GG"); // 2 shifted seq2, 3 matches
 279     assertFollows("-AA--A", "G--GG"); // 2 shifted seq2, 3 shifted seq1
 280     assertPrecedes("-AAA", "G--GG"); // 2 shifted seq2, 3 shifted seq2
 281
 282     /*
 283      * 9 cases where first position is shifted in second sequence.
 284      */
 285     assertPrecedes("A-AA", "-GGG"); // 2 and 3 match
 286     assertPrecedes("A-A-A", "-GGG"); // 2 matches, 3 shifted seq1
 287     assertPrecedes("A-AA", "-GG-G"); // 2 matches, 3 shifted seq2
 288     assertPrecedes("A--AA", "-GG-G"); // 2 shifted seq1, 3 matches
 289     // 'enclosing' case with middle base deciding:
 290     assertFollows("A--AA", "-GGG"); // 2 shifted seq1, 3 shifted seq1
 291     assertPrecedes("A--AA", "-GG--G"); // 2 shifted seq1, 3 shifted seq2
 292     assertPrecedes("AA-A", "-GGG"); // 2 shifted seq2, 3 matches
 293     assertPrecedes("AA--A", "-GGG"); // 2 shifted seq2, 3 shifted seq1
 294     assertPrecedes("AAA", "-GGG"); // 2 shifted seq2, 3 shifted seq2
 295   }
 296
 297   /**
 298    * This test generates a random cDNA alignment and its translation, then
 299    * reorders the cDNA and retranslates, and verifies that the translations are
 300    * the same (apart from ordering).
 301    */
 302   @Test(groups = { "Functional" })
 303   public void testTranslateCdna_sequenceOrderIndependent()
 304   {
 305     /*
 306      * Generate cDNA - 8 sequences of 12 bases each.
 307      */
 308     AlignmentI cdna = new AlignmentGenerator(true)
 309             .generate(12, 8, 97, 5, 5);
 310     HiddenColumns cs = new HiddenColumns();
 311     AlignViewportI av = new AlignViewport(cdna, cs);
 312     int[] contig = new int[] { 0, cdna.getWidth() - 1 };
 313     List<int[]> contigs = new ArrayList<>();
 314     contigs.add(contig);
 315     Dna dna = new Dna(av, contigs);
 316     AlignmentI translated = dna.translateCdna();
 317
 318     /*
 319      * Jumble the cDNA sequences and translate.
 320      */
 321     SequenceI[] sorted = new SequenceI[cdna.getHeight()];
 322     final int[] jumbler = new int[] { 6, 7, 3, 4, 2, 0, 1, 5 };
 323     int seqNo = 0;
 324     for (int i : jumbler)
 325     {
 326       sorted[seqNo++] = cdna.getSequenceAt(i);
 327     }
 328     AlignmentI cdnaReordered = new Alignment(sorted);
 329     av = new AlignViewport(cdnaReordered, cs);
 330     contig = new int[] { 0, cdna.getWidth() - 1 };
 331     contigs = new ArrayList<>();
 332     contigs.add(contig);
 333     dna = new Dna(av, contigs);
 334     AlignmentI translated2 = dna.translateCdna();
 335
 336     /*
 337      * Check translated sequences are the same in both alignments.
 338      */
 339     System.out.println("Original");
 340     System.out.println(translated.toString());
 341     System.out.println("Sorted");
 342     System.out.println(translated2.toString());
 343
 344     int sortedSequenceIndex = 0;
 345     for (int originalSequenceIndex : jumbler)
 346     {
 347       final String translation1 = translated.getSequenceAt(
 348               originalSequenceIndex).getSequenceAsString();
 349       final String translation2 = translated2.getSequenceAt(
 350               sortedSequenceIndex).getSequenceAsString();
 351       assertEquals(translation2, translation1);
 352       sortedSequenceIndex++;
 353     }
 354   }
 355
 356   /**
 357    * Test that all the cases in testCompareCodonPos have a 'symmetric'
 358    * comparison (without checking the actual comparison result).
 359    */
 360   @Test(groups = { "Functional" })
 361   public void testCompareCodonPos_isSymmetric()
 362   {
 363     assertSymmetric("AAA", "GGG");
 364     assertSymmetric("AA-A", "GGG");
 365     assertSymmetric("AAA", "GG-G");
 366     assertSymmetric("A-AA", "GG-G");
 367     assertSymmetric("A-A-A", "GG-G");
 368     assertSymmetric("A-AA", "GG--G");
 369     assertSymmetric("AA-A", "G-GG");
 370     assertSymmetric("AA--A", "G-GG");
 371     assertSymmetric("AAA", "G-GG");
 372     assertSymmetric("-AAA", "G-GG");
 373     assertSymmetric("-AA-A", "G-GG");
 374     assertSymmetric("-AAA", "G-G-G");
 375     assertSymmetric("-A-AA", "G-G-G");
 376     assertSymmetric("-A-A-A", "G-G-G");
 377     assertSymmetric("-A-AA", "G-G--G");
 378     assertSymmetric("-AA-A", "G--GG");
 379     assertSymmetric("-AA--A", "G--GG");
 380     assertSymmetric("-AAA", "G--GG");
 381     assertSymmetric("A-AA", "-GGG");
 382     assertSymmetric("A-A-A", "-GGG");
 383     assertSymmetric("A-AA", "-GG-G");
 384     assertSymmetric("A--AA", "-GG-G");
 385     assertSymmetric("A--AA", "-GGG");
 386     assertSymmetric("A--AA", "-GG--G");
 387     assertSymmetric("AA-A", "-GGG");
 388     assertSymmetric("AA--A", "-GGG");
 389     assertSymmetric("AAA", "-GGG");
 390   }
 391
 392   private void assertSymmetric(String codon1, String codon2)
 393   {
 394     assertEquals("Comparison of '" + codon1 + "' and '" + codon2
 395             + " not symmetric", Integer.signum(compare(codon1, codon2)),
 396             -Integer.signum(compare(codon2, codon1)));
 397   }
 398
 399   /**
 400    * Assert that the first sequence should map to the same position as the
 401    * second in a translated alignment. Also checks that this is true if the
 402    * order of the codons is reversed.
 403    *
 404    * @param codon1
 405    * @param codon2
 406    */
 407   private void assertMatches(String codon1, String codon2)
 408   {
 409     assertEquals("Expected '" + codon1 + "' matches '" + codon2 + "'", 0,
 410             compare(codon1, codon2));
 411     assertEquals("Expected '" + codon2 + "' matches '" + codon1 + "'", 0,
 412             compare(codon2, codon1));
 413   }
 414
 415   /**
 416    * Assert that the first sequence should precede the second in a translated
 417    * alignment
 418    *
 419    * @param codon1
 420    * @param codon2
 421    */
 422   private void assertPrecedes(String codon1, String codon2)
 423   {
 424     assertEquals("Expected '" + codon1 + "'  precedes '" + codon2 + "'",
 425             -1, compare(codon1, codon2));
 426   }
 427
 428   /**
 429    * Assert that the first sequence should follow the second in a translated
 430    * alignment
 431    *
 432    * @param codon1
 433    * @param codon2
 434    */
 435   private void assertFollows(String codon1, String codon2)
 436   {
 437     assertEquals("Expected '" + codon1 + "'  follows '" + codon2 + "'", 1,
 438             compare(codon1, codon2));
 439   }
 440
 441   /**
 442    * Convert two nucleotide strings to base positions and pass to
 443    * Dna.compareCodonPos, return the result.
 444    *
 445    * @param s1
 446    * @param s2
 447    * @return
 448    */
 449   private int compare(String s1, String s2)
 450   {
 451     final AlignedCodon cd1 = convertCodon(s1);
 452     final AlignedCodon cd2 = convertCodon(s2);
 453     System.out.println("K: " + s1 + "  " + cd1.toString());
 454     System.out.println("G: " + s2 + "  " + cd2.toString());
 455     System.out.println();
 456     return Dna.compareCodonPos(cd1, cd2);
 457   }
 458
 459   /**
 460    * Convert a string e.g. "-GC-T" to base positions e.g. [1, 2, 4]. The string
 461    * should have exactly 3 non-gap characters, and use '-' for gaps.
 462    *
 463    * @param s
 464    * @return
 465    */
 466   private AlignedCodon convertCodon(String s)
 467   {
 468     int[] codon = new int[3];
 469     int i = 0;
 470     for (int j = 0; j < s.length(); j++)
 471     {
 472       if (s.charAt(j) != '-')
 473       {
 474         codon[i++] = j;
 475       }
 476     }
 477     return new AlignedCodon(codon[0], codon[1], codon[2]);
 478   }
 479
 480   /**
 481    * Weirdly, maybe worth a test to prove the helper method of this test class.
 482    */
 483   @Test(groups = { "Functional" })
 484   public void testConvertCodon()
 485   {
 486     assertEquals("[0, 1, 2]", convertCodon("AAA").toString());
 487     assertEquals("[0, 2, 5]", convertCodon("A-A--A").toString());
 488     assertEquals("[1, 3, 4]", convertCodon("-A-AA-").toString());
 489   }
 490
 491   /**
 492    * Test dna complementing
 493    */
 494   @Test(groups = "Functional")
 495   public void testGetComplement()
 496   {
 497     assertEquals('t', Dna.getComplement('a'));
 498     assertEquals('T', Dna.getComplement('A'));
 499     assertEquals('a', Dna.getComplement('t'));
 500     assertEquals('A', Dna.getComplement('T'));
 501     assertEquals('c', Dna.getComplement('g'));
 502     assertEquals('C', Dna.getComplement('G'));
 503     assertEquals('g', Dna.getComplement('c'));
 504     assertEquals('G', Dna.getComplement('C'));
 505     // note uU --> aA but not vice versa
 506     assertEquals('a', Dna.getComplement('u'));
 507     assertEquals('A', Dna.getComplement('U'));
 508     // ambiguity codes, see http://www.bioinformatics.org/sms/iupac.html
 509     assertEquals('r', Dna.getComplement('y'));
 510     assertEquals('R', Dna.getComplement('Y'));
 511     assertEquals('y', Dna.getComplement('r'));
 512     assertEquals('Y', Dna.getComplement('R'));
 513     assertEquals('k', Dna.getComplement('m'));
 514     assertEquals('K', Dna.getComplement('M'));
 515     assertEquals('m', Dna.getComplement('k'));
 516     assertEquals('M', Dna.getComplement('K'));
 517     assertEquals('b', Dna.getComplement('v'));
 518     assertEquals('B', Dna.getComplement('V'));
 519     assertEquals('v', Dna.getComplement('b'));
 520     assertEquals('V', Dna.getComplement('B'));
 521     assertEquals('d', Dna.getComplement('h'));
 522     assertEquals('D', Dna.getComplement('H'));
 523     assertEquals('h', Dna.getComplement('d'));
 524     assertEquals('H', Dna.getComplement('D'));
 525     assertEquals('Q', Dna.getComplement('Q'));
 526   }
 527
 528   @Test(groups = "Functional")
 529   public void testReverseSequence()
 530   {
 531     String seq = "-Ac-GtU--rYkMbVdHNX-";
 532     String seqRev = new StringBuilder(seq).reverse().toString();
 533
 534     // reverse:
 535     SequenceI reversed = Dna.reverseSequence("Seq1", seq, false);
 536     assertEquals(1, reversed.getStart());
 537     assertEquals(15, reversed.getEnd());
 538     assertEquals(20, reversed.getLength());
 539     assertEquals(seqRev, reversed.getSequenceAsString());
 540     assertEquals("Seq1|rev", reversed.getName());
 541
 542     // reverse complement:
 543     SequenceI revcomp = Dna.reverseSequence("Seq1", seq, true);
 544     assertEquals("-XNDhBvKmRy--AaC-gT-", revcomp.getSequenceAsString());
 545     assertEquals("Seq1|revcomp", revcomp.getName());
 546   }
 547
 548   @Test(groups = "Functional")
 549   public void testReverseCdna()
 550   {
 551     String seq = "-Ac-GtU--rYkMbVdHNX-";
 552     String seqRev = new StringBuilder(seq).reverse().toString();
 553     String seqDs = seq.replaceAll("-", "");
 554     String seqDsRev = new StringBuilder(seqDs).reverse().toString();
 555
 556     SequenceI dna = new Sequence("Seq1", seq);
 557     Alignment al = new Alignment(new SequenceI[] { dna });
 558     al.createDatasetAlignment();
 559     assertEquals(seqDs, al.getSequenceAt(0).getDatasetSequence()
 560             .getSequenceAsString());
 561
 562     HiddenColumns cs = new HiddenColumns();
 563     AlignViewportI av = new AlignViewport(al, cs);
 564     int[] contig = new int[] { 0, al.getWidth() - 1 };
 565     List<int[]> contigs = new ArrayList<>();
 566     contigs.add(contig);
 567     Dna testee = new Dna(av, contigs);
 568     AlignmentI reversed = testee.reverseCdna(false);
 569     assertEquals(1, reversed.getHeight());
 570     assertEquals(seqRev, reversed.getSequenceAt(0).getSequenceAsString());
 571     assertEquals(seqDsRev, reversed.getSequenceAt(0).getDatasetSequence()
 572             .getSequenceAsString());
 573   }
 574 }