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