JAL-2068 minimised jalview.gui imports, test for removeAnnotation
[jalview.git] / 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.testng.ConversionUtils.wrapDataProvider;
24
25 import jalview.analysis.NJTree;
26 import jalview.analysis.SequenceIdMatcher;
27 import jalview.datamodel.SequenceI;
28 import jalview.datamodel.SequenceNode;
29
30 import java.util.Arrays;
31 import java.util.Collection;
32 import java.util.Vector;
33
34 import org.junit.runners.Parameterized.Parameters;
35 import org.testng.Assert;
36 import org.testng.AssertJUnit;
37 import org.testng.annotations.AfterClass;
38 import org.testng.annotations.BeforeClass;
39 import org.testng.annotations.Factory;
40 import org.testng.annotations.Test;
41
42 /**
43  * @author jimp
44  * 
45  */
46 public class NewickFileTests
47 {
48
49   @Factory
50   public static Object[] factoryData()
51   {
52     return wrapDataProvider(NewickFileTests.class, data());
53   }
54
55   @Parameters
56   public static Collection data()
57   {
58     return Arrays
59             .asList(new Object[][] {
60
61                 new String[] {
62                     "Simple uniref50 newick",
63                     "(((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);" },
64                 new String[] {
65                     "Tree with quotes",
66                     "('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);" },
67                 new String[] {
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(alwaysRun = true)
84   public static void setUpBeforeClass() throws Exception
85   {
86   }
87
88   @Test(groups = { "Functional" })
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       AssertJUnit.assertTrue(
99               stage + "Invalid Tree '" + nf.getWarningMessage() + "'",
100               nf.isValid());
101       SequenceNode tree = nf.getTree();
102       AssertJUnit.assertTrue(stage + "Null Tree", tree != null);
103       stage = "Creating newick file from testTree " + treename;
104       String gentree = new NewickFile(tree).print(nf.HasBootstrap(),
105               nf.HasDistances());
106       AssertJUnit.assertTrue(stage + "Empty string generated",
107               gentree != null && gentree.trim().length() > 0);
108       stage = "Parsing regenerated testTree " + treename;
109       NewickFile nf_regen = new NewickFile(gentree, FormatAdapter.PASTE);
110       nf_regen.parse();
111       AssertJUnit.assertTrue(
112               stage + "Newick file is invalid ('"
113                       + nf_regen.getWarningMessage() + "')",
114               nf_regen.isValid());
115       SequenceNode tree_regen = nf.getTree();
116       AssertJUnit.assertTrue(stage + "Null Tree", tree_regen != null);
117       stage = "Compare original and generated tree" + treename;
118
119       Vector oseqs, nseqs;
120       oseqs = new NJTree(new SequenceI[0], nf).findLeaves(nf.getTree(),
121               new Vector());
122       AssertJUnit.assertTrue(stage + "No nodes in original tree.",
123               oseqs.size() > 0);
124       SequenceI[] olsqs = new SequenceI[oseqs.size()];
125       for (int i = 0, iSize = oseqs.size(); i < iSize; i++)
126       {
127         olsqs[i] = (SequenceI) ((SequenceNode) oseqs.get(i)).element();
128       }
129       nseqs = new NJTree(new SequenceI[0], nf_regen).findLeaves(
130               nf_regen.getTree(), new Vector());
131       AssertJUnit.assertTrue(stage + "No nodes in regerated tree.",
132               nseqs.size() > 0);
133       SequenceI[] nsqs = new SequenceI[nseqs.size()];
134       for (int i = 0, iSize = nseqs.size(); i < iSize; i++)
135       {
136         nsqs[i] = (SequenceI) ((SequenceNode) nseqs.get(i)).element();
137       }
138       AssertJUnit.assertTrue(stage
139               + " Different number of leaves (original " + olsqs.length
140               + " and regen " + nsqs.length + ")",
141               olsqs.length == nsqs.length);
142       SequenceIdMatcher omatcher = new SequenceIdMatcher(olsqs), nmatcher = new SequenceIdMatcher(
143               nsqs);
144
145       SequenceI[] osmatches = omatcher.findIdMatch(nsqs);
146       SequenceI[] nsmatches = nmatcher.findIdMatch(olsqs);
147       String warns = "";
148       for (int i = 0, iSize = nseqs.size(); i < iSize; i++)
149       {
150         if (nsmatches[i] == null)
151         {
152           warns += "\noriginal sequence ID '" + olsqs[i].getName()
153                   + "' wasn't found in regenerated set.";
154         }
155         if (osmatches[i] == null)
156         {
157           warns += "\nregenerated sequence ID '" + nsqs[i].getName()
158                   + "' wasn't found in original set.";
159         }
160       }
161
162       if (warns.length() > 0)
163       {
164         Assert.fail(stage + warns);
165       }
166     } catch (Exception x)
167     {
168       throw (new Exception(stage + "Exception raised", x));
169     }
170   }
171
172   /**
173    * @throws java.lang.Exception
174    */
175   @AfterClass
176   public static void tearDownAfterClass() throws Exception
177   {
178   }
179
180 }