Load integration test credentials from well-known files (firebase#84)

hiranya911 · web-flow · commit 30a0e5b4a06e · 2017-10-09T11:49:00.000-07:00
* Load integration test credentials from well-known files

* Updated documentation

* Updated documentation

* Updated error messages
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,5 @@ target/
 .project
 .checkstyle
 release.properties
+integration_cert.json
+integration_apikey.txt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -130,21 +130,20 @@ Integration tests are also written using Junit4. They coexist with the unit test
 subdirectory. Integration tests follow the naming convention `*IT.java` (e.g. `DataTestIT.java`),
 which enables the Maven Surefire and Failsafe plugins to differentiate between the two types of
 tests. Integration tests are executed against a real life Firebase project, and therefore
-requires an Internet connection. Create a new project in the
-[Firebase console](https://console.firebase.google.com/) if you do not already have one. Use a 
-separate, dedicated project for integration tests since the test suite makes a large number of
-writes to the Firebase realtime database. Download the service account private key from the 
-"Settings > Service Accounts" page of the project. Also obtain the web API key of the project
-from the "Settings > General" page. Now run the following command to invoke the integration
-test suite:
+requires an Internet connection.
+
+Create a new project in the [Firebase console](https://console.firebase.google.com/) if you do
+not already have one. Use a separate, dedicated project for integration tests since the test suite
+makes a large number of writes to the Firebase realtime database. Download the service account
+private key from the "Settings > Service Accounts" page of the project, and save it as
+`integration_cert.json` at the root of the codebase. Also obtain the web API key of the project
+from the "Settings > General" page, and save it as `integration_apikey.txt` at the root of the
+codebase. Now run the following command to invoke the integration test suite:
 
 ```
-mvn verify -Dfirebase.it.certificate=path/to/serviceAccount.json -Dfirebase.it.apikey=API-Key
+mvn verify
 ```
 
-Make sure to specify the correct path to your downloaded service account key file as the
-`firebase.it.certificate` system property. 
-
 The above command invokes both unit and integration test suites. To execute only the integration
 tests, specify the `-DskipUTs` flag.
 
diff --git a/src/test/java/com/google/firebase/testing/IntegrationTestUtils.java b/src/test/java/com/google/firebase/testing/IntegrationTestUtils.java
@@ -16,10 +16,10 @@
 
 package com.google.firebase.testing;
 
-import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkNotNull;
 
-import com.google.common.base.Strings;
+import com.google.api.client.googleapis.util.Utils;
+import com.google.api.client.json.GenericJson;
 import com.google.common.collect.ImmutableList;
 import com.google.common.io.CharStreams;
 import com.google.firebase.FirebaseApp;
@@ -40,26 +40,28 @@
 import org.apache.http.entity.StringEntity;
 import org.apache.http.impl.client.DefaultHttpClient;
 import org.apache.http.util.EntityUtils;
-import org.json.JSONObject;
 
 public class IntegrationTestUtils {
 
-  private static JSONObject IT_SERVICE_ACCOUNT;
+  private static final String IT_SERVICE_ACCOUNT_PATH = "integration_cert.json";
+  private static final String IT_API_KEY_PATH = "integration_apikey.txt";
+
+  private static GenericJson serviceAccount;
+  private static String apiKey;
   private static FirebaseApp masterApp;
 
-  private static synchronized JSONObject ensureServiceAccount() {
-    if (IT_SERVICE_ACCOUNT == null) {
-      String certificatePath = System.getProperty("firebase.it.certificate");
-      checkArgument(!Strings.isNullOrEmpty(certificatePath),
-          "Service account certificate path not set. Set the "
-              + "firebase.it.certificate system property and try again.");
-      try (InputStreamReader reader = new InputStreamReader(new FileInputStream(certificatePath))) {
-        IT_SERVICE_ACCOUNT = new JSONObject(CharStreams.toString(reader));
+  private static synchronized GenericJson ensureServiceAccount() {
+    if (serviceAccount == null) {
+      try (InputStream stream = new FileInputStream(IT_SERVICE_ACCOUNT_PATH)) {
+        serviceAccount = Utils.getDefaultJsonFactory().fromInputStream(stream, GenericJson.class);
       } catch (IOException e) {
-        throw new RuntimeException("Failed to read service account certificate", e);
+        String msg = String.format("Failed to read service account certificate from %s. "
+            + "Integration tests require a service account credential obtained from a Firebase "
+            + "project. See CONTRIBUTING.md for more details.", IT_SERVICE_ACCOUNT_PATH);
+        throw new RuntimeException(msg, e);
       }
     }
-    return IT_SERVICE_ACCOUNT;
+    return serviceAccount;
   }
 
   public static InputStream getServiceAccountCertificate() {
@@ -78,10 +80,17 @@ public static String getStorageBucket() {
     return getProjectId() + ".appspot.com";
   }
 
-  public static String getApiKey() {
-    String apiKey = System.getProperty("firebase.it.apikey");
-    checkArgument(!Strings.isNullOrEmpty(apiKey), "API key not specified. Set the "
-        + "firebase.it.apikey system property and try again.");
+  public static synchronized String getApiKey() {
+    if (apiKey == null) {
+      try (InputStream stream = new FileInputStream(IT_API_KEY_PATH)) {
+        apiKey = CharStreams.toString(new InputStreamReader(stream)).trim();
+      } catch (IOException e) {
+        String msg = String.format("Failed to read API key from %s. "
+            + "Integration tests require an API key obtained from a Firebase "
+            + "project. See CONTRIBUTING.md for more details.", IT_API_KEY_PATH);
+        throw new RuntimeException(msg, e);
+      }
+    }
     return apiKey;
   }
 
