test/jalview/ws/sifts/SiftsClientTest.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.ws.sifts;
  22
  23 import jalview.api.DBRefEntryI;
  24 import jalview.bin.Cache;
  25 import jalview.datamodel.DBRefEntry;
  26 import jalview.datamodel.DBRefSource;
  27 import jalview.datamodel.Sequence;
  28 import jalview.datamodel.SequenceI;
  29 import jalview.io.AppletFormatAdapter;
  30 import jalview.structure.StructureMapping;
  31 import jalview.xml.binding.sifts.Entry.Entity;
  32
  33 import java.io.File;
  34 import java.io.IOException;
  35 import java.util.ArrayList;
  36 import java.util.HashMap;
  37
  38 import org.testng.Assert;
  39 import org.testng.FileAssert;
  40 import org.testng.annotations.AfterTest;
  41 import org.testng.annotations.BeforeTest;
  42 import org.testng.annotations.Test;
  43
  44 import MCview.Atom;
  45 import MCview.PDBfile;
  46
  47 public class SiftsClientTest
  48 {
  49
  50   public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
  51           .getProperty("user.home")
  52           + File.separatorChar
  53           + ".sifts_downloads" + File.separatorChar;
  54
  55   private String testPDBId = "1a70";
  56
  57   private SiftsClient siftsClient = null;
  58
  59   SequenceI testSeq = new Sequence(
  60           "P00221",
  61           "MAAT..TTTMMG..MATTFVPKPQAPPMMAALPSNTGR..SLFGLKT.GSR..GGRMTMA"
  62                   + "AYKVTLVTPTGNVEFQCPDDVYILDAAEEEGIDLPYSCRAGSCSSCAGKLKTGSLNQDD"
  63                   + "QSFLDDDQIDEGWVLTCAAYPVSDVTIETHKEEELTA.", 1, 147);
  64
  65   int u = SiftsClient.UNASSIGNED;
  66
  67   HashMap<Integer, int[]> expectedMapping = new HashMap<Integer, int[]>();
  68
  69   @BeforeTest(alwaysRun = true)
  70   public void populateExpectedMapping() throws SiftsException
  71    {
  72     expectedMapping.put(51, new int[] { 1, 2 });
  73     expectedMapping.put(52, new int[] { 2, 7 });
  74     expectedMapping.put(53, new int[] { 3, 12 });
  75     expectedMapping.put(54, new int[] { 4, 24 });
  76     expectedMapping.put(55, new int[] { 5, 33 });
  77     expectedMapping.put(56, new int[] { 6, 40 });
  78     expectedMapping.put(57, new int[] { 7, 47 });
  79     expectedMapping.put(58, new int[] { 8, 55 });
  80     expectedMapping.put(59, new int[] { 9, 62 });
  81     expectedMapping.put(60, new int[] { 10, 69 });
  82     expectedMapping.put(61, new int[] { 11, 76 });
  83     expectedMapping.put(62, new int[] { 12, 83 });
  84     expectedMapping.put(63, new int[] { 13, 87 });
  85     expectedMapping.put(64, new int[] { 14, 95 });
  86     expectedMapping.put(65, new int[] { 15, 102 });
  87     expectedMapping.put(66, new int[] { 16, 111 });
  88     expectedMapping.put(67, new int[] { 17, 122 });
  89     expectedMapping.put(68, new int[] { 18, 131 });
  90     expectedMapping.put(69, new int[] { 19, 137 });
  91     expectedMapping.put(70, new int[] { 20, 144 });
  92     expectedMapping.put(71, new int[] { 21, 152 });
  93     expectedMapping.put(72, new int[] { 22, 160 });
  94     expectedMapping.put(73, new int[] { 23, 167 });
  95     expectedMapping.put(74, new int[] { 24, 179 });
  96     expectedMapping.put(75, new int[] { 25, 187 });
  97     expectedMapping.put(76, new int[] { 26, 195 });
  98     expectedMapping.put(77, new int[] { 27, 203 });
  99     expectedMapping.put(78, new int[] { 28, 208 });
 100     expectedMapping.put(79, new int[] { 29, 213 });
 101     expectedMapping.put(80, new int[] { 30, 222 });
 102     expectedMapping.put(81, new int[] { 31, 231 });
 103     expectedMapping.put(82, new int[] { 32, 240 });
 104     expectedMapping.put(83, new int[] { 33, 244 });
 105     expectedMapping.put(84, new int[] { 34, 252 });
 106     expectedMapping.put(85, new int[] { 35, 260 });
 107     expectedMapping.put(86, new int[] { 36, 268 });
 108     expectedMapping.put(87, new int[] { 37, 275 });
 109     expectedMapping.put(88, new int[] { 38, 287 });
 110     expectedMapping.put(89, new int[] { 39, 293 });
 111     expectedMapping.put(90, new int[] { 40, 299 });
 112     expectedMapping.put(91, new int[] { 41, 310 });
 113     expectedMapping.put(92, new int[] { 42, 315 });
 114     expectedMapping.put(93, new int[] { 43, 319 });
 115     expectedMapping.put(94, new int[] { 44, 325 });
 116     expectedMapping.put(95, new int[] { 45, 331 });
 117     expectedMapping.put(96, new int[] { 46, 337 });
 118     expectedMapping.put(97, new int[] { 47, 343 });
 119     expectedMapping.put(98, new int[] { 48, 349 });
 120     expectedMapping.put(99, new int[] { 49, 354 });
 121     expectedMapping.put(100, new int[] { 50, 358 });
 122     expectedMapping.put(101, new int[] { 51, 367 });
 123     expectedMapping.put(102, new int[] { 52, 375 });
 124     expectedMapping.put(103, new int[] { 53, 384 });
 125     expectedMapping.put(104, new int[] { 54, 391 });
 126     expectedMapping.put(105, new int[] { 55, 395 });
 127     expectedMapping.put(106, new int[] { 56, 401 });
 128     expectedMapping.put(107, new int[] { 57, 409 });
 129     expectedMapping.put(108, new int[] { 58, 417 });
 130     expectedMapping.put(109, new int[] { 59, 426 });
 131     expectedMapping.put(110, new int[] { 60, 434 });
 132     expectedMapping.put(111, new int[] { 61, 442 });
 133     expectedMapping.put(112, new int[] { 62, 451 });
 134     expectedMapping.put(113, new int[] { 63, 457 });
 135     expectedMapping.put(114, new int[] { 64, 468 });
 136     expectedMapping.put(115, new int[] { 65, 476 });
 137     expectedMapping.put(116, new int[] { 66, 484 });
 138     expectedMapping.put(117, new int[] { 67, 492 });
 139     expectedMapping.put(118, new int[] { 68, 500 });
 140     expectedMapping.put(119, new int[] { 69, 509 });
 141     expectedMapping.put(120, new int[] { 70, 517 });
 142     expectedMapping.put(121, new int[] { 71, 525 });
 143     expectedMapping.put(122, new int[] { 72, 534 });
 144     expectedMapping.put(123, new int[] { 73, 538 });
 145     expectedMapping.put(124, new int[] { 74, 552 });
 146     expectedMapping.put(125, new int[] { 75, 559 });
 147     expectedMapping.put(126, new int[] { 76, 567 });
 148     expectedMapping.put(127, new int[] { 77, 574 });
 149     expectedMapping.put(128, new int[] { 78, 580 });
 150     expectedMapping.put(129, new int[] { 79, 585 });
 151     expectedMapping.put(130, new int[] { 80, 590 });
 152     expectedMapping.put(131, new int[] { 81, 602 });
 153     expectedMapping.put(132, new int[] { 82, 609 });
 154     expectedMapping.put(133, new int[] { 83, 616 });
 155     expectedMapping.put(134, new int[] { 84, 622 });
 156     expectedMapping.put(135, new int[] { 85, 630 });
 157     expectedMapping.put(136, new int[] { 86, 637 });
 158     expectedMapping.put(137, new int[] { 87, 644 });
 159     expectedMapping.put(138, new int[] { 88, 652 });
 160     expectedMapping.put(139, new int[] { 89, 661 });
 161     expectedMapping.put(140, new int[] { 90, 668 });
 162     expectedMapping.put(141, new int[] { 91, 678 });
 163     expectedMapping.put(142, new int[] { 92, 687 });
 164     expectedMapping.put(143, new int[] { 93, 696 });
 165     expectedMapping.put(144, new int[] { 94, 705 });
 166     expectedMapping.put(145, new int[] { 95, 714 });
 167     expectedMapping.put(146, new int[] { 96, 722 });
 168     expectedMapping.put(147, new int[] { 97, 729 });
 169    }
 170
 171   @BeforeTest(alwaysRun = true)
 172   public void setUpSiftsClient() throws SiftsException
 173   {
 174     // read test props before manipulating config
 175     Cache.loadProperties("test/jalview/io/testProps.jvprops");
 176     // SIFTs entries are updated weekly - so use saved SIFTs file to enforce
 177     // test reproducibility
 178     new SiftsSettings();
 179     SiftsSettings.setSiftDownloadDirectory(jalview.bin.Cache.getDefault(
 180             "sifts_download_dir", DEFAULT_SIFTS_DOWNLOAD_DIR));
 181     SiftsSettings.setMapWithSifts(true);
 182     SiftsSettings.setCacheThresholdInDays("2");
 183     SiftsSettings.setFailSafePIDThreshold("70");
 184     PDBfile pdbFile;
 185     try
 186     {
 187       pdbFile = new PDBfile(false, false, false, "test/jalview/io/"
 188               + testPDBId + ".pdb", AppletFormatAdapter.FILE);
 189       siftsClient = new SiftsClient(pdbFile);
 190     } catch (Exception e)
 191     {
 192       e.printStackTrace();
 193     }
 194   }
 195
 196   @AfterTest(alwaysRun = true)
 197   public void cleanUpSiftsClient()
 198   {
 199     siftsClient = null;
 200   }
 201
 202   @Test(groups = { "Functional" })
 203   public void getSIFTsFileTest() throws SiftsException
 204   {
 205     File siftsFile;
 206     try
 207     {
 208       siftsFile = SiftsClient.downloadSiftsFile(testPDBId);
 209       FileAssert.assertFile(siftsFile);
 210       // test for SIFTs file caching
 211       SiftsSettings.setCacheThresholdInDays("0");
 212       siftsFile = SiftsClient.getSiftsFile(testPDBId);
 213       FileAssert.assertFile(siftsFile);
 214       SiftsSettings.setCacheThresholdInDays("2");
 215     } catch (IOException e)
 216     {
 217       e.printStackTrace();
 218     }
 219   }
 220
 221   @Test(groups = { "Functional" })
 222   public void downloadSiftsFileTest() throws SiftsException
 223   {
 224     // Assert that file isn't yet downloaded - if already downloaded, assert it
 225     // is deleted
 226     Assert.assertTrue(SiftsClient.deleteSiftsFileByPDBId(testPDBId));
 227     File siftsFile;
 228     try
 229     {
 230       siftsFile = SiftsClient.downloadSiftsFile(testPDBId);
 231       FileAssert.assertFile(siftsFile);
 232       SiftsClient.downloadSiftsFile(testPDBId);
 233     } catch (IOException e)
 234     {
 235       e.printStackTrace();
 236     }
 237   }
 238
 239
 240   @Test(groups = { "Functional" })
 241   public void getAllMappingAccessionTest()
 242   {
 243     Assert.assertNotNull(siftsClient);
 244     Assert.assertNotNull(siftsClient.getAllMappingAccession());
 245     Assert.assertTrue(siftsClient.getAllMappingAccession().size() > 1);
 246   }
 247
 248   @Test(groups = { "Functional" })
 249   public void getGreedyMappingTest()
 250   {
 251     Assert.assertNotNull(siftsClient);
 252     Assert.assertNotNull(testSeq);
 253     Assert.assertNotNull(expectedMapping);
 254
 255     // TODO delete when auto-fetching of DBRefEntry is implemented
 256     DBRefEntry dbRef = new DBRefEntry("uniprot", "", "P00221");
 257     testSeq.addDBRef(dbRef);
 258     // testSeq.setSourceDBRef(dbRef);
 259
 260     try
 261     {
 262       HashMap<Integer, int[]> actualMapping = siftsClient.getGreedyMapping(
 263               "A", testSeq,
 264               null);
 265       Assert.assertEquals(testSeq.getStart(), 1);
 266       Assert.assertEquals(testSeq.getEnd(), 147);
 267       Assert.assertEquals(actualMapping, expectedMapping);
 268     } catch (Exception e)
 269     {
 270       e.printStackTrace();
 271       Assert.fail("Exception thrown while generating mapping...");
 272     }
 273   }
 274
 275   @Test(groups = { "Functional" })
 276   private void getAtomIndexTest()
 277   {
 278     ArrayList<Atom> atoms = new ArrayList<Atom>();
 279     Atom atom = new Atom(u, u, u);
 280     atom.resNumber = 43;
 281     atom.atomIndex = 7;
 282     atoms.add(atom);
 283     int actualAtomIndex = siftsClient.getAtomIndex(1, atoms);
 284     Assert.assertEquals(actualAtomIndex, -1);
 285     actualAtomIndex = siftsClient.getAtomIndex(43, atoms);
 286     Assert.assertEquals(actualAtomIndex, 7);
 287   }
 288
 289   @Test(
 290     groups = { "Functional" },
 291     expectedExceptions = IllegalArgumentException.class)
 292   private void getAtomIndexNullTest()
 293   {
 294     siftsClient.getAtomIndex(1, null);
 295   }
 296
 297   @Test(groups = { "Functional" })
 298   private void padWithGapsTest()
 299   {
 300
 301   }
 302
 303   @Test(
 304     groups = { "Functional" },
 305     expectedExceptions = SiftsException.class)
 306   private void populateAtomPositionsNullTest1()
 307           throws IllegalArgumentException, SiftsException
 308   {
 309       siftsClient.populateAtomPositions(null, null);
 310   }
 311
 312   @Test(
 313     groups = { "Functional" },
 314     expectedExceptions = SiftsException.class)
 315   private void populateAtomPositionsNullTest2()
 316           throws IllegalArgumentException, SiftsException
 317   {
 318     siftsClient.populateAtomPositions("A", null);
 319   }
 320
 321   @Test(groups = { "Functional" })
 322   public void getValidSourceDBRefTest()
 323   {
 324     try
 325     {
 326       DBRefEntryI actualValidSrcDBRef = siftsClient
 327               .getValidSourceDBRef(testSeq);
 328       DBRefEntryI expectedDBRef = new DBRefEntry();
 329       expectedDBRef.setSource(DBRefSource.UNIPROT);
 330       expectedDBRef.setAccessionId("P00221");
 331       expectedDBRef.setVersion("");
 332       Assert.assertEquals(actualValidSrcDBRef, expectedDBRef);
 333     } catch (Exception e)
 334     {
 335     }
 336   }
 337
 338   @Test(
 339     groups = { "Functional" },
 340     expectedExceptions = SiftsException.class)
 341   public void getValidSourceDBRefExceptionTest() throws SiftsException
 342   {
 343       SequenceI invalidTestSeq = new Sequence("testSeq", "ABCDEFGH");
 344     try
 345     {
 346       siftsClient.getValidSourceDBRef(invalidTestSeq);
 347     } catch (SiftsException e)
 348     {
 349       throw new SiftsException(e.getMessage());
 350     }
 351   }
 352
 353   @Test(
 354     groups = { "Functional" },
 355     expectedExceptions = SiftsException.class)
 356   public void getValidSourceDBRefExceptionXTest() throws SiftsException
 357   {
 358     SequenceI invalidTestSeq = new Sequence("testSeq", "ABCDEFGH");
 359     DBRefEntry invalidDBRef = new DBRefEntry();
 360     invalidDBRef.setAccessionId("BLAR");
 361     invalidTestSeq.addDBRef(invalidDBRef);
 362     try
 363     {
 364       siftsClient.getValidSourceDBRef(invalidTestSeq);
 365     } catch (SiftsException e)
 366     {
 367       throw new SiftsException(e.getMessage());
 368     }
 369
 370   }
 371
 372   @Test(groups = { "Functional" })
 373   public void isValidDBRefEntryTest()
 374   {
 375     DBRefEntryI validDBRef = new DBRefEntry();
 376     validDBRef.setSource(DBRefSource.UNIPROT);
 377     validDBRef.setAccessionId("P00221");
 378     validDBRef.setVersion("");
 379     Assert.assertTrue(siftsClient.isValidDBRefEntry(validDBRef));
 380   }
 381
 382   @Test(groups = { "Functional" })
 383   public void getSiftsStructureMappingTest()
 384   {
 385     try
 386     {
 387       Assert.assertTrue(SiftsSettings.isMapWithSifts());
 388       StructureMapping strucMapping = siftsClient.getSiftsStructureMapping(
 389               testSeq, testPDBId, "A");
 390       String expectedMappingOutput = "\nSequence ⟷ Structure mapping details\n"
 391               + "Method: SIFTS\n\n"
 392               + "P00221 :  1 - 97 Maps to \n"
 393               + "1A70|A :  51 - 147\n\n"
 394               + "P00221 AAYKVTLVTPTGNVEFQCPDDVYILDAAEEEGIDLPYSCRAGSCSSCAGKLKTGSLNQDDQSFLD\n"
 395               + "       |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||\n"
 396               + "1A70|A AAYKVTLVTPTGNVEFQCPDDVYILDAAEEEGIDLPYSCRAGSCSSCAGKLKTGSLNQDDQSFLD\n\n"
 397
 398               + "P00221 DDQIDEGWVLTCAAYPVSDVTIETHKEEELTA\n"
 399               + "       |||||||||||||||||||||||||| |||||\n"
 400               + "1A70|A DDQIDEGWVLTCAAYPVSDVTIETHKKEELTA\n\n" +
 401
 402               "Length of alignment = 97\n" + "Percentage ID = 98.97\n";
 403
 404       Assert.assertEquals(strucMapping.getMappingDetailsOutput(),
 405               expectedMappingOutput);
 406       Assert.assertEquals(strucMapping.getMapping(), expectedMapping);
 407     } catch (SiftsException e)
 408     {
 409       e.printStackTrace();
 410     }
 411   }
 412
 413   @Test(groups = { "Functional" })
 414   public void getEntityCountTest()
 415   {
 416     int actualEntityCount = siftsClient.getEntityCount();
 417     System.out.println("actual entity count : " + actualEntityCount);
 418     Assert.assertEquals(actualEntityCount, 1);
 419   }
 420
 421   @Test(groups = { "Functional" })
 422   public void getDbAccessionIdTest()
 423   {
 424     String actualDbAccId = siftsClient.getDbAccessionId();
 425     System.out.println("Actual Db Accession Id: " + actualDbAccId);
 426     Assert.assertEquals(actualDbAccId, "1a70");
 427   }
 428
 429   @Test(groups = { "Functional" })
 430   public void getDbCoordSysTest()
 431   {
 432     String actualDbCoordSys = siftsClient.getDbCoordSys();
 433     System.out.println("Actual DbCoordSys: " + actualDbCoordSys);
 434     Assert.assertEquals(actualDbCoordSys, "PDBe");
 435   }
 436
 437   @Test(groups = { "Functional" })
 438   public void getDbSourceTest()
 439   {
 440     String actualDbSource = siftsClient.getDbSource();
 441     System.out.println("Actual DbSource: " + actualDbSource);
 442     Assert.assertEquals(actualDbSource, "PDBe");
 443   }
 444
 445   @Test(groups = { "Functional" })
 446   public void getDbVersionTest()
 447   {
 448     String actualDbVersion = siftsClient.getDbVersion();
 449     System.out.println("Actual DbVersion: " + actualDbVersion);
 450     Assert.assertEquals(actualDbVersion, "2.0");
 451   }
 452
 453   @Test(groups = { "Functional" })
 454   public void getEntityByMostOptimalMatchedIdTest()
 455   {
 456     SiftsClient siftsClientX = null;
 457     PDBfile pdbFile;
 458     try
 459     {
 460       pdbFile = new PDBfile(false, false, false, "test/jalview/io/2nq2"
 461               + ".pdb", AppletFormatAdapter.FILE);
 462       siftsClientX = new SiftsClient(pdbFile);
 463     } catch (Exception e)
 464     {
 465       e.printStackTrace();
 466     }
 467     Entity entityA = siftsClientX.getEntityByMostOptimalMatchedId("A");
 468     Assert.assertEquals(entityA.getEntityId(), "A");
 469     Entity entityB = siftsClientX.getEntityByMostOptimalMatchedId("B");
 470     Assert.assertEquals(entityB.getEntityId(), "C");
 471     Entity entityC = siftsClientX.getEntityByMostOptimalMatchedId("C");
 472     Assert.assertEquals(entityC.getEntityId(), "B");
 473     Entity entityD = siftsClientX.getEntityByMostOptimalMatchedId("D");
 474     Assert.assertEquals(entityD.getEntityId(), "D");
 475
 476   }
 477 }