test/jalview/io/AnnotationFileIOTest.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.io;
  20
  21 import static org.junit.Assert.assertNotNull;
  22 import static org.junit.Assert.assertTrue;
  23 import static org.junit.Assert.fail;
  24 import jalview.datamodel.AlignmentI;
  25
  26 import java.io.File;
  27
  28 import org.junit.Test;
  29
  30 public class AnnotationFileIOTest
  31 {
  32
  33   static String TestFiles[][] = {{ "Test example annotation import/export","examples/uniref50.fa", "examples/testdata/example_annot_file.jva" }
  34           ,{"Test multiple combine annotation statements import/export","examples/uniref50.fa", "examples/testdata/test_combine_annot.jva"}
  35           ,{"Test multiple combine annotation statements with sequence_ref import/export","examples/uniref50.fa", "examples/testdata/uniref50_iupred.jva"}};
  36
  37   @Test
  38   public void exampleAnnotationFileIO() throws Exception
  39   {
  40     for (String[] testPair:TestFiles)
  41     {
  42       testAnnotationFileIO(testPair[0], new File(testPair[1]), new File(testPair[2]));
  43     }
  44   }
  45
  46   public static AlignmentI readAlignmentFile(File f)
  47   {
  48     System.out.println("Reading file: " + f);
  49     String ff = f.getPath();
  50     try
  51     {
  52       FormatAdapter rf = new FormatAdapter();
  53
  54       AlignmentI al = rf.readFile(ff, AppletFormatAdapter.FILE,
  55               new IdentifyFile().Identify(ff, AppletFormatAdapter.FILE));
  56
  57       // make sure dataset is initialised ? not sure about this
  58       for (int i = 0; i < al.getSequencesArray().length; ++i)
  59       {
  60         al.getSequenceAt(i).setDatasetSequence(al.getSequenceAt(i).createDatasetSequence());
  61       }
  62       assertNotNull("Couldn't read supplied alignment data.", al);
  63       return al;
  64     } catch (Exception e)
  65     {
  66       e.printStackTrace();
  67     }
  68     fail("Couln't read the alignment in file '"+f.toString()+"'");
  69     return null;
  70   }
  71   /**
  72    * test alignment data in given file can be imported, exported and reimported
  73    * with no dataloss
  74    *
  75    * @param f
  76    *          - source datafile (IdentifyFile.identify() should work with it)
  77    * @param ioformat
  78    *          - label for IO class used to write and read back in the data from
  79    *          f
  80    */
  81   public static void testAnnotationFileIO(String testname, File f, File annotFile)
  82   {
  83     System.out.println("Test: "+testname+"\nReading annotation file '"+annotFile+"' onto : " + f);
  84     String af = annotFile.getPath();
  85     try
  86     {
  87       AlignmentI al = readAlignmentFile(f);
  88
  89       assertTrue("Test "+testname+"\nAlignment was not annotated - annotation file not imported.",new AnnotationFile().readAnnotationFile(al, af, FormatAdapter.FILE));
  90
  91       String anfileout = new AnnotationFile().printAnnotations(al.getAlignmentAnnotation(), al.getGroups(), al.getProperties());
  92       assertTrue("Test "+testname+"\nAlignment annotation file was not regenerated. Null string",anfileout!=null);
  93       assertTrue("Test "+testname+"\nAlignment annotation file was not regenerated. Empty string",anfileout.length()>"JALVIEW_ANNOTATION".length());
  94
  95       System.out.println("Output annotation file:\n"+anfileout+"\n<<EOF\n");
  96
  97       AlignmentI al_new = readAlignmentFile(f);
  98       assertTrue("Test "+testname+"\nregenerated annotation file did not annotate alignment.",new AnnotationFile().readAnnotationFile(al_new, anfileout, FormatAdapter.PASTE));
  99
 100       // test for consistency in io
 101       StockholmFileTest.testAlignmentEquivalence(al, al_new);
 102       return;
 103     } catch (Exception e)
 104     {
 105       e.printStackTrace();
 106     }
 107     fail("Test "+testname+"\nCouldn't complete Annotation file roundtrip input/output/input test for '"+annotFile+"'.");
 108   }
 109 }