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