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