test/jalview/ws/jabaws/RNAStructExportImport.java

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