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