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