Add clickDialogButton methods for FedCM

cbiesinger · cbiesinger · commit 85e560e9dd64 · 2024-06-04T15:47:52.000-04:00
This builds on commit 7ad44ee The specification for clickdialogbutton is here: https://fedidcg.github.io/FedCM/#webdriver-clickdialogbutton The version that takes an index is specified here: w3c-fedid/FedCM#610 Bug #12088
diff --git a/common/src/web/fedcm/client_metadata.json b/common/src/web/fedcm/client_metadata.json
@@ -1,4 +1,4 @@
 {
-  "privacy_policy_url": "https://rp.example/privacy_policy.html",
-  "terms_of_service_url": "https://rp.example/terms_of_service.html"
+  "privacy_policy_url": "privacy_policy.html",
+  "terms_of_service_url": "terms_of_service.html"
 }
diff --git a/common/src/web/fedcm/privacy_policy.html b/common/src/web/fedcm/privacy_policy.html
@@ -0,0 +1,4 @@
+<!DOCTYPE html>
+<title>Privacy Policy</title>
+
+This is the privacy policy.
diff --git a/java/src/org/openqa/selenium/federatedcredentialmanagement/FederatedCredentialManagementDialog.java b/java/src/org/openqa/selenium/federatedcredentialmanagement/FederatedCredentialManagementDialog.java
@@ -29,6 +29,11 @@ public interface FederatedCredentialManagementDialog {
   String DIALOG_TYPE_ACCOUNT_LIST = "AccountChooser";
   String DIALOG_TYPE_AUTO_REAUTH = "AutoReauthn";
 
+  String BUTTON_CONFIRM_IDP_LOGIN_CONTINUE = "ConfirmIdpLoginContinue";
+  // The following buttons need an account index.
+  String BUTTON_TERMS_OF_SERVICE = "TermsOfService";
+  String BUTTON_PRIVACY_POLICY = "PrivacyPolicy";
+
   /** Closes the dialog as if the user had clicked X. */
   void cancelDialog();
 
@@ -58,4 +63,19 @@ public interface FederatedCredentialManagementDialog {
    * <p>If this is an auto reauth dialog, returns the single account that is being signed in.
    */
   List<FederatedCredentialManagementAccount> getAccounts();
+
+  /**
+   * Clicks a button on the dialog.
+   *
+   * @param button The button to click.
+   */
+  void clickButton(String button);
+
+  /**
+   * Clicks a button on the dialog that requires an account index.
+   *
+   * @param button The button to click.
+   * @param index The account index, if needed by the specified button.
+   */
+  void clickButton(String button, int index);
 }
diff --git a/java/src/org/openqa/selenium/remote/FedCmDialogImpl.java b/java/src/org/openqa/selenium/remote/FedCmDialogImpl.java
@@ -70,4 +70,15 @@ public List<FederatedCredentialManagementAccount> getAccounts() {
     }
     return accounts;
   }
+
+  @Override
+  public void clickButton(String button) {
+    executeMethod.execute(DriverCommand.CLICK_DIALOG, Map.of("dialogButton", button));
+  }
+
+  @Override
+  public void clickButton(String button, int index) {
+    executeMethod.execute(DriverCommand.CLICK_DIALOG,
+        Map.of("dialogButton", button, "index", index));
+  }
 }
diff --git a/java/test/org/openqa/selenium/federatedcredentialmanagement/FederatedCredentialManagementTest.java b/java/test/org/openqa/selenium/federatedcredentialmanagement/FederatedCredentialManagementTest.java
@@ -138,4 +138,31 @@ void testSelectAccount() {
     response = jsAwareDriver.executeScript("return await promise");
     assertThat(response).asInstanceOf(MAP).containsEntry("token", "a token");
   }
+
+  void testClickDialogButton() {
+    fedcmDriver.setDelayEnabled(false);
+    assertNull(fedcmDriver.getFederatedCredentialManagementDialog());
+
+    Object response = triggerFedCm();
+
+    waitForDialog();
+
+    FederatedCredentialManagementDialog dialog =
+        fedcmDriver.getFederatedCredentialManagementDialog();
+
+    assertEquals("Sign in to localhost with localhost", dialog.getTitle());
+    assertEquals("AccountChooser", dialog.getDialogType());
+
+    dialog.clickButton(dialog.BUTTON_PRIVACY_POLICY);
+    int windowCount = localDriver.getWindowHandles().size();
+    WebDriverWait wait = new WebDriverWait(localDriver, Duration.ofSeconds(5));
+    wait.until(
+        driver ->
+            driver.getWindowHandles().size() > windowCount);
+
+    dialog.selectAccount(0);
+
+    response = jsAwareDriver.executeScript("return await promise");
+    assertThat(response).asInstanceOf(MAP).containsEntry("token", "a token");
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "privacy_policy_url": "https://rp.example/privacy_policy.html",`
`3`		`- "terms_of_service_url": "https://rp.example/terms_of_service.html"`
	`2`	`+ "privacy_policy_url": "privacy_policy.html",`
	`3`	`+ "terms_of_service_url": "terms_of_service.html"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -70,4 +70,15 @@ public List<FederatedCredentialManagementAccount> getAccounts() {`
`70`	`70`	`}`
`71`	`71`	`return accounts;`
`72`	`72`	`}`
	`73`	`+`
	`74`	`+ @Override`
	`75`	`+ public void clickButton(String button) {`
	`76`	`+ executeMethod.execute(DriverCommand.CLICK_DIALOG, Map.of("dialogButton", button));`
	`77`	`+ }`
	`78`	`+`
	`79`	`+ @Override`
	`80`	`+ public void clickButton(String button, int index) {`
	`81`	`+ executeMethod.execute(DriverCommand.CLICK_DIALOG,`
	`82`	`+ Map.of("dialogButton", button, "index", index));`
	`83`	`+ }`
`73`	`84`	`}`