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