You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Docs/source/pages/advanced-usage.md
+59Lines changed: 59 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -609,6 +609,65 @@ Use [Reverse Port Forwarding](#what-is-reverse-port-forwarding-and-when-to-use-i
609
609
On mobile devices, AltDriver can interact only with a single app at a time and the app needs to be in focus. In case of 2 drivers and 2 apps, you need to switch (in your test scripts) between the applications. This is due to the fact that on Android/iOS only one application is in focus at a time, even when using split screen mode.
610
610
```
611
611
612
+
## Secure Mode (WSS) in AltTester® Unity SDK
613
+
614
+
AltTester® Unity SDK can communicate with AltTester® Server using a **secure WebSocket
615
+
connection** (``wss://``). Secure mode encrypts all data exchanged between the
616
+
instrumented application and the server.
617
+
618
+
To successfully establish a secure connection, the Unity SDK configuration,
619
+
AltTester® Server configuration, and client environment must match.
620
+
621
+
### Enabling Secure Mode
622
+
623
+
Secure mode is enabled in the instrumented application by activating the
624
+
**Secure Mode (WSS)** option, either by enabling the toggle in the AltTester®
625
+
Editor or by selecting the secure protocol in the AltTester® PopUp (green pop-up).
626
+
627
+
When enabled:
628
+
- The Unity application connects to the server using ``wss://``
629
+
- The AltTester® Server must be running in secure mode
630
+
- A valid TLS certificate must be configured on the server
631
+
632
+
If secure mode is enabled in the SDK but the server is not configured for secure
633
+
connections, the connection will fail.
634
+
635
+
Likewise, if the server runs in secure mode but secure mode is disabled in the SDK,
636
+
the connection will fail.
637
+
638
+
```eval_rst
639
+
.. note::
640
+
The Secure Mode (WSS) setting must always match the server configuration.
641
+
```
642
+
643
+
### Secure Mode in WebGL Builds
644
+
645
+
For **WebGL instrumented builds**, secure mode has additional browser-specific
646
+
requirements.
647
+
648
+
When using secure mode (``wss://``) in WebGL:
649
+
- The server URL must use HTTPS
650
+
(for example: ``https://127.0.0.1:13000``)
651
+
- The HTTPS endpoint must be **trusted by the browser**
652
+
653
+
If the certificate is self-signed or not trusted by default, the browser will block
654
+
the connection.
655
+
656
+
To allow the connection:
657
+
1. Open a new browser tab
658
+
2. Navigate to ``https://<host>:<port>``
659
+
(for example: ``https://127.0.0.1:13000``)
660
+
3. Proceed through the browser security warning
661
+
4. Confirm that you want to continue to the unsafe site
662
+
663
+
Once the URL is trusted, reload the WebGL application and retry the connection.
664
+
665
+
```eval_rst
666
+
.. important::
667
+
This step is required only once per browser session. Without explicitly trusting
668
+
the HTTPS endpoint, secure WebSocket connections from WebGL builds will now work.
669
+
```
670
+
612
671
## Execute tests concurrently
613
672
614
673
In the `AltDriver` constructor you have the option to specify multiple tags. The available tags are: app name, platform, platform version, device instance id and app id. The app id can be used to uniquely identify an app. In case you specify no tags, the tests will be run on a randomly chosen app.
@@ -45,20 +49,6 @@ In the following sections you can see a breakdown of all the sections in the GUI
45
49
46
50
The product name (same with Unity's Player Settings).
47
51
48
-
-*Hide AltTester Popup Option*
49
-
50
-
You can choose to hide the green AltTester popup by checking the "Hide Green Popup" option in the AltTester Editor. When checked, the popup will not be shown in the instrumented build.
51
-
52
-
*Toggling the Popup at Runtime*
53
-
54
-
You can show or hide it at any time using the following platform-specific shortcuts:
-*Append "Test" to product name for AltTester® Unity SDK builds*:
63
53
64
54
Will add "Test" to the product name.
@@ -84,6 +74,32 @@ In the following sections you can see a breakdown of all the sections in the GUI
84
74
You can also use the shortcut:
85
75
- Press <kbd>LeftCtrl</kbd> + <kbd>LeftShift</kbd> + <kbd>D</kbd> + <kbd>L</kbd> to reset your connection data to the default values specified in the Build Settings.
86
76
77
+
-*Hide AltTester Popup Option*
78
+
79
+
You can choose to hide the green AltTester popup by checking the "Hide Green Popup" option in the AltTester Editor. When checked, the popup will not be shown in the instrumented build.
80
+
81
+
*Toggling the Popup at Runtime*
82
+
83
+
You can show or hide it at any time using the following platform-specific shortcuts:
Copy file name to clipboardExpand all lines: Docs/source/pages/commands.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,6 +59,11 @@ An AltDriver instance will connect to the running instrumented Unity application
59
59
- string
60
60
- No
61
61
- The unique ID of the Unity application. The default value is: `unknown`
62
+
* - secureMode
63
+
- boolean
64
+
- No
65
+
- Enables secure WebSocket communication (``wss://``). When set to `true`, the driver will attempt to connect to the AltTester® Server using a secure connection. The default value is: `false`.
66
+
62
67
63
68
.. tab:: Java
64
69
@@ -106,6 +111,11 @@ An AltDriver instance will connect to the running instrumented Unity application
106
111
- string
107
112
- No
108
113
- The unique ID of the Unity application. The default value is: `unknown`
114
+
* - secureMode
115
+
- boolean
116
+
- No
117
+
- Enables secure WebSocket communication (``wss://``). When set to `true`, the driver will attempt to connect to the AltTester® Server using a secure connection. The default value is: `false`.
118
+
109
119
110
120
.. tab:: Python
111
121
@@ -132,7 +142,7 @@ An AltDriver instance will connect to the running instrumented Unity application
132
142
* - enable_logging
133
143
- boolean
134
144
- No
135
-
- The default value is: `false`
145
+
- The default value is: `False`
136
146
* - connect_timeout
137
147
- int
138
148
- No
@@ -153,6 +163,11 @@ An AltDriver instance will connect to the running instrumented Unity application
153
163
- string
154
164
- No
155
165
- The unique ID of the Unity application. The default value is: `unknown`
166
+
* - secure_mode
167
+
- boolean
168
+
- No
169
+
- Enables secure WebSocket communication (``wss://``). When set to `True`, the driver will attempt to connect to the AltTester® Server using a secure connection. The default value is: `False`.
170
+
156
171
157
172
.. tab:: Robot
158
173
@@ -179,7 +194,7 @@ An AltDriver instance will connect to the running instrumented Unity application
179
194
* - enable_logging
180
195
- boolean
181
196
- No
182
-
- The default value is: `false`
197
+
- The default value is: `False`
183
198
* - connect_timeout
184
199
- int
185
200
- No
@@ -200,6 +215,11 @@ An AltDriver instance will connect to the running instrumented Unity application
200
215
- string
201
216
- No
202
217
- The unique ID of the Unity application. The default value is: `unknown`
218
+
* - secure_mode
219
+
- boolean
220
+
- No
221
+
- Enables secure WebSocket communication (``wss://``). When set to `True`, the driver will attempt to connect to the AltTester® Server using a secure connection. The default value is: `False`.
0 commit comments