JAL-2068 minimised jalview.gui imports, test for removeAnnotation
[jalview.git] / test / jalview / io / AnnotationFileIOTest.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.AssertJUnit.assertNotNull;
24 import static org.testng.AssertJUnit.assertTrue;
25
26 import jalview.datamodel.AlignmentI;
27 import jalview.datamodel.ColumnSelection;
28 import jalview.io.AnnotationFile.ViewDef;
29
30 import java.io.File;
31 import java.util.Hashtable;
32
33 import org.testng.Assert;
34 import org.testng.annotations.Test;
35
36 public class AnnotationFileIOTest
37 {
38
39   static String TestFiles[][] = {
40       { "Test example annotation import/export", "examples/uniref50.fa",
41           "examples/testdata/example_annot_file.jva" },
42       { "Test multiple combine annotation statements import/export",
43           "examples/uniref50.fa",
44           "examples/testdata/test_combine_annot.jva" },
45       {
46           "Test multiple combine annotation statements with sequence_ref import/export",
47           "examples/uniref50.fa", "examples/testdata/uniref50_iupred.jva" },
48       {
49           "Test group only annotation file parsing results in parser indicating annotation was parsed",
50           "examples/uniref50.fa", "examples/testdata/test_grpannot.jva" },
51       { "Test hiding/showing of insertions on sequence_ref",
52           "examples/uniref50.fa", "examples/testdata/uniref50_seqref.jva" } };
53
54   @Test(groups = { "Functional" })
55   public void exampleAnnotationFileIO() throws Exception
56   {
57     for (String[] testPair : TestFiles)
58     {
59       testAnnotationFileIO(testPair[0], new File(testPair[1]), new File(
60               testPair[2]));
61     }
62   }
63
64   public static AlignmentI readAlignmentFile(File f)
65   {
66     System.out.println("Reading file: " + f);
67     String ff = f.getPath();
68     try
69     {
70       FormatAdapter rf = new FormatAdapter();
71
72       AlignmentI al = rf.readFile(ff, AppletFormatAdapter.FILE,
73               new IdentifyFile().identify(ff, AppletFormatAdapter.FILE));
74
75       // make sure dataset is initialised ? not sure about this
76       for (int i = 0; i < al.getSequencesArray().length; ++i)
77       {
78         al.getSequenceAt(i).setDatasetSequence(
79                 al.getSequenceAt(i).createDatasetSequence());
80       }
81       assertNotNull("Couldn't read supplied alignment data.", al);
82       return al;
83     } catch (Exception e)
84     {
85       e.printStackTrace();
86     }
87     Assert.fail("Couln't read the alignment in file '" + f.toString() + "'");
88     return null;
89   }
90
91   /**
92    * test alignment data in given file can be imported, exported and reimported
93    * with no dataloss
94    * 
95    * @param f
96    *          - source datafile (IdentifyFile.identify() should work with it)
97    * @param ioformat
98    *          - label for IO class used to write and read back in the data from
99    *          f
100    */
101
102   // @Test(groups ={ "Functional" })
103   public static void testAnnotationFileIO(String testname, File f,
104           File annotFile)
105   {
106     System.out.println("Test: " + testname + "\nReading annotation file '"
107             + annotFile + "' onto : " + f);
108     String af = annotFile.getPath();
109     try
110     {
111       AlignmentI al = readAlignmentFile(f);
112       ColumnSelection cs = new ColumnSelection();
113       assertTrue(
114               "Test "
115                       + testname
116                       + "\nAlignment was not annotated - annotation file not imported.",
117               new AnnotationFile().readAnnotationFile(al, cs, af,
118                       FormatAdapter.FILE));
119
120       AnnotationFile aff = new AnnotationFile();
121       ViewDef v = aff.new ViewDef(null, al.getHiddenSequences(), cs,
122               new Hashtable());
123       String anfileout = new AnnotationFile().printAnnotations(
124               al.getAlignmentAnnotation(), al.getGroups(),
125               al.getProperties(), null, al, v);
126       assertTrue(
127               "Test "
128                       + testname
129                       + "\nAlignment annotation file was not regenerated. Null string",
130               anfileout != null);
131       assertTrue(
132               "Test "
133                       + testname
134                       + "\nAlignment annotation file was not regenerated. Empty string",
135               anfileout.length() > "JALVIEW_ANNOTATION".length());
136
137       System.out.println("Output annotation file:\n" + anfileout
138               + "\n<<EOF\n");
139
140       AlignmentI al_new = readAlignmentFile(f);
141       assertTrue(
142               "Test "
143                       + testname
144                       + "\nregenerated annotation file did not annotate alignment.",
145               new AnnotationFile().readAnnotationFile(al_new, anfileout,
146                       FormatAdapter.PASTE));
147
148       // test for consistency in io
149       StockholmFileTest.testAlignmentEquivalence(al, al_new, false);
150       return;
151     } catch (Exception e)
152     {
153       e.printStackTrace();
154     }
155     Assert.fail("Test "
156             + testname
157             + "\nCouldn't complete Annotation file roundtrip input/output/input test for '"
158             + annotFile + "'.");
159   }
160 }