test/jalview/io/NewickFileTests.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.io;
  22
  23 import static org.junit.Assert.assertTrue;
  24 import static org.junit.Assert.fail;
  25
  26 import java.util.Arrays;
  27 import java.util.Collection;
  28 import java.util.Vector;
  29
  30 import org.junit.AfterClass;
  31 import org.junit.BeforeClass;
  32 import org.junit.Test;
  33 import org.junit.runner.RunWith;
  34 import org.junit.runners.Parameterized;
  35 import org.junit.runners.Parameterized.Parameters;
  36
  37 import jalview.analysis.NJTree;
  38 import jalview.analysis.SequenceIdMatcher;
  39 import jalview.datamodel.SequenceI;
  40 import jalview.datamodel.SequenceNode;
  41
  42 /**
  43  * @author jimp
  44  *
  45  */
  46 @RunWith(Parameterized.class)
  47 public class NewickFileTests
  48 {
  49
  50   @Parameters
  51   public static Collection data()
  52   {
  53     return Arrays
  54             .asList(new Object[][]
  55             {
  56
  57                 new String[]
  58                 {
  59                     "Simple uniref50 newick",
  60                     "(((FER_BRANA:128.0,FER3_RAPSA:128.0):50.75,FER_CAPAA:178.75):121.94443,(Q93Z60_ARATH:271.45456,((O80429_MAIZE:183.0,FER1_MAIZE:183.0):30.5,((Q7XA98_TRIPR:90.0,FER1_PEA:90.0):83.32143,(((FER2_ARATH:64.0,FER1_ARATH:64.0):94.375,(FER1_SPIOL:124.5,FER1_MESCR:124.5):33.875):6.4166718,((Q93XJ9_SOLTU:33.5,FER1_SOLLC:33.5):49.0,FER_CAPAN:82.5):82.29167):8.529755):40.178574):57.95456):29.239868);" },
  61                 new String[]
  62                 {
  63                     "Tree with quotes",
  64                     "('Syn_PROSU-1_IIh_3d(CA4)|CK_Syn_PROSU-1_1907':1.0638313,'Syn_MINOS11_5.3_3d(CA4)|CK_Syn_MINOS11_750':1.063831);" },
  65                 new String[]
  66                 {
  67                     "Tree with double escaped comma in node",
  68                     "('Syn_PROSU-1_IIh_3d(CA4)|CK_Syn_PROSU-1_1907':1.0638313,'Syn_MINOS11_5.3_3d(CA4)''|CK_Syn_MINOS11_750':1.063831);" } });
  69   };
  70
  71   String name, testTree;
  72
  73   public NewickFileTests(String _name, String _testTree)
  74   {
  75     this.name = _name;
  76     this.testTree = _testTree;
  77   }
  78
  79   /**
  80    * @throws java.lang.Exception
  81    */
  82   @BeforeClass
  83   public static void setUpBeforeClass() throws Exception
  84   {
  85   }
  86
  87   @Test
  88   public void testTreeIO() throws Exception
  89   {
  90     String stage = "Init", treename = " '" + name + "' :";
  91     try
  92     {
  93       stage = "Parsing testTree " + treename;
  94       System.out.println(treename + "\n" + testTree);
  95       NewickFile nf = new NewickFile(testTree, FormatAdapter.PASTE);
  96       nf.parse();
  97       assertTrue(stage + "Invalid Tree '" + nf.getWarningMessage() + "'",
  98               nf.isValid());
  99       SequenceNode tree = nf.getTree();
 100       assertTrue(stage + "Null Tree", tree != null);
 101       stage = "Creating newick file from testTree " + treename;
 102       String gentree = new NewickFile(tree).print(nf.HasBootstrap(),
 103               nf.HasDistances());
 104       assertTrue(stage + "Empty string generated", gentree != null
 105               && gentree.trim().length() > 0);
 106       stage = "Parsing regenerated testTree " + treename;
 107       NewickFile nf_regen = new NewickFile(gentree, FormatAdapter.PASTE);
 108       nf_regen.parse();
 109       assertTrue(
 110               stage + "Newick file is invalid ('"
 111                       + nf_regen.getWarningMessage() + "')",
 112               nf_regen.isValid());
 113       SequenceNode tree_regen = nf.getTree();
 114       assertTrue(stage + "Null Tree", tree_regen != null);
 115       stage = "Compare original and generated tree" + treename;
 116
 117       Vector oseqs, nseqs;
 118       oseqs = new NJTree(new SequenceI[0], nf).findLeaves(nf.getTree(),
 119               new Vector());
 120       assertTrue(stage + "No nodes in original tree.", oseqs.size() > 0);
 121       SequenceI[] olsqs = new SequenceI[oseqs.size()];
 122       for (int i = 0, iSize = oseqs.size(); i < iSize; i++)
 123       {
 124         olsqs[i] = (SequenceI) ((SequenceNode) oseqs.get(i)).element();
 125       }
 126       nseqs = new NJTree(new SequenceI[0], nf_regen).findLeaves(
 127               nf_regen.getTree(), new Vector());
 128       assertTrue(stage + "No nodes in regerated tree.", nseqs.size() > 0);
 129       SequenceI[] nsqs = new SequenceI[nseqs.size()];
 130       for (int i = 0, iSize = nseqs.size(); i < iSize; i++)
 131       {
 132         nsqs[i] = (SequenceI) ((SequenceNode) nseqs.get(i)).element();
 133       }
 134       assertTrue(stage + " Different number of leaves (original "
 135               + olsqs.length + " and regen " + nsqs.length + ")",
 136               olsqs.length == nsqs.length);
 137       SequenceIdMatcher omatcher = new SequenceIdMatcher(olsqs), nmatcher = new SequenceIdMatcher(
 138               nsqs);
 139
 140       SequenceI[] osmatches = omatcher.findIdMatch(nsqs);
 141       SequenceI[] nsmatches = nmatcher.findIdMatch(olsqs);
 142       String warns = "";
 143       for (int i = 0, iSize = nseqs.size(); i < iSize; i++)
 144       {
 145         if (nsmatches[i] == null)
 146         {
 147           warns += "\noriginal sequence ID '" + olsqs[i].getName()
 148                   + "' wasn't found in regenerated set.";
 149         }
 150         if (osmatches[i] == null)
 151         {
 152           warns += "\nregenerated sequence ID '" + nsqs[i].getName()
 153                   + "' wasn't found in original set.";
 154         }
 155       }
 156
 157       if (warns.length() > 0)
 158       {
 159         fail(stage + warns);
 160       }
 161     } catch (Exception x)
 162     {
 163       throw (new Exception(stage + "Exception raised", x));
 164     }
 165   }
 166
 167   /**
 168    * @throws java.lang.Exception
 169    */
 170   @AfterClass
 171   public static void tearDownAfterClass() throws Exception
 172   {
 173   }
 174
 175 }