test/jalview/ws/dbsources/PDBRestClientTest.java

   1 package jalview.ws.dbsources;
   2
   3 import static org.testng.AssertJUnit.assertEquals;
   4 import static org.testng.AssertJUnit.assertTrue;
   5
   6 import jalview.ws.dbsources.PDBRestClient.PDBDocField;
   7 import jalview.ws.uimodel.PDBRestRequest;
   8 import jalview.ws.uimodel.PDBRestResponse;
   9
  10 import java.io.BufferedReader;
  11 import java.io.FileReader;
  12 import java.io.IOException;
  13 import java.util.ArrayList;
  14 import java.util.Iterator;
  15 import java.util.List;
  16
  17 import javax.ws.rs.core.MediaType;
  18
  19 import org.json.simple.JSONArray;
  20 import org.json.simple.JSONObject;
  21 import org.json.simple.parser.JSONParser;
  22 import org.json.simple.parser.ParseException;
  23 import org.testng.Assert;
  24 import org.testng.annotations.AfterMethod;
  25 import org.testng.annotations.BeforeMethod;
  26 import org.testng.annotations.Test;
  27
  28 import com.sun.jersey.api.client.Client;
  29 import com.sun.jersey.api.client.ClientResponse;
  30 import com.sun.jersey.api.client.WebResource;
  31 import com.sun.jersey.api.client.config.ClientConfig;
  32 import com.sun.jersey.api.client.config.DefaultClientConfig;
  33
  34 public class PDBRestClientTest
  35 {
  36
  37   @BeforeMethod
  38   public void setUp() throws Exception
  39   {
  40   }
  41
  42   @AfterMethod
  43   public void tearDown() throws Exception
  44   {
  45   }
  46
  47   @Test
  48   public void executeRequestTest()
  49   {
  50     List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
  51     wantedFields.add(PDBDocField.MOLECULE_TYPE);
  52     wantedFields.add(PDBDocField.PDB_ID);
  53     wantedFields.add(PDBDocField.GENUS);
  54     wantedFields.add(PDBDocField.GENE_NAME);
  55     wantedFields.add(PDBDocField.TITLE);
  56
  57     PDBRestRequest request = new PDBRestRequest();
  58     request.setAllowEmptySeq(false);
  59     request.setResponseSize(100);
  60     request.setFieldToSearchBy("text:");
  61     request.setSearchTerm("abc");
  62     request.setWantedFields(wantedFields);
  63
  64     PDBRestResponse response;
  65     try
  66     {
  67       response = new PDBRestClient().executeRequest(request);
  68     } catch (Exception e)
  69     {
  70       e.printStackTrace();
  71       Assert.fail("Couldn't execute webservice call!");
  72       return;
  73     }
  74     assertTrue(response.getNumberOfItemsFound() > 99);
  75     assertTrue(response.getSearchSummary() != null);
  76     assertTrue(response.getSearchSummary().size() > 99);
  77   }
  78
  79   @Test
  80   public void getPDBDocFieldsAsCommaDelimitedStringTest()
  81   {
  82     List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
  83     wantedFields.add(PDBDocField.MOLECULE_TYPE);
  84     wantedFields.add(PDBDocField.PDB_ID);
  85     wantedFields.add(PDBDocField.GENUS);
  86     wantedFields.add(PDBDocField.GENE_NAME);
  87     wantedFields.add(PDBDocField.TITLE);
  88
  89     String expectedResult = "molecule_type,pdb_id,genus,gene_name,title";
  90     String actualResult = PDBRestClient
  91             .getPDBDocFieldsAsCommaDelimitedString(wantedFields);
  92
  93     assertEquals("", expectedResult, actualResult);
  94   }
  95
  96   @Test
  97   public void parsePDBJsonExceptionStringTest()
  98   {
  99     List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
 100     wantedFields.add(PDBDocField.MOLECULE_TYPE);
 101     wantedFields.add(PDBDocField.PDB_ID);
 102     wantedFields.add(PDBDocField.GENUS);
 103     wantedFields.add(PDBDocField.GENE_NAME);
 104     wantedFields.add(PDBDocField.TITLE);
 105
 106     PDBRestRequest request = new PDBRestRequest();
 107     request.setAllowEmptySeq(false);
 108     request.setResponseSize(100);
 109     request.setFieldToSearchBy("text:");
 110     request.setSearchTerm("abc");
 111     request.setWantedFields(wantedFields);
 112
 113     String jsonErrorResponse = "";
 114     try
 115     {
 116       jsonErrorResponse = readJsonStringFromFile("test/jalview/io/pdb_request_json_error.txt");
 117     } catch (IOException e)
 118     {
 119       e.printStackTrace();
 120     }
 121
 122     String parsedErrorResponse = PDBRestClient
 123             .parseJsonExceptionString(jsonErrorResponse);
 124
 125     String expectedErrorMsg = "\n============= PDB Rest Client RunTime error =============\n"
 126             + "Status: 400\n"
 127             + "Message: org.apache.solr.search.SyntaxError: Cannot parse 'text:abc OR text:go:abc AND molecule_sequence:['' TO *]': Encountered \" \":\" \": \"\" at line 1, column 19.\n"
 128             + "query: text:abc OR text:go:abc AND molecule_sequence:['' TO *]\n"
 129             + "fl: pdb_id\n";
 130
 131     assertEquals(expectedErrorMsg, parsedErrorResponse);
 132   }
 133
 134   @Test(expectedExceptions = Exception.class)
 135   public void testForExpectedRuntimeException() throws Exception
 136   {
 137     List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
 138     wantedFields.add(PDBDocField.PDB_ID);
 139
 140     PDBRestRequest request = new PDBRestRequest();
 141     request.setFieldToSearchBy("text:");
 142     request.setSearchTerm("abc OR text:go:abc");
 143     request.setWantedFields(wantedFields);
 144     new PDBRestClient().executeRequest(request);
 145   }
 146
 147   @Test
 148   public void parsePDBJsonResponseTest()
 149   {
 150     List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
 151     wantedFields.add(PDBDocField.MOLECULE_TYPE);
 152     wantedFields.add(PDBDocField.PDB_ID);
 153     wantedFields.add(PDBDocField.GENUS);
 154     wantedFields.add(PDBDocField.GENE_NAME);
 155     wantedFields.add(PDBDocField.TITLE);
 156
 157     PDBRestRequest request = new PDBRestRequest();
 158     request.setAllowEmptySeq(false);
 159     request.setWantedFields(wantedFields);
 160
 161     String jsonString = "";
 162     try
 163     {
 164       jsonString = readJsonStringFromFile("test/jalview/io/pdb_response_json.txt");
 165     } catch (IOException e)
 166     {
 167       e.printStackTrace();
 168     }
 169     PDBRestResponse response = PDBRestClient.parsePDBJsonResponse(
 170             jsonString, request);
 171     assertTrue(response.getSearchSummary() != null);
 172     assertTrue(response.getNumberOfItemsFound() == 931);
 173     assertTrue(response.getSearchSummary().size() == 14);
 174   }
 175
 176   @Test
 177   public void getPDBIdColumIndexTest()
 178   {
 179     List<PDBDocField> wantedFields = new ArrayList<PDBDocField>();
 180     wantedFields.add(PDBDocField.MOLECULE_TYPE);
 181     wantedFields.add(PDBDocField.GENUS);
 182     wantedFields.add(PDBDocField.GENE_NAME);
 183     wantedFields.add(PDBDocField.TITLE);
 184     wantedFields.add(PDBDocField.PDB_ID);
 185     assertEquals(5, PDBRestClient.getPDBIdColumIndex(wantedFields, true));
 186     assertEquals(4, PDBRestClient.getPDBIdColumIndex(wantedFields, false));
 187   }
 188
 189   @Test
 190   public void externalServiceIntegrationTest()
 191   {
 192     ClientConfig clientConfig = new DefaultClientConfig();
 193     Client client = Client.create(clientConfig);
 194
 195     // Build request parameters for the REST Request
 196     WebResource webResource = client
 197             .resource(PDBRestClient.PDB_SEARCH_ENDPOINT)
 198             .queryParam("wt", "json").queryParam("rows", String.valueOf(1))
 199             .queryParam("q", "text:abc AND molecule_sequence:['' TO *]");
 200
 201     // Execute the REST request
 202     ClientResponse clientResponse = webResource.accept(
 203             MediaType.APPLICATION_JSON).get(ClientResponse.class);
 204
 205     // Get the JSON string from the response object
 206     String pdbJsonResponseString = clientResponse.getEntity(String.class);
 207
 208     // Check the response status and report exception if one occurs
 209     if (clientResponse.getStatus() != 200)
 210     {
 211       Assert.fail("Webservice call failed!!!");
 212     }
 213     else
 214     {
 215       try
 216       {
 217         JSONParser jsonParser = new JSONParser();
 218         JSONObject jsonObj = (JSONObject) jsonParser
 219                 .parse(pdbJsonResponseString);
 220         JSONObject pdbResponse = (JSONObject) jsonObj.get("response");
 221         String queryTime = ((JSONObject) jsonObj.get("responseHeader"))
 222                 .get("QTime").toString();
 223         String numFound = pdbResponse.get("numFound").toString();
 224         JSONArray docs = (JSONArray) pdbResponse.get("docs");
 225         Iterator<JSONObject> docIter = docs.iterator();
 226
 227         assertTrue("Couldn't Retrieve 'response' object",
 228                 pdbResponse != null);
 229         assertTrue("Couldn't Retrieve 'QTime' value", queryTime != null);
 230         assertTrue("Couldn't Retrieve 'numFound' value", numFound != null);
 231         assertTrue("Couldn't Retrieve 'docs' object", docs != null
 232                 || !docIter.hasNext());
 233
 234         JSONObject pdbJsonDoc = docIter.next();
 235
 236         for (PDBDocField field : PDBDocField.values())
 237         {
 238           if (field == PDBDocField.ALL)
 239           {
 240             continue;
 241           }
 242           if (pdbJsonDoc.get(field.getCode()) == null)
 243           {
 244             // System.out.println(">>>\t" + field.getCode());
 245             assertTrue(field.getClass()
 246                     + " has been removed from PDB doc Entity",
 247                     !pdbJsonResponseString.contains(field.getCode()));
 248           }
 249         }
 250       } catch (ParseException e)
 251       {
 252         Assert.fail(">>>  Test failed due to exception while parsing pdb response json !!!");
 253         e.printStackTrace();
 254       }
 255     }
 256   }
 257
 258   public String readJsonStringFromFile(String filePath) throws IOException
 259   {
 260     String fileContent;
 261     BufferedReader br = new BufferedReader(new FileReader(filePath));
 262     try
 263     {
 264       StringBuilder sb = new StringBuilder();
 265       String line = br.readLine();
 266
 267       while (line != null)
 268       {
 269         sb.append(line);
 270         sb.append(System.lineSeparator());
 271         line = br.readLine();
 272         }
 273       fileContent = sb.toString();
 274     } finally
 275     {
 276       br.close();
 277     }
 278     return fileContent;
 279   }
 280
 281 }