Merge branch 'dev' into fadi/server-telemetry

Author: fadidurah

changelog.txt

@@ -1,5 +1,8 @@
 vNext
 ----------
+
+Version 24.1.0
+----------
 - [MINOR] Add sovereign cloud (Bleu/Delos/SovSG) instance discovery support with pre-seeded cloud metadata, cache-aware discovery routing, and ensureCloudDiscoveryForAuthority API (#3027)
 - [PATCH] Fix bug in Authority.getKnownAuthorityResult where cloud discovery failure would skip knownAuthorities check and fix thread safety in Authority.isKnownAuthority and getEquivalentConfiguredAuthority with synchronized block (#3027)
 - [MINOR] Add helper method in the PackageHelper class for BrokerDiscovery (#3044)

common4j/versioning/version.properties

@@ -1,4 +1,4 @@
 #Wed May 12 20:08:39 UTC 2021
-versionName=24.0.1
+versionName=24.1.0
 versionCode=1
 latestPatchVersion=227

uiautomationutilities/src/main/java/com/microsoft/identity/client/ui/automation/broker/BrokerHost.java

@@ -44,11 +44,10 @@
 /**
  * A model for interacting with the BrokerHost app during UI Test.
  * <p>
- * By default all the {@link ITestBroker} operations are performed using the {@link SingleWpjApiFragment} class.
+ * By default all the {@link ITestBroker} operations are performed using the {@link MultipleWpjApiFragment} class.
  * if you want to perform specif broker host operations, you need to call the corresponding fragment class
  * and then call the corresponding method.
  * <p>
- * Legacy WPJ operations are contained in the {@link SingleWpjApiFragment} class.
  * Multiple WPJ operations are contained in the {@link MultipleWpjApiFragment} class.
  * Broker API operations are contained in the {@link BrokerApiFragment} class.
  * Broker Flights operations are contained in the {@link BrokerFlightsFragment} class.
@@ -71,11 +70,8 @@ public class BrokerHost extends AbstractTestBroker {
     public final BrokerFlightsFragment brokerFlightsFragment;
     public final BrokerApiFragment brokerApiFragment;
     @Getter
-    public final SingleWpjApiFragment singleWpjApiFragment;
-    // If you're writing test specifically for MWPJ, use this fragment
-    // the default behavior for brokerHost app is to use the SingleWpjApiFragment
-    @Getter
-    public final MultipleWpjApiFragment multipleWpjApiFragment;
+    private final MultipleWpjApiFragment multipleWpjApiFragment;
+
 
     public BrokerHost() {
         this(BROKER_HOST_APK, BROKER_HOST_APK);
@@ -97,53 +93,49 @@ public BrokerHost(@NonNull final String brokerHostApkName,
         localUpdateApkFileName = updateBrokerHostApkName;
         brokerFlightsFragment = new BrokerFlightsFragment();
         brokerApiFragment = new BrokerApiFragment();
-        singleWpjApiFragment = new SingleWpjApiFragment();
         multipleWpjApiFragment = new MultipleWpjApiFragment(this);
     }
 
     @Override
     public void performDeviceRegistration(@NonNull final String username,
                                           @NonNull final String password) {
-        singleWpjApiFragment.launch();
-        singleWpjApiFragment.performDeviceRegistration(
+        multipleWpjApiFragment.launch();
+        multipleWpjApiFragment.performDeviceRegistration(
                 username,
-                password,
-                false,
-                false,
-                getDefaultBrokerPromptHandlerParameters(username)
+                password
         );
-        final String joinedUpn = singleWpjApiFragment.getWpjAccount();
-        Assert.assertTrue("Assert that the joined account is the expected account", username.equalsIgnoreCase(joinedUpn));
     }
 
     @Override
     public void performDeviceRegistration(@NonNull String username,
                                           @NonNull String password,
                                           boolean isFederatedUser) {
-        singleWpjApiFragment.launch();
-        singleWpjApiFragment.performDeviceRegistration(
+        multipleWpjApiFragment.launch();
+        multipleWpjApiFragment.performDeviceRegistration(
                 username,
                 password,
-                isFederatedUser,
                 false,
-                getDefaultBrokerPromptHandlerParameters(username)
+                false,
+                getDefaultBrokerPromptHandlerParameters(username),
+                isFederatedUser
         );
-        final String joinedUpn = singleWpjApiFragment.getWpjAccount();
+        final String joinedUpn = multipleWpjApiFragment.getRecordByUpn(username).get("Upn");
         Assert.assertTrue("Assert that the joined account is the expected account", username.equalsIgnoreCase(joinedUpn));
     }
 
     @Override
     public void performSharedDeviceRegistration(String username, String password) {
         Logger.i(TAG, "Performing Shared Device Registration for the given account..");
-        singleWpjApiFragment.launch();
-        singleWpjApiFragment.performDeviceRegistration(
+        multipleWpjApiFragment.launch();
+        multipleWpjApiFragment.performDeviceRegistration(
                 username,
                 password,
-                false,
                 true,
-                getDefaultBrokerPromptHandlerParameters(username)
+                true,
+                getDefaultBrokerPromptHandlerParameters(username),
+                false
         );
-        final String joinedUpn = singleWpjApiFragment.getWpjAccount();
+        final String joinedUpn = multipleWpjApiFragment.getRecordByUpn(username).get("Upn");
         Assert.assertTrue("Assert that the joined account is the expected account", username.equalsIgnoreCase(joinedUpn));
     }
 
@@ -156,15 +148,27 @@ public void performSharedDeviceRegistrationDontValidate(@NonNull final String us
     @Nullable
     @Override
     public String obtainDeviceId() {
-        singleWpjApiFragment.launch();
-        return singleWpjApiFragment.getDeviceId();
+        multipleWpjApiFragment.launch();
+        final List<?> records = multipleWpjApiFragment.getAllRecords();
+        if (records == null || records.isEmpty()) {
+            // No WPJ records are available; honor the @Nullable contract.
+            return null;
+        }
+
+        Assert.assertTrue(
+                "Expected exactly one WPJ record when obtaining device id, but found: " + records.size(),
+                records.size() == 1
+        );
+
+        // Safe to access the first record now that we have asserted the size.
+        return (String) ((java.util.Map<?, ?>) records.get(0)).get("DeviceId");
     }
 
     @Override
     public void enableBrowserAccess(@NonNull final String username) {
         Logger.i(TAG, "Enable Browser Access..");
-        singleWpjApiFragment.launch();
-        singleWpjApiFragment.installCertificate();
+        multipleWpjApiFragment.launch();
+        multipleWpjApiFragment.installCertificate(username);
     }
 
     @Override
@@ -183,31 +187,6 @@ public void initialiseAppImpl() {
         // nothing needed here
     }
 
-    @Nullable
-    public String getAccountUpn() {
-        singleWpjApiFragment.launch();
-        return singleWpjApiFragment.getWpjAccount();
-    }
-
-    @Nullable
-    public String getDeviceState() {
-        singleWpjApiFragment.launch();
-        return singleWpjApiFragment.getDeviceState();
-    }
-
-    @Nullable
-    public String getBlob(@NonNull final String tenantId) {
-        Logger.i(TAG, "Get Blob..");
-        singleWpjApiFragment.launch();
-        return singleWpjApiFragment.getBlob(tenantId);
-    }
-
-    @NonNull
-    public String getDeviceToken() {
-        Logger.i(TAG, "Get Device Token..");
-        singleWpjApiFragment.launch();
-        return singleWpjApiFragment.getDeviceToken();
-    }
 
     @Override
     public void overwriteFlights(@NonNull final String flightsJson) {
@@ -233,15 +212,16 @@ public String getFlights() {
     public void performDeviceRegistration(@NonNull final String username,
                                           @NonNull final String password,
                                           @NonNull final PromptHandlerParameters promptHandlerParameters) {
-        singleWpjApiFragment.launch();
-        singleWpjApiFragment.performDeviceRegistration(
+        multipleWpjApiFragment.launch();
+        multipleWpjApiFragment.performDeviceRegistration(
                 username,
                 password,
                 false,
                 false,
-                promptHandlerParameters
+                promptHandlerParameters,
+                false
         );
-        final String joinedUpn = singleWpjApiFragment.getWpjAccount();
+        final String joinedUpn = multipleWpjApiFragment.getRecordByUpn(username).get("Upn");
         Assert.assertTrue("Assert that the joined account is the expected account", username.equalsIgnoreCase(joinedUpn));
     }
 
@@ -277,15 +257,11 @@ public String obtainDeviceIdLegacyApp() {
     }
 
 
-    public void wpjLeave() {
-        singleWpjApiFragment.launch();
-        singleWpjApiFragment.wpjLeave();
+    public void wpjLeave(@NonNull final String username) {
+        multipleWpjApiFragment.launch();
+        multipleWpjApiFragment.unregister(username);
     }
 
-    public void clickJoinTenant(@NonNull final String tenantId) {
-        singleWpjApiFragment.launch();
-        singleWpjApiFragment.clickJoinTenant(tenantId);
-    }
 
     /**
      * Gets all the accounts added

uiautomationutilities/src/main/java/com/microsoft/identity/client/ui/automation/broker/MultipleWpjApiFragment.java

@@ -27,6 +27,7 @@
 import android.widget.TextView;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import androidx.test.platform.app.InstrumentationRegistry;
 import androidx.test.uiautomator.UiDevice;
 import androidx.test.uiautomator.UiObject;
@@ -36,6 +37,7 @@
 import com.microsoft.identity.client.ui.automation.interaction.IPromptHandler;
 import com.microsoft.identity.client.ui.automation.interaction.PromptHandlerParameters;
 import com.microsoft.identity.client.ui.automation.interaction.PromptParameter;
+import com.microsoft.identity.client.ui.automation.interaction.microsoftsts.AdfsPromptHandler;
 import com.microsoft.identity.client.ui.automation.utils.UiAutomatorUtils;
 import com.microsoft.identity.common.java.util.StringUtil;
 import com.microsoft.identity.common.java.util.ThreadUtils;
@@ -215,10 +217,12 @@ public String getBlob(@NonNull final String tenantId) {
      * @param password the password to be used for device registration
      */
     public String performDeviceRegistrationDontValidate(String username, String password) {
-        return performDeviceRegistrationInternal(
+        return performDeviceRegistration(
                 username,
                 password,
                 false,
+                false,
+                null,
                 false
         );
     }
@@ -230,11 +234,13 @@ public String performDeviceRegistrationDontValidate(String username, String pass
      * @param password the password to be used for device registration
      */
     public void performDeviceRegistration(String username, String password) {
-        performDeviceRegistrationInternal(
+        performDeviceRegistration(
                 username,
                 password,
                 false,
-                true
+                true,
+                null,
+                false
         );
     }
 
@@ -245,11 +251,13 @@ public void performDeviceRegistration(String username, String password) {
      * @param password the password to be used for device registration
      */
     public void performSharedDeviceRegistration(String username, String password) {
-        performDeviceRegistrationInternal(
+        performDeviceRegistration(
                 username,
                 password,
                 true,
-                true
+                true,
+                null,
+                false
         );
     }
 
@@ -261,10 +269,13 @@ public void performSharedDeviceRegistration(String username, String password) {
      * @param password                      the password to be used for device registration
      * @param isSharedDevice                true if the device is a shared device
      */
-    private String performDeviceRegistrationInternal(@NonNull final String username,
-                                                     @NonNull final String password,
-                                                     final boolean isSharedDevice,
-                                                     final boolean shouldValidate) {
+    public String performDeviceRegistration(
+            @NonNull final String username,
+            @NonNull final String password,
+            final boolean isSharedDevice,
+            final boolean shouldValidate,
+            @Nullable final PromptHandlerParameters userPromptHandlerParameters,
+            final boolean isFederatedUser) {
         launch();
         fillTextBox(USERNAME_EDIT_TEXT, username);
 
@@ -274,26 +285,37 @@ private String performDeviceRegistrationInternal(@NonNull final String username,
             clickButton(DEVICE_REGISTRATION_BUTTON_ID);
         }
 
-        final PromptHandlerParameters promptHandlerParameters = PromptHandlerParameters.builder()
-                .prompt(PromptParameter.LOGIN)
-                .broker(brokerHost)
-                .consentPageExpected(false)
-                .expectingBrokerAccountChooserActivity(false)
-                .expectingLoginPageAccountPicker(false)
-                .sessionExpected(false)
-                .loginHint(username)
-                .build();
+        final PromptHandlerParameters promptHandlerParameters;
+        if (userPromptHandlerParameters == null) {
+            promptHandlerParameters = PromptHandlerParameters.builder()
+                    .prompt(PromptParameter.LOGIN)
+                    .broker(brokerHost)
+                    .consentPageExpected(false)
+                    .expectingBrokerAccountChooserActivity(false)
+                    .expectingLoginPageAccountPicker(false)
+                    .sessionExpected(false)
+                    .loginHint(username)
+                    .build();
+        } else if (isFederatedUser) {
+            promptHandlerParameters = new AdfsPromptHandler(userPromptHandlerParameters).getParameters();
+        } else {
+            promptHandlerParameters = userPromptHandlerParameters;
+        }
 
 
         final IPromptHandler promptHandler = getPromptHandler(false, promptHandlerParameters);
         promptHandler.handlePrompt(username, password);
         ThreadUtils.sleepSafely(1000,"performDeviceRegistrationInternal", "Waiting for result to be returned from the broker");
         if (shouldValidate) {
-            dismissDialogBoxAndAssertContainsText("SUCCESS");
+            final String dialogText = dismissDialogBoxAndGetText();
+            Assert.assertTrue(
+                    "Expected dialog text to contain 'SUCCESS' but was: " + dialogText,
+                    !StringUtil.isNullOrEmpty(dialogText) && dialogText.contains("SUCCESS")
+            );
+            return dialogText;
         } else {
             return dismissDialogBoxAndGetText();
         }
-        return null;
     }
 
 }