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