test/jalview/ext/jmol/JmolParserTest.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.jmol;
  22
  23 import static org.testng.AssertJUnit.assertEquals;
  24 import static org.testng.AssertJUnit.assertTrue;
  25
  26 import jalview.bin.Cache;
  27 import jalview.datamodel.Alignment;
  28 import jalview.datamodel.AlignmentI;
  29 import jalview.datamodel.SequenceI;
  30 import jalview.gui.AlignFrame;
  31 import jalview.io.AppletFormatAdapter;
  32 import jalview.io.FileLoader;
  33 import jalview.structure.StructureImportSettings;
  34
  35 import java.util.Vector;
  36
  37 import org.jmol.c.STR;
  38 import org.testng.annotations.BeforeMethod;
  39 import org.testng.annotations.Test;
  40
  41 import MCview.PDBfile;
  42
  43 /**
  44  * @author jimp
  45  *
  46  */
  47 public class JmolParserTest
  48 {
  49   /*
  50    * 1GAQ has been reduced to alpha carbons only
  51    * 1QCF is the full PDB file including headers, HETATM etc
  52    */
  53   String[] testFile = new String[] { "./examples/1GAQ.txt",
  54       "./test/jalview/ext/jmol/1xyz.pdb",
  55       "./test/jalview/ext/jmol/1qcf.pdb" };
  56
  57   //@formatter:off
  58   // a modified and very cut-down extract of 4UJ4
  59   String pastePDBDataWithChainBreak =
  60      "HEADER    TRANSPORT PROTEIN                       08-APR-15   4UJ4\n" +
  61      // chain B has missing residues; these should all go in the same sequence:
  62      "ATOM   1909  CA  VAL B 358      21.329 -19.739 -67.740  1.00201.05           C\n" +
  63      "ATOM   1916  CA  GLY B 359      21.694 -23.563 -67.661  1.00198.09           C\n" +
  64      "ATOM   1920  CA  LYS B 367      32.471 -12.135 -77.100  1.00257.97           C\n" +
  65      "ATOM   1925  CA  ALA B 368      31.032  -9.324 -74.946  1.00276.01           C\n" +
  66      // switch to chain C; should be a separate sequence
  67      "ATOM   1930  CA  SER C 369      32.589  -7.517 -71.978  1.00265.44           C\n" +
  68      "ATOM   1936  CA  ALA C 370      31.650  -6.849 -68.346  1.00249.48           C\n";
  69   //@formatter:on
  70
  71   //@formatter:off
  72   // a very cut-down extract of 1ejg
  73   String pdbWithAltLoc =
  74      "HEADER    TRANSPORT PROTEIN                       08-APR-15   1EJG\n" +
  75      "ATOM    448  CA  ALA A  24       6.619  16.195   1.970  1.00  1.65           C\n" +
  76      "ATOM    458  CA ALEU A  25       3.048  14.822   1.781  0.57  1.48           C\n" +
  77      // alternative residue 25 entries (with ILE instead of LEU) should be ignored:
  78      "ATOM    478  CA BILE A  25       3.048  14.822   1.781  0.21  1.48           C\n" +
  79      // including the next altloc causes the unit test to fail but it works with the full file
  80      // not sure why!
  81      //     "ATOM    479  CA CILE A  25       3.048  14.822   1.781  0.22  1.48           C\n" +
  82      "ATOM    512  CA  CYS A  26       4.137  11.461   3.154  1.00  1.52           C\n";
  83   //@formatter:on
  84
  85   @BeforeMethod(alwaysRun = true)
  86   public void setUp()
  87   {
  88     Cache.applicationProperties.setProperty("STRUCT_FROM_PDB",
  89             Boolean.TRUE.toString());
  90     Cache.applicationProperties.setProperty("ADD_SS_ANN",
  91             Boolean.TRUE.toString());
  92     StructureImportSettings.setDefaultStructureFileFormat("PDB");
  93     StructureImportSettings
  94             .setDefaultPDBFileParser(StructureImportSettings.JALVIEW_PARSER);
  95   }
  96
  97   @Test(groups = { "Functional" })
  98   public void testAlignmentLoader() throws Exception
  99   {
 100     for (String f : testFile)
 101     {
 102       FileLoader fl = new jalview.io.FileLoader(false);
 103       AlignFrame af = fl
 104               .LoadFileWaitTillLoaded(f, AppletFormatAdapter.FILE);
 105       validateSecStrRows(af.getViewport().getAlignment());
 106     }
 107   }
 108
 109   @Test(groups = { "Functional" })
 110   public void testFileParser() throws Exception
 111   {
 112     StructureImportSettings.setProcessHETATMs(false);
 113     for (String pdbStr : testFile)
 114     {
 115       PDBfile mctest = new PDBfile(false, false, false, pdbStr,
 116               AppletFormatAdapter.FILE);
 117       JmolParser jtest = new JmolParser(false, false, false, pdbStr,
 118               jalview.io.AppletFormatAdapter.FILE);
 119       Vector<SequenceI> seqs = jtest.getSeqs(), mcseqs = mctest.getSeqs();
 120
 121       assertTrue(
 122               "No sequences extracted from testfile\n"
 123                       + (jtest.hasWarningMessage() ? jtest.getWarningMessage()
 124                               : "(No warnings raised)"), seqs != null
 125                       && seqs.size() > 0);
 126       for (SequenceI sq : seqs)
 127       {
 128         assertEquals("JMol didn't process " + pdbStr
 129                 + " to the same sequence as MCView",
 130                 sq.getSequenceAsString(), mcseqs.remove(0)
 131                         .getSequenceAsString());
 132         AlignmentI al = new Alignment(new SequenceI[] { sq });
 133         validateSecStrRows(al);
 134       }
 135     }
 136     StructureImportSettings.setProcessHETATMs(true);
 137     for (String pdbStr : testFile)
 138     {
 139       PDBfile mctest = new PDBfile(false, false, false, pdbStr,
 140               AppletFormatAdapter.FILE);
 141       JmolParser jtest = new JmolParser(false, false, false, pdbStr,
 142               jalview.io.AppletFormatAdapter.FILE);
 143       Vector<SequenceI> seqs = jtest.getSeqs(), mcseqs = mctest.getSeqs();
 144
 145       assertTrue(
 146               "No sequences extracted from testfile\n"
 147                       + (jtest.hasWarningMessage() ? jtest.getWarningMessage()
 148                               : "(No warnings raised)"), seqs != null
 149                       && seqs.size() > 0);
 150       for (SequenceI sq : seqs)
 151       {
 152         assertEquals("JMol didn't process " + pdbStr
 153                 + " to the same sequence as MCView",
 154                 sq.getSequenceAsString(), mcseqs.remove(0)
 155                         .getSequenceAsString());
 156         AlignmentI al = new Alignment(new SequenceI[] { sq });
 157         validateSecStrRows(al);
 158       }
 159     }
 160   }
 161
 162   private void validateSecStrRows(AlignmentI al)
 163   {
 164     if (!al.isNucleotide())
 165     {
 166       for (SequenceI asq : al.getSequences())
 167       {
 168         SequenceI sq = asq;
 169         boolean hasDs = false;
 170         while (sq.getDatasetSequence() != null
 171                 && sq.getAnnotation() == null)
 172         {
 173           sq = sq.getDatasetSequence();
 174           hasDs = true;
 175         }
 176         checkFirstAAIsAssoc(sq);
 177         if (hasDs)
 178         {
 179           // also verify if alignment sequence has annotation on it
 180           // that is correctly mapped
 181           checkFirstAAIsAssoc(asq);
 182         }
 183       }
 184     }
 185   }
 186
 187   private void checkFirstAAIsAssoc(SequenceI sq)
 188   {
 189     assertTrue("No secondary structure assigned for protein sequence.",
 190             sq.getAnnotation() != null && sq.getAnnotation().length >= 1
 191                     && sq.getAnnotation()[0].hasIcons);
 192     assertTrue(
 193             "Secondary structure not associated for sequence "
 194                     + sq.getName(), sq.getAnnotation()[0].sequenceRef == sq);
 195   }
 196
 197   /**
 198    * Test parsing a chain with missing residues
 199    *
 200    * @throws Exception
 201    */
 202   @Test(groups = { "Functional" })
 203   public void testParse_missingResidues() throws Exception
 204   {
 205     PDBfile mctest = new PDBfile(false, false, false,
 206             pastePDBDataWithChainBreak,
 207             AppletFormatAdapter.PASTE);
 208     boolean annotFromStructure = false;
 209     boolean localSecondaryStruct = false;
 210     boolean serviceSecondaryStruct = false;
 211     JmolParser jtest = new JmolParser(annotFromStructure,
 212             localSecondaryStruct, serviceSecondaryStruct,
 213             pastePDBDataWithChainBreak,
 214             jalview.io.AppletFormatAdapter.PASTE);
 215     Vector<SequenceI> seqs = jtest.getSeqs();
 216     Vector<SequenceI> mcseqs = mctest.getSeqs();
 217
 218     assertEquals("Failed to find 2 sequences\n", 2, seqs.size());
 219     assertEquals("Failed to find 2 sequences\n", 2, mcseqs.size());
 220     assertEquals("VGKA", seqs.get(0).getSequenceAsString());
 221     assertEquals("VGKA", mcseqs.get(0).getSequenceAsString());
 222     assertEquals("SA", seqs.get(1).getSequenceAsString());
 223     assertEquals("SA", mcseqs.get(1).getSequenceAsString());
 224   }
 225
 226   /**
 227    * Test parsing a chain with 'altloc' residues
 228    *
 229    * @throws Exception
 230    */
 231   @Test(groups = { "Functional" })
 232   public void testParse_alternativeResidues() throws Exception
 233   {
 234     PDBfile mctest = new PDBfile(false, false, false, pdbWithAltLoc,
 235             AppletFormatAdapter.PASTE);
 236     boolean annotFromStructure = false;
 237     boolean localSecondaryStruct = false;
 238     boolean serviceSecondaryStruct = false;
 239     JmolParser jtest = new JmolParser(annotFromStructure,
 240             localSecondaryStruct, serviceSecondaryStruct, pdbWithAltLoc,
 241             jalview.io.AppletFormatAdapter.PASTE);
 242     Vector<SequenceI> seqs = jtest.getSeqs();
 243     Vector<SequenceI> mcseqs = mctest.getSeqs();
 244
 245     assertEquals("Failed to find 1 sequence\n", 1, seqs.size());
 246     assertEquals("Failed to find 1 sequence\n", 1, mcseqs.size());
 247     assertEquals("ALC", seqs.get(0).getSequenceAsString());
 248     assertEquals("ALC", mcseqs.get(0).getSequenceAsString());
 249   }
 250
 251   @Test(groups = "Functional")
 252   public void testSetSecondaryStructure()
 253   {
 254     JmolParser testee = new JmolParser();
 255     char[] struct = new char[10];
 256     char[] structCode = new char[10];
 257     struct[0] = '1';
 258     structCode[0] = '1';
 259
 260     testee.setSecondaryStructure(STR.NONE, 0, struct, structCode);
 261     testee.setSecondaryStructure(STR.HELIX, 1, struct, structCode);
 262     testee.setSecondaryStructure(STR.HELIX310, 2, struct, structCode);
 263     testee.setSecondaryStructure(STR.HELIXALPHA, 3, struct, structCode);
 264     testee.setSecondaryStructure(STR.HELIXPI, 4, struct, structCode);
 265     testee.setSecondaryStructure(STR.SHEET, 5, struct, structCode);
 266
 267     assertEquals(0, struct[0]);
 268     assertEquals('H', struct[1]);
 269     assertEquals('3', struct[2]);
 270     assertEquals('H', struct[3]);
 271     assertEquals('P', struct[4]);
 272     assertEquals('E', struct[5]);
 273
 274     assertEquals(0, structCode[0]);
 275     assertEquals('H', structCode[1]);
 276     assertEquals('H', structCode[2]);
 277     assertEquals('H', structCode[3]);
 278     assertEquals('H', structCode[4]);
 279     assertEquals('E', structCode[5]);
 280   }
 281 }