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.Assert.assertEquals;
  24 import static org.testng.AssertJUnit.assertNotNull;
  25 import static org.testng.AssertJUnit.assertTrue;
  26
  27 import java.util.Collection;
  28 import java.util.Vector;
  29
  30 import org.junit.Assert;
  31 import org.testng.annotations.AfterMethod;
  32 import org.testng.annotations.BeforeClass;
  33 import org.testng.annotations.BeforeMethod;
  34 import org.testng.annotations.Test;
  35
  36 import jalview.datamodel.DBRefEntry;
  37 import jalview.datamodel.PDBEntry;
  38 import jalview.datamodel.Sequence;
  39 import jalview.datamodel.SequenceI;
  40 import jalview.fts.api.FTSData;
  41 import jalview.fts.core.FTSRestClient;
  42 import jalview.fts.service.pdb.PDBFTSRestClient;
  43 import jalview.fts.service.pdb.PDBFTSRestClientTest;
  44 import jalview.fts.service.threedbeacons.TDBeaconsFTSRestClient;
  45 import jalview.fts.threedbeacons.TDBeaconsFTSRestClientTest;
  46 import jalview.gui.structurechooser.PDBStructureChooserQuerySource;
  47 import jalview.jbgui.FilterOption;
  48 import junit.extensions.PA;
  49
  50 @Test(singleThreaded = true)
  51 public class StructureChooserTest
  52 {
  53
  54   @BeforeClass(alwaysRun = true)
  55   public void setUpJvOptionPane()
  56   {
  57     JvOptionPane.setInteractiveMode(false);
  58     JvOptionPane.setMockResponse(JvOptionPane.CANCEL_OPTION);
  59   }
  60
  61   Sequence seq,upSeq,upSeq_nocanonical;
  62
  63   @BeforeMethod(alwaysRun = true)
  64   public void setUp() throws Exception
  65   {
  66     seq = new Sequence("PDB|4kqy|4KQY|A", "ABCDEFGHIJKLMNOPQRSTUVWXYZ", 1,
  67             26);
  68     seq.createDatasetSequence();
  69     for (int x = 1; x < 5; x++)
  70     {
  71       DBRefEntry dbRef = new DBRefEntry();
  72       dbRef.setAccessionId("XYZ_" + x);
  73       seq.addDBRef(dbRef);
  74     }
  75
  76     PDBEntry dbRef = new PDBEntry();
  77     dbRef.setId("1tim");
  78
  79     Vector<PDBEntry> pdbIds = new Vector<>();
  80     pdbIds.add(dbRef);
  81
  82     seq.setPDBId(pdbIds);
  83
  84     // Uniprot sequence for 3D-Beacons mocks
  85     upSeq = new Sequence("P38398",
  86             "MDLSALRVEEVQNVINAMQKILECPICLELIKEPVSTKCDHIFCKFCMLKLLNQKKGPSQCPLCKNDITKRS\n"
  87             + "LQESTRFSQLVEELLKIICAFQLDTGLEYANSYNFAKKENNSPEHLKDEVSIIQSMGYRNRAKRLLQSEPEN\n"
  88             + "PSLQETSLSVQLSNLGTVRTLRTKQRIQPQKTSVYIELGSDSSEDTVNKATYCSVGDQELLQITPQGTRDEI\n"
  89             + "SLDSAKKAACEFSETDVTNTEHHQPSNNDLNTTEKRAAERHPEKYQGSSVSNLHVEPCGTNTHASSLQHENS\n"
  90             + "SLLLTKDRMNVEKAEFCNKSKQPGLARSQHNRWAGSKETCNDRRTPSTEKKVDLNADPLCERKEWNKQKLPC\n"
  91             + "SENPRDTEDVPWITLNSSIQKVNEWFSRSDELLGSDDSHDGESESNAKVADVLDVLNEVDEYSGSSEKIDLL\n"
  92             + "ASDPHEALICKSERVHSKSVESNIEDKIFGKTYRKKASLPNLSHVTENLIIGAFVTEPQIIQERPLTNKLKR\n"
  93             + "KRRPTSGLHPEDFIKKADLAVQKTPEMINQGTNQTEQNGQVMNITNSGHENKTKGDSIQNEKNPNPIESLEK\n"
  94             + "ESAFKTKAEPISSSISNMELELNIHNSKAPKKNRLRRKSSTRHIHALELVVSRNLSPPNCTELQIDSCSSSE\n"
  95             + "EIKKKKYNQMPVRHSRNLQLMEGKEPATGAKKSNKPNEQTSKRHDSDTFPELKLTNAPGSFTKCSNTSELKE\n"
  96             + "FVNPSLPREEKEEKLETVKVSNNAEDPKDLMLSGERVLQTERSVESSSISLVPGTDYGTQESISLLEVSTLG\n"
  97             + "KAKTEPNKCVSQCAAFENPKGLIHGCSKDNRNDTEGFKYPLGHEVNHSRETSIEMEESELDAQYLQNTFKVS\n"
  98             + "KRQSFAPFSNPGNAEEECATFSAHSGSLKKQSPKVTFECEQKEENQGKNESNIKPVQTVNITAGFPVVGQKD\n"
  99             + "KPVDNAKCSIKGGSRFCLSSQFRGNETGLITPNKHGLLQNPYRIPPLFPIKSFVKTKCKKNLLEENFEEHSM\n"
 100             + "SPEREMGNENIPSTVSTISRNNIRENVFKEASSSNINEVGSSTNEVGSSINEIGSSDENIQAELGRNRGPKL\n"
 101             + "NAMLRLGVLQPEVYKQSLPGSNCKHPEIKKQEYEEVVQTVNTDFSPYLISDNLEQPMGSSHASQVCSETPDD\n"
 102             + "LLDDGEIKEDTSFAENDIKESSAVFSKSVQKGELSRSPSPFTHTHLAQGYRRGAKKLESSEENLSSEDEELP\n"
 103             + "CFQHLLFGKVNNIPSQSTRHSTVATECLSKNTEENLLSLKNSLNDCSNQVILAKASQEHHLSEETKCSASLF\n"
 104             + "SSQCSELEDLTANTNTQDPFLIGSSKQMRHQSESQGVGLSDKELVSDDEERGTGLEENNQEEQSMDSNLGEA\n"
 105             + "ASGCESETSVSEDCSGLSSQSDILTTQQRDTMQHNLIKLQQEMAELEAVLEQHGSQPSNSYPSIISDSSALE\n"
 106             + "DLRNPEQSTSEKAVLTSQKSSEYPISQNPEGLSADKFEVSADSSTSKNKEPGVERSSPSKCPSLDDRWYMHS\n"
 107             + "CSGSLQNRNYPSQEELIKVVDVEEQQLEESGPHDLTETSYLPRQDLEGTPYLESGISLFSDDPESDPSEDRA\n"
 108             + "PESARVGNIPSSTSALKVPQLKVAESAQSPAAAHTTDTAGYNAMEESVSREKPELTASTERVNKRMSMVVSG\n"
 109             + "LTPEEFMLVYKFARKHHITLTNLITEETTHVVMKTDAEFVCERTLKYFLGIAGGKWVVSYFWVTQSIKERKM\n"
 110             + "LNEHDFEVRGDVVNGRNHQGPKRARESQDRKIFRGLEICCYGPFTNMPTDQLEWMVQLCGASVVKELSSFTL\n"
 111             + "GTGVHPIVVVQPDAWTEDNGFHAIGQMCEAPVVTREWVLDSVALYQCQELDTYLIPQIPHSHY\n"
 112             + "", 1,
 113 1863);
 114     upSeq.setDescription("Breast cancer type 1 susceptibility protein");
 115     upSeq_nocanonical = new Sequence(upSeq);
 116     upSeq.createDatasetSequence();
 117     upSeq.addDBRef(new DBRefEntry("UNIPROT","0","P38398",null,true));
 118
 119     upSeq_nocanonical.createDatasetSequence();
 120     // not a canonical reference
 121     upSeq_nocanonical.addDBRef(new DBRefEntry("UNIPROT","0","P38398",null,false));
 122
 123   }
 124
 125   @AfterMethod(alwaysRun = true)
 126   public void tearDown() throws Exception
 127   {
 128     seq = null;
 129     upSeq=null;
 130     upSeq_nocanonical=null;
 131   }
 132
 133   @Test(groups = { "Functional" })
 134   public void populateFilterComboBoxTest() throws InterruptedException
 135   {
 136     TDBeaconsFTSRestClientTest.setMock();
 137     PDBFTSRestClientTest.setMock();
 138
 139     SequenceI[] selectedSeqs = new SequenceI[] { seq };
 140     StructureChooser sc = new StructureChooser(selectedSeqs, seq, null);
 141     ThreadwaitFor(200, sc);
 142
 143     // if structures are not discovered then don't
 144     // populate filter options
 145     sc.populateFilterComboBox(false, false);
 146     int optionsSize = sc.getCmbFilterOption().getItemCount();
 147     System.out.println("Items (no data, no cache): ");
 148     StringBuilder items = new StringBuilder();
 149     for (int p=0;p<optionsSize;p++)
 150     {
 151       items.append
 152       ("- ").append(sc.getCmbFilterOption().getItemAt(p).getName()).append("\n");
 153
 154     }
 155     // report items when this fails - seems to be a race condition
 156     Assert.assertEquals(items.toString(),optionsSize,2);
 157
 158     sc.populateFilterComboBox(true, false);
 159     optionsSize = sc.getCmbFilterOption().getItemCount();
 160     assertTrue(optionsSize > 3); // if structures are found, filter options
 161                                  // should be populated
 162
 163     sc.populateFilterComboBox(true, true);
 164     assertTrue(sc.getCmbFilterOption().getSelectedItem() != null);
 165     FilterOption filterOpt = (FilterOption) sc.getCmbFilterOption()
 166             .getSelectedItem();
 167     assertEquals("Cached Structures", filterOpt.getName());
 168     FTSRestClient.unMock((FTSRestClient) TDBeaconsFTSRestClient.getInstance());
 169     FTSRestClient.unMock((FTSRestClient) PDBFTSRestClient.getInstance());
 170
 171   }
 172
 173   @Test(groups = { "Functional" })
 174   public void displayTDBQueryTest() throws InterruptedException
 175   {
 176     TDBeaconsFTSRestClientTest.setMock();
 177     PDBFTSRestClientTest.setMock();
 178
 179     SequenceI[] selectedSeqs = new SequenceI[] { upSeq_nocanonical };
 180     StructureChooser sc = new StructureChooser(selectedSeqs, upSeq_nocanonical, null);
 181     // mock so should be quick. Exceptions from mocked PDBFTS are expected too
 182     ThreadwaitFor(500, sc);
 183
 184     assertTrue(sc.isCanQueryTDB() && sc.isNotQueriedTDBYet());
 185   }
 186
 187   @Test(groups = { "Network" })
 188   public void fetchStructuresInfoTest()
 189   {
 190     FTSRestClient.unMock((FTSRestClient) TDBeaconsFTSRestClient.getInstance());
 191     PDBFTSRestClient.unMock((FTSRestClient) PDBFTSRestClient.getInstance());
 192     SequenceI[] selectedSeqs = new SequenceI[] { seq };
 193     StructureChooser sc = new StructureChooser(selectedSeqs, seq, null);
 194     // not mocked, wait for 2s
 195     ThreadwaitFor(2000, sc);
 196
 197     sc.fetchStructuresMetaData();
 198     Collection<FTSData> ss = (Collection<FTSData>) PA.getValue(sc,
 199             "discoveredStructuresSet");
 200     assertNotNull(ss);
 201     assertTrue(ss.size() > 0);
 202   }
 203
 204   @Test(groups = { "Functional" })
 205   public void fetchStructuresInfoMockedTest()
 206   {
 207     TDBeaconsFTSRestClientTest.setMock();
 208     PDBFTSRestClientTest.setMock();
 209     SequenceI[] selectedSeqs = new SequenceI[] { upSeq };
 210     StructureChooser sc = new StructureChooser(selectedSeqs, seq, null);
 211     ThreadwaitFor(500, sc);
 212
 213     sc.fetchStructuresMetaData();
 214     Collection<FTSData> ss = (Collection<FTSData>) PA.getValue(sc,
 215             "discoveredStructuresSet");
 216     assertNotNull(ss);
 217     assertTrue(ss.size() > 0);
 218   }
 219
 220   private void ThreadwaitFor(int i, StructureChooser sc)
 221   {
 222     long timeout = i+System.currentTimeMillis();
 223     while (!sc.isDialogVisible() && timeout > System.currentTimeMillis())
 224     {
 225       try {
 226         Thread.sleep(50);
 227       } catch (InterruptedException x)
 228       {
 229
 230       }
 231     }
 232
 233   }
 234
 235
 236   @Test(groups = { "Functional" })
 237   public void sanitizeSeqNameTest()
 238   {
 239     String name = "ab_cdEF|fwxyz012349";
 240     assertEquals(name, PDBStructureChooserQuerySource.sanitizeSeqName(name));
 241
 242     // remove a [nn] substring
 243     name = "abcde12[345]fg";
 244     assertEquals("abcde12fg", PDBStructureChooserQuerySource.sanitizeSeqName(name));
 245
 246     // remove characters other than a-zA-Z0-9 | or _
 247     name = "ab[cd],.\t£$*!- \\\"@:e";
 248     assertEquals("abcde", PDBStructureChooserQuerySource.sanitizeSeqName(name));
 249
 250     name = "abcde12[345a]fg";
 251     assertEquals("abcde12345afg", PDBStructureChooserQuerySource.sanitizeSeqName(name));
 252   }
 253 }