update client to make it capable of calling oneauth upn json

Author: fadidurah

LabApiUtilities/src/main/com/microsoft/identity/labapi/utilities/client/LabClient.java

@@ -73,6 +73,7 @@ public class LabClient implements ILabClient {
     public static final long TEMP_USER_WAIT_TIME = TimeUnit.SECONDS.toMillis(35);
 
     private static final String ACCOUNT_UPN_JSON_STRING_SECRET_NAME = "Android-ID4SLAB2-User-Identifiers";
+    private String mAlternativeUpnJsonStringSecretName;
     private Map<String, LabJsonStringAccountEntry> labUPNJsonMap = null;
 
     /**
@@ -108,6 +109,18 @@ private static void setLatestLabAccount(final ILabAccount account) {
         latestLabAccount = account;
     }
 
+    /**
+     * This method allows tests to specify an alternative secret name for the UPN JSON string in Key Vault,
+     * as the default points specifically to Android Team's upn json. T
+     *
+     * IF YOU ARE THE ONEAUTH TEAM, PLEASE USE THIS METHOD TO POINT TO YOUR OWN JSON SECRET NAME
+     *
+     * @param secretName The name of the alternative Key Vault secret to use for fetching the UPN JSON string.
+     */
+    public void setAccountUpnJsonStringSecretName(final String secretName) {
+        mAlternativeUpnJsonStringSecretName = secretName;
+    }
+
     @Override
     public ILabAccount getLabAccount(@NonNull final LabQuery labQuery) throws LabApiException {
         // Adding a second attempt here, api sometimes fails to fetch the user.
@@ -375,8 +388,15 @@ public Map<String, LabJsonStringAccountEntry> getAccountMapJsonFromMobileBuildKe
         );
         final KeyVaultSecretsApi keyVaultSecretsApi = new KeyVaultSecretsApi(KeyVaultSecretsApi.MOBILE_BUILD_VAULT_URL);
 
+        final String keyvaultSecret;
+        if (mAlternativeUpnJsonStringSecretName != null && !mAlternativeUpnJsonStringSecretName.isEmpty()) {
+            keyvaultSecret = mAlternativeUpnJsonStringSecretName;
+        } else {
+            keyvaultSecret = ACCOUNT_UPN_JSON_STRING_SECRET_NAME;
+        }
+
         try {
-            final SecretBundle secretBundle = keyVaultSecretsApi.getKeyVaultSecret(ACCOUNT_UPN_JSON_STRING_SECRET_NAME);
+            final SecretBundle secretBundle = keyVaultSecretsApi.getKeyVaultSecret(keyvaultSecret);
 
             labUPNJsonMap = LabJsonStringAccountEntry.parseJsonToMap(secretBundle.getValue());
             return labUPNJsonMap;

LabApiUtilities/src/main/com/microsoft/identity/labapi/utilities/client/LabJsonStringAccountEntry.java

@@ -24,11 +24,20 @@
 package com.microsoft.identity.labapi.utilities.client;
 
 import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonDeserializationContext;
+import com.google.gson.JsonDeserializer;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParseException;
 import com.google.gson.annotations.SerializedName;
 import com.google.gson.reflect.TypeToken;
 
 import java.io.Serializable;
+import java.lang.reflect.Field;
 import java.lang.reflect.Type;
+import java.util.HashMap;
+import java.util.Locale;
 import java.util.Map;
 
 import lombok.Getter;
@@ -70,8 +79,48 @@ public class LabJsonStringAccountEntry implements Serializable {
      * @return a map of key to LabJsonStringAccountEntry
      */
     public static Map<String, LabJsonStringAccountEntry> parseJsonToMap(String json) {
-        Gson gson = new Gson();
+        final Gson gson = new GsonBuilder()
+                .registerTypeAdapter(LabJsonStringAccountEntry.class, new CaseInsensitiveDeserializer())
+                .create();
         Type type = new TypeToken<Map<String, LabJsonStringAccountEntry>>(){}.getType();
         return gson.fromJson(json, type);
     }
+
+    /**
+     * Gson deserializer that matches JSON property names to {@link SerializedName} values
+     * in a case-insensitive manner, so {@code upn}, {@code Upn} and {@code UPN} are all
+     * treated as the same field.
+     */
+    private static class CaseInsensitiveDeserializer implements JsonDeserializer<LabJsonStringAccountEntry> {
+        @Override
+        public LabJsonStringAccountEntry deserialize(JsonElement json, Type typeOfT,
+                                                     JsonDeserializationContext context) throws JsonParseException {
+            final JsonObject src = json.getAsJsonObject();
+
+            // Build a lowercase-keyed view of the incoming JSON object.
+            final Map<String, JsonElement> lowerCased = new HashMap<>();
+            for (Map.Entry<String, JsonElement> e : src.entrySet()) {
+                lowerCased.put(e.getKey().toLowerCase(Locale.ROOT), e.getValue());
+            }
+
+            final LabJsonStringAccountEntry result = new LabJsonStringAccountEntry();
+            for (Field field : LabJsonStringAccountEntry.class.getDeclaredFields()) {
+                final SerializedName annotation = field.getAnnotation(SerializedName.class);
+                if (annotation == null) {
+                    continue;
+                }
+                final JsonElement value = lowerCased.get(annotation.value().toLowerCase(Locale.ROOT));
+                if (value == null || value.isJsonNull()) {
+                    continue;
+                }
+                try {
+                    field.setAccessible(true);
+                    field.set(result, context.deserialize(value, field.getGenericType()));
+                } catch (IllegalAccessException ex) {
+                    throw new JsonParseException("Failed to set field " + field.getName(), ex);
+                }
+            }
+            return result;
+        }
+    }
 }

LabApiUtilities/src/test/com/microsoft/identity/labapi/utilities/client/LabClientTest.java

@@ -209,6 +209,17 @@ public void canFetchAccountUpnJsonStringOtherAccounts() {
         }
     }
 
+    @Test
+    public void canFetchAccountFromDifferentJson() {
+        try {
+            mLabClient.setAccountUpnJsonStringSecretName("OneAuth-ID4SLAB2-User-Identifiers");
+            final ILabAccount labAccount = mLabClient.getAccountFromLabJsonStringInMobileBuildVault(UserType.BASIC);
+            assertLabAccount(labAccount, UserType.BASIC, DEFAULT_LAB_NAME);
+        } catch (final LabApiException e) {
+            throw new AssertionError(e);
+        }
+    }
+
     // Helper to assert common properties of a lab account
     private void assertLabAccount(final ILabAccount labAccount,
                                   final UserType expectedUserType,