JAL-3829 ensure tests use mocked service - proper exception for mocked 400 response

[jalview.git] / src / jalview / fts / core / FTSRestClient.java

diff --git a/src/jalview/fts/core/FTSRestClient.java b/src/jalview/fts/core/FTSRestClient.java
index f94d455..b262f64 100644 (file)
--- a/src/jalview/fts/core/FTSRestClient.java
+++ b/src/jalview/fts/core/FTSRestClient.java
@@ -20,11 +20,6 @@
  */
 package jalview.fts.core;
 
-import jalview.fts.api.FTSDataColumnI;
-import jalview.fts.api.FTSDataColumnI.FTSDataColumnGroupI;
-import jalview.fts.api.FTSRestClientI;
-import jalview.util.MessageManager;
-
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
@@ -33,6 +28,12 @@ import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Objects;
 
+import jalview.fts.api.FTSDataColumnI;
+import jalview.fts.api.FTSDataColumnI.FTSDataColumnGroupI;
+import jalview.fts.core.FTSDataColumnPreferences.PreferenceSource;
+import jalview.fts.service.threedbeacons.TDBeaconsFTSRestClient;
+import jalview.fts.api.FTSRestClientI;
+
 /**
  * Base class providing implementation for common methods defined in
  * FTSRestClientI
@@ -43,13 +44,13 @@ import java.util.Objects;
  */
 public abstract class FTSRestClient implements FTSRestClientI
 {
-  protected Collection<FTSDataColumnI> dataColumns = new ArrayList<FTSDataColumnI>();
+  protected Collection<FTSDataColumnI> dataColumns = new ArrayList<>();
 
-  protected Collection<FTSDataColumnGroupI> dataColumnGroups = new ArrayList<FTSDataColumnGroupI>();
+  protected Collection<FTSDataColumnGroupI> dataColumnGroups = new ArrayList<>();
 
-  protected Collection<FTSDataColumnI> searchableDataColumns = new ArrayList<FTSDataColumnI>();
+  protected Collection<FTSDataColumnI> searchableDataColumns = new ArrayList<>();
 
-  protected Collection<FTSDataColumnI> defaulDisplayedDataColumns = new ArrayList<FTSDataColumnI>();
+  protected Collection<FTSDataColumnI> defaulDisplayedDataColumns = new ArrayList<>();
 
   protected FTSDataColumnI primaryKeyColumn;
 
@@ -57,6 +58,10 @@ public abstract class FTSRestClient implements FTSRestClientI
 
   private int defaultResponsePageSize = 100;
 
+  protected String mockQuery = null;
+
+  protected String mockResponse = null;
+
   protected FTSRestClient()
   {
 
@@ -68,7 +73,7 @@ public abstract class FTSRestClient implements FTSRestClientI
 
     InputStream in = getClass().getResourceAsStream(fileName);
 
-    try (BufferedReader br = new BufferedReader(new InputStreamReader(in)))
+    try (BufferedReader br = new BufferedReader(new InputStreamReader(in))) 
     {
       String line;
       while ((line = br.readLine()) != null)
@@ -428,6 +433,12 @@ public abstract class FTSRestClient implements FTSRestClientI
             "Couldn't find data column with name : " + nameOrCode);
   }
 
+  public static void createMockFTSRestClient(FTSRestClient instance,String workingQuery,
+          String jsonResponse)
+  {
+    instance.setMock(workingQuery,jsonResponse);
+  }
+
   @Override
   public FTSDataColumnGroupI getDataColumnGroupById(String id)
           throws Exception
@@ -446,22 +457,21 @@ public abstract class FTSRestClient implements FTSRestClientI
     throw new Exception("Couldn't find data column group with id : " + id);
   }
 
-  public String getMessageByHTTPStatusCode(int code, String service)
+  public static String getMessageByHTTPStatusCode(int code, String service)
   {
     String message = "";
     switch (code)
     {
     case 400:
-      message = MessageManager.getString("exception.bad_request");
+      message = "Bad request. There is a problem with your input.";
       break;
 
     case 410:
-      message = MessageManager.formatMessage(
-              "exception.fts_rest_service_no_longer_available", service);
+      message = service + " rest services no longer available!";
       break;
     case 403:
     case 404:
-      message = MessageManager.getString("exception.resource_not_be_found");
+      message = "The requested resource could not be found";
       break;
     case 408:
     case 409:
@@ -470,16 +480,22 @@ public abstract class FTSRestClient implements FTSRestClientI
     case 502:
     case 504:
     case 505:
-      message = MessageManager.formatMessage("exception.fts_server_error",
-              service);
+      message = "There seems to be an error from the " + service
+              + " server";
       break;
     case 503:
-      message = MessageManager.getString("exception.service_not_available");
+      message = "Service not available. The server is being updated, try again later.";
       break;
     default:
       break;
     }
-    return message;
+    return String.valueOf(code) + " " + message;
+  }
+
+  public static void unMock(FTSRestClient instance)
+  {
+    instance.mockQuery =null;
+    instance.mockResponse =null;
   }
 
   protected String getResourceFile(String fileName)
@@ -506,4 +522,30 @@ public abstract class FTSRestClient implements FTSRestClientI
     return defaultResponsePageSize;
   }
 
+  protected void setMock(String workingQuery, String jsonResponse)
+  {
+    mockQuery=workingQuery;
+    mockResponse = jsonResponse;
+  }
+
+  protected boolean isMocked()
+  {
+    return mockQuery != null && mockResponse!=null;
+  }
+
+  @Override
+  public String[] getPreferencesColumnsFor(PreferenceSource source)
+  {
+    String[] columnNames = null;
+    switch (source)
+    {
+    case SEARCH_SUMMARY:
+      columnNames = new String[] { "", "Display", "Group" };
+      break;
+    default:
+      // non structure sources don't return any other kind of preferences columns
+      break;
+    }
+    return columnNames;
+  }
 }