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