JAL-2505 removed SequenceFeature constructor JAL-1641 include
[jalview.git] / test / jalview / gui / StructureChooserTest.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.gui;
22
23 import static org.testng.AssertJUnit.assertEquals;
24 import static org.testng.AssertJUnit.assertTrue;
25
26 import jalview.datamodel.DBRefEntry;
27 import jalview.datamodel.DBRefSource;
28 import jalview.datamodel.PDBEntry;
29 import jalview.datamodel.Sequence;
30 import jalview.datamodel.SequenceI;
31 import jalview.jbgui.GStructureChooser.FilterOption;
32
33 import java.util.Vector;
34
35 import org.testng.annotations.AfterMethod;
36 import org.testng.annotations.BeforeClass;
37 import org.testng.annotations.BeforeMethod;
38 import org.testng.annotations.Test;
39
40 public class StructureChooserTest
41 {
42
43   @BeforeClass(alwaysRun = true)
44   public void setUpJvOptionPane()
45   {
46     JvOptionPane.setInteractiveMode(false);
47     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
48   }
49
50   Sequence seq;
51
52   @BeforeMethod(alwaysRun = true)
53   public void setUp() throws Exception
54   {
55     seq = new Sequence("PDB|4kqy|4KQY|A", "ABCDEFGHIJKLMNOPQRSTUVWXYZ", 1,
56             26);
57     seq.createDatasetSequence();
58     for (int x = 1; x < 5; x++)
59     {
60       DBRefEntry dbRef = new DBRefEntry();
61       dbRef.setAccessionId("XYZ_" + x);
62       seq.addDBRef(dbRef);
63     }
64
65     PDBEntry dbRef = new PDBEntry();
66     dbRef.setId("1tim");
67
68     Vector<PDBEntry> pdbIds = new Vector<PDBEntry>();
69     pdbIds.add(dbRef);
70
71     seq.setPDBId(pdbIds);
72   }
73
74   @AfterMethod(alwaysRun = true)
75   public void tearDown() throws Exception
76   {
77     seq = null;
78   }
79
80   @Test(groups = { "Functional" })
81   public void buildQueryTest()
82   {
83     String query = StructureChooser.buildQuery(seq);
84     assertEquals("pdb_id:1tim", query);
85     System.out.println("seq >>>> " + seq);
86     seq.getAllPDBEntries().clear();
87     query = StructureChooser.buildQuery(seq);
88     assertEquals(
89             "text:XYZ_1 OR text:XYZ_2 OR text:XYZ_3 OR text:XYZ_4 OR text:4kqy",
90             query);
91     seq.setDBRefs(null);
92     query = StructureChooser.buildQuery(seq);
93     assertEquals("text:4kqy", query);
94
95     DBRefEntry uniprotDBRef = new DBRefEntry();
96     uniprotDBRef.setAccessionId("P12345");
97     uniprotDBRef.setSource(DBRefSource.UNIPROT);
98     seq.addDBRef(uniprotDBRef);
99
100     DBRefEntry pdbDBRef = new DBRefEntry();
101     pdbDBRef.setAccessionId("1XYZ");
102     pdbDBRef.setSource(DBRefSource.PDB);
103     seq.addDBRef(pdbDBRef);
104
105     for (int x = 1; x < 5; x++)
106     {
107       DBRefEntry dbRef = new DBRefEntry();
108       dbRef.setAccessionId("XYZ_" + x);
109       seq.addDBRef(dbRef);
110     }
111     query = StructureChooser.buildQuery(seq);
112     assertEquals(
113             "uniprot_accession:P12345 OR uniprot_id:P12345 OR pdb_id:1xyz",
114             query);
115   }
116
117   @Test(groups = { "Functional" })
118   public void populateFilterComboBoxTest() throws InterruptedException
119   {
120     SequenceI[] selectedSeqs = new SequenceI[] { seq };
121     StructureChooser sc = new StructureChooser(selectedSeqs, seq, null);
122     sc.populateFilterComboBox(false, false);
123     int optionsSize = sc.getCmbFilterOption().getItemCount();
124     assertEquals(3, optionsSize); // if structures are not discovered then don't
125                                   // populate filter options
126
127     sc.populateFilterComboBox(true, false);
128     optionsSize = sc.getCmbFilterOption().getItemCount();
129     assertTrue(optionsSize > 3); // if structures are found, filter options
130                                  // should be populated
131
132     sc.populateFilterComboBox(true, true);
133     assertTrue(sc.getCmbFilterOption().getSelectedItem() != null);
134     FilterOption filterOpt = (FilterOption) sc.getCmbFilterOption()
135             .getSelectedItem();
136     assertEquals("Cached PDB Entries", filterOpt.getName());
137   }
138
139   @Test(groups = { "Network" })
140   public void fetchStructuresInfoTest()
141   {
142     SequenceI[] selectedSeqs = new SequenceI[] { seq };
143     StructureChooser sc = new StructureChooser(selectedSeqs, seq, null);
144     sc.fetchStructuresMetaData();
145     assertTrue(sc.getDiscoveredStructuresSet() != null);
146     assertTrue(sc.getDiscoveredStructuresSet().size() > 0);
147
148   }
149
150   @Test(groups = { "Functional" })
151   public void sanitizeSeqNameTest()
152   {
153     String name = "ab_cdEF|fwxyz012349";
154     assertEquals(name, StructureChooser.sanitizeSeqName(name));
155
156     // remove a [nn] substring
157     name = "abcde12[345]fg";
158     assertEquals("abcde12fg", StructureChooser.sanitizeSeqName(name));
159
160     // remove characters other than a-zA-Z0-9 | or _
161     name = "ab[cd],.\t£$*!- \\\"@:e";
162     assertEquals("abcde", StructureChooser.sanitizeSeqName(name));
163
164     name = "abcde12[345a]fg";
165     assertEquals("abcde12345afg", StructureChooser.sanitizeSeqName(name));
166   }
167 }