Merge pull request #162 from saucelabs/refactor-deleteTunnel

Resolve #161.

Author: sceiler

src/main/java/com/saucelabs/saucerest/ErrorExplainers.java

@@ -61,4 +61,12 @@ static String LogNotFound() {
             " * A error occurred where the job was created on Sauce Labs but no test were executed."
         );
     }
+
+    static String TunnelNotFound() {
+        return String.join(System.lineSeparator(),
+            " * Tunnel id could not be found. Possible reasons:",
+            " * The tunnel id requested does not exist in this data center. Ensure the data center endpoint is correct.",
+            " * A tunnel with this id never existed."
+        );
+    }
 }

src/main/java/com/saucelabs/saucerest/SauceException.java

@@ -32,6 +32,16 @@ public NotAuthorized() {
         }
     }
 
+    public static class NotFound extends SauceException {
+
+        public NotFound(String message) {
+            super(message);
+        }
+
+        public NotFound() {
+        }
+    }
+
     public static class TooManyRequests extends SauceException {
     }
 

src/main/java/com/saucelabs/saucerest/SauceREST.java

@@ -1173,8 +1173,8 @@ private BufferedInputStream downloadFileData(String jobId, URL restEndpoint) thr
         return new BufferedInputStream(stream);
     }
 
-    private HttpURLConnection setConnection(String jobId, URL restEndpoint) throws IOException {
-        HttpURLConnection connection = openConnection("GET", restEndpoint);
+    private HttpURLConnection setConnection(String jobId, URL restEndpoint, String method) throws IOException {
+        HttpURLConnection connection = openConnection(method, restEndpoint);
 
         int responseCode = connection.getResponseCode();
         logger.log(Level.FINEST, "{0} - {1} for: {2}", new Object[] { responseCode, restEndpoint, jobId });
@@ -1189,6 +1189,9 @@ private HttpURLConnection setConnection(String jobId, URL restEndpoint) throws I
                     errorDetails = ErrorExplainers.HARMissing();
                 } else if (path.endsWith("log") || path.endsWith("json")) {
                     errorDetails = ErrorExplainers.LogNotFound();
+                } else if (path.contains("tunnels")) {
+                    errorDetails = ErrorExplainers.TunnelNotFound();
+                    throw new SauceException.NotFound(String.join(System.lineSeparator(), errorDetails));
                 }
 
                 String error = ErrorExplainers.resourceMissing();
@@ -1228,6 +1231,14 @@ private HttpURLConnection setConnection(String jobId, URL restEndpoint) throws I
         return connection;
     }
 
+    private HttpURLConnection setConnection(String jobId, URL restEndpoint) throws IOException {
+        return setConnection(jobId, restEndpoint, "GET");
+    }
+
+    private HttpURLConnection setConnection(URL restEndpoint, String method) throws IOException {
+        return setConnection("", restEndpoint, method);
+    }
+
     private boolean saveAsset(String jobId, String assetName, String location, String fileName) {
         return handleErrorAtDownloadGracefully(() -> saveAssetOrThrowException(jobId, assetName, location, fileName));
     }
@@ -1613,19 +1624,26 @@ protected String encodeAuthentication() {
      * Invokes the Sauce REST API to delete a tunnel.
      *
      * @param tunnelId Identifier of the tunnel to delete
+     * @return BufferedInputStream with response from server
      */
-    public void deleteTunnel(String tunnelId) {
-
+    public BufferedInputStream deleteTunnel(String tunnelId) throws IOException {
         HttpURLConnection connection = null;
         try {
             URL restEndpoint = buildURL(username + "/tunnels/" + tunnelId);
-            connection = openConnection("DELETE", restEndpoint);
-            connection.getOutputStream().write("".getBytes());
+            connection = setConnection(restEndpoint, "DELETE");
         } catch (IOException e) {
-            logger.log(Level.WARNING, "Error stopping Sauce Job", e);
+            Throwable throwable = e.getCause();
+
+            if (throwable instanceof SauceException.NotAuthorized) {
+                throw (SauceException.NotAuthorized) throwable;
+            } else if (throwable instanceof SauceException.NotFound) {
+                throw (SauceException.NotFound) throwable;
+            }
+            logger.log(Level.WARNING, "Error deleting tunnel", e);
         }
 
-        closeInputStream(connection);
+        InputStream stream = connection.getInputStream();
+        return new BufferedInputStream(stream);
     }
 
     /**

src/test/java/com/saucelabs/saucerest/SauceRESTTest.java

@@ -355,6 +355,34 @@ void testGetTunnelInformation() {
         assertEquals(this.urlConnection.getRealURL().getPath(), "/rest/v1/" + this.sauceREST.getUsername() + "/tunnels/1234-1234-1231-123-123");
     }
 
+    @Test
+    void testDeleteTunnel() throws Exception {
+        urlConnection.setResponseCode(401);
+        urlConnection.setInputStream(new ByteArrayInputStream("Not authorized".getBytes(StandardCharsets.UTF_8)));
+        assertThrows(SauceException.NotAuthorized.class, () -> sauceREST.deleteTunnel("1234"));
+
+        urlConnection.setResponseCode(404);
+        urlConnection.setInputStream(new ByteArrayInputStream("Not found".getBytes(StandardCharsets.UTF_8)));
+        assertThrows(SauceException.NotFound.class, () -> sauceREST.deleteTunnel("1234"));
+
+        urlConnection.setResponseCode(200);
+        urlConnection.setInputStream(new ByteArrayInputStream("{\"result\": true, \"id\": \"1234\", \"jobs_running\": 0}".getBytes(StandardCharsets.UTF_8)));
+
+        String results;
+        try (BufferedInputStream stream = sauceREST.deleteTunnel("1234")) {
+            assertEquals("/rest/v1/" + sauceREST.getUsername() + "/tunnels/1234",
+                urlConnection.getRealURL().getPath());
+
+            results = IOUtils.toString(stream, StandardCharsets.UTF_8);
+        }
+        JSONObject jsonObject = new JSONObject(results);
+
+        assertTrue(jsonObject.getBoolean("result"));
+        assertEquals("1234", jsonObject.getString("id"));
+        assertEquals(0, jsonObject.getInt("jobs_running"));
+        assertFalse(jsonObject.isEmpty());
+    }
+
     @Test
     void testGetActivity() {
         urlConnection.setResponseCode(200);