Skip to content

Commit

Permalink
Chain cause exception to service exception in translateAndThrow (#946)
Browse files Browse the repository at this point in the history
* Chain cause exception to service exception in translateAndThrow

* Make exception constructors package scoped, better test coverage

* Make exception classes final with public constructors
  • Loading branch information
mziccard committed Apr 21, 2016
1 parent e213176 commit 0a6c6f7
Show file tree
Hide file tree
Showing 11 changed files with 287 additions and 31 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* @see <a href="https://cloud.google.com/bigquery/troubleshooting-errors">Google Cloud
* BigQuery error codes</a>
*/
public class BigQueryException extends BaseServiceException {
public final class BigQueryException extends BaseServiceException {

// see: https://cloud.google.com/bigquery/troubleshooting-errors
private static final Set<Error> RETRYABLE_ERRORS = ImmutableSet.of(
Expand All @@ -44,7 +44,12 @@ public class BigQueryException extends BaseServiceException {
private final BigQueryError error;

public BigQueryException(int code, String message) {
this(code, message, null);
this(code, message, (Throwable) null);
}

public BigQueryException(int code, String message, Throwable cause) {
super(code, message, null, true, cause);
this.error = null;
}

public BigQueryException(int code, String message, BigQueryError error) {
Expand Down Expand Up @@ -100,6 +105,6 @@ public int hashCode() {
*/
static BaseServiceException translateAndThrow(RetryHelperException ex) {
BaseServiceException.translateAndPropagateIfPossible(ex);
throw new BigQueryException(UNKNOWN_CODE, ex.getMessage());
throw new BigQueryException(UNKNOWN_CODE, ex.getMessage(), ex.getCause());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;

import com.google.cloud.BaseServiceException;
Expand Down Expand Up @@ -86,18 +87,29 @@ public void testBigqueryException() {
assertTrue(exception.retryable());
assertTrue(exception.idempotent());

IOException cause = new SocketTimeoutException();
IOException cause = new SocketTimeoutException("socketTimeoutMessage");
exception = new BigQueryException(cause);
assertEquals(BigQueryException.UNKNOWN_CODE, exception.code());
assertNull(exception.reason());
assertNull(exception.getMessage());
assertEquals("socketTimeoutMessage", exception.getMessage());
assertEquals(cause, exception.getCause());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertEquals(cause, exception.getCause());
assertSame(cause, exception.getCause());

exception = new BigQueryException(504, "message", cause);
assertEquals(504, exception.code());
assertEquals("message", exception.getMessage());
assertNull(exception.reason());
assertNull(exception.error());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());
}

@Test
public void testTranslateAndThrow() throws Exception {
BigQueryException cause = new BigQueryException(503, "message");
Exception cause = new BigQueryException(503, "message");
RetryHelperException exceptionMock = createMock(RetryHelperException.class);
expect(exceptionMock.getCause()).andReturn(cause).times(2);
replay(exceptionMock);
Expand All @@ -111,5 +123,21 @@ public void testTranslateAndThrow() throws Exception {
} finally {
verify(exceptionMock);
}
cause = new IllegalArgumentException("message");
exceptionMock = createMock(RetryHelperException.class);
expect(exceptionMock.getMessage()).andReturn("message").times(1);
expect(exceptionMock.getCause()).andReturn(cause).times(2);
replay(exceptionMock);
try {
BigQueryException.translateAndThrow(exceptionMock);
} catch (BaseServiceException ex) {
assertEquals(BigQueryException.UNKNOWN_CODE, ex.code());
assertEquals("message", ex.getMessage());
assertFalse(ex.retryable());
assertTrue(ex.idempotent());
assertSame(cause, ex.getCause());
} finally {
verify(exceptionMock);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,19 @@
* @see <a href="https://cloud.google.com/datastore/docs/concepts/errors#Error_Codes">Google Cloud
* Datastore error codes</a>
*/
public class DatastoreException extends BaseServiceException {
public final class DatastoreException extends BaseServiceException {

// see https://cloud.google.com/datastore/docs/concepts/errors#Error_Codes"
private static final Set<Error> RETRYABLE_ERRORS = ImmutableSet.of(
new Error(10, "ABORTED"), new Error(4, "DEADLINE_EXCEEDED"), new Error(14, "UNAVAILABLE"));
private static final long serialVersionUID = 2663750991205874435L;

public DatastoreException(int code, String message, String reason, Throwable cause) {
super(code, message, reason, true, cause);
public DatastoreException(int code, String message, String reason) {
this(code, message, reason, null);
}

public DatastoreException(int code, String message, String reason) {
super(code, message, reason, true);
public DatastoreException(int code, String message, String reason, Throwable cause) {
super(code, message, reason, true, cause);
}

public DatastoreException(IOException exception) {
Expand All @@ -63,7 +63,7 @@ protected Set<Error> retryableErrors() {
*/
static DatastoreException translateAndThrow(RetryHelperException ex) {
BaseServiceException.translateAndPropagateIfPossible(ex);
throw new DatastoreException(UNKNOWN_CODE, ex.getMessage(), null);
throw new DatastoreException(UNKNOWN_CODE, ex.getMessage(), null, ex.getCause());
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

Expand Down Expand Up @@ -66,18 +67,28 @@ public void testDatastoreException() throws Exception {
assertFalse(exception.retryable());
assertTrue(exception.idempotent());

IOException cause = new SocketTimeoutException();
IOException cause = new SocketTimeoutException("socketTimeoutMessage");
exception = new DatastoreException(cause);
assertEquals(DatastoreException.UNKNOWN_CODE, exception.code());
assertNull(exception.reason());
assertNull(exception.getMessage());
assertEquals("socketTimeoutMessage", exception.getMessage());
assertEquals(cause, exception.getCause());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());

exception = new DatastoreException(2, "message", "INTERNAL", cause);
assertEquals(2, exception.code());
assertEquals("INTERNAL", exception.reason());
assertEquals("message", exception.getMessage());
assertFalse(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());
}

@Test
public void testTranslateAndThrow() throws Exception {
DatastoreException cause = new DatastoreException(14, "message", "UNAVAILABLE");
Exception cause = new DatastoreException(14, "message", "UNAVAILABLE");
RetryHelper.RetryHelperException exceptionMock =
createMock(RetryHelper.RetryHelperException.class);
expect(exceptionMock.getCause()).andReturn(cause).times(2);
Expand All @@ -92,6 +103,22 @@ public void testTranslateAndThrow() throws Exception {
} finally {
verify(exceptionMock);
}
cause = new IllegalArgumentException("message");
exceptionMock = createMock(RetryHelper.RetryHelperException.class);
expect(exceptionMock.getMessage()).andReturn("message").times(1);
expect(exceptionMock.getCause()).andReturn(cause).times(2);
replay(exceptionMock);
try {
DatastoreException.translateAndThrow(exceptionMock);
} catch (BaseServiceException ex) {
assertEquals(DatastoreException.UNKNOWN_CODE, ex.code());
assertEquals("message", ex.getMessage());
assertFalse(ex.retryable());
assertTrue(ex.idempotent());
assertSame(cause, ex.getCause());
} finally {
verify(exceptionMock);
}
}

@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/**
* DNS service exception.
*/
public class DnsException extends BaseServiceException {
public final class DnsException extends BaseServiceException {

// see: https://cloud.google.com/dns/troubleshooting
private static final Set<Error> RETRYABLE_ERRORS = ImmutableSet.of(
Expand All @@ -48,8 +48,8 @@ public DnsException(GoogleJsonError error, boolean idempotent) {
super(error, idempotent);
}

private DnsException(int code, String message) {
super(code, message, null, true);
public DnsException(int code, String message, Throwable cause) {
super(code, message, null, true, cause);
}

@Override
Expand All @@ -66,6 +66,6 @@ protected Set<Error> retryableErrors() {
*/
static DnsException translateAndThrow(RetryHelperException ex) {
BaseServiceException.translateAndPropagateIfPossible(ex);
throw new DnsException(UNKNOWN_CODE, ex.getMessage());
throw new DnsException(UNKNOWN_CODE, ex.getMessage(), ex.getCause());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
/*
* Copyright 2016 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.google.cloud.dns;

import static org.easymock.EasyMock.createMock;
import static org.easymock.EasyMock.expect;
import static org.easymock.EasyMock.replay;
import static org.easymock.EasyMock.verify;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;

import com.google.api.client.googleapis.json.GoogleJsonError;
import com.google.cloud.BaseServiceException;
import com.google.cloud.RetryHelper.RetryHelperException;

import org.junit.Test;

import java.io.IOException;
import java.net.SocketTimeoutException;

public class DnsExceptionTest {

@Test
public void testDnsException() throws Exception {
IOException cause = new SocketTimeoutException("socketTimeoutMessage");
DnsException exception = new DnsException(500, "message", cause);
assertEquals(500, exception.code());
assertEquals("message", exception.getMessage());
assertNull(exception.reason());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());

exception = new DnsException(502, "message", cause);
assertEquals(502, exception.code());
assertEquals("message", exception.getMessage());
assertNull(exception.reason());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());

exception = new DnsException(503, "message", cause);
assertEquals(503, exception.code());
assertEquals("message", exception.getMessage());
assertNull(exception.reason());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());

exception = new DnsException(429, "message", cause);
assertEquals(429, exception.code());
assertEquals("message", exception.getMessage());
assertNull(exception.reason());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());

exception = new DnsException(404, "message", cause);
assertEquals(404, exception.code());
assertEquals("message", exception.getMessage());
assertNull(exception.reason());
assertFalse(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());

exception = new DnsException(cause, true);
assertEquals(DnsException.UNKNOWN_CODE, exception.code());
assertNull(exception.reason());
assertEquals("socketTimeoutMessage", exception.getMessage());
assertEquals(cause, exception.getCause());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
assertSame(cause, exception.getCause());

GoogleJsonError error = new GoogleJsonError();
error.setCode(503);
error.setMessage("message");
exception = new DnsException(error, true);
assertEquals(503, exception.code());
assertEquals("message", exception.getMessage());
assertTrue(exception.retryable());
assertTrue(exception.idempotent());
}

@Test
public void testTranslateAndThrow() throws Exception {
IOException timeoutException = new SocketTimeoutException("message");
Exception cause = new DnsException(timeoutException, true);
RetryHelperException exceptionMock = createMock(RetryHelperException.class);
expect(exceptionMock.getCause()).andReturn(cause).times(2);
replay(exceptionMock);
try {
DnsException.translateAndThrow(exceptionMock);
} catch (BaseServiceException ex) {
assertEquals(DnsException.UNKNOWN_CODE, ex.code());
assertNull(ex.reason());
assertEquals("message", ex.getMessage());
assertEquals(timeoutException, ex.getCause());
assertTrue(ex.retryable());
assertTrue(ex.idempotent());
} finally {
verify(exceptionMock);
}
cause = new IllegalArgumentException("message");
exceptionMock = createMock(RetryHelperException.class);
expect(exceptionMock.getMessage()).andReturn("message").times(1);
expect(exceptionMock.getCause()).andReturn(cause).times(2);
replay(exceptionMock);
try {
DnsException.translateAndThrow(exceptionMock);
} catch (BaseServiceException ex) {
assertEquals(DnsException.UNKNOWN_CODE, ex.code());
assertEquals("message", ex.getMessage());
assertFalse(ex.retryable());
assertTrue(ex.idempotent());
assertSame(cause, ex.getCause());
} finally {
verify(exceptionMock);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public class ZoneTest {
ChangeRequestInfo.builder().generatedId("someid").build();
private static final ChangeRequestInfo CHANGE_REQUEST_NO_ID =
ChangeRequestInfo.builder().build();
private static final DnsException EXCEPTION = createStrictMock(DnsException.class);
private static final DnsException EXCEPTION = new DnsException(-1, "message", null);
private static final DnsOptions OPTIONS = createStrictMock(DnsOptions.class);

private Dns dns;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* @see <a href="https://cloud.google.com/resource-manager/v1/errors/core_errors">Google Cloud
* Resource Manager error codes</a>
*/
public class ResourceManagerException extends BaseServiceException {
public final class ResourceManagerException extends BaseServiceException {

// see https://cloud.google.com/resource-manager/v1/errors/core_errors
private static final Set<Error> RETRYABLE_ERRORS = ImmutableSet.of(
Expand All @@ -48,7 +48,11 @@ public class ResourceManagerException extends BaseServiceException {
private static final long serialVersionUID = -9207194488966554136L;

public ResourceManagerException(int code, String message) {
super(code, message, null, true);
this(code, message, null);
}

public ResourceManagerException(int code, String message, Throwable cause) {
super(code, message, null, true, cause);
}

public ResourceManagerException(IOException exception) {
Expand All @@ -70,6 +74,6 @@ protected Set<Error> retryableErrors() {
*/
static ResourceManagerException translateAndThrow(RetryHelperException ex) {
BaseServiceException.translateAndPropagateIfPossible(ex);
throw new ResourceManagerException(UNKNOWN_CODE, ex.getMessage());
throw new ResourceManagerException(UNKNOWN_CODE, ex.getMessage(), ex.getCause());
}
}
Loading

0 comments on commit 0a6c6f7

Please sign in to comment.