-
-
Notifications
You must be signed in to change notification settings - Fork 113
/
Copy pathcontainer
executable file
·1570 lines (1300 loc) · 59.7 KB
/
container
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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/python3
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Script to manage a container or a VM for FreedomBox development.
This script creates either a simple container using systemd-nspawn or a virtual
machine using libvirt for developing FreedomBox. Containers have many
advantages over running a VM. RAM is allocated to processes in the container as
needed without any fixed limit. Also RAM does not have to be statically
allocated so it is typically much lighter than running an VM. There is no
hardware emulation when running a container with same architecture, so
processes run as fast as they would on the host machine. On the other hand, VMs
have the advantage of full machine emulation. They allow full permissions as
required for mounting filesystems, USB passthrough of Wi-Fi devices, emulation
of multiple disks, etc. as required for testing some of the features of
FreedomBox.
Environment: The script will run only run on hosts having systemd-nspawn,
virsh, and network-manager installed, typical GNU/Linux distributions. It has
been primarily developed and tested on Debian Buster but should work on most
modern GNU/Linux distributions.
Disk image: For a container, systemd-nspawn accepts not only a directory for
starting a container but also a disk image. This disk image is loop-back
mounted and container is started from that mounted directory. The partition to
use is determined by looking at the boot flag in the partition table. This
happens to work well with all existing FreedomBox images. In future, we may be
able to run different architectures in this manner.
For a VM, a disk drive is created that is backed by the image file. The image
is a bootable image using GRUB as built by freedom-maker.
After downloading, the disk image is expanded along with the partition and file
system inside so that development can be done without running into disk space
issues. Expanding the disk does not immediately consume disk space because it
will be a sparse file. As data is written to the disk, it will occupy more and
more space but the upper limit is the size to which disk has been expanded.
Downloading images: Images are downloaded from FreedomBox download server using
fixed URLs for each distribution. Signature is verified for the download
images. The fingerprint of the allowed signing key is hard-coded in this
script. Downloaded images are kept even after destroying the extracted raw
image along with container. This allows for quickly resetting the container
without downloading again.
Booting: For a container, systemd-nspawn is run in 'boot' mode. This means that
init process (happens to be systemd) is started inside the container. It then
spawns all the other necessary daemons including openssh-server, firewalld and
network-manager. A login terminal can be opened using 'machinectl login'
because container is running systemd. SSH into the container is possible
because network is up, configured by network-manager, and openssh server is
running.
For a VM, when the virtual machine is started, the firmware of the machine
boots the machine from the attached disk. The boot process is similar to a
physical machine.
Shared folder: For a container, using systemd-nspawn, the project directory is
mounted as /freedombox inside the container. The project directory is
determined as directory in which this script resides. The project folder from
the container point of view will be read-only. Container should be able to
write various files such as build files into the /freedombox folder. To enable
writing, an additional read-write folder is overlayed onto /freedombox folder
in the container. This directory can't be created under the project folder and
is created instead in
$XDG_DATA_HOME/freedombox-container/overlay/$DISTRIBUTION. If XDG_DATA_HOME is
not set, it is assumed to be $HOME/.local/shared/. Whenever data is written
into /freedombox directory inside the container, this directory on the host
receives the changes. See documentation for Overlay filesystem for further
details. When container is destroyed, this overlay folder is destroyed to
ensure clean state after bringing up the container again.
For a VM, the project directory is exposed into the virtual machine with the
mount token 'freedombox' using virtiofs. This is done as part of virtual
machine configuration. Inside the virtual machine, a systemd .mount unit will
mount the virtiofs filesystem using the 'freedombox' token onto the folder
/freedombox. The folder is read-write.
Users: In container, PrivateUsers configuration flag for systemd-nspawn is
currently off. This means that each user's UID on the host is also the same UID
in the container as along as there is an entry in the container's password
database. In future, we may explore using private users inside the container.
'fbx' is the development user and its UID is changed during setup phase to
10000 hoping it would not match anything on the host system. 'fbx' user has
full sudo access inside the container without needing a password. Password for
this user is not set by default, but can be set if needed. If there is no
access to the container in any way, one can run 'sudo machinectl shell' and
then run 'passwd fbx' to set the password for the 'fbx' user.
'plinth' user's UID in the container is also changed and set to the UID of
whichever user owns the project directory. This allows the files to written by
'plinth' container user in the project directory because UID of the owner of
the directory is same as the 'plinth' user's UID in container.
Network: For a container, a private network is created inside the container
using systemd-nspawn feature. Network interfaces from the host are not
available inside the container. A new network interface called 'host0' is
configured inside the container which is automatically configured by
network-manager. On the host a new network interface is created. This script
creates configuration for a 'shared' network using network-manager. When
bringing up the container, this network connection is also brought up. A DHCP
server and a DNS server are started network-manager on the host side so that
DHCP and DNS client functions work inside the container. Traffic from the
container is also masqueraded so that Internet connectivity inside the
container works if the host has one.
If necessary, the network interface on host side can be differently configured.
For example, it can be bridged with another interface to expose the container
on a network that the host machine participates in.
The network IP address inside the container can be queried using machinectl.
This script queries that IP address and presents the address in its console
messages. All ports in the container can be reached from the host using this IP
address as long as the firewall inside the container allows it. There is no
need to perform port forwarding or mapping.
For a VM, the network device is fully emulated. On the host it is exposed as
network interface that is bridged with the default libvirt bridge. The bridge
interface is configured by libvirt and it listens for DHCP requests from the
guests and also has a DNS server running. All traffic from the guest is NATed
and, as a result, the guest has full network access. The guest is accessible
from the host using the guest IP address which can be retrieved by asking
libvirt.
SSH: It is assumed that openssh-server is installed inside the container. SSH
server keys in the container are created if missing. Client side keys are
created in .container/ssh directory and the public key is installed in the
authorized keys file of the 'fbx' user. The 'ssh' sub-command to this script is
simply a convenience mechanism for quick launch of ssh with the right IP
address, user name and identity file.
Role of machinectl: For a container, most of the work is done by
systemd-nspawn. machinectl is useful for running systemd-nspawn in the
background and querying its current state. It also helps with providing the IP
address of the container. machinectl is made to recognize the container by
creating a link in /var/lib/machines/ to the image file. systemd-nspawn options
are added by creating a temporary file in /run/systemd/nspawn. All machinectl
commands should work.
"""
import argparse
import datetime
import ipaddress
import itertools
import json
import logging
import os
import pathlib
import platform
import re
import shlex
import shutil
import subprocess
import sys
import tempfile
import time
import urllib.parse
from typing import Callable
from urllib.request import urlopen
URLS_AMD64 = {
'stable': 'https://ftp.freedombox.org/pub/freedombox/hardware/'
'amd64/bookworm/freedombox-bookworm_all-amd64.img.xz',
'testing': 'https://ftp.freedombox.org/pub/freedombox/hardware/'
'amd64/testing/freedombox-testing_dev_all-amd64.img.xz',
'unstable': 'https://ftp.freedombox.org/pub/freedombox/hardware/'
'amd64/nightly/freedombox-unstable_dev_all-amd64.img.xz',
}
URLS_ARM64 = {
'stable': 'https://ftp.freedombox.org/pub/freedombox/hardware/'
'arm64/bookworm/freedombox-bookworm_all-arm64.img.xz',
'testing': 'https://ftp.freedombox.org/pub/freedombox/hardware/'
'arm64/testing/freedombox-testing_dev_all-arm64.img.xz',
'unstable': 'https://ftp.freedombox.org/pub/freedombox/hardware/'
'arm64/nightly/freedombox-unstable_dev_all-arm64.img.xz',
}
URLS = URLS_AMD64
TRUSTED_KEYS = ['D4B069124FCF43AA1FCD7FBC2ACFC1E15AF82D8C']
KEY_SERVER = 'keyserver.ubuntu.com'
KEY_SERVER_HTTPS_API = \
'https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x{key_id}'
PROVISION_SCRIPT = '''
set -xe pipefail
cd /freedombox/
sudo apt-get -y install make
sudo make provision-dev
echo 'alias freedombox-develop="cd /freedombox; sudo -u plinth /freedombox/run --develop"' \
>> /home/fbx/.bashrc
# Make some pytest related files and directories writable to the fbx user
sudo touch geckodriver.log
sudo chmod a+rw geckodriver.log
sudo mkdir -p .pytest_cache/
sudo chmod --recursive a+rw .pytest_cache/
sudo chmod a+w /freedombox
sudo chmod --recursive --silent a+w htmlcov || true
sudo chmod --silent a+w .coverage || true
exit 0
''' # noqa
SETUP_AND_RUN_TESTS_SCRIPT = '''
set -x
BACKPORTS_SOURCES_LIST=/etc/apt/sources.list.d/freedombox2.list
LDAPSCRIPTS_CONF=/etc/ldapscripts/freedombox-ldapscripts.conf
# Remount /freedoombox to be up to date
echo "> In machine: Remounting /freedombox"
mount -o remount /freedombox
# Activate backports if Debian stable
if [[ "{distribution}" == "stable" && ! -e $BACKPORTS_SOURCES_LIST ]]
then
echo "> In machine: Enable backports"
/freedombox/actions/actions upgrades activate_backports --no-args
fi
echo "> In machine: Upgrade packages"
apt-get update
DEBIAN_FRONTEND=noninteractive apt-get -yq --with-new-pkgs upgrade
# Install requirements for tests if not already installed as root
if ! [[ -e /usr/local/bin/geckodriver ]]
then
/freedombox/plinth/tests/functional/install.sh
fi
# Run the plinth server if functional tests are requested
if [[ "{pytest_command}" =~ "--include-functional" ]]
then
is_plinth_running=0
ps -ax -o cmd | grep -q "^sudo -u plinth /freedombox/run" && \
is_plinth_running=1
ps -ax -o cmd | grep -q "^/usr/bin/python3 /usr/bin/plinth" && \
is_plinth_running=1
if [[ $is_plinth_running -eq 1 ]]
then
echo "> In machine: Plinth is already running"
else
echo -n "> In machine: Starting plinth ... "
sudo -u plinth /freedombox/run --develop > plinth.log 2>&1 &
while ! grep -q "Setup finished" plinth.log
do
sleep 1
echo -n .
done
echo
fi
if [[ "{pytest_command}" != *"--splinter-headless"* ]]
then
# Use the X11 authority file from the fbx user to run GUI programs
xauth merge /home/fbx/.Xauthority
fi
fi
# Run pytest
cd /freedombox
export FREEDOMBOX_URL=https://localhost
export FREEDOMBOX_SSH_PORT=22
export FREEDOMBOX_SAMBA_PORT=445
{pytest_command}
# Make pytest cache files writable to the fbx user
chmod --recursive --silent a+rw .pytest_cache/
chmod --recursive --silent a+w htmlcov
chmod --silent a+w .coverage
exit 0
'''
LIBVIRT_DOMAIN_XML_TEMPLATE = '''<domain type="kvm">
<name>{domain_name}</name>
<metadata>
<libosinfo:libosinfo xmlns:libosinfo="http://libosinfo.org/xmlns/libvirt/domain/1.0">
<libosinfo:os id="http://debian.org/debian/testing"/>
</libosinfo:libosinfo>
</metadata>
<memory unit="MiB">{memory_mib}</memory>
<currentMemory unit="MiB">{memory_mib}</currentMemory>
<memoryBacking>
<source type="memfd"/>
<access mode="shared"/>
</memoryBacking>
<vcpu placement="static">{cpus}</vcpu>
<os>
<type arch="x86_64" machine="pc-q35-7.2">hvm</type>
<boot dev="hd"/>
</os>
<features>
<acpi/>
<apic/>
<vmport state="off"/>
</features>
<cpu mode="host-passthrough" check="none" migratable="on"/>
<clock offset="utc">
<timer name="rtc" tickpolicy="catchup"/>
<timer name="pit" tickpolicy="delay"/>
<timer name="hpet" present="no"/>
</clock>
<on_poweroff>destroy</on_poweroff>
<on_reboot>restart</on_reboot>
<on_crash>destroy</on_crash>
<pm>
<suspend-to-mem enabled="no"/>
<suspend-to-disk enabled="no"/>
</pm>
<devices>
<emulator>/usr/bin/qemu-system-x86_64</emulator>
<disk type="file" device="disk">
<driver name="qemu" type="qcow2"/>
<source file="{image_file}"/>
<target dev="vda" bus="virtio"/>
<address type="pci" domain="0x0000" bus="0x04" slot="0x00" function="0x0"/>
</disk>
<controller type="usb" index="0" model="qemu-xhci" ports="15">
<address type="pci" domain="0x0000" bus="0x02" slot="0x00" function="0x0"/>
</controller>
<controller type="pci" index="0" model="pcie-root"/>
<controller type="pci" index="1" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="1" port="0x10"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x0" multifunction="on"/>
</controller>
<controller type="pci" index="2" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="2" port="0x11"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x1"/>
</controller>
<controller type="pci" index="3" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="3" port="0x12"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x2"/>
</controller>
<controller type="pci" index="4" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="4" port="0x13"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x3"/>
</controller>
<controller type="pci" index="5" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="5" port="0x14"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x4"/>
</controller>
<controller type="pci" index="6" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="6" port="0x15"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x5"/>
</controller>
<controller type="pci" index="7" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="7" port="0x16"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x6"/>
</controller>
<controller type="pci" index="8" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="8" port="0x17"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x02" function="0x7"/>
</controller>
<controller type="pci" index="9" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="9" port="0x18"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x0" multifunction="on"/>
</controller>
<controller type="pci" index="10" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="10" port="0x19"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x1"/>
</controller>
<controller type="pci" index="11" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="11" port="0x1a"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x2"/>
</controller>
<controller type="pci" index="12" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="12" port="0x1b"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x3"/>
</controller>
<controller type="pci" index="13" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="13" port="0x1c"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x4"/>
</controller>
<controller type="pci" index="14" model="pcie-root-port">
<model name="pcie-root-port"/>
<target chassis="14" port="0x1d"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x03" function="0x5"/>
</controller>
<controller type="sata" index="0">
<address type="pci" domain="0x0000" bus="0x00" slot="0x1f" function="0x2"/>
</controller>
<controller type="virtio-serial" index="0">
<address type="pci" domain="0x0000" bus="0x03" slot="0x00" function="0x0"/>
</controller>
<filesystem type="mount" accessmode="passthrough">
<driver type="virtiofs"/>
<source dir="{source_dir}"/>
<target dir="freedombox"/>
<address type="pci" domain="0x0000" bus="0x07" slot="0x00" function="0x0"/>
</filesystem>
<interface type="network">
<source network="default"/>
<model type="virtio"/>
<address type="pci" domain="0x0000" bus="0x01" slot="0x00" function="0x0"/>
</interface>
<serial type="pty">
<target type="isa-serial" port="0">
<model name="isa-serial"/>
</target>
</serial>
<console type="pty">
<target type="serial" port="0"/>
</console>
<channel type="unix">
<target type="virtio" name="org.qemu.guest_agent.0"/>
<address type="virtio-serial" controller="0" bus="0" port="1"/>
</channel>
<channel type="spicevmc">
<target type="virtio" name="com.redhat.spice.0"/>
<address type="virtio-serial" controller="0" bus="0" port="2"/>
</channel>
<input type="tablet" bus="usb">
<address type="usb" bus="0" port="1"/>
</input>
<input type="mouse" bus="ps2"/>
<input type="keyboard" bus="ps2"/>
<graphics type="spice" autoport="yes">
<listen type="address"/>
<image compression="off"/>
</graphics>
<sound model="ich9">
<address type="pci" domain="0x0000" bus="0x00" slot="0x1b" function="0x0"/>
</sound>
<audio id="1" type="spice"/>
<video>
<model type="virtio" heads="1" primary="yes"/>
<address type="pci" domain="0x0000" bus="0x00" slot="0x01" function="0x0"/>
</video>
<redirdev bus="usb" type="spicevmc">
<address type="usb" bus="0" port="2"/>
</redirdev>
<redirdev bus="usb" type="spicevmc">
<address type="usb" bus="0" port="3"/>
</redirdev>
<memballoon model="virtio">
<address type="pci" domain="0x0000" bus="0x05" slot="0x00" function="0x0"/>
</memballoon>
<rng model="virtio">
<backend model="random">/dev/urandom</backend>
<address type="pci" domain="0x0000" bus="0x06" slot="0x00" function="0x0"/>
</rng>
</devices>
</domain>
''' # noqa: E501
logger = logging.getLogger(__name__)
def parse_arguments() -> argparse.Namespace:
"""Return parsed command line arguments as dictionary."""
parser = argparse.ArgumentParser(
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
subparsers = parser.add_subparsers(dest='subcommand', help='Sub command')
distributions = list(URLS.keys())
distribution = os.environ.get('DISTRIBUTION')
formatter_class = argparse.ArgumentDefaultsHelpFormatter
default_distribution = 'testing'
if distribution and distribution in distributions:
default_distribution = distribution
def _add_common_args(subparser):
subparser.add_argument('--distribution', choices=distributions,
default=default_distribution,
help='Distribution to work with')
subparser.add_argument(
'--machine-type', choices=('container', 'vm'), default='container',
help='Type of the machine, container to virtual machine, to run '
'operation on')
# Up
subparser = subparsers.add_parser('up', help='Bring up the container',
formatter_class=formatter_class)
_add_common_args(subparser)
subparser.add_argument('--image-size', default='16G',
help='Disk image size to resize to after download')
subparser.add_argument('--hkp-client', choices=('gpg', 'wget'),
default='gpg', help='Client for key retrieval')
# Print IP address
subparser = subparsers.add_parser(
'ip', help='Print the IP address of the container.',
formatter_class=formatter_class)
_add_common_args(subparser)
# ssh
subparser = subparsers.add_parser('ssh', help='SSH into the container',
formatter_class=formatter_class)
_add_common_args(subparser)
# Run tests
subparser = subparsers.add_parser('run-tests',
help='Run tests in the container',
formatter_class=formatter_class)
_add_common_args(subparser)
subparser.add_argument(
'--pytest-args', nargs='...',
help='Additional arguments to pass to the pytest command')
# Stop
subparser = subparsers.add_parser('stop', help='Stop the container',
formatter_class=formatter_class)
_add_common_args(subparser)
# Destroy
subparser = subparsers.add_parser('destroy',
help='Destroy the container image',
formatter_class=formatter_class)
_add_common_args(subparser)
# Update
subparser = subparsers.add_parser(
'update', help='Update the container image to the latest version',
formatter_class=formatter_class)
_add_common_args(subparser)
subparser.add_argument('--hkp-client', choices=('gpg', 'wget'),
default='gpg', help='Client for key retrieval')
# Display help message when no args are passed
if len(sys.argv) == 1:
parser.print_help()
sys.exit()
return parser.parse_args()
def _get_work_directory() -> pathlib.Path:
"""Return script's working directory."""
return pathlib.Path(__file__).parent / '.container'
def _check_command(command) -> bool:
"""Check that a command is present in PATH."""
if command == 'sudo':
which = ['which', command]
else:
which = ['sudo', 'which', command]
process = subprocess.run(which, stdout=subprocess.DEVNULL, check=False)
return process.returncode == 0
def _verify_dependencies() -> None:
"""Ensure that all the dependencies are present."""
if not _check_command('sudo'):
logger.info('sudo command is needed. Run `apt install sudo`.')
sys.exit(1)
# Old versions of machinectl can't modprobe loop driver and immediately use
# it leading to machinectl start failing first time after boot. See
# https://github.com/systemd/systemd/issues/13130 . Workaround for old
# versions of machinectl. Ignore errors.
subprocess.run(['sudo', 'modprobe', '--all', '--quiet', 'loop'],
check=False)
dependencies = {
'systemd-nspawn': 'systemd-container',
'machinectl': 'systemd-container',
'kpartx': 'kpartx',
'wget': 'wget',
'gpg': 'gpg',
'xz': 'xz-utils',
'parted': 'parted',
'sgdisk': 'gdisk',
'btrfs': 'btrfs-progs',
'nmcli': 'network-manager',
'dnsmasq': 'dnsmasq',
'ssh': 'openssh-client',
'ssh-keygen': 'openssh-client',
'virsh': 'libvirt-clients',
}
missing_commands = []
missing_packages = []
for command, package in dependencies.items():
if not _check_command(command):
missing_commands.append(command)
missing_packages.append(package)
if not missing_commands:
return
logger.info('You need to install the following commands: %s',
' '.join(missing_commands))
process = subprocess.run(['lsb_release', '--id', '--short'],
stdout=subprocess.PIPE, check=False)
if process.stdout.decode().strip() != 'Debian':
sys.exit(1)
logger.info('Running apt for missing packages: %s',
' '.join(missing_packages))
subprocess.run(['sudo', 'apt', 'install'] + missing_packages, check=True)
def _download_file(url: str, target_file: pathlib.Path, force: bool = False):
"""Download a file from remote URL."""
if target_file.exists():
if force:
os.remove(target_file)
else:
return
partial_file = target_file.with_suffix(target_file.suffix + '.partial')
logger.info('Downloading %s', target_file)
subprocess.run([
'wget', '--quiet', '--show-progress', '--continue',
'--output-document',
str(partial_file), url
], check=True)
partial_file.rename(target_file)
def _receive_keys_with_gpg(gpg_home: pathlib.Path, key_ids: list[str]):
"""Use gpg to retrieve and import a list of keys."""
subprocess.run([
'gpg', '--quiet', '--homedir',
str(gpg_home), '--keyserver', KEY_SERVER, '--recv-keys'
] + key_ids, check=True)
def _receive_keys_with_wget(gpg_home: pathlib.Path, key_ids: list[str]):
"""Use wget to retrieve a list of keys and import them."""
for key_id in key_ids:
# Download public key
logger.info('Getting public key %s', key_id)
url = KEY_SERVER_HTTPS_API.format(key_id=key_id)
wget_result = subprocess.run(
['wget', '--quiet', '--output-document=-', url], check=True,
capture_output=True)
public_key = wget_result.stdout
subprocess.run(
['gpg', '--quiet', '--homedir',
str(gpg_home), '--import=-'], input=public_key, check=True)
def _verify_signature(hkp_client: str, data_file: pathlib.Path,
signature_file: pathlib.Path):
"""Verify the detached signature on a file using GPG."""
verified_file = signature_file.with_suffix(signature_file.suffix +
'.verified')
if verified_file.exists():
return
gpg_home = _get_work_directory() / 'gpg'
gpg_home.mkdir(exist_ok=True)
gpg_home.chmod(0o700)
logger.info('Receiving GPG keys')
if hkp_client == 'wget':
_receive_keys_with_wget(gpg_home, TRUSTED_KEYS)
else:
_receive_keys_with_gpg(gpg_home, TRUSTED_KEYS)
process = subprocess.run(
['gpg', '--quiet', '--homedir',
str(gpg_home), '--armor', '--export'] + TRUSTED_KEYS, check=True,
stdout=subprocess.PIPE)
exported_keys = process.stdout
trusted_keys = gpg_home / 'trustedkeys.gpg'
subprocess.run([
'gpg', '--quiet', '--homedir',
str(gpg_home), '--no-default-keyring', '--keyring',
str(trusted_keys), '--import', '-'
], check=True, input=exported_keys)
logger.info('Verify GPG signature')
subprocess.run([
'gpgv', '--quiet', '--homedir',
str(gpg_home),
str(signature_file),
str(data_file)
], check=True)
verified_file.touch()
def _extract_image(compressed_file: pathlib.Path):
"""Extract the image file."""
decompressed_file = compressed_file.with_suffix('')
if decompressed_file.exists():
return decompressed_file
logger.info('Decompressing file %s', compressed_file)
partial_file = compressed_file.with_suffix('.partial')
with partial_file.open('w', encoding='utf-8') as file_handle:
subprocess.run([
'xz', '--verbose', '--decompress', '--keep', '--to-stdout',
str(compressed_file)
], check=True, stdout=file_handle)
partial_file.rename(decompressed_file)
return decompressed_file
def _get_compressed_image_path(distribution: str) -> pathlib.Path:
"""Return the path of the compressed image."""
url = URLS[distribution]
result = urllib.parse.urlparse(url)
return _get_work_directory() / pathlib.Path(result.path).name
def _get_image_file(distribution: str) -> pathlib.Path:
"""Return the path of the image file."""
compressed_image = _get_compressed_image_path(distribution)
return compressed_image.with_suffix('')
def _get_project_folder() -> pathlib.Path:
"""Return the read-only folder that should be exposed into container."""
return _get_work_directory().parent.resolve()
def _get_overlay_folder(distribution: str) -> pathlib.Path:
"""Return the writable folder that should be exposed into container."""
default_data_dir = pathlib.Path.home() / '.local' / 'share'
data_folder = os.environ.get('XDG_DATA_HOME', default_data_dir)
folder = pathlib.Path(data_folder) / \
'freedombox-container' / 'overlay' / distribution
return folder.resolve()
def _download_disk_image(distribution: str, hkp_client: str,
force: bool = False) -> pathlib.Path:
"""Download and unpack FreedomBox disk image."""
_get_work_directory().mkdir(exist_ok=True)
url = URLS[distribution]
target_file = _get_compressed_image_path(distribution)
_download_file(url, target_file, force=force)
signature_file = target_file.with_suffix(target_file.suffix + '.sig')
_download_file(url + '.sig', signature_file, force=force)
_verify_signature(hkp_client, target_file, signature_file)
return _extract_image(target_file)
def _get_partition_info(image_file: pathlib.Path) -> tuple[str, str]:
"""Return the number of the final partition in the image file."""
process = subprocess.run(
['sudo', 'parted', '--script',
str(image_file), 'print'], stdout=subprocess.PIPE, check=True)
lines = process.stdout.decode().splitlines()
last_partition_number = lines[-2].split()[0]
partition_table_type = 'msdos'
for line in lines:
if line.startswith('Partition Table:'):
partition_table_type = line.partition(': ')[2]
logger.info('Main partition: %s', last_partition_number)
return partition_table_type, last_partition_number
def _resize_disk_image(image_file: pathlib.Path, new_size: str):
"""Resize the disk image if has not already been."""
if new_size[-1] != 'G':
raise ValueError(f'Invalid size: {new_size}')
new_size_bytes = int(new_size.strip('G')) * 1024 * 1024 * 1024
image_size = image_file.stat().st_size
if image_size >= new_size_bytes:
return
logger.info('Resizing disk image to %s', new_size)
disk_free = shutil.disk_usage(_get_work_directory()).free
if disk_free < new_size_bytes - image_size:
raise ValueError(f'Not enough free space on disk: {disk_free} bytes')
subprocess.run(
['truncate', '--size',
str(new_size_bytes),
str(image_file)], check=True)
partition_table_type, last_partition_number = _get_partition_info(
image_file)
if partition_table_type == 'gpt':
subprocess.run(
['sudo', 'sgdisk', '--move-second-header',
str(image_file)], check=True)
subprocess.run([
'sudo', 'parted', '--align=optimal', '--script',
str(image_file), 'resizepart', last_partition_number, '100%'
], check=True)
process = subprocess.run(
['sudo', 'kpartx', '-avs', str(image_file)], stdout=subprocess.PIPE,
check=True)
last_line = process.stdout.decode().splitlines()[-1]
partition = '/dev/mapper/' + last_line.split()[2]
old_fsid = _get_fsid(partition)
subprocess.run(['sudo', 'btrfstune', '-uf', partition], check=True)
new_fsid = _get_fsid(partition)
with tempfile.TemporaryDirectory(
dir=_get_work_directory().resolve()) as mount_point:
subprocess.run(['sudo', 'mount', partition, mount_point], check=True)
subprocess.run(
['sudo', 'btrfs', 'filesystem', 'resize', 'max', mount_point],
check=True, stdout=subprocess.DEVNULL)
_update_fsid(mount_point, partition, old_fsid, new_fsid)
subprocess.run(['sudo', 'umount', mount_point], check=True)
subprocess.run(
['sudo', 'kpartx', '-ds', str(image_file)], check=True,
stderr=subprocess.DEVNULL)
def _get_fsid(partition: str) -> str:
"""Return the btrfs filesystem ID for a device."""
# Find the new FSID
process = subprocess.run(
['sudo', 'btrfs', 'filesystem', 'show', partition], check=True,
stdout=subprocess.PIPE)
return process.stdout.decode().splitlines()[0].rpartition(' ')[2]
def _update_fsid(mount_point: str, partition: str, old_fsid: str,
new_fsid: str):
"""After changing btrfs fsid, run grub-install to keep image bootable."""
# Guess the loopback device for the filesystem
matches = re.match(r'^/dev/mapper/loop(\d+)p\d+$', partition)
assert matches
loop_device = f'/dev/loop{matches[1]}'
# Mount /dev, /proc and run grub commands in chroot
grub_args = []
if platform.machine() in ('aarch64', 'arm64'):
grub_args += ['--no-nvram']
subprocess.run(
['sudo', 'mount', '-o', 'bind', '/dev/', f'{mount_point}/dev'],
check=True)
subprocess.run(
['sudo', 'mount', '-o', 'bind', '/proc/', f'{mount_point}/proc'],
check=True)
subprocess.run(['sudo', 'chroot', mount_point, 'update-grub'], check=True)
subprocess.run(
['sudo', 'chroot', mount_point, 'grub-install', loop_device] +
grub_args, check=True)
subprocess.run([
'sudo', 'chroot', mount_point, 'sed', '-ie',
f's|UUID={old_fsid}|UUID={new_fsid}|', '/etc/fstab'
], check=True)
subprocess.run(['sudo', 'umount', f'{mount_point}/proc'], check=True)
subprocess.run(['sudo', 'umount', f'{mount_point}/dev'], check=True)
def _runc(image_file: pathlib.Path, command: list[str], **kwargs):
"""Run a command inside the container."""
subprocess.run([
'sudo', 'systemd-nspawn', '--image',
str(image_file), '--console=autopipe', '--quiet'
] + command, check=True, **kwargs)
def _setup_users(image_file: pathlib.Path):
"""Change UID, GID and password of fbx user in container."""
folder = _get_project_folder()
uid = 10000
gid = 10000
logger.info('In image: Setting UID/GID of "fbx" to %s/%s', uid, gid)
_runc(image_file, ['groupmod', '--gid', str(gid), 'fbx'])
_runc(image_file, ['usermod', '--uid',
str(uid), '--gid',
str(gid), 'fbx'], stdout=subprocess.DEVNULL)
uid = folder.stat().st_uid
gid = folder.stat().st_gid
logger.info(
'In image: Setting UID/GID of "plinth" to %s/%s to match %s/%s', uid,
gid, folder.owner(), folder.group())
_runc(image_file, ['groupmod', '--gid', str(gid), 'plinth'])
_runc(image_file,
['usermod', '--uid',
str(uid), '--gid',
str(gid), 'plinth'], stdout=subprocess.DEVNULL)
logger.info('In image: Setting up sudo for users "fbx" and "plinth"')
sudo_config = 'Cmnd_Alias FREEDOMBOX_ACTION_DEV = /usr/share/plinth/' \
'actions/actions, /freedombox/actions/actions\n' \
'Defaults!FREEDOMBOX_ACTION_DEV closefrom_override\n' \
'plinth ALL=(ALL:ALL) NOPASSWD:SETENV : FREEDOMBOX_ACTION_DEV\n' \
'fbx ALL=(ALL:ALL) NOPASSWD : ALL\n'
_runc(image_file, ['tee', '/etc/sudoers.d/01-freedombox-development'],
input=sudo_config.encode(), stdout=subprocess.DEVNULL)
def _setup_ssh(image_file: pathlib.Path):
"""Setup SSH server and client keys."""
logger.info('In image: Generating SSH server keys')
_runc(image_file, ['dpkg-reconfigure', 'openssh-server'],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
ssh_directory = _get_work_directory() / 'ssh'
ssh_directory.mkdir(exist_ok=True)
ssh_directory.chmod(0o700)
key_file = ssh_directory / 'id_ed25519'
if not key_file.exists():
logger.info('Generating SSH client key %s', key_file)
subprocess.run(
['ssh-keygen', '-t', 'ed25519', '-N', '', '-f',
str(key_file)], stdout=subprocess.DEVNULL, check=True)
public_key_file = key_file.with_suffix('.pub')
public_key = public_key_file.read_bytes()
if not public_key:
logger.error('Unable to read SSH public key from %s', public_key_file)
sys.exit(1)
logger.info(
'Adding SSH client key to "fbx" user authorized keys in container')
_runc(image_file, ['mkdir', '--parents', '/home/fbx/.ssh'])
_runc(image_file, ['tee', '--append', '/home/fbx/.ssh/authorized_keys'],
input=public_key, stdout=subprocess.DEVNULL)
_runc(image_file, ['chmod', '600', '/home/fbx/.ssh/authorized_keys'])
_runc(image_file, ['chown', 'fbx:fbx', '/home/fbx/.ssh/authorized_keys'])
def _setup_image(image_file: pathlib.Path):
"""Prepare the image for execution."""
setup_file = image_file.with_suffix(image_file.suffix + '.setup')
if setup_file.exists():
return
logger.info('In image: Disabling automatic updates temporarily')
contents = 'APT::Periodic::Update-Package-Lists "0";\n' \
'APT::Periodic::Unattended-Upgrade "0";\n'
_runc(image_file, ['tee', '/etc/apt/apt.conf.d/20auto-upgrades'],
input=contents.encode())
logger.info('In image: Disabling FreedomBox service')
_runc(image_file, ['systemctl', 'disable', 'plinth'],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
logger.info('In image: Creating virtiofs mount at /freedombox')
mount = '''[Unit]
Description=FreedomBox development directory on host
ConditionVirtualization=kvm
[Mount]
What=freedombox
Where=/freedombox
Type=virtiofs
[Install]
WantedBy=multi-user.target
'''
_runc(image_file, ['tee', '/usr/lib/systemd/system/freedombox.mount'],
input=mount.encode(), stdout=subprocess.DEVNULL)
_runc(image_file, ['systemctl', 'enable', 'freedombox.mount'],
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
_setup_ssh(image_file)
_setup_users(image_file)
setup_file.touch()
logger.info('Setup completed')
def _destroy_image(distribution: str):
"""Remove all traces of the machine and its image."""
image_file = _get_image_file(distribution)
logger.info('Removing image file %s', image_file)
try:
image_file.with_suffix(image_file.suffix + '.provisioned').unlink()
except FileNotFoundError:
pass
try:
image_file.with_suffix(image_file.suffix + '.setup').unlink()
except FileNotFoundError: