test/jalview/io/AnnotatedPDBFileInputTest.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.io;
  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 java.io.File;
  28 import java.util.List;
  29
  30 import org.junit.Assert;
  31 import org.testng.annotations.AfterClass;
  32 import org.testng.annotations.BeforeClass;
  33 import org.testng.annotations.BeforeMethod;
  34 import org.testng.annotations.Test;
  35
  36 import jalview.bin.Cache;
  37 import jalview.datamodel.AlignmentAnnotation;
  38 import jalview.datamodel.AlignmentI;
  39 import jalview.datamodel.PDBEntry;
  40 import jalview.datamodel.SequenceFeature;
  41 import jalview.datamodel.SequenceI;
  42 import jalview.datamodel.features.SequenceFeatures;
  43 import jalview.gui.AlignFrame;
  44 import jalview.gui.Desktop;
  45 import jalview.gui.JvOptionPane;
  46 import jalview.structure.StructureImportSettings;
  47 import jalview.structure.StructureImportSettings.StructureParser;
  48
  49 public class AnnotatedPDBFileInputTest
  50 {
  51
  52   @BeforeClass(alwaysRun = true)
  53   public void setUpJvOptionPane()
  54   {
  55     JvOptionPane.setInteractiveMode(false);
  56     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  57   }
  58
  59   AlignmentI al;
  60
  61   String pdbId;
  62
  63   /**
  64    * Ensure 'process secondary structure from PDB and add annotations' are set
  65    * in preferences, and load PDB example file 1gaq
  66    *
  67    * @throws Exception
  68    */
  69   @BeforeMethod(alwaysRun = true)
  70   public void setup() throws Exception
  71   {
  72     Cache.applicationProperties.setProperty("STRUCT_FROM_PDB",
  73             Boolean.TRUE.toString());
  74     Cache.applicationProperties.setProperty("ADD_SS_ANN",
  75             Boolean.TRUE.toString());
  76     FileLoader loader = new FileLoader(false);
  77     AlignFrame af = loader.LoadFileWaitTillLoaded("examples/1gaq.txt",
  78             DataSourceType.FILE);
  79     al = af.getViewport().getAlignment();
  80     pdbId = al.getSequenceAt(0).getDatasetSequence().getAllPDBEntries()
  81             .get(0).getId();
  82     StructureImportSettings.setDefaultStructureFileFormat("PDB");
  83     // StructureImportSettings
  84     // .setDefaultPDBFileParser(StructureParser.JALVIEW_PARSER);
  85   }
  86
  87   @Test(groups = { "Functional" })
  88   public void checkNoDuplicates()
  89   {
  90     // not strictly a requirement, but strange things may happen if multiple
  91     // instances of the same annotation are placed in the alignment annotation
  92     // vector
  93     assertNotNull(al.getAlignmentAnnotation());
  94     // verify that all sequence annotation is doubly referenced
  95     AlignmentAnnotation[] avec = al.getAlignmentAnnotation();
  96     for (int p = 0; p < avec.length; p++)
  97     {
  98       for (int q = p + 1; q < avec.length; q++)
  99       {
 100         assertTrue("Found a duplicate annotation row " + avec[p].label,
 101                 avec[p] != avec[q]);
 102       }
 103     }
 104   }
 105
 106   @Test(groups = { "Functional" }, enabled = false)
 107   public void checkPDBannotationSource()
 108   {
 109     Assert.fail(
 110             "This test is incorrect - does not verify that JmolParser's annotation rows can be recognised as generated by the Jmol parser.");
 111     for (SequenceI asq : al.getSequences())
 112     {
 113       for (AlignmentAnnotation aa : asq.getAnnotation())
 114       {
 115
 116         System.out.println("CalcId: " + aa.getCalcId());
 117         if (StructureImportSettings.getDefaultPDBFileParser()
 118                 .equals(StructureParser.JALVIEW_PARSER))
 119         {
 120           assertTrue(mc_view.PDBfile.isCalcIdForFile(aa, pdbId));
 121         }
 122       }
 123     }
 124   }
 125
 126   /**
 127    * Check sequence features have been added
 128    */
 129   @Test(groups = { "Functional" })
 130   public void checkPDBSequenceFeatures()
 131   {
 132     /*
 133      * 1GAQ/A
 134      */
 135     List<SequenceFeature> sf = al.getSequenceAt(0).getSequenceFeatures();
 136     SequenceFeatures.sortFeatures(sf, true);
 137     assertEquals(296, sf.size());
 138     assertEquals("RESNUM", sf.get(0).getType());
 139     assertEquals("GLU:  19  1gaqA", sf.get(0).getDescription());
 140     assertEquals("RESNUM", sf.get(295).getType());
 141     assertEquals("TYR: 314  1gaqA", sf.get(295).getDescription());
 142
 143     /*
 144      * 1GAQ/B
 145      */
 146     sf = al.getSequenceAt(1).getSequenceFeatures();
 147     SequenceFeatures.sortFeatures(sf, true);
 148     assertEquals(98, sf.size());
 149     assertEquals("RESNUM", sf.get(0).getType());
 150     assertEquals("ALA:   1  1gaqB", sf.get(0).getDescription());
 151     assertEquals("RESNUM", sf.get(97).getType());
 152     assertEquals("ALA:  98  1gaqB", sf.get(97).getDescription());
 153
 154     /*
 155      * 1GAQ/C
 156      */
 157     sf = al.getSequenceAt(2).getSequenceFeatures();
 158     SequenceFeatures.sortFeatures(sf, true);
 159     assertEquals(296, sf.size());
 160     assertEquals("RESNUM", sf.get(0).getType());
 161     assertEquals("GLU:  19  1gaqC", sf.get(0).getDescription());
 162     assertEquals("RESNUM", sf.get(295).getType());
 163     assertEquals("TYR: 314  1gaqC", sf.get(295).getDescription());
 164   }
 165
 166   @Test(groups = { "Functional" })
 167   public void checkAnnotationWiring()
 168   {
 169     assertTrue(al.getAlignmentAnnotation() != null);
 170     // verify that all sequence annotation is doubly referenced
 171     for (AlignmentAnnotation aa : al.getAlignmentAnnotation())
 172     {
 173       if (aa.sequenceRef != null)
 174       {
 175         assertTrue(al.getSequences().contains(aa.sequenceRef));
 176         assertNotNull(aa.sequenceRef.getAnnotation());
 177         boolean found = false;
 178         for (AlignmentAnnotation sqan : aa.sequenceRef.getAnnotation())
 179         {
 180           if (sqan == aa)
 181           {
 182             found = true;
 183             break;
 184           }
 185         }
 186         assertTrue("Couldn't find sequence associated annotation "
 187                 + aa.label
 188                 + " on the sequence it is associated with.\nSequence associated editing will fail.",
 189                 found);
 190       }
 191     }
 192   }
 193
 194   /**
 195    * @throws java.lang.Exception
 196    */
 197   @BeforeClass(alwaysRun = true)
 198   public static void setUpBeforeClass() throws Exception
 199   {
 200     jalview.bin.Jalview
 201             .main(new String[]
 202             { "-props", "test/jalview/io/testProps.jvprops" });
 203   }
 204
 205   /**
 206    * @throws java.lang.Exception
 207    */
 208   @AfterClass(alwaysRun = true)
 209   public static void tearDownAfterClass() throws Exception
 210   {
 211     if (Desktop.instance != null)
 212       Desktop.instance.closeAll_actionPerformed(null);
 213   }
 214
 215   @Test(groups = { "Functional" })
 216   public void testJalviewProjectRelocationAnnotation() throws Exception
 217   {
 218
 219     String inFile = "examples/1gaq.txt";
 220     String tfile = File.createTempFile("JalviewTest", ".jvp")
 221             .getAbsolutePath();
 222     AlignFrame af = new jalview.io.FileLoader()
 223             .LoadFileWaitTillLoaded(inFile, DataSourceType.FILE);
 224     assertTrue("Didn't read input file " + inFile, af != null);
 225     af.saveAlignment(tfile, FileFormat.Jalview);
 226     assertTrue("Failed to store as a project.",
 227             af.isSaveAlignmentSuccessful());
 228     af.closeMenuItem_actionPerformed(true);
 229     af = null;
 230     af = new jalview.io.FileLoader().LoadFileWaitTillLoaded(tfile,
 231             DataSourceType.FILE);
 232     assertTrue("Failed to import new project", af != null);
 233     for (SequenceI asq : af.getViewport().getAlignment().getSequences())
 234     {
 235       SequenceI sq = asq;
 236       while (sq.getDatasetSequence() != null)
 237       {
 238         sq = sq.getDatasetSequence();
 239       }
 240       assertNotNull(sq.getAllPDBEntries());
 241       assertEquals("Expected only one PDB ID", 1,
 242               sq.getAllPDBEntries().size());
 243       for (PDBEntry pdbentry : sq.getAllPDBEntries())
 244       {
 245         System.err.println(
 246                 "PDB Entry " + pdbentry.getId() + " " + pdbentry.getFile());
 247         boolean exists = false, found = false;
 248         for (AlignmentAnnotation ana : sq.getAnnotation())
 249         {
 250           System.err.println("CalcId " + ana.getCalcId());
 251           if (ana.getCalcId() != null
 252                   && mc_view.PDBfile.isCalcIdHandled(ana.getCalcId()))
 253           {
 254             exists = true;
 255             if (mc_view.PDBfile.isCalcIdForFile(ana, pdbentry.getId()))
 256             {
 257               found = true;
 258             }
 259           }
 260         }
 261         if (exists)
 262         {
 263           assertTrue(
 264                   "Couldn't find any annotation for " + pdbentry.getId()
 265                           + " (file handle " + pdbentry.getFile() + ")",
 266                   found);
 267         }
 268       }
 269     }
 270   }
 271 }