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