JAL-2546 JAL-2490 efficient lookup of features, correct handling of
[jalview.git] / test / jalview / ws / PDBSequenceFetcherTest.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.ws;
22
23 import static org.testng.AssertJUnit.assertTrue;
24
25 import jalview.bin.Cache;
26 import jalview.datamodel.AlignmentI;
27 import jalview.datamodel.SequenceI;
28 import jalview.gui.JvOptionPane;
29 import jalview.structure.StructureImportSettings;
30 import jalview.structure.StructureImportSettings.StructureParser;
31 import jalview.ws.seqfetcher.DbSourceProxy;
32
33 import java.util.List;
34
35 import org.testng.annotations.BeforeClass;
36 import org.testng.annotations.BeforeMethod;
37 import org.testng.annotations.Test;
38
39 public class PDBSequenceFetcherTest
40 {
41
42   @BeforeClass(alwaysRun = true)
43   public void setUpJvOptionPane()
44   {
45     JvOptionPane.setInteractiveMode(false);
46     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
47   }
48
49   SequenceFetcher sf;
50
51   @BeforeMethod(alwaysRun = true)
52   public void setUp() throws Exception
53   {
54     Cache.loadProperties("test/jalview/io/testProps.jvprops");
55     // ensure 'add annotation from structure' is selected
56     Cache.applicationProperties.setProperty("STRUCT_FROM_PDB",
57             Boolean.TRUE.toString());
58     Cache.applicationProperties.setProperty("ADD_SS_ANN",
59             Boolean.TRUE.toString());
60
61     sf = new SequenceFetcher(false);
62   }
63
64   /**
65    * Test that RNA structure can be added by a call to the RNAML service.
66    * 
67    * Note this test depends on http://arn-ibmc.in2p3.fr/api/compute/2d which is
68    * not always reliable.
69    * 
70    * @throws Exception
71    */
72   @Test(groups = { "Network" }, enabled = true)
73   public void testRnaSeqRetrieve() throws Exception
74   {
75     Cache.applicationProperties.setProperty("PDB_DOWNLOAD_FORMAT", "PDB");
76     List<DbSourceProxy> sps = sf.getSourceProxy("PDB");
77     AlignmentI response = sps.get(0).getSequenceRecords("2GIS");
78     assertTrue(response != null);
79     assertTrue(response.getHeight() == 1);
80     for (SequenceI sq : response.getSequences())
81     {
82       assertTrue("No annotation transfered to sequence.",
83               sq.getAnnotation().length > 0);
84       assertTrue("No PDBEntry on sequence.",
85               sq.getAllPDBEntries().size() > 0);
86       assertTrue(
87               "No RNA annotation on sequence, possibly http://arn-ibmc.in2p3.fr/api/compute/2d not available?",
88               sq.getRNA() != null);
89     }
90   }
91
92   @Test(groups = { "Network" }, enabled = true)
93   public void testPdbSeqRetrieve() throws Exception
94   {
95     StructureImportSettings.setDefaultStructureFileFormat("PDB");
96     StructureImportSettings
97             .setDefaultPDBFileParser(StructureParser.JALVIEW_PARSER);
98
99     testRetrieveProteinSeqFromPDB();
100   }
101
102   @Test(groups = { "Network" }, enabled = true)
103   public void testmmCifSeqRetrieve() throws Exception
104   {
105     StructureImportSettings.setDefaultStructureFileFormat("mmCIF");
106     testRetrieveProteinSeqFromPDB();
107   }
108
109   private void testRetrieveProteinSeqFromPDB() throws Exception
110   {
111     List<DbSourceProxy> sps = sf.getSourceProxy("PDB");
112     AlignmentI response = sps.get(0).getSequenceRecords("1QIP");
113     assertTrue(response != null);
114     assertTrue(response.getHeight() == 4);
115     for (SequenceI sq : response.getSequences())
116     {
117       assertTrue("No annotation transfered to sequence.",
118               sq.getAnnotation().length > 0);
119       assertTrue("No PDBEntry on sequence.",
120               sq.getAllPDBEntries().size() > 0);
121       org.testng.Assert
122               .assertEquals(sq.getEnd() - sq.getStart() + 1,
123                       sq.getLength(),
124                       "Sequence start/end doesn't match number of residues in sequence");
125     }
126   }
127
128 }