From 20a8cd95d77193e784a6b9c4ecb3d50008fed5fa Mon Sep 17 00:00:00 2001
From: Julian Descottes <jdescottes@mozilla.com>
Date: Fri, 15 Jan 2021 08:55:47 +0000
Subject: [PATCH] Bug 1685291 - [marionette] Add test for sendKeys with context
 menus r=marionette-reviewers,whimboo

Depends on D101046

Differential Revision: https://phabricator.services.mozilla.com/D101152
---
 .../static/browser_all_files_referenced.js    |   1 +
 .../marionette/chrome/test_menupopup.xhtml    |  30 +++++
 .../unit/test_sendkeys_menupopup_chrome.py    | 115 ++++++++++++++++++
 .../tests/unit/unit-tests.ini                 |   2 +
 testing/marionette/jar.mn                     |   1 +
 5 files changed, 149 insertions(+)
 create mode 100644 testing/marionette/chrome/test_menupopup.xhtml
 create mode 100644 testing/marionette/harness/marionette_harness/tests/unit/test_sendkeys_menupopup_chrome.py

diff --git a/browser/base/content/test/static/browser_all_files_referenced.js b/browser/base/content/test/static/browser_all_files_referenced.js
index 3710f02e1d93..109a4a772a8d 100644
--- a/browser/base/content/test/static/browser_all_files_referenced.js
+++ b/browser/base/content/test/static/browser_all_files_referenced.js
@@ -174,6 +174,7 @@ var whitelist = [
   { file: "chrome://marionette/content/test.xhtml" },
   { file: "chrome://marionette/content/test_dialog.properties" },
   { file: "chrome://marionette/content/test_dialog.xhtml" },
+  { file: "chrome://marionette/content/test_menupopup.xhtml" },
   // Bug 1348559
   { file: "chrome://pippki/content/resetpassword.xhtml" },
   // Bug 1337345
diff --git a/testing/marionette/chrome/test_menupopup.xhtml b/testing/marionette/chrome/test_menupopup.xhtml
new file mode 100644
index 000000000000..5d8902f01176
--- /dev/null
+++ b/testing/marionette/chrome/test_menupopup.xhtml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!-- This Source Code Form is subject to the terms of the Mozilla Public
+   - License, v. 2.0. If a copy of the MPL was not distributed with this
+   - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
+
+<?xml-stylesheet href="chrome://global/skin/global.css" type="text/css"?>
+
+<!DOCTYPE window [
+]>
+<window id="test-window" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
+    <popupset id="options-popupset">
+        <menupopup id="options-menupopup" position="before_end">
+            <menuitem id="option-enabled"
+                      type="checkbox"
+                      label="enabled"/>
+            <menuitem id="option-hidden"
+                      type="checkbox"
+                      label="hidden"
+                      hidden="true"/>
+            <menuitem id="option-disabled"
+                      type="checkbox"
+                      label="disabled"
+                      disabled="true"/>
+        </menupopup>
+    </popupset>
+    <hbox align="center" style="height: 300px;">
+      <button id="options-button"
+              popup="options-menupopup" label="button"/>
+    </hbox>
+</window>
diff --git a/testing/marionette/harness/marionette_harness/tests/unit/test_sendkeys_menupopup_chrome.py b/testing/marionette/harness/marionette_harness/tests/unit/test_sendkeys_menupopup_chrome.py
new file mode 100644
index 000000000000..6f24cc44d1c6
--- /dev/null
+++ b/testing/marionette/harness/marionette_harness/tests/unit/test_sendkeys_menupopup_chrome.py
@@ -0,0 +1,115 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from __future__ import absolute_import, division
+
+from six.moves.urllib.parse import quote
+
+from marionette_driver import By, errors, Wait
+from marionette_driver.keys import Keys
+
+from marionette_harness import (
+    MarionetteTestCase,
+    skip_if_framescript,
+    WindowManagerMixin,
+)
+
+
+class TestSendkeysMenupopup(WindowManagerMixin, MarionetteTestCase):
+    def setUp(self):
+        super(TestSendkeysMenupopup, self).setUp()
+
+        self.marionette.set_context("chrome")
+        new_window = self.open_chrome_window(
+            "chrome://marionette/content/test_menupopup.xhtml"
+        )
+        self.marionette.switch_to_window(new_window)
+
+        self.click_el = self.marionette.find_element(By.ID, "options-button")
+        self.disabled_menuitem_el = self.marionette.find_element(
+            By.ID, "option-disabled"
+        )
+        self.hidden_menuitem_el = self.marionette.find_element(By.ID, "option-hidden")
+        self.menuitem_el = self.marionette.find_element(By.ID, "option-enabled")
+        self.menupopup_el = self.marionette.find_element(By.ID, "options-menupopup")
+        self.testwindow_el = self.marionette.find_element(By.ID, "test-window")
+
+    def context_menu_state(self):
+        return self.menupopup_el.get_property("state")
+
+    def open_context_menu(self):
+        def attempt_open_context_menu():
+            self.assertEqual(self.context_menu_state(), "closed")
+            self.click_el.click()
+            Wait(self.marionette).until(
+                lambda _: self.context_menu_state() == "open",
+                message="Context menu did not open",
+            )
+
+        try:
+            attempt_open_context_menu()
+        except errors.TimeoutException:
+            # If the first attempt timed out, try a second time.
+            # On Linux, the test will intermittently fail if we click too
+            # early on the button. Retrying fixes the issue. See Bug 1686769.
+            attempt_open_context_menu()
+
+    def wait_for_context_menu_closed(self):
+        Wait(self.marionette).until(
+            lambda _: self.context_menu_state() == "closed",
+            message="Context menu did not close",
+        )
+
+    def tearDown(self):
+        try:
+            self.close_all_windows()
+        finally:
+            super(TestSendkeysMenupopup, self).tearDown()
+
+    def test_sendkeys_menuitem(self):
+        # Try closing the context menu by sending ESCAPE to a visible context menu item.
+        self.open_context_menu()
+
+        self.menuitem_el.send_keys(Keys.ESCAPE)
+        self.wait_for_context_menu_closed()
+
+    def test_sendkeys_menupopup(self):
+        # Try closing the context menu by sending ESCAPE to the context menu.
+        self.open_context_menu()
+
+        self.menupopup_el.send_keys(Keys.ESCAPE)
+        self.wait_for_context_menu_closed()
+
+    def test_sendkeys_window(self):
+        # Try closing the context menu by sending ESCAPE to the main window.
+        self.open_context_menu()
+
+        self.testwindow_el.send_keys(Keys.ESCAPE)
+        self.wait_for_context_menu_closed()
+
+    @skip_if_framescript(
+        "Bug 1675173: Interactability is only checked with actors enabled"
+    )
+    def test_sendkeys_closed_menu(self):
+        # send_keys should throw for the menupopup if the contextmenu is closed.
+        with self.assertRaises(errors.ElementNotInteractableException):
+            self.menupopup_el.send_keys(Keys.ESCAPE)
+
+        # send_keys should throw for the menuitem if the contextmenu is closed.
+        with self.assertRaises(errors.ElementNotInteractableException):
+            self.menuitem_el.send_keys(Keys.ESCAPE)
+
+    @skip_if_framescript(
+        "Bug 1675173: Interactability is only checked with actors enabled"
+    )
+    def test_sendkeys_hidden_disabled_menuitem(self):
+        self.open_context_menu()
+
+        # send_keys should throw for a disabled menuitem in an opened contextmenu.
+        with self.assertRaises(errors.ElementNotInteractableException):
+            self.disabled_menuitem_el.send_keys(Keys.ESCAPE)
+
+        # send_keys should throw for a hidden menuitem in an opened contextmenu.
+        with self.assertRaises(errors.ElementNotInteractableException):
+            self.hidden_menuitem_el.send_keys(Keys.ESCAPE)
diff --git a/testing/marionette/harness/marionette_harness/tests/unit/unit-tests.ini b/testing/marionette/harness/marionette_harness/tests/unit/unit-tests.ini
index 1fa4fbc507c8..b2c31b02aa20 100644
--- a/testing/marionette/harness/marionette_harness/tests/unit/unit-tests.ini
+++ b/testing/marionette/harness/marionette_harness/tests/unit/unit-tests.ini
@@ -102,3 +102,5 @@ skip-if = asan || manage_instance == false
 
 [test_reftest.py]
 skip-if = (os == 'mac' && webrender) # bug 1674411
+
+[test_sendkeys_menupopup_chrome.py]
diff --git a/testing/marionette/jar.mn b/testing/marionette/jar.mn
index ca096685d106..d2f4145e04c8 100644
--- a/testing/marionette/jar.mn
+++ b/testing/marionette/jar.mn
@@ -52,6 +52,7 @@ marionette.jar:
   content/test_dialog.dtd (chrome/test_dialog.dtd)
   content/test_dialog.properties (chrome/test_dialog.properties)
   content/test_dialog.xhtml (chrome/test_dialog.xhtml)
+  content/test_menupopup.xhtml (chrome/test_menupopup.xhtml)
   content/test_nested_iframe.xhtml (chrome/test_nested_iframe.xhtml)
 #ifdef MOZ_CODE_COVERAGE
   content/PerTestCoverageUtils.jsm (../../tools/code-coverage/PerTestCoverageUtils.jsm)