test/jalview/ws/jabaws/DisorderAnnotExportImport.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.ws.jabaws;
  22
  23 import static org.testng.AssertJUnit.assertNotNull;
  24 import static org.testng.AssertJUnit.assertTrue;
  25
  26 import jalview.bin.Cache;
  27 import jalview.datamodel.AlignmentAnnotation;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.gui.JvOptionPane;
  30 import jalview.io.AnnotationFile;
  31 import jalview.io.DataSourceType;
  32 import jalview.io.FileFormat;
  33 import jalview.io.FormatAdapter;
  34 import jalview.io.StockholmFileTest;
  35 import jalview.ws.jws2.AADisorderClient;
  36 import jalview.ws.jws2.Jws2Discoverer;
  37 import jalview.ws.jws2.jabaws2.Jws2Instance;
  38
  39 import java.util.ArrayList;
  40 import java.util.List;
  41
  42 import org.testng.Assert;
  43 import org.testng.annotations.AfterClass;
  44 import org.testng.annotations.BeforeClass;
  45 import org.testng.annotations.Test;
  46
  47 /*
  48  * All methods in this class are set to the Network group because setUpBeforeClass will fail
  49  * if there is no network.
  50  */
  51 @Test(singleThreaded = true)
  52 public class DisorderAnnotExportImport
  53 {
  54
  55   @BeforeClass(alwaysRun = true)
  56   public void setUpJvOptionPane()
  57   {
  58     JvOptionPane.setInteractiveMode(false);
  59     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  60   }
  61
  62   public static String testseqs = "examples/uniref50.fa";
  63
  64   public static Jws2Discoverer disc;
  65
  66   public static List<Jws2Instance> iupreds;
  67
  68   jalview.ws.jws2.AADisorderClient disorderClient;
  69
  70   public static jalview.gui.AlignFrame af = null;
  71
  72   @BeforeClass(inheritGroups = true)
  73   public static void setUpBeforeClass() throws Exception
  74   {
  75     Cache.loadProperties("test/jalview/io/testProps.jvprops");
  76     Cache.initLogger();
  77     disc = JalviewJabawsTestUtils.getJabawsDiscoverer();
  78     iupreds = new ArrayList<Jws2Instance>();
  79     for (Jws2Instance svc : disc.getServices())
  80     {
  81       if (svc.getServiceTypeURI().toLowerCase().contains("iupredws"))
  82       {
  83         iupreds.add(svc);
  84       }
  85     }
  86     assertTrue("Couldn't discover any IUPred services to use to test.",
  87             iupreds.size() > 0);
  88     jalview.io.FileLoader fl = new jalview.io.FileLoader(false);
  89     af = fl.LoadFileWaitTillLoaded(testseqs, jalview.io.DataSourceType.FILE);
  90     assertNotNull("Couldn't load test data ('" + testseqs + "')", af);
  91   }
  92
  93   @AfterClass(alwaysRun = true)
  94   public static void tearDownAfterClass() throws Exception
  95   {
  96     if (af != null)
  97     {
  98       af.setVisible(false);
  99       af.dispose();
 100       af = null;
 101     }
 102   }
 103
 104   /**
 105    * test for patches to JAL-1294
 106    */
 107   @Test(groups = { "External", "Network" })
 108   public void testDisorderAnnotExport()
 109   {
 110     disorderClient = new AADisorderClient(iupreds.get(0), af, null, null);
 111     af.getViewport().getCalcManager().startWorker(disorderClient);
 112     do
 113     {
 114       try
 115       {
 116         Thread.sleep(50);
 117       } catch (InterruptedException x)
 118       {
 119       }
 120       ;
 121     } while (af.getViewport().getCalcManager().isWorking());
 122     AlignmentI orig_alig = af.getViewport().getAlignment();
 123     // NOTE: Consensus annotation row cannot be exported and reimported
 124     // faithfully - so we remove them
 125     List<AlignmentAnnotation> toremove = new ArrayList<AlignmentAnnotation>();
 126     for (AlignmentAnnotation aa : orig_alig.getAlignmentAnnotation())
 127     {
 128       if (aa.autoCalculated)
 129       {
 130         toremove.add(aa);
 131       }
 132     }
 133     for (AlignmentAnnotation aa : toremove)
 134     {
 135       orig_alig.deleteAnnotation(aa);
 136     }
 137     checkAnnotationFileIO("Testing IUPred Annotation IO", orig_alig);
 138
 139   }
 140
 141   static void checkAnnotationFileIO(String testname, AlignmentI al)
 142   {
 143     try
 144     {
 145       String aligfileout = FileFormat.Pfam.getWriter(al).print(
 146               al.getSequencesArray(), true);
 147       String anfileout = new AnnotationFile()
 148               .printAnnotationsForAlignment(al);
 149       assertTrue(
 150               "Test "
 151                       + testname
 152                       + "\nAlignment annotation file was not regenerated. Null string",
 153               anfileout != null);
 154       assertTrue(
 155               "Test "
 156                       + testname
 157                       + "\nAlignment annotation file was not regenerated. Empty string",
 158               anfileout.length() > "JALVIEW_ANNOTATION".length());
 159
 160       System.out.println("Output annotation file:\n" + anfileout
 161               + "\n<<EOF\n");
 162
 163       AlignmentI al_new = new FormatAdapter().readFile(aligfileout,
 164               DataSourceType.PASTE, FileFormat.Pfam);
 165       assertTrue(
 166               "Test "
 167                       + testname
 168                       + "\nregenerated annotation file did not annotate alignment.",
 169               new AnnotationFile().readAnnotationFile(al_new, anfileout,
 170                       DataSourceType.PASTE));
 171
 172       // test for consistency in io
 173       StockholmFileTest.testAlignmentEquivalence(al, al_new, true);
 174       return;
 175     } catch (Exception e)
 176     {
 177       e.printStackTrace();
 178     }
 179     Assert.fail("Test "
 180             + testname
 181             + "\nCouldn't complete Annotation file roundtrip input/output/input test.");
 182   }
 183
 184 }