Merge pull request #821 from watson-developer-cloud/jdni-service-url

Retrieve service URL from JDNI

Author: germanattanasio

core/src/main/java/com/ibm/watson/developer_cloud/util/CredentialUtils.java

@@ -12,6 +12,7 @@
  */
 package com.ibm.watson.developer_cloud.util;
 
+import java.util.Hashtable;
 import java.util.Map.Entry;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -91,6 +92,9 @@ public String getUsername() {
   /** The services. */
   private static String services;
 
+  /** The context. */
+  private static Context context;
+
   /** The Constant USERNAME. */
   private static final String USERNAME = "username";
 
@@ -109,26 +113,46 @@ public String getUsername() {
   /** The Constant API_KEY. */
   private static final String API_KEY = "api_key";
 
+  /** The Constant LOOKUP_NAME_EXTENSION_API_KEY. */
+  private static final String LOOKUP_NAME_EXTENSION_API_KEY = "/credentials";
+
+  /** The Constant LOOKUP_NAME_EXTENSION_URL. */
+  private static final String LOOKUP_NAME_EXTENSION_URL = "/url";
+
   private CredentialUtils() {
     // This is a utility class - no instantiation allowed.
   }
 
   /**
-   * Attempt to get the Base64-encoded API key through JNDI.
+   * Builds the lookup name to be searched for in JDNI
+   * and uses it to call the overloaded JDNI method.
+   *
+   * @param serviceName Name of the bluemix service
+   * @param lookupNameExtension Extension to determine which value should be retrieved through JDNI
+   * @return The encoded desired value
+   */
+  private static String getJDNIValue(String serviceName, String lookupNameExtension) {
+    return getJDNIValue("watson-developer-cloud/" + serviceName + lookupNameExtension);
+  }
+
+  /**
+   * Attempt to get the Base64-encoded value through JNDI.
    *
    * This method should always return null on Android due to the javax functions being unsupported
    *
-   * @param serviceName Name of the bluemix service
-   * @return The encoded API Key
+   * @param lookupName Key to lookup in JDNI
+   * @return The encoded desired value
    */
-  private static String getKeyUsingJNDI(String serviceName) {
+  private static String getJDNIValue(String lookupName) {
     if (!isClassAvailable("javax.naming.Context") || !isClassAvailable("javax.naming.InitialContext")) {
       log.info("JNDI string lookups is not available.");
       return null;
     }
-    String lookupName = "watson-developer-cloud/" + serviceName + "/credentials";
+
     try {
-      Context context = new InitialContext();
+      if (context == null) {
+        context = new InitialContext();
+      }
       return (String) context.lookup(lookupName);
     } catch (Exception e) {
       log.fine("JNDI " + lookupName + " not found.");
@@ -192,7 +216,7 @@ public static String getAPIKey(String serviceName, String plan) {
 
     final JsonObject services = getVCAPServices();
     if (services == null) {
-      return getKeyUsingJNDI(serviceName);
+      return getJDNIValue(serviceName, LOOKUP_NAME_EXTENSION_API_KEY);
     }
     if (serviceName.equalsIgnoreCase(ALCHEMY_API)) {
       final JsonObject credentials = getCredentialsObject(services, serviceName, plan);
@@ -299,12 +323,12 @@ public static String getAPIUrl(String serviceName) {
   }
 
   /**
-   * Returns the apiKey from the VCAP_SERVICES or null if doesn't exists. If plan is specified, then only credentials
-   * for the given plan will be returned.
+   * Returns the API URL from the VCAP_SERVICES, JDNI, or null if doesn't exists. If plan is specified, then only
+   * credentials for the given plan will be returned.
    *
    * @param serviceName the service name
    * @param plan the service plan: standard, free or experimental
-   * @return the API key
+   * @return the API URL
    */
   public static String getAPIUrl(String serviceName, String plan) {
     if ((serviceName == null) || serviceName.isEmpty()) {
@@ -313,7 +337,7 @@ public static String getAPIUrl(String serviceName, String plan) {
 
     final JsonObject services = getVCAPServices();
     if (services == null) {
-      return null;
+      return getJDNIValue(serviceName, LOOKUP_NAME_EXTENSION_URL);
     }
 
     final JsonObject credentials = getCredentialsObject(services, serviceName, plan);
@@ -332,4 +356,32 @@ public static String getAPIUrl(String serviceName, String plan) {
   public static void setServices(String services) {
     CredentialUtils.services = services;
   }
+
+  /**
+   * Sets the context variable for JDNI. This is a utility method for testing.
+   *
+   * @param env Configuration options for the context
+   */
+  public static void setContext(Hashtable<String, String> env) {
+    try {
+      CredentialUtils.context = new InitialContext(env);
+    } catch (Exception e) {
+      log.fine("Error setting up JDNI context: " + e.getMessage());
+    }
+  }
+
+  /**
+   * Method for testing the getAPIUrl method that bypasses the VCAP
+   * services to ensure retrieval from JDNI.
+   *
+   * @param serviceName the service name
+   * @return the API URL
+   */
+  public static String getAPIUrlTest(String serviceName) {
+    if ((serviceName == null) || serviceName.isEmpty()) {
+      return null;
+    }
+
+    return getJDNIValue("jdni/watson-developer-cloud/" + serviceName + LOOKUP_NAME_EXTENSION_URL);
+  }
 }

core/src/test/java/com/ibm/watson/developer_cloud/util/CredentialUtilsTest.java

@@ -15,8 +15,10 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assume.assumeTrue;
 
 import java.io.InputStream;
+import java.util.Hashtable;
 
 import org.junit.Assert;
 import org.junit.Before;
@@ -50,6 +52,8 @@ public class CredentialUtilsTest extends WatsonServiceTest {
 
   private static final String VISUAL_RECOGNITION = "watson_vision_combined";
 
+  private static final String PERSONALITY_INSIGHTS_URL = "https://gateway.watsonplatform.net/personality-insights/api";
+
   /**
    * Setup.
    */
@@ -58,6 +62,13 @@ public void setup() {
     final InputStream in = Thread.currentThread().getContextClassLoader().getResourceAsStream(VCAP_SERVICES);
     final String vcapServices = getStringFromInputStream(in);
     CredentialUtils.setServices(vcapServices);
+
+    final Hashtable<String, String> env = new Hashtable<>();
+    env.put("java.naming.factory.initial", "org.osjava.sj.SimpleContextFactory");
+    env.put("org.osjava.sj.delimiter", "/");
+    env.put("org.osjava.sj.root", "src/test/resources");
+
+    CredentialUtils.setContext(env);
   }
 
   /**
@@ -113,4 +124,14 @@ public void testGetUserCredentialsWithPlan() {
     assertEquals(credentials.getUsername(), NOT_A_USERNAME);
     assertEquals(credentials.getPassword(), NOT_A_PASSWORD);
   }
+
+  /**
+   * Test getting the API URL using JDNI. We ignore this test in Travis because
+   * it always fails there.
+   */
+  @Test
+  public void testGetAPIUrlFromJDNI() {
+    assumeTrue(!System.getenv().containsKey("TRAVIS"));
+    assertEquals(CredentialUtils.getAPIUrlTest(SERVICE_NAME), PERSONALITY_INSIGHTS_URL);
+  }
 }

core/src/test/resources/jdni.properties

@@ -0,0 +1 @@
+watson-developer-cloud/personality_insights/url=https://gateway.watsonplatform.net/personality-insights/api