api: Add a convenience factory that builds GoogleJsonResponseException instances for testing. Also migrate ComputeCredential to point to the "v1" endpoint.

https://codereview.appspot.com/66560045/

Author: Daniel Wang

google-api-client/src/main/java/com/google/api/client/googleapis/compute/ComputeCredential.java

@@ -61,7 +61,7 @@ public class ComputeCredential extends Credential {
 
   /** Metadata Service Account token server encoded URL. */
   public static final String TOKEN_SERVER_ENCODED_URL =
-      "http://metadata/computeMetadata/v1beta1/instance/service-accounts/default/token";
+      "http://metadata/computeMetadata/v1/instance/service-accounts/default/token";
 
   /**
    * @param transport HTTP transport
@@ -83,6 +83,7 @@ protected TokenResponse executeRefreshToken() throws IOException {
     GenericUrl tokenUrl = new GenericUrl(getTokenServerEncodedUrl());
     HttpRequest request = getTransport().createRequestFactory().buildGetRequest(tokenUrl);
     request.setParser(new JsonObjectParser(getJsonFactory()));
+    request.getHeaders().set("X-Google-Metadata-Request", true);
     return request.execute().parseAs(TokenResponse.class);
   }
 

google-api-client/src/main/java/com/google/api/client/googleapis/testing/json/GoogleJsonResponseExceptionFactoryTesting.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2013 Google Inc.
+ *
+ * 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.api.client.googleapis.testing.json;
+
+import com.google.api.client.googleapis.json.GoogleJsonResponseException;
+import com.google.api.client.http.HttpRequest;
+import com.google.api.client.http.HttpResponse;
+import com.google.api.client.json.JsonFactory;
+import com.google.api.client.testing.http.HttpTesting;
+import com.google.api.client.testing.http.MockHttpTransport;
+import com.google.api.client.testing.http.MockLowLevelHttpResponse;
+import com.google.api.client.util.Beta;
+
+import java.io.IOException;
+
+/**
+ * {@link Beta} <br/>
+ * Factory class that builds {@link GoogleJsonResponseException} instances for
+ * testing.
+ *
+ * @since 1.18
+ */
+@Beta
+public final class GoogleJsonResponseExceptionFactoryTesting {
+
+  /**
+   * Convenience factory method that builds a {@link GoogleJsonResponseException}
+   * from its arguments. The method builds a dummy {@link HttpRequest} and
+   * {@link HttpResponse}, sets the response's status to a user-specified HTTP
+   * error code, suppresses exceptions, and executes the request. This forces
+   * the underlying framework to create, but not throw, a
+   * {@link GoogleJsonResponseException}, which the method retrieves and returns
+   * to the invoker.
+   *
+   * @param jsonFactory the JSON factory that will create all JSON required
+   *        by the underlying framework
+   * @param httpCode the desired HTTP error code. Note: do nut specify any codes
+   *        that indicate successful completion, e.g. 2XX.
+   * @param reasonPhrase the HTTP reason code that explains the error. For example,
+   *        if {@code httpCode} is {@code 404}, the reason phrase should be
+   *        {@code NOT FOUND}.
+   * @return the generated {@link GoogleJsonResponseException}, as specified.
+   * @throws IOException if request transport fails.
+   */
+  public static GoogleJsonResponseException newMock(JsonFactory jsonFactory,
+      int httpCode, String reasonPhrase) throws IOException {
+    MockLowLevelHttpResponse otherServiceUnavaiableLowLevelResponse =
+        new MockLowLevelHttpResponse()
+        .setStatusCode(httpCode)
+        .setReasonPhrase(reasonPhrase);
+    MockHttpTransport otherTransport = MockHttpTransport.builder()
+        .setLowLevelHttpResponse(otherServiceUnavaiableLowLevelResponse)
+        .build();
+    HttpRequest otherRequest = otherTransport
+        .createRequestFactory().buildGetRequest(HttpTesting.SIMPLE_GENERIC_URL);
+    otherRequest.setThrowExceptionOnExecuteError(false);
+    HttpResponse otherServiceUnavailableResponse = otherRequest.execute();
+    return GoogleJsonResponseException.from(jsonFactory, otherServiceUnavailableResponse);
+  }
+}

google-api-client/src/main/java/com/google/api/client/googleapis/testing/json/package-info.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2013 Google Inc.
+ *
+ * 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.
+ */
+
+/**
+ * {@link com.google.api.client.util.Beta} <br/>
+ * Test utilities for the {@code com.google.api.client.googleapis.json} package.
+ *
+ * @since 1.18
+ */
+@com.google.api.client.util.Beta
+package com.google.api.client.googleapis.testing.json;
+

google-api-client/src/test/java/com/google/api/client/googleapis/compute/ComputeCredentialTest.java

@@ -14,6 +14,8 @@
 
 package com.google.api.client.googleapis.compute;
 
+import static com.google.common.collect.Iterables.getOnlyElement;
+
 import com.google.api.client.auth.oauth2.TokenResponse;
 import com.google.api.client.http.HttpTransport;
 import com.google.api.client.http.LowLevelHttpRequest;
@@ -38,27 +40,36 @@ public class ComputeCredentialTest extends TestCase {
 
   static final String TOKEN_TYPE = "Bearer";
 
+  static final String URL =
+      "http://metadata/computeMetadata/v1/instance/service-accounts/default/token";
+
   public void testExecuteRefreshToken() throws Exception {
-    HttpTransport transport = new MockHttpTransport() {
+    String content = "{" + "\"access_token\":\"" + ACCESS_TOKEN + "\"," + "\"expires_in\":"
+        + EXPIRES_IN_SECONDS + "," + "\"token_type\":\"" + TOKEN_TYPE + "\"" + "}";
+    final MockLowLevelHttpRequest request = new MockLowLevelHttpRequest(URL).setResponse(
+        new MockLowLevelHttpResponse().setContent(content).setContentType(Json.MEDIA_TYPE));
 
+    HttpTransport transport = new MockHttpTransport() {
       private int count = 0;
 
       @Override
       public LowLevelHttpRequest buildRequest(String method, String url) {
         assertEquals(1, ++count);
         assertEquals("GET", method);
-        assertEquals(
-            "http://metadata/computeMetadata/v1beta1/instance/service-accounts/default/token", url);
-        String content = "{" + "\"access_token\":\"" + ACCESS_TOKEN + "\"," + "\"expires_in\":"
-            + EXPIRES_IN_SECONDS + "," + "\"token_type\":\"" + TOKEN_TYPE + "\"" + "}";
-        return new MockLowLevelHttpRequest(url).setResponse(
-            new MockLowLevelHttpResponse().setContent(content).setContentType(Json.MEDIA_TYPE));
+        assertEquals(URL, url);
+
+        return request;
       }
     };
+
     ComputeCredential cred = new ComputeCredential(transport, new JacksonFactory());
     TokenResponse response = cred.executeRefreshToken();
     assertEquals(ACCESS_TOKEN, response.getAccessToken());
     assertEquals(EXPIRES_IN_SECONDS, response.getExpiresInSeconds().longValue());
     assertEquals(TOKEN_TYPE, response.getTokenType());
+
+    // Verify that the request had the metadata-request header configured properly
+    assertEquals("true", getOnlyElement(request.getHeaderValues(
+        "X-Google-Metadata-Request")));
   }
 }

google-api-client/src/test/java/com/google/api/client/googleapis/testing/json/GoogleJsonResponseExceptionFactoryTestingTest.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2013 Google Inc.
+ *
+ * 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.api.client.googleapis.testing.json;
+
+import com.google.api.client.googleapis.json.GoogleJsonResponseException;
+import com.google.api.client.json.JsonFactory;
+import com.google.api.client.json.jackson.JacksonFactory;
+
+import junit.framework.TestCase;
+
+import java.io.IOException;
+
+/**
+ * Tests {@link GoogleJsonResponseExceptionFactoryTesting}
+ *
+ * @author Eric Mintz
+ */
+public class GoogleJsonResponseExceptionFactoryTestingTest extends TestCase {
+
+  private static final JsonFactory JSON_FACTORY = new JacksonFactory();
+  private static final int HTTP_CODE_NOT_FOUND = 404;
+  private static final String REASON_PHRASE_NOT_FOUND = "NOT FOUND";
+
+  public void testCreateException() throws IOException {
+    GoogleJsonResponseException exception =
+        GoogleJsonResponseExceptionFactoryTesting.newMock(
+            JSON_FACTORY, HTTP_CODE_NOT_FOUND, REASON_PHRASE_NOT_FOUND);
+    assertEquals(HTTP_CODE_NOT_FOUND, exception.getStatusCode());
+    assertEquals(REASON_PHRASE_NOT_FOUND, exception.getStatusMessage());
+  }
+}