Merge pull request #224 from lancedfr/improve_exception_handling

SidneyAllen · web-flow · commit 16060129ee48 · 2020-08-25T10:54:12.000-07:00
Improve exception handling
diff --git a/src/main/java/com/xero/api/XeroApiException.java b/src/main/java/com/xero/api/XeroApiException.java
@@ -5,14 +5,14 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public class XeroApiException extends RuntimeException {
+public class XeroApiException extends XeroException {
 
     private static final long serialVersionUID = 1L;
     private final int responseCode;
     private String message;
     private Map<String, String> messageMap = new HashMap<String, String>();
     private Error error;
-    
+
     // LEGACY ERROR HANDLER
     public XeroApiException(int responseCode) {
         super(responseCode + " response.");
diff --git a/src/main/java/com/xero/api/XeroAuthenticationException.java b/src/main/java/com/xero/api/XeroAuthenticationException.java
@@ -0,0 +1,12 @@
+package com.xero.api;
+
+/**
+ * Base authentication exception all other Xero authentication exceptions should extend.
+ */
+public class XeroAuthenticationException extends XeroException {
+    private static final long serialVersionUID = -6292824871010327632L;
+
+    public XeroAuthenticationException(final String message) {
+        super(message);
+    }
+}
diff --git a/src/main/java/com/xero/api/XeroBadRequestException.java b/src/main/java/com/xero/api/XeroBadRequestException.java
@@ -4,9 +4,7 @@
 import java.util.List;
 import java.util.Objects;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
 import com.xero.models.accounting.Element;
-import com.xero.models.accounting.Employees;
 import com.xero.models.assets.FieldValidationErrorsElement;
 import com.xero.models.bankfeeds.FeedConnection;
 import com.xero.models.bankfeeds.FeedConnections;
@@ -15,7 +13,7 @@
 
 import io.swagger.annotations.ApiModelProperty;
 
-public class XeroBadRequestException extends RuntimeException {
+public class XeroBadRequestException extends XeroException {
 
     private static final long serialVersionUID = 1L;
     private Integer statusCode;
diff --git a/src/main/java/com/xero/api/XeroException.java b/src/main/java/com/xero/api/XeroException.java
@@ -0,0 +1,17 @@
+package com.xero.api;
+
+/**
+ * Base application exception all other Xero exceptions should extend.
+ */
+public class XeroException extends RuntimeException {
+
+    private static final long serialVersionUID = 1708393240501381142L;
+
+    public XeroException() {
+    }
+
+    public XeroException(final String message) {
+        super(message);
+    }
+
+}
diff --git a/src/main/java/com/xero/api/XeroForbiddenException.java b/src/main/java/com/xero/api/XeroForbiddenException.java
@@ -1,6 +1,6 @@
 package com.xero.api;
 
-public class XeroForbiddenException extends RuntimeException {
+public class XeroForbiddenException extends XeroAuthenticationException {
 
     private static final long serialVersionUID = 1L;
     private int statusCode = 0;
diff --git a/src/main/java/com/xero/api/XeroMethodNotAllowedException.java b/src/main/java/com/xero/api/XeroMethodNotAllowedException.java
@@ -14,7 +14,7 @@
 
 import io.swagger.annotations.ApiModelProperty;
 
-public class XeroMethodNotAllowedException extends RuntimeException {
+public class XeroMethodNotAllowedException extends XeroException {
 
     private static final long serialVersionUID = 1L;
     private Integer statusCode;
diff --git a/src/main/java/com/xero/api/XeroNotFoundException.java b/src/main/java/com/xero/api/XeroNotFoundException.java
@@ -1,6 +1,6 @@
 package com.xero.api;
 
-public class XeroNotFoundException extends RuntimeException {
+public class XeroNotFoundException extends XeroException {
 
     private static final long serialVersionUID = 1L;
     private int statusCode = 0;
diff --git a/src/main/java/com/xero/api/XeroRateLimitException.java b/src/main/java/com/xero/api/XeroRateLimitException.java
@@ -1,6 +1,6 @@
 package com.xero.api;
 
-public class XeroRateLimitException extends RuntimeException {
+public class XeroRateLimitException extends XeroException {
 
     private static final long serialVersionUID = 1L;
     private int statusCode = 0;
diff --git a/src/main/java/com/xero/api/XeroServerErrorException.java b/src/main/java/com/xero/api/XeroServerErrorException.java
@@ -1,6 +1,6 @@
 package com.xero.api;
 
-public class XeroServerErrorException extends RuntimeException {
+public class XeroServerErrorException extends XeroException {
 
     private static final long serialVersionUID = 1L;
     private int statusCode = 0;
diff --git a/src/main/java/com/xero/api/XeroUnauthorizedException.java b/src/main/java/com/xero/api/XeroUnauthorizedException.java
@@ -1,6 +1,6 @@
 package com.xero.api;
 
-public class XeroUnauthorizedException extends RuntimeException {
+public class XeroUnauthorizedException extends XeroAuthenticationException {
 
     private static final long serialVersionUID = 1L;
     private int statusCode = 0;
diff --git a/src/test/java/com/xero/api/XeroExceptionsTest.java b/src/test/java/com/xero/api/XeroExceptionsTest.java
@@ -0,0 +1,145 @@
+package com.xero.api;
+
+import static org.hamcrest.Matchers.is;
+import static org.mockito.Mockito.when;
+
+import com.google.api.client.http.HttpHeaders;
+import com.google.api.client.http.HttpResponseException;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+
+public class XeroExceptionsTest {
+
+    @InjectMocks
+    private static XeroApiExceptionHandler xeroApiExceptionHandler;
+    @Rule
+    public ExpectedException expectedException = ExpectedException.none();
+    @Mock
+    private com.xero.models.accounting.Error error;
+    @Mock
+    private HttpResponseException httpResponseException;
+    @Mock
+    private HttpHeaders httpHeaders;
+    @Mock
+    private com.xero.models.payrolluk.Problem problem;
+
+    private final String objectType = "objectType";
+
+    @Before
+    public void setUp() {
+        MockitoAnnotations.initMocks(this);
+    }
+
+    @Test
+    public void testXeroBadRequestException() {
+        // XeroBadRequestException extends XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(is(new XeroBadRequestException(objectType, error)));
+
+        xeroApiExceptionHandler.validationError(objectType, error);
+    }
+
+    @Test
+    public void testXeroMethodNotAllowedException() {
+        // XeroMethodNotAllowedException extends XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(is(new XeroMethodNotAllowedException(objectType, problem)));
+
+        xeroApiExceptionHandler.validationError(405, objectType, problem);
+    }
+
+    @Test
+    public void testXeroUnauthorizedException() {
+        int statusCode = 401;
+        String message = "Unauthorized - check your scopes and confirm access to this resource";
+
+        // XeroUnauthorizedException extends XeroAuthenticationException and XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(XeroAuthenticationException.class);
+        expectedException.expect(XeroUnauthorizedException.class);
+        expectedException.expectMessage(message);
+
+        when(httpResponseException.getStatusCode()).thenReturn(statusCode);
+        xeroApiExceptionHandler.execute(httpResponseException);
+    }
+
+    @Test
+    public void testXeroForbiddenException() {
+        int statusCode = 403;
+        String message = "Forbidden - authentication unsuccessful";
+
+        // XeroForbiddenException extends XeroAuthenticationException and XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(XeroAuthenticationException.class);
+        expectedException.expect(XeroForbiddenException.class);
+        expectedException.expectMessage(message);
+
+        when(httpResponseException.getStatusCode()).thenReturn(statusCode);
+        xeroApiExceptionHandler.execute(httpResponseException);
+    }
+
+    @Test
+    public void testXeroNotFoundException() {
+        int statusCode = 404;
+        String message = "The resource you're looking for cannot be found";
+
+        // XeroNotFoundException extends XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(XeroNotFoundException.class);
+        expectedException.expectMessage(message);
+
+        when(httpResponseException.getStatusCode()).thenReturn(statusCode);
+        xeroApiExceptionHandler.execute(httpResponseException);
+    }
+
+    @Test
+    public void testXeroRateLimitException() {
+        int statusCode = 429;
+        String message = "You've exceeded the per 100 rate limit";
+
+        // XeroRateLimitException extends XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(XeroRateLimitException.class);
+        expectedException.expectMessage(message);
+
+        when(httpResponseException.getStatusCode()).thenReturn(statusCode);
+        when(httpResponseException.getHeaders()).thenReturn(httpHeaders);
+        when(httpHeaders.get("x-rate-limit-problem")).thenReturn(100);
+        xeroApiExceptionHandler.execute(httpResponseException);
+    }
+
+    @Test
+    public void testXeroServerErrorException() {
+        int statusCode = 500;
+        String message = "An error occurred in Xero. Check the API Status page http://status.developer.xero.com for current service status.";
+
+        // XeroServerErrorException extends XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(XeroServerErrorException.class);
+        expectedException.expectMessage(message);
+
+        when(httpResponseException.getStatusCode()).thenReturn(statusCode);
+        xeroApiExceptionHandler.execute(httpResponseException);
+    }
+
+    @Test
+    public void testXeroApiException() {
+        int statusCode = 1;
+        String message = "Unknown http status code 1";
+
+        // XeroApiException extends XeroException so we can catch either
+        expectedException.expect(XeroException.class);
+        expectedException.expect(XeroApiException.class);
+        expectedException.expectMessage(message);
+
+        when(httpResponseException.getStatusMessage()).thenReturn(message);
+        when(httpResponseException.getStatusCode()).thenReturn(statusCode);
+        xeroApiExceptionHandler.execute(httpResponseException);
+    }
+
+}
