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