8303130: Document required Accessibility permissions on macOS
Reviewed-by: erikj, aivanov, prr, serb
This commit is contained in:
parent
50dc041ee6
commit
a10d5ac61b
@ -578,12 +578,13 @@ directories.</p>
|
|||||||
<p>For more notes about the PKCS11 tests, please refer to
|
<p>For more notes about the PKCS11 tests, please refer to
|
||||||
test/jdk/sun/security/pkcs11/README.</p>
|
test/jdk/sun/security/pkcs11/README.</p>
|
||||||
<h3 id="client-ui-tests">Client UI Tests</h3>
|
<h3 id="client-ui-tests">Client UI Tests</h3>
|
||||||
|
<h4 id="system-key-shortcuts">System key shortcuts</h4>
|
||||||
<p>Some Client UI tests use key sequences which may be reserved by the
|
<p>Some Client UI tests use key sequences which may be reserved by the
|
||||||
operating system. Usually that causes the test failure. So it is highly
|
operating system. Usually that causes the test failure. So it is highly
|
||||||
recommended to disable system key shortcuts prior testing. The steps to
|
recommended to disable system key shortcuts prior testing. The steps to
|
||||||
access and disable system key shortcuts for various platforms are
|
access and disable system key shortcuts for various platforms are
|
||||||
provided below.</p>
|
provided below.</p>
|
||||||
<h4 id="macos">MacOS</h4>
|
<h5 id="macos">macOS</h5>
|
||||||
<p>Choose Apple menu; System Preferences, click Keyboard, then click
|
<p>Choose Apple menu; System Preferences, click Keyboard, then click
|
||||||
Shortcuts; select or deselect desired shortcut.</p>
|
Shortcuts; select or deselect desired shortcut.</p>
|
||||||
<p>For example,
|
<p>For example,
|
||||||
@ -594,17 +595,41 @@ operating system. To run the test correctly the default global key
|
|||||||
shortcut should be disabled using the steps described above, and then
|
shortcut should be disabled using the steps described above, and then
|
||||||
deselect "Turn keyboard access on or off" option which is responsible
|
deselect "Turn keyboard access on or off" option which is responsible
|
||||||
for <code>CTRL + F1</code> combination.</p>
|
for <code>CTRL + F1</code> combination.</p>
|
||||||
<h4 id="linux">Linux</h4>
|
<h5 id="linux">Linux</h5>
|
||||||
<p>Open the Activities overview and start typing Settings; Choose
|
<p>Open the Activities overview and start typing Settings; Choose
|
||||||
Settings, click Devices, then click Keyboard; set or override desired
|
Settings, click Devices, then click Keyboard; set or override desired
|
||||||
shortcut.</p>
|
shortcut.</p>
|
||||||
<h4 id="windows">Windows</h4>
|
<h5 id="windows">Windows</h5>
|
||||||
<p>Type <code>gpedit</code> in the Search and then click Edit group
|
<p>Type <code>gpedit</code> in the Search and then click Edit group
|
||||||
policy; navigate to User Configuration -> Administrative Templates
|
policy; navigate to User Configuration -> Administrative Templates
|
||||||
-> Windows Components -> File Explorer; in the right-side pane
|
-> Windows Components -> File Explorer; in the right-side pane
|
||||||
look for "Turn off Windows key hotkeys" and double click on it; enable
|
look for "Turn off Windows key hotkeys" and double click on it; enable
|
||||||
or disable hotkeys.</p>
|
or disable hotkeys.</p>
|
||||||
<p>Note: restart is required to make the settings take effect.</p>
|
<p>Note: restart is required to make the settings take effect.</p>
|
||||||
|
<h4 id="robot-api">Robot API</h4>
|
||||||
|
<p>Most automated Client UI tests use <code>Robot</code> API to control
|
||||||
|
the UI. Usually, the default operating system settings need to be
|
||||||
|
adjusted for Robot to work correctly. The detailed steps how to access
|
||||||
|
and update these settings for different platforms are provided
|
||||||
|
below.</p>
|
||||||
|
<h5 id="macos-1">macOS</h5>
|
||||||
|
<p><code>Robot</code> is not permitted to control your Mac by default
|
||||||
|
since macOS 10.15. To allow it, choose Apple menu -> System Settings,
|
||||||
|
click Privacy & Security; then click Accessibility and ensure the
|
||||||
|
following apps are allowed to control your computer: <em>Java</em> and
|
||||||
|
<em>Terminal</em>. If the tests are run from an IDE, the IDE should be
|
||||||
|
granted this permission too.</p>
|
||||||
|
<h5 id="windows-1">Windows</h5>
|
||||||
|
<p>On Windows if Cygwin terminal is used to run the tests, there is a
|
||||||
|
delay in focus transfer. Usually it causes automated UI test failure. To
|
||||||
|
disable the delay, type <code>regedit</code> in the Search and then
|
||||||
|
select Registry Editor; navigate to the following key:
|
||||||
|
<code>HKEY_CURRENT_USER\Control Panel\Desktop</code>; make sure the
|
||||||
|
<code>ForegroundLockTimeout</code> value is set to 0.</p>
|
||||||
|
<p>Additional information about Client UI tests configuration for
|
||||||
|
various operating systems can be obtained at <a
|
||||||
|
href="https://wiki.openjdk.org/display/ClientLibs/Automated+client+GUI+testing+system+set+up+requirements">Automated
|
||||||
|
client GUI testing system set up requirements</a></p>
|
||||||
<h2 id="editing-this-document">Editing this document</h2>
|
<h2 id="editing-this-document">Editing this document</h2>
|
||||||
<p>If you want to contribute changes to this document, edit
|
<p>If you want to contribute changes to this document, edit
|
||||||
<code>doc/testing.md</code> and then run
|
<code>doc/testing.md</code> and then run
|
||||||
|
@ -606,12 +606,14 @@ test/jdk/sun/security/pkcs11/README.
|
|||||||
|
|
||||||
### Client UI Tests
|
### Client UI Tests
|
||||||
|
|
||||||
|
#### System key shortcuts
|
||||||
|
|
||||||
Some Client UI tests use key sequences which may be reserved by the operating
|
Some Client UI tests use key sequences which may be reserved by the operating
|
||||||
system. Usually that causes the test failure. So it is highly recommended to
|
system. Usually that causes the test failure. So it is highly recommended to
|
||||||
disable system key shortcuts prior testing. The steps to access and disable
|
disable system key shortcuts prior testing. The steps to access and disable
|
||||||
system key shortcuts for various platforms are provided below.
|
system key shortcuts for various platforms are provided below.
|
||||||
|
|
||||||
#### MacOS
|
##### macOS
|
||||||
|
|
||||||
Choose Apple menu; System Preferences, click Keyboard, then click Shortcuts;
|
Choose Apple menu; System Preferences, click Keyboard, then click Shortcuts;
|
||||||
select or deselect desired shortcut.
|
select or deselect desired shortcut.
|
||||||
@ -624,12 +626,12 @@ test correctly the default global key shortcut should be disabled using the
|
|||||||
steps described above, and then deselect "Turn keyboard access on or off"
|
steps described above, and then deselect "Turn keyboard access on or off"
|
||||||
option which is responsible for `CTRL + F1` combination.
|
option which is responsible for `CTRL + F1` combination.
|
||||||
|
|
||||||
#### Linux
|
##### Linux
|
||||||
|
|
||||||
Open the Activities overview and start typing Settings; Choose Settings, click
|
Open the Activities overview and start typing Settings; Choose Settings, click
|
||||||
Devices, then click Keyboard; set or override desired shortcut.
|
Devices, then click Keyboard; set or override desired shortcut.
|
||||||
|
|
||||||
#### Windows
|
##### Windows
|
||||||
|
|
||||||
Type `gpedit` in the Search and then click Edit group policy; navigate to User
|
Type `gpedit` in the Search and then click Edit group policy; navigate to User
|
||||||
Configuration -> Administrative Templates -> Windows Components -> File
|
Configuration -> Administrative Templates -> Windows Components -> File
|
||||||
@ -638,6 +640,33 @@ double click on it; enable or disable hotkeys.
|
|||||||
|
|
||||||
Note: restart is required to make the settings take effect.
|
Note: restart is required to make the settings take effect.
|
||||||
|
|
||||||
|
#### Robot API
|
||||||
|
|
||||||
|
Most automated Client UI tests use `Robot` API to control the UI. Usually,
|
||||||
|
the default operating system settings need to be adjusted for Robot
|
||||||
|
to work correctly. The detailed steps how to access and update these settings
|
||||||
|
for different platforms are provided below.
|
||||||
|
|
||||||
|
##### macOS
|
||||||
|
|
||||||
|
`Robot` is not permitted to control your Mac by default since
|
||||||
|
macOS 10.15. To allow it, choose Apple menu -> System Settings, click
|
||||||
|
Privacy & Security; then click Accessibility and ensure the following apps are
|
||||||
|
allowed to control your computer: *Java* and *Terminal*. If the tests are run
|
||||||
|
from an IDE, the IDE should be granted this permission too.
|
||||||
|
|
||||||
|
##### Windows
|
||||||
|
|
||||||
|
On Windows if Cygwin terminal is used to run the tests, there is a delay in
|
||||||
|
focus transfer. Usually it causes automated UI test failure. To disable the
|
||||||
|
delay, type `regedit` in the Search and then select Registry Editor; navigate
|
||||||
|
to the following key: `HKEY_CURRENT_USER\Control Panel\Desktop`; make sure
|
||||||
|
the `ForegroundLockTimeout` value is set to 0.
|
||||||
|
|
||||||
|
Additional information about Client UI tests configuration for various operating
|
||||||
|
systems can be obtained at [Automated client GUI testing system set up
|
||||||
|
requirements](https://wiki.openjdk.org/display/ClientLibs/Automated+client+GUI+testing+system+set+up+requirements)
|
||||||
|
|
||||||
## Editing this document
|
## Editing this document
|
||||||
|
|
||||||
If you want to contribute changes to this document, edit `doc/testing.md` and
|
If you want to contribute changes to this document, edit `doc/testing.md` and
|
||||||
|
Loading…
Reference in New Issue
Block a user