forked from pywinauto/pywinauto
/
remote_execution.txt
161 lines (110 loc) · 6.39 KB
/
remote_execution.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
============================================================
Remote Execution Guide
============================================================
Desktop GUI tests usually require active desktop to move mouse cursor
and type some keys into a focused window. That completely blocks local
machine from normal usage.
But running tests on a remote machine is a challenge. This guide collected
known issues and solutions to control a remote machine with GUI tests.
Windows Remote Desktop features
-------------------------------
Remote Desktop (RDP) provides virtual active desktop to remote machine with Windows OS.
There are 2 potential issues:
* If RDP window is minimized, there is no active desktop on remote PC by default.
* If RDP is disconnected, the desktop is locked out.
In both cases any GUI automation jobs will fail (if you don't use some tricks described below).
The workarounds are well described in TestComplete documetation:
* `Running Tests in Minimized Remote Desktop Windows`_
* `Disconnecting From Remote Desktop While Running Automated Tests`_
.. _`Running Tests in Minimized Remote Desktop Windows`: https://support.smartbear.com/testcomplete/docs/testing-with/running/via-rdp/in-minimized-window.html
.. _`Disconnecting From Remote Desktop While Running Automated Tests`: https://support.smartbear.com/testcomplete/docs/testing-with/running/via-rdp/keeping-computer-unlocked.html
VNC Server software
-------------------
There is more simple way to avoid above issues: using VNC server software
(for example, Tight VNC). It works as a pair of client and server. VNC server
also provides active desktop on a remote machine.
* This is a non-virtual desktop so working with native screen resolution
on a remote PC may require updating video drivers.
* Minimizing or disconnecting VNC client doesn't destroy active desktop (by default!).
* This is a cross-platform solution (VNC server is a native part of macOS
and available on Linux).
The only problem you may face with:
* Using Remote Desktop (RDP) may break VNC server benefits and you have
to restart remote PC or apply RDP workarounds described above.
Other remote access software
----------------------------
If anyone tried to run GUI tests/automation remotely using Team Viewer,
PowerBI desktop or any other virtual desktop software, feel free to add
more details into this guide.
Tricks to run automation on a locked machine
--------------------------------------------
For some applications it's possible to run GUI automation on a locked
machine, but it requires using special methods. First it's worth listing
methods that don't work on a locked machine:
* `click_input`_ and all other mouse click and press methods ending with ``_input``.
* `set_focus`_ as it uses ``SetCursorPos`` and ``SetForegroundWindow``.
* `type_keys`_ for native keyboard input.
* Direct usage of modules `mouse`_ and `keyboard`_.
.. _`click_input`: code/pywinauto.base_wrapper.html#pywinauto.base_wrapper.BaseWrapper.click_input
.. _`set_focus`: code/pywinauto.controls.hwndwrapper.html#pywinauto.controls.hwndwrapper.HwndWrapper.set_focus
.. _`type_keys`: code/pywinauto.base_wrapper.html#pywinauto.base_wrapper.BaseWrapper.type_keys
.. _`mouse`: code/pywinauto.mouse.html
.. _`keyboard`: code/pywinauto.keyboard.html
Some other methods may not work also, but it depends on application.
There are few methods for silent text input in ``backend="win32"``:
* `send_chars`_ (symbols only; special key combinations do not work)
* `send_keystrokes`_ (some special key combinations may work)
.. _`send_chars`: code/pywinauto.controls.hwndwrapper.html#pywinauto.controls.hwndwrapper.HwndWrapper.send_chars
.. _`send_keystrokes`: code/pywinauto.controls.hwndwrapper.html#pywinauto.controls.hwndwrapper.HwndWrapper.send_keystrokes
There is another useful method to enter string at once (available for both backends, usually for edit box only):
* `"uia": set_edit_text`_ (enter text as is, no modifiers supported)
* `"win32": set_edit_text`_
.. _`"uia": set_edit_text`: code/pywinauto.controls.uia_controls.html#pywinauto.controls.uia_controls.EditWrapper.set_edit_text
.. _`"win32": set_edit_text`: code/pywinauto.controls.win32_controls.html#pywinauto.controls.win32_controls.EditWrapper.set_edit_text
Start remote script using agent based CI
----------------------------------------
When your script is ready and you can run it on a remote machine manually,
it's time to automate the last step: trigger running the script from local
machine or from CI server.
If you have internal hosted CI (for example, Jenkins), probably target
machine is already connected to Jenkins master using an agent. There are
three ways to connect agent:
* Run agent as a service: GUI tests won't work in this case because
GUI can't be even created when running as a service.
* Run agent through SSH: GUI tests won't work.
* Run agent as a normal application. This is the only working case!
Start remote script directly
----------------------------
This chapter is inspired by `issue #401`_ (special thanks to `yangliang003`_).
.. _`issue #401`: https://github.com/pywinauto/pywinauto/issues/401
.. _`yangliang003`: https://github.com/yangliang003
First option is PsExec. Thanks to `this post on StackExchange`_.
1. Download `PsTools`_.
2. Get process ID of RDP session using ``tasklist`` command. PowerShell script:
::
$session = tasklist /fo CSV | findstr RDP ; $session = $session.Split(",")[3] ; $session.Split('"')[1]
3. Start process: ``PsExec.exe -s -i 123 python my_script.py``.
.. _`this post on StackExchange`: https://serverfault.com/a/852877/368634
.. _`PsTools`: https://docs.microsoft.com/en-us/sysinternals/downloads/psexec
`Ansible`_ has PsExec plugin that simplifies it. Playbook example:
.. _`Ansible`: https://github.com/ansible/ansible
::
---
- name: test ra module
hosts: *****
tasks:
- name: run GUI automation
win_psexec:
command: python pywinauto_example.py
executable: C:\Windows\PSTools\psexec.exe
interactive: yes
username: admin
password: ******
hostnames: ******
Windows Scheduler is also capable to start jobs with GUI interaction support.
There is easy way to schedule the task from ``cmd.exe`` once:
::
Schtasks /Create /tn my_task /tr c:\temp\my_task.bat /sc ONCE /st hh:mi:ss /sd yyyy/mm/dd
How To`s
==================
* :doc:`HowTo`