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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
# Creating a test image
This document explains how to create base OS images and run test runners on them.
This guide is written from the perspective of a Linux user, but it should work on Windows as well.
## Prerequisites
You need to have [QEMU](https://www.qemu.org/) installed.
# Linux
These instructions use Debian, but the process is pretty much the same for any other distribution.
## Creating a virtual machine
On the host, start by creating a disk image and installing Debian on it:
```
wget -O debian.iso https://cdimage.debian.org/debian-cd/current/amd64/iso-cd/debian-11.5.0-amd64-netinst.iso
qemu-img create -f qcow2 ./debian.qcow2 5G
qemu-system-x86_64 -cpu host -accel kvm -m 8192 -smp 8 -cdrom debian.iso -drive file=./debian.qcow2
```
## Installing Linux
Follow the distribution's installation process. The only important detail is to set up the [user](#User) correctly.
### User
The testframework expects there to be a regular user in the guest which it can login as.
The `test-manager` makes no assumptions about the login credentials of this user, but they have to be provided as outlined in the [test-manager configuration specification](../test-manager/docs/config.md).
To better illustrate the remaining steps of the installation process, we assume that a regular system user called `test` has been created.
#### sudo
The user should be able to execute `sudo` without a password. On Debian/Ubuntu, the user should be added to the group `sudo`.
On Fedora, the group is typically called `wheel`, which is used in the example below.
Add the `test` user to the `wheel` group
```bash
gpasswd -a test wheel
```
and edit `/etc/sudoers` to allow members of `wheel` to execute commands without a password
```bash
sudo visudo
```
Then comment out
```bash
## Allows people in group wheel to run all commands
# %wheel ALL=(ALL) ALL
```
and add
```bash
## Same thing without a password
%wheel ALL=(ALL) NOPASSWD: ALL
```
#### ssh
Make sure that `sshd.service` is enabled on boot.
```bash
systemctl enable sshd.service
```
### Ubuntu
Stop `unattended-upgrades` by uninstalling it
```
sudo apt remove unattended-upgrades
```
## Finishing setup
Now you are done! If the VM was configured correctly, `test-manager` will be able to install the required dependencies and run the test suite using the new OS image.
Now you should [add your new VM to the test-manager config](./test-manager/README.md#configuring-test-manager)
# Windows
## Windows 10
* Download a Windows 10 ISO: https://www.microsoft.com/software-download/windows10
* On the host, create a new disk image and install Windows on it:
```
mkdir -p os-images
qemu-img create -f qcow2 ./os-images/windows10.qcow2 32G
qemu-system-x86_64 -cpu host -accel kvm -m 4096 -smp 2 -cdrom <YOUR ISO HERE> -drive file=./os-images/windows10.qcow2
```
## Windows 11
* Download an ISO: https://www.microsoft.com/software-download/windows11
* Create a disk image with at least 64GB of space:
```
mkdir -p os-images
qemu-img create -f qcow2 ./os-images/windows11.qcow2 64G
```
* Windows 11 requires a TPM as well as secure boot to be enabled (and thus UEFI). For TPM, use the
emulator SWTPM:
```
mkdir -p .tpm
swtpm socket -t --ctrl type=unixio,path=".tpm/tpmsock" --tpmstate ".tpm" --tpm2 -d
```
* For UEFI, use OVMF, which is available in the `edk2-ovmf` package.
`OVMF_VARS` is used writeable UEFI variables. Copy it to the root directory:
```
cp /usr/share/OVMF/OVMF_VARS.secboot.fd .
```
* Launch the VM and install Windows:
```
qemu-system-x86_64 -cpu host -accel kvm -m 4096 -smp 2 -cdrom <YOUR ISO HERE> -drive file=./os-images/windows11.qcow2 \
-tpmdev emulator,id=tpm0,chardev=chrtpm -chardev socket,id=chrtpm,path=".tpm/tpmsock" -device tpm-tis,tpmdev=tpm0 \
-global driver=cfi.pflash01,property=secure,value=on \
-drive if=pflash,format=raw,unit=0,file=/usr/share/OVMF/OVMF_CODE.secboot.fd,readonly=on \
-drive if=pflash,format=raw,unit=1,file=./OVMF_VARS.secboot.fd \
-machine q35,smm=on
```
## Notes on local accounts
Logging in on a Microsoft account should not be necessary. A local account is sufficient.
If you are asked to log in and there is no option to create a local account, try to disconnect
from the network before trying again:
1. Press shift-F10 to open a command prompt.
1. Type `ipconfig /release` and press enter.
If you are forced to connect to a network during the install, and cannot opt to use a local account,
do the following:
1. Press shift-F10 to open a command prompt.
1. Type `oobe\BypassNRO` and press enter.
### Bootstrapping the test runner
The test runner needs to be started on boot, with the test runner image mounted at `E:`.
This can be achieved as follows:
* Restart the VM:
```
qemu-system-x86_64 -cpu host -accel kvm -m 4096 -smp 2 -drive file="./os-images/windows10.qcow2"
```
* In the guest admin `cmd`, add the test runner as a scheduled task:
```
schtasks /create /tn "Mullvad Test Runner" /sc onlogon /tr "\"E:\test-runner.exe\" \\.\COM1 serve" /rl highest
```
Further changes might be required to prevent the task from stopping unexpectedly. In the
Task Scheduler (`taskschd.msc`), change the following settings for the runner task:
* Disable "Start the task only if the computer is on AC power".
* Disable "Stop task if it runs longer than ...".
* Enable "Run task as soon as possible after a scheduled start is missed".
* Enable "If the task fails, restart every: 1 minute".
* In the guest, make sure that the time service is enabled and running
First, enable the Windows Time service (`W32Time`):
https://learn.microsoft.com/en-us/windows-server/networking/windows-time-service/windows-time-service-tools-and-settings?tabs=config#set-the-client-to-sync-time-automatically-from-a-domain-source
```
schtasks /create /tn "Synchronize Time Service" /tr "cmd.exe /c 'w32tm /resync'" /sc onlogon /rl HIGHEST
```
* In the guest, disable Windows Update.
* Open `services.msc`.
* Open the properties for `Windows Update`.
* Set "Startup type" to "Disabled". Also, click "stop".
* In the guest, disable SmartScreen.
* Go to "Reputation-based protection settings" under
Start > Settings > Update & Security > Windows Security > App & browser control.
* Set "Check apps and files" to off.
* (Windows 11) In the guest, disable Smart App Control
* Go to "Smart App Control" under
Start > Settings > Privacy & security > Windows Security > App & browser control.
* Set it to off.
* Enable autologon by creating or editing the following registry values (all of type REG_SZ):
* Set the current user in
`HKLM\Software\Microsoft\Windows NT\CurrentVersion\Winlogon\DefaultUserName`.
* Set the password in
`HKLM\Software\Microsoft\Windows NT\CurrentVersion\Winlogon\DefaultPassword`.
* Set `HKLM\Software\Microsoft\Windows NT\CurrentVersion\Winlogon\AutoAdminLogon` to 1.
* Shut down.
## Windows Security
Windows Defender ocasionally kills the `test-runner` because it believes it to be a trojan. This can be worked around by excluding `E:` and [the folder containing the standalone e2e GUI test executable](../../desktop/packages/mullvad-vpn/README.md) following this guide: https://support.microsoft.com/en-us/windows/add-an-exclusion-to-windows-security-811816c0-4dfd-af4a-47e4-c301afe13b26.
## Finishing setup
Now you are done! If the VM was configured correctly, `test-manager` will be able to run the test suite using the new OS image.
Now you should [add your new VM to the test-manager config](./test-manager/README.md#configuring-test-manager)
## Notes on editing Windows VM images
When editing the VM image, never shut it down with the test runner volume mounted (i.e. `E:`). When
Windows is shut down with the disk mounted, it will be unable to remount it correctly when the image
is replaced.
To get around this behavior, remove the disk from your VM config before starting it with
`--keep-changes`.
# macOS 🚧
_Instructions for building an OS image based on macOS are still under construction._
|
