test/jalview/ws/dbsources/RemoteFormatTest.java

   1 package jalview.ws.dbsources;
   2
   3 import static org.testng.Assert.assertEquals;
   4 import static org.testng.Assert.assertFalse;
   5 import static org.testng.Assert.assertNotNull;
   6 import static org.testng.Assert.assertTrue;
   7
   8 import jalview.analysis.AlignSeq;
   9 import jalview.bin.Cache;
  10 import jalview.datamodel.AlignmentI;
  11 import jalview.datamodel.DBRefSource;
  12 import jalview.datamodel.SequenceI;
  13 import jalview.fts.api.FTSData;
  14 import jalview.fts.api.FTSDataColumnI;
  15 import jalview.fts.api.FTSRestClientI;
  16 import jalview.fts.core.FTSRestRequest;
  17 import jalview.fts.core.FTSRestResponse;
  18 import jalview.fts.service.uniprot.UniProtFTSRestClient;
  19 import jalview.ws.SequenceFetcher;
  20 import jalview.ws.seqfetcher.DbSourceProxy;
  21
  22 import java.util.ArrayList;
  23 import java.util.List;
  24
  25 import org.testng.annotations.BeforeTest;
  26 import org.testng.annotations.DataProvider;
  27 import org.testng.annotations.Test;
  28
  29 /**
  30  * A class to verify that remotely fetched data has an expected format and can
  31  * be successfully processed by Jalview. This is intended as a first line of
  32  * defence and early warning of service affecting changes to data fetched
  33  * externally.
  34  * <p>
  35  * This is class is not intended to cover remote services e.g. alignment. Nor
  36  * should it duplicate tests already provided by other classes (such as
  37  * PDBFTSRestClientTest). Or maybe we will relocate those tests here...
  38  */
  39 public class RemoteFormatTest
  40 {
  41   SequenceFetcher sf;
  42
  43   @BeforeTest(alwaysRun = true)
  44   public void setUp() throws Exception
  45   {
  46     Cache.loadProperties("test/jalview/io/testProps.jvprops");
  47     // ensure 'add annotation from structure' is selected
  48     Cache.applicationProperties.setProperty("STRUCT_FROM_PDB",
  49             Boolean.TRUE.toString());
  50     Cache.applicationProperties.setProperty("ADD_SS_ANN",
  51             Boolean.TRUE.toString());
  52
  53     sf = new SequenceFetcher();
  54   }
  55
  56   @DataProvider(name = "AccessionData")
  57   protected Object[][] getAccessions()
  58   {
  59     return new Object[][] { { DBRefSource.UNIPROT, "P30419" },
  60         { DBRefSource.PDB, "1QIP" }, { DBRefSource.EMBL, "X53828" },
  61         { DBRefSource.EMBLCDS, "CAA37824" },
  62         { DBRefSource.ENSEMBL, "ENSG00000157764" },
  63         // { new EnsemblGenomes().getDbSource(), "DDB_G0283883" },
  64         { new PfamFull().getDbSource(), "PF03760" },
  65         { new PfamSeed().getDbSource(), "PF03760" },
  66         { new RfamSeed().getDbSource(), "RF00014" } };
  67   }
  68
  69   @Test(groups = "Network", dataProvider = "AccessionData")
  70   public void testFetchAccession(String dbSource, String accessionId)
  71           throws Exception
  72   {
  73     System.out.println("Fetching " + accessionId + " from " + dbSource);
  74     List<DbSourceProxy> sps = sf.getSourceProxy(dbSource);
  75     assertFalse(sps.isEmpty());
  76     AlignmentI al = sps.get(0).getSequenceRecords(accessionId);
  77     assertNotNull(al);
  78     assertTrue(al.getHeight() > 0);
  79     SequenceI sq = al.getSequenceAt(0);
  80     // suppress this check as only Uniprot and PDB acquire PDB refs
  81     // assertTrue(sq.getAllPDBEntries().size() > 0, "No PDBEntry on sequence.");
  82     assertTrue(sq.getDBRefs().length > 0, "No DBRef on sequence.");
  83     // suppress this test as only certain databases provide 'primary' dbrefs
  84     // assertFalse(sq.getPrimaryDBRefs().isEmpty());
  85     int length = AlignSeq.extractGaps("-. ", sq.getSequenceAsString())
  86             .length();
  87     assertEquals(sq.getEnd() - sq.getStart() + 1, length,
  88             "Sequence start/end doesn't match number of residues in sequence");
  89   }
  90
  91   @Test(groups = { "Network" })
  92   public void testUniprotFreeTextSearch() throws Exception
  93   {
  94     List<FTSDataColumnI> wantedFields = new ArrayList<>();
  95     FTSRestClientI client = UniProtFTSRestClient.getInstance();
  96     wantedFields.add(client.getDataColumnByNameOrCode("id"));
  97     wantedFields.add(client.getDataColumnByNameOrCode("entry name"));
  98     wantedFields.add(client.getDataColumnByNameOrCode("organism"));
  99     wantedFields.add(client.getDataColumnByNameOrCode("reviewed")); // Status
 100     wantedFields.add(client.getDataColumnByNameOrCode("length"));
 101
 102     FTSRestRequest request = new FTSRestRequest();
 103     request.setAllowEmptySeq(false);
 104     request.setResponseSize(100);
 105     request.setFieldToSearchBy("Search All");
 106     request.setSearchTerm("metanephrops"); // lobster!
 107     request.setWantedFields(wantedFields);
 108
 109     FTSRestResponse response;
 110     response = client.executeRequest(request);
 111     assertTrue(response.getNumberOfItemsFound() > 20);
 112     assertTrue(response.getSearchSummary() != null);
 113     assertTrue(response.getSearchSummary().size() > 20);
 114     // verify we successfully filtered out the header row (JAL-2485)
 115     FTSData header = response.getSearchSummary().iterator().next();
 116     assertFalse(
 117             header.getSummaryData()[0].toString().equalsIgnoreCase("Entry"),
 118             "Failed to filter out summary header row");
 119   }
 120 }