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.junit.Assert.assertNotNull;
  24 import static org.junit.Assert.assertTrue;
  25 import static org.junit.Assert.fail;
  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.junit.Test;
  34
  35 public class AnnotationFileIOTest
  36 {
  37
  38   static String TestFiles[][] =
  39   {
  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
  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     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   public static void testAnnotationFileIO(String testname, File f,
 102           File annotFile)
 103   {
 104     System.out.println("Test: " + testname + "\nReading annotation file '"
 105             + annotFile + "' onto : " + f);
 106     String af = annotFile.getPath();
 107     try
 108     {
 109       AlignmentI al = readAlignmentFile(f);
 110       ColumnSelection cs = new ColumnSelection();
 111       assertTrue(
 112               "Test "
 113                       + testname
 114                       + "\nAlignment was not annotated - annotation file not imported.",
 115               new AnnotationFile().readAnnotationFile(al, cs, af,
 116                       FormatAdapter.FILE));
 117
 118       AnnotationFile aff = new AnnotationFile();
 119       ViewDef v = aff.new ViewDef(null, al.getHiddenSequences(), cs,
 120               new Hashtable());
 121       String anfileout = new AnnotationFile().printAnnotations(
 122               al.getAlignmentAnnotation(), al.getGroups(),
 123               al.getProperties(), null, al, v);
 124       assertTrue(
 125               "Test "
 126                       + testname
 127                       + "\nAlignment annotation file was not regenerated. Null string",
 128               anfileout != null);
 129       assertTrue(
 130               "Test "
 131                       + testname
 132                       + "\nAlignment annotation file was not regenerated. Empty string",
 133               anfileout.length() > "JALVIEW_ANNOTATION".length());
 134
 135       System.out.println("Output annotation file:\n" + anfileout
 136               + "\n<<EOF\n");
 137
 138       AlignmentI al_new = readAlignmentFile(f);
 139       assertTrue(
 140               "Test "
 141                       + testname
 142                       + "\nregenerated annotation file did not annotate alignment.",
 143               new AnnotationFile().readAnnotationFile(al_new, anfileout,
 144                       FormatAdapter.PASTE));
 145
 146       // test for consistency in io
 147       StockholmFileTest.testAlignmentEquivalence(al, al_new);
 148       return;
 149     } catch (Exception e)
 150     {
 151       e.printStackTrace();
 152     }
 153     fail("Test "
 154             + testname
 155             + "\nCouldn't complete Annotation file roundtrip input/output/input test for '"
 156             + annotFile + "'.");
 157   }
 158 }