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