Support for setting up Server Url in the Manifest (#600)

hermanliang · rogerhu · commit fedb7ef5e65d · 2017-03-16T18:40:25.000-07:00
* Supports setting Server Url in Manifest

* Add test and update JavaDoc

* remove redundant null assignment

* using Roboelectric to mock Context &amp; PackageManager
add testConfigureFromManifestWithoutClientKey

* minor optimization for unit test &amp; update Javadoc
diff --git a/Parse/src/main/java/com/parse/Parse.java b/Parse/src/main/java/com/parse/Parse.java
@@ -51,7 +51,7 @@ public static final class Builder {
       private Context context;
       private String applicationId;
       private String clientKey;
-      private String server = "https://api.parse.com/1/";
+      private String server;
       private boolean localDataStoreEnabled;
       private List<ParseNetworkInterceptor> interceptors;
 
@@ -62,7 +62,7 @@ public static final class Builder {
        * initialization.
        *
        * <p/>
-       * You may define {@code com.parse.APPLICATION_ID} and {@code com.parse.CLIENT_KEY}
+       * You may define {@code com.parse.SERVER_URL}, {@code com.parse.APPLICATION_ID} and (optional) {@code com.parse.CLIENT_KEY}
        * {@code meta-data} in your {@code AndroidManifest.xml}:
        * <pre>
        * &lt;manifest ...&gt;
@@ -71,6 +71,9 @@ public static final class Builder {
        *
        *   &lt;application ...&gt;
        *     &lt;meta-data
+       *       android:name="com.parse.SERVER_URL"
+       *       android:value="@string/parse_server_url" /&gt;
+       *     &lt;meta-data
        *       android:name="com.parse.APPLICATION_ID"
        *       android:value="@string/parse_app_id" /&gt;
        *     &lt;meta-data
@@ -84,7 +87,7 @@ public static final class Builder {
        * </pre>
        * <p/>
        *
-       * This will cause the values for {@code applicationId} and {@code clientKey} to be set to
+       * This will cause the values for {@code server}, {@code applicationId} and {@code clientKey} to be set to
        * those defined in your manifest.
        *
        * @param context The active {@link Context} for your application. Cannot be null.
@@ -98,6 +101,7 @@ public Builder(Context context) {
           Context applicationContext = context.getApplicationContext();
           Bundle metaData = ManifestInfo.getApplicationMetadata(applicationContext);
           if (metaData != null) {
+            server(metaData.getString(PARSE_SERVER_URL));
             applicationId = metaData.getString(PARSE_APPLICATION_ID);
             clientKey = metaData.getString(PARSE_CLIENT_KEY);
           }
@@ -145,7 +149,7 @@ public Builder server(String server) {
 
         // Add an extra trailing slash so that Parse REST commands include
         // the path as part of the server URL (i.e. http://api.myhost.com/parse)
-        if (server.endsWith("/") == false) {
+        if (server != null && !server.endsWith("/")) {
           server = server + "/";
         }
 
@@ -223,6 +227,7 @@ private Configuration(Builder builder) {
     }
   }
 
+  private static final String PARSE_SERVER_URL = "com.parse.SERVER_URL";
   private static final String PARSE_APPLICATION_ID = "com.parse.APPLICATION_ID";
   private static final String PARSE_CLIENT_KEY = "com.parse.CLIENT_KEY";
 
@@ -284,7 +289,7 @@ public static void enableLocalDatastore(Context context) {
   /**
    * Authenticates this client as belonging to your application.
    * <p/>
-   * You must define {@code com.parse.APPLICATION_ID} and {@code com.parse.CLIENT_KEY}
+   * You may define {@code com.parse.SERVER_URL}, {@code com.parse.APPLICATION_ID} and (optional) {@code com.parse.CLIENT_KEY}
    * {@code meta-data} in your {@code AndroidManifest.xml}:
    * <pre>
    * &lt;manifest ...&gt;
@@ -293,6 +298,9 @@ public static void enableLocalDatastore(Context context) {
    *
    *   &lt;application ...&gt;
    *     &lt;meta-data
+   *       android:name="com.parse.SERVER_URL"
+   *       android:value="@string/parse_server_url" /&gt;
+   *     &lt;meta-data
    *       android:name="com.parse.APPLICATION_ID"
    *       android:value="@string/parse_app_id" /&gt;
    *     &lt;meta-data
@@ -322,18 +330,18 @@ public static void enableLocalDatastore(Context context) {
    */
   public static void initialize(Context context) {
     Configuration.Builder builder = new Configuration.Builder(context);
-    if (builder.applicationId == null) {
+    if (builder.server == null) {
+      throw new RuntimeException("ServerUrl not defined. " +
+          "You must provide ServerUrl in AndroidManifest.xml.\n" +
+          "<meta-data\n" +
+          "    android:name=\"com.parse.SERVER_URL\"\n" +
+          "    android:value=\"<Your Server Url>\" />");
+    } if (builder.applicationId == null) {
       throw new RuntimeException("ApplicationId not defined. " +
         "You must provide ApplicationId in AndroidManifest.xml.\n" +
         "<meta-data\n" +
         "    android:name=\"com.parse.APPLICATION_ID\"\n" +
         "    android:value=\"<Your Application Id>\" />");
-    } if (builder.clientKey == null) {
-      throw new RuntimeException("ClientKey not defined. " +
-        "You must provide ClientKey in AndroidManifest.xml.\n" +
-        "<meta-data\n" +
-        "    android:name=\"com.parse.CLIENT_KEY\"\n" +
-        "    android:value=\"<Your Client Key>\" />");
     }
     initialize(builder.setNetworkInterceptors(interceptors)
         .setLocalDatastoreEnabled(isLocalDatastoreEnabled)
diff --git a/Parse/src/test/java/com/parse/ParseClientConfigurationTest.java b/Parse/src/test/java/com/parse/ParseClientConfigurationTest.java
@@ -8,10 +8,20 @@
  */
 package com.parse;
 
+import android.content.pm.ApplicationInfo;
+import android.content.pm.PackageManager;
+import android.os.Bundle;
+
 import com.parse.http.ParseNetworkInterceptor;
 
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.robolectric.RobolectricTestRunner;
+import org.robolectric.RuntimeEnvironment;
+import org.robolectric.annotation.Config;
+import org.robolectric.shadows.ShadowPackageManager;
 
+import java.net.URL;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;
@@ -22,9 +32,21 @@
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.robolectric.Shadows.shadowOf;
 
+@RunWith(RobolectricTestRunner.class)
+@Config(constants = BuildConfig.class)
 public class ParseClientConfigurationTest {
 
+  private final String serverUrl = "http://example.com/parse";
+  private final String appId = "MyAppId";
+  private final String clientKey = "MyClientKey";
+  private final String PARSE_SERVER_URL = "com.parse.SERVER_URL";
+  private final String PARSE_APPLICATION_ID = "com.parse.APPLICATION_ID";
+  private final String PARSE_CLIENT_KEY = "com.parse.CLIENT_KEY";
+
   @Test
   public void testBuilder() {
     Parse.Configuration.Builder builder = new Parse.Configuration.Builder(null);
@@ -105,6 +127,75 @@ public void testSetNetworkInterceptors() {
     assertTrue(collectionsEqual(configurationB.interceptors, collectionB));
   }
 
+  @Test
+  public void testConfigureFromManifest() throws Exception {
+    Bundle metaData = setupMockMetaData();
+    when(metaData.getString(PARSE_SERVER_URL)).thenReturn(serverUrl);
+    when(metaData.getString(PARSE_APPLICATION_ID)).thenReturn(appId);
+    when(metaData.getString(PARSE_CLIENT_KEY)).thenReturn(clientKey);
+
+    Parse.Configuration.Builder builder = new Parse.Configuration.Builder(RuntimeEnvironment.application);
+    Parse.Configuration config = builder.build();
+    assertEquals(serverUrl + "/", config.server);
+    assertEquals(appId, config.applicationId);
+    assertEquals(clientKey, config.clientKey);
+
+    verifyMockMetaData(metaData);
+  }
+
+  @Test(expected = RuntimeException.class)
+  public void testConfigureFromManifestWithoutServer() throws Exception {
+    Bundle metaData = setupMockMetaData();
+    when(metaData.getString(PARSE_SERVER_URL)).thenReturn(null);
+    when(metaData.getString(PARSE_APPLICATION_ID)).thenReturn(appId);
+    when(metaData.getString(PARSE_CLIENT_KEY)).thenReturn(clientKey);
+
+    // RuntimeException due to serverUrl = null
+    Parse.initialize(RuntimeEnvironment.application);
+  }
+
+  @Test(expected = RuntimeException.class)
+  public void testConfigureFromManifestWithoutAppId() throws Exception {
+    Bundle metaData = setupMockMetaData();
+    when(metaData.getString(PARSE_SERVER_URL)).thenReturn(serverUrl);
+    when(metaData.getString(PARSE_APPLICATION_ID)).thenReturn(null);
+    when(metaData.getString(PARSE_CLIENT_KEY)).thenReturn(clientKey);
+
+    // RuntimeException due to applicationId = null
+    Parse.initialize(RuntimeEnvironment.application);
+  }
+
+  @Test
+  public void testConfigureFromManifestWithoutClientKey() throws Exception {
+    Bundle metaData = setupMockMetaData();
+    when(metaData.getString(PARSE_SERVER_URL)).thenReturn(serverUrl);
+    when(metaData.getString(PARSE_APPLICATION_ID)).thenReturn(appId);
+    when(metaData.getString(PARSE_CLIENT_KEY)).thenReturn(null);
+
+    Parse.initialize(RuntimeEnvironment.application);
+    assertEquals(new URL(serverUrl + "/"), ParseRESTCommand.server);
+    assertEquals(appId, ParsePlugins.get().applicationId());
+    assertNull(ParsePlugins.get().clientKey());
+
+    verifyMockMetaData(metaData);
+  }
+
+  private void verifyMockMetaData(Bundle metaData) throws Exception {
+    verify(metaData).getString(PARSE_SERVER_URL);
+    verify(metaData).getString(PARSE_APPLICATION_ID);
+    verify(metaData).getString(PARSE_CLIENT_KEY);
+  }
+
+  private Bundle setupMockMetaData() throws Exception {
+    Bundle metaData = mock(Bundle.class);
+    ShadowPackageManager packageManager = shadowOf(RuntimeEnvironment.application.getPackageManager());
+    ApplicationInfo info = packageManager.getApplicationInfo(
+        RuntimeEnvironment.application.getPackageName(),
+        PackageManager.GET_META_DATA);
+    info.metaData = metaData;
+    return metaData;
+  }
+
   private static <T> boolean collectionsEqual(Collection<T> a, Collection<T> b) {
     if (a.size() != b.size()) {
       return false;
diff --git a/ParseStarterProject/src/main/AndroidManifest.xml b/ParseStarterProject/src/main/AndroidManifest.xml
@@ -19,6 +19,9 @@
         android:icon="@mipmap/ic_launcher"
         android:label="@string/app_name"
         android:theme="@style/AppTheme" >
+        <meta-data
+            android:name="com.parse.SERVER_URL"
+            android:value="@string/parse_server_url" />
         <meta-data
             android:name="com.parse.APPLICATION_ID"
             android:value="@string/parse_app_id" />
diff --git a/ParseStarterProject/src/main/res/values/strings.xml b/ParseStarterProject/src/main/res/values/strings.xml
@@ -8,6 +8,7 @@
   ~ of patent rights can be found in the PATENTS file in the same directory.
   -->
 <resources>
+    <string name="parse_server_url">YOUR_SERVER_URL</string>
     <string name="parse_app_id">YOUR_APPLICATION_ID</string>
     <string name="parse_client_key">YOUR_CLIENT_KEY</string>
 
