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