test/jalview/ws/jabaws/RNAStructExportImport.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.junit.Assert.assertNotNull;
  24 import static org.junit.Assert.assertTrue;
  25 import static org.junit.Assert.fail;
  26 import jalview.datamodel.AlignmentAnnotation;
  27 import jalview.datamodel.AlignmentI;
  28 import jalview.gui.Jalview2XML;
  29 import jalview.io.AnnotationFile;
  30 import jalview.io.FormatAdapter;
  31 import jalview.io.StockholmFileTest;
  32 import jalview.ws.jws2.Jws2Discoverer;
  33 import jalview.ws.jws2.RNAalifoldClient;
  34 import jalview.ws.jws2.SequenceAnnotationWSClient;
  35 import jalview.ws.jws2.jabaws2.Jws2Instance;
  36 import jalview.ws.params.AutoCalcSetting;
  37
  38 import java.awt.Component;
  39 import java.util.ArrayList;
  40 import java.util.List;
  41
  42 import javax.swing.JMenu;
  43 import javax.swing.JMenuItem;
  44
  45 import org.junit.AfterClass;
  46 import org.junit.Assert;
  47 import org.junit.BeforeClass;
  48 import org.junit.Test;
  49
  50 import compbio.metadata.WrongParameterException;
  51
  52 public class RNAStructExportImport
  53 {
  54   public static String testseqs = "examples/RF00031_folded.stk";
  55
  56   public static Jws2Discoverer disc;
  57
  58   public static Jws2Instance rnaalifoldws;
  59
  60   jalview.ws.jws2.RNAalifoldClient alifoldClient;
  61
  62   public static jalview.gui.AlignFrame af = null;
  63
  64   @BeforeClass
  65   public static void setUpBeforeClass() throws Exception
  66   {
  67
  68     jalview.bin.Cache.initLogger();
  69     disc = JalviewJabawsTestUtils.getJabawsDiscoverer(false);
  70
  71     for (Jws2Instance svc : disc.getServices())
  72     {
  73
  74       if (svc.getServiceTypeURI().toLowerCase().contains("rnaalifoldws"))
  75       {
  76         rnaalifoldws = svc;
  77       }
  78     }
  79
  80     System.out.println("State of rnaalifoldws: " + rnaalifoldws);
  81
  82     if (rnaalifoldws == null)
  83     {
  84       fail("no web service");
  85     }
  86
  87     jalview.io.FileLoader fl = new jalview.io.FileLoader(false);
  88
  89     af = fl.LoadFileWaitTillLoaded(testseqs, jalview.io.FormatAdapter.FILE);
  90
  91     assertNotNull("Couldn't load test data ('" + testseqs + "')", af);
  92
  93     // remove any existing annotation
  94     List<AlignmentAnnotation> aal = new ArrayList<AlignmentAnnotation>();
  95     for (AlignmentAnnotation rna : af.getViewport().getAlignment()
  96             .getAlignmentAnnotation())
  97     {
  98       if (rna.isRNA())
  99       {
 100         aal.add(rna);
 101       }
 102     }
 103     for (AlignmentAnnotation rna : aal)
 104     {
 105       af.getViewport().getAlignment().deleteAnnotation(rna);
 106     }
 107     af.getViewport().alignmentChanged(af.alignPanel); // why is af.alignPanel
 108                                                       // public?
 109   }
 110
 111   @AfterClass
 112   public static void tearDownAfterClass() throws Exception
 113   {
 114     if (af != null)
 115     {
 116       af.setVisible(false);
 117       af.dispose();
 118     }
 119   }
 120
 121   @Test
 122   public void testRNAAliFoldValidStructure()
 123   {
 124
 125     alifoldClient = new RNAalifoldClient(rnaalifoldws, af, null, null);
 126
 127     af.getViewport().getCalcManager().startWorker(alifoldClient);
 128
 129     do
 130     {
 131       try
 132       {
 133         Thread.sleep(50);
 134       } catch (InterruptedException x)
 135       {
 136       }
 137       ;
 138     } while (af.getViewport().getCalcManager().isWorking());
 139
 140     AlignmentI orig_alig = af.getViewport().getAlignment();
 141     for (AlignmentAnnotation aa:orig_alig.getAlignmentAnnotation())
 142     {
 143       if (alifoldClient.involves(aa))
 144       {
 145         if (aa.isRNA())
 146         {
 147           Assert.assertTrue("Did not create valid structure from RNAALiFold prediction", aa.isValidStruc());
 148         }
 149       }
 150     }
 151   }
 152
 153   @Test
 154   public void testRNAStructExport()
 155   {
 156
 157     alifoldClient = new RNAalifoldClient(rnaalifoldws, af, null, null);
 158
 159     af.getViewport().getCalcManager().startWorker(alifoldClient);
 160
 161     do
 162     {
 163       try
 164       {
 165         Thread.sleep(50);
 166       } catch (InterruptedException x)
 167       {
 168       }
 169       ;
 170     } while (af.getViewport().getCalcManager().isWorking());
 171
 172     AlignmentI orig_alig = af.getViewport().getAlignment();
 173
 174     testAnnotationFileIO("Testing RNAalifold Annotation IO", orig_alig);
 175
 176   }
 177
 178   public static void testAnnotationFileIO(String testname, AlignmentI al)
 179   {
 180     try
 181     {
 182       // what format would be appropriate for RNAalifold annotations?
 183       String aligfileout = new FormatAdapter().formatSequences("PFAM",
 184               al.getSequencesArray());
 185
 186       String anfileout = new AnnotationFile()
 187               .printAnnotationsForAlignment(al);
 188       assertTrue(
 189               "Test "
 190                       + testname
 191                       + "\nAlignment annotation file was not regenerated. Null string",
 192               anfileout != null);
 193       assertTrue(
 194               "Test "
 195                       + testname
 196                       + "\nAlignment annotation file was not regenerated. Empty string",
 197               anfileout.length() > "JALVIEW_ANNOTATION".length());
 198
 199       System.out.println("Output annotation file:\n" + anfileout
 200               + "\n<<EOF\n");
 201
 202       // again what format would be appropriate?
 203       AlignmentI al_new = new FormatAdapter().readFile(aligfileout,
 204               FormatAdapter.PASTE, "PFAM");
 205       assertTrue(
 206               "Test "
 207                       + testname
 208                       + "\nregenerated annotation file did not annotate alignment.",
 209               new AnnotationFile().readAnnotationFile(al_new, anfileout,
 210                       FormatAdapter.PASTE));
 211
 212       // test for consistency in io
 213       StockholmFileTest.testAlignmentEquivalence(al, al_new, false);
 214       return;
 215     } catch (Exception e)
 216     {
 217       e.printStackTrace();
 218     }
 219     fail("Test "
 220             + testname
 221             + "\nCouldn't complete Annotation file roundtrip input/output/input test.");
 222   }
 223
 224   @Test
 225   public void testRnaalifoldSettingsRecovery()
 226   {
 227     List<compbio.metadata.Argument> opts = new ArrayList<compbio.metadata.Argument>();
 228     for (compbio.metadata.Argument rg : (List<compbio.metadata.Argument>) rnaalifoldws
 229             .getRunnerConfig().getArguments())
 230     {
 231       if (rg.getDescription().contains("emperature"))
 232       {
 233         try
 234         {
 235           rg.setValue("292");
 236         } catch (WrongParameterException q)
 237         {
 238           fail("Couldn't set the temperature parameter "
 239                   + q.getStackTrace());
 240         }
 241         opts.add(rg);
 242       }
 243       if (rg.getDescription().contains("max"))
 244       {
 245         opts.add(rg);
 246       }
 247     }
 248     alifoldClient = new RNAalifoldClient(rnaalifoldws, af, null, opts);
 249
 250     af.getViewport().getCalcManager().startWorker(alifoldClient);
 251
 252     do
 253     {
 254       try
 255       {
 256         Thread.sleep(50);
 257       } catch (InterruptedException x)
 258       {
 259       }
 260       ;
 261     } while (af.getViewport().getCalcManager().isWorking());
 262     AutoCalcSetting oldacs = af.getViewport().getCalcIdSettingsFor(
 263             alifoldClient.getCalcId());
 264     String oldsettings = oldacs.getWsParamFile();
 265     // write out parameters
 266     jalview.gui.AlignFrame nalf = null;
 267     assertTrue("Couldn't write out the Jar file",
 268             new Jalview2XML(false).saveAlignment(af,
 269                     "testRnalifold_param.jar", "trial parameter writeout"));
 270     assertTrue("Couldn't read back the Jar file", (nalf = new Jalview2XML(
 271             false).loadJalviewAlign("testRnalifold_param.jar")) != null);
 272     if (nalf != null)
 273     {
 274       AutoCalcSetting acs = af.getViewport().getCalcIdSettingsFor(
 275               alifoldClient.getCalcId());
 276       assertTrue("Calc ID settings not recovered from viewport stash",
 277               acs.equals(oldacs));
 278       assertTrue(
 279               "Serialised Calc ID settings not identical to those recovered from viewport stash",
 280               acs.getWsParamFile().equals(oldsettings));
 281       JMenu nmenu = new JMenu();
 282       new SequenceAnnotationWSClient().attachWSMenuEntry(nmenu,
 283               rnaalifoldws, af);
 284       assertTrue("Couldn't get menu entry for service",
 285               nmenu.getItemCount() > 0);
 286       for (Component itm : nmenu.getMenuComponents())
 287       {
 288         if (itm instanceof JMenuItem)
 289         {
 290           JMenuItem i = (JMenuItem) itm;
 291           if (i.getText().equals(
 292                   rnaalifoldws.getAlignAnalysisUI().getAAconToggle()))
 293           {
 294             i.doClick();
 295             break;
 296           }
 297         }
 298       }
 299       while (af.getViewport().isCalcInProgress())
 300       {
 301         try
 302         {
 303           Thread.sleep(200);
 304         } catch (Exception x)
 305         {
 306         }
 307         ;
 308       }
 309       AutoCalcSetting acs2 = af.getViewport().getCalcIdSettingsFor(
 310               alifoldClient.getCalcId());
 311       assertTrue(
 312               "Calc ID settings after recalculation has not been recovered.",
 313               acs2.getWsParamFile().equals(oldsettings));
 314     }
 315   }
 316 }