test/jalview/ext/paradise/TestAnnotate3D.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.ext.paradise;
  22
  23 import static org.junit.Assert.assertTrue;
  24
  25 import java.io.BufferedReader;
  26 import java.io.File;
  27 import java.io.Reader;
  28 import java.util.Iterator;
  29
  30 import org.junit.Assert;
  31 import org.junit.Test;
  32
  33 import MCview.PDBfile;
  34 import compbio.util.FileUtil;
  35
  36 import jalview.datamodel.AlignmentI;
  37 import jalview.datamodel.SequenceI;
  38 import jalview.io.FastaFile;
  39 import jalview.io.FormatAdapter;
  40
  41 public class TestAnnotate3D
  42 {
  43
  44   @Test
  45   public void test1GIDbyId() throws Exception
  46   {
  47     // use same ID as standard tests given at
  48     // https://bitbucket.org/fjossinet/pyrna-rest-clients
  49     Iterator<Reader> ids = Annotate3D.getRNAMLForPDBId("1GID");
  50     assertTrue("Didn't retrieve 1GID by id.", ids != null);
  51     testRNAMLcontent(ids, null);
  52   }
  53
  54   @Test
  55   public void testIdVsContent2GIS() throws Exception
  56   {
  57     Iterator<Reader> ids = Annotate3D.getRNAMLForPDBId("2GIS");
  58     assertTrue("Didn't retrieve 2GIS by id.", ids != null);
  59     Iterator<Reader> files = Annotate3D.getRNAMLForPDBFileAsString(FileUtil
  60             .readFileToString(new File("examples/2GIS.pdb")));
  61     assertTrue("Didn't retrieve using examples/2GIS.pdb.", files != null);
  62     int i = 0;
  63     while (ids.hasNext() && files.hasNext())
  64     {
  65       BufferedReader file = new BufferedReader(files.next()), id = new BufferedReader(
  66               ids.next());
  67       String iline, fline;
  68       do
  69       {
  70         iline = id.readLine();
  71         fline = file.readLine();
  72         if (iline != null)
  73         {
  74           System.out.println(iline);
  75         }
  76         if (fline != null)
  77         {
  78           System.out.println(fline);
  79         }
  80         // next assert fails for latest RNAview - because the XMLID entries
  81         // change between file and ID based RNAML generation.
  82         assertTrue(
  83                 "Results differ for ID and file upload based retrieval (chain entry "
  84                         + (++i) + ")",
  85                 ((iline == fline && iline == null) || (iline != null
  86                         && fline != null && iline.equals(fline))));
  87
  88       } while (iline != null);
  89     }
  90   }
  91
  92   /**
  93    * test to demonstrate JAL-1142 - compare sequences in RNAML returned from
  94    * Annotate3d vs those extracted by Jalview from the originl PDB file
  95    *
  96    * @throws Exception
  97    */
  98   @Test
  99   public void testPDBfileVsRNAML() throws Exception
 100   {
 101     PDBfile pdbf = new PDBfile(true, false, true, "examples/2GIS.pdb",
 102             FormatAdapter.FILE);
 103     Assert.assertTrue(pdbf.isValid());
 104     // Comment - should add new FileParse constructor like new FileParse(Reader
 105     // ..). for direct reading
 106     Iterator<Reader> readers = Annotate3D
 107             .getRNAMLForPDBFileAsString(FileUtil.readFileToString(new File(
 108                     "examples/2GIS.pdb")));
 109     testRNAMLcontent(readers, pdbf);
 110   }
 111
 112   private void testRNAMLcontent(Iterator<Reader> readers, PDBfile pdbf)
 113           throws Exception
 114   {
 115     StringBuffer sb = new StringBuffer();
 116     int r = 0;
 117     while (readers.hasNext())
 118     {
 119       System.out.println("Testing RNAML input number " + (++r));
 120       BufferedReader br = new BufferedReader(readers.next());
 121       String line;
 122       while ((line = br.readLine()) != null)
 123       {
 124         sb.append(line + "\n");
 125       }
 126       assertTrue("No data returned by Annotate3D", sb.length() > 0);
 127       final String lines = sb.toString();
 128       AlignmentI al = new FormatAdapter().readFile(lines,
 129               FormatAdapter.PASTE, "RNAML");
 130       if (al == null || al.getHeight() == 0)
 131       {
 132         System.out.println(lines);
 133       }
 134       assertTrue("No alignment returned.", al != null);
 135       assertTrue("No sequences in returned alignment.", al.getHeight() > 0);
 136       if (pdbf != null)
 137       {
 138         for (SequenceI sq : al.getSequences())
 139         {
 140           {
 141             SequenceI struseq = null;
 142             String sq_ = new String(sq.getSequence()).toLowerCase();
 143             for (SequenceI _struseq : pdbf.getSeqsAsArray())
 144             {
 145               final String lowerCase = new String(_struseq.getSequence()).toLowerCase();
 146               if (lowerCase.equals(
 147                       sq_))
 148               {
 149                 struseq = _struseq;
 150                 break;
 151               }
 152             }
 153             if (struseq == null)
 154             {
 155               Assert.fail("Couldn't find this sequence in original input:\n"
 156                       + new FastaFile().print(new SequenceI[]
 157                       { sq })
 158                       + "\n\nOriginal input:\n"
 159                       + new FastaFile().print(pdbf.getSeqsAsArray()) + "\n");
 160             }
 161           }
 162         }
 163       }
 164     }
 165   }
 166 }