test/jalview/io/NewickFileTests.java

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