fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-01-16 15:50:44 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

tools: add nm-in-vm script

Browse source 
https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1724
This commit is contained in:
Íñigo Huguet 2023-09-21 15:53:46 +02:00
commit 33cc96b137
22 changed files with 746 additions and 223 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

0
tools/nm-in-container/data/.gitignore → tools/nm-guest-data/.gitignore vendored
View file

10
tools/nm-guest-data/README.md Normal file
View file

@ -0,0 +1,10 @@
Run NetworkManager in Container for Development
===============================================
Run `nm-in-container` script for running NetworkManager in a non-root,
privileged podman container. Run `nm-in-vm` to do it in a vitual machine.
This is useful for testing NetworkManager for development.
Try `./nm-in-container --help` or `./nm-in-vm --help` to see options. Inside
the container, see the bash history for useful commands and read the hints in
"/etc/motd".

0
tools/nm-in-container/data/data-_nm-in-container-setup.sh → tools/nm-guest-data/bin-_nm-in-container-setup.sh.in Executable file → Normal file
View file

0
tools/nm-in-container/data/data-nm-deploy.sh → tools/nm-guest-data/bin-nm-deploy.sh.in Executable file → Normal file
View file

0
tools/nm-in-container/data/data-nm-env-prepare.sh → tools/nm-guest-data/bin-nm-env-prepare.sh.in Executable file → Normal file
View file

4
tools/nm-guest-data/etc-bashrc-motd.my.in Normal file
View file

@ -0,0 +1,4 @@
if test "$SHOW_MOTD" != 0; then
cat /etc/motd
export SHOW_MOTD=0
fi

43
tools/nm-guest-data/etc-bashrc.my.in Normal file
View file

@ -0,0 +1,43 @@
alias m="make -j 8"
alias n="ninja -C build"
alias l='ls -l --color=auto'
ulimit -c unlimited
export G_DEBUG=fatal-warnings
unset DEBUGINFOD_URLS
export NMCI_DEBUG=1
Clean() {
systemctl stop NetworkManager
rm -i -rf /run/NetworkManager
nm-env-prepare.sh
}
Cat-Timestamp() {
while IFS=$'\n' read line; do
printf "[%s]: %s\n" "1689938340.403232924" "$line"
done
}
Journald-clear() {
rm -rf /var/log/journal/????????????????????????????????/*
systemctl restart systemd-journald
}
nm_run_gdb() {
systemctl stop NetworkManager.service
gdb --args "${1:-/opt/test/sbin/NetworkManager}" --debug
}
nm_run_normal() {
systemctl stop NetworkManager.service
"${1:-/opt/test/sbin/NetworkManager}" --debug 2>&1 | tee /tmp/nm-log.txt
}
. /usr/share/git-core/contrib/completion/git-prompt.sh
PS1="\[\033[01;36m\]\u@\h\[\033[00m\]:\t:\[\033[01;34m\]\w\$(__git_ps1 \" \[\033[01;36m\](%s)\[\033[00m\]\")\[\033[00m\]$ "
export GIT_PS1_SHOWDIRTYSTATE=1

75
tools/nm-guest-data/etc-motd-container.in Normal file
View file

@ -0,0 +1,75 @@
*** nm-in-container:
find NetworkManager bind mounted at {{BASEDIR_NM}}
run `nm-env-prepare.sh setup --idx 1` to setup test interfaces
Coredumps: coredumps are not namespaced, so by default they will
be sent to coredumpctl of the outer host, which has no idea where
to get the debugging symbols from. A possible workaround is setting
$ echo '/tmp/core.%e.%p' | sudo tee /proc/sys/kernel/core_pattern
so that core dumps get written to file. Afterwards, restore with
$ echo '|/usr/lib/systemd/systemd-coredump %P %u %g %s %t %c %h' | sudo tee /proc/sys/kernel/core_pattern
from /usr/lib/sysctl.d/50-coredump.conf.
For example, configure NetworkManager with
$ ./configure \
--enable-address-sanitizer=no \
--enable-compile-warnings=yes \
--enable-concheck \
--enable-config-plugin-ibft=yes \
--enable-gtk-doc \
--enable-ifcfg-rh=yes \
--enable-ifcfg-suse \
--enable-ifnet \
--enable-ifupdown=yes \
--enable-introspection \
--enable-json-validation=yes \
--enable-maintainer-mode \
--enable-more-logging \
--enable-more-warnings=error \
--enable-ovs=yes \
--enable-polkit=yes \
--enable-teamdctl=yes \
--enable-undefined-sanitizer=no \
--enable-vala=yes \
--enable-wimax \
--localstatedir=/var \
--prefix=/opt/test \
--sysconfdir=/etc \
--with-config-dhcp-default=internal \
--with-config-dns-rc-manager-default=auto \
--with-consolekit=yes \
--with-consolekit=yes \
--with-crypto=nss \
--with-dhclient=yes \
--with-dhcpcanon=yes \
--with-dhcpcd=yes \
--with-iwd=yes \
--with-libnm-glib=yes \
--with-modem-manager-1 \
--with-netconfig=/bin/nowhere/netconfig \
--with-nm-cloud-setup=yes \
--with-nmcli=yes \
--with-nmtui=yes \
--with-ofono=yes \
--with-resolvconf=/bin/nowhere/resolvconf \
--with-session-tracking=systemd \
--with-suspend-resume=systemd \
--with-systemd-logind=yes \
--with-valgrind=yes \
--enable-tests="${NM_BUILD_TESTS:-yes}" \
--with-more-asserts="${NM_BUILD_MORE_ASSERTS:-1000}" \
"${NM_CONFIGURE_OTPS[@]}"
Test with:
$ systemctl stop NetworkManager; /opt/test/sbin/NetworkManager --debug 2>&1 | tee -a /tmp/nm-log.txt
Or better, configure with `contrib/fedora/rpm/configure-for-system.sh`,
subsequent `make && make install` will overwrite your system's NetworkManager,
and you can test it with `systemctl daemon-reload ; systemctl restart NetworkManager`.
Run NM-ci tests after creating eth1 with
`nm-env-prepare.sh --prefix eth -i 1 && sleep 1 && nmcli device connect eth1`.

63
tools/nm-guest-data/etc-motd-vm.in Normal file
View file

@ -0,0 +1,63 @@
*** nm-in-vm:
find NetworkManager bind mounted at {{BASEDIR_NM}}
run `nm-env-prepare.sh setup --idx 1` to setup test interfaces
For example, configure NetworkManager with
$ ./configure \
--enable-address-sanitizer=no \
--enable-compile-warnings=yes \
--enable-concheck \
--enable-config-plugin-ibft=yes \
--enable-gtk-doc \
--enable-ifcfg-rh=yes \
--enable-ifcfg-suse \
--enable-ifnet \
--enable-ifupdown=yes \
--enable-introspection \
--enable-json-validation=yes \
--enable-maintainer-mode \
--enable-more-logging \
--enable-more-warnings=error \
--enable-ovs=yes \
--enable-polkit=yes \
--enable-teamdctl=yes \
--enable-undefined-sanitizer=no \
--enable-vala=yes \
--enable-wimax \
--localstatedir=/var \
--prefix=/opt/test \
--sysconfdir=/etc \
--with-config-dhcp-default=internal \
--with-config-dns-rc-manager-default=auto \
--with-consolekit=yes \
--with-consolekit=yes \
--with-crypto=nss \
--with-dhclient=yes \
--with-dhcpcanon=yes \
--with-dhcpcd=yes \
--with-iwd=yes \
--with-libnm-glib=yes \
--with-modem-manager-1 \
--with-netconfig=/bin/nowhere/netconfig \
--with-nm-cloud-setup=yes \
--with-nmcli=yes \
--with-nmtui=yes \
--with-ofono=yes \
--with-resolvconf=/bin/nowhere/resolvconf \
--with-session-tracking=systemd \
--with-suspend-resume=systemd \
--with-systemd-logind=yes \
--with-valgrind=yes \
--enable-tests="${NM_BUILD_TESTS:-yes}" \
--with-more-asserts="${NM_BUILD_MORE_ASSERTS:-1000}" \
"${NM_CONFIGURE_OTPS[@]}"
Test with:
$ systemctl stop NetworkManager; /opt/test/sbin/NetworkManager --debug 2>&1 | tee -a /tmp/nm-log.txt
Or better, if using Fedora, configure with `contrib/fedora/rpm/configure-for-system.sh`,
subsequent `make && make install` will overwrite your system's NetworkManager,
and you can test it with `systemctl daemon-reload ; systemctl restart NetworkManager`.
Run NM-ci tests after creating eth1 with
`nm-env-prepare.sh --prefix eth -i 1 && sleep 1 && nmcli device connect eth1`.

0
tools/nm-in-container/data/data-etc-rc.local → tools/nm-guest-data/etc-rc.local.in Executable file → Normal file
View file

31
tools/nm-guest-data/home-bash_history.in Normal file
View file

@ -0,0 +1,31 @@
NM-log
NM-log /tmp/nm-log.txt
behave -f html --stop -t ipv4_method_static_with_IP ./features/scenarios/ipv4.feature
behave -f html --stop ./features/scenarios/vrf.feature
cd {{BASEDIR_NM}}
cd /NetworkManager-ci
cd /NetworkManager
for i in {1..9}; do nm-env-prepare.sh --prefix eth -i $i; done
Journald-clear
journalctl | NM-log
journalctl --since '3 min ago' | NM-log
m
make
make install
n
nm-deploy.sh
nm-env-prepare.sh
nm-env-prepare.sh --prefix eth -i 1
nm-env-prepare.sh --prefix eth -i 1 && sleep 1 && nmcli device connect eth1
nm_run_gdb
nm_run_normal
gdb /usr/sbin/NetworkManager /tmp/core.NetworkManager.
nmcli connection add type pppoe con-name ppp-net1 ifname ppp-net1 pppoe.parent net1 service isp username test password networkmanager autoconnect no
nmcli device connect eth1
systemctl stop NetworkManager; /opt/test/sbin/NetworkManager --debug 2>&1 | tee -a ./nm-log.txt
systemctl stop NetworkManager; gdb -ex run --args /opt/test/sbin/NetworkManager --debug
systemctl stop NetworkManager
systemctl daemon-reload ; systemctl restart NetworkManager
(cd /NetworkManager && n && n install && systemctl daemon-reload && systemctl restart NetworkManager.service)
(cd /NetworkManager && m && m install && systemctl daemon-reload && systemctl restart NetworkManager.service)
systemctl status NetworkManager

2
tools/nm-guest-data/home-behaverc.in Normal file
View file

@ -0,0 +1,2 @@
[behave.formatters]
html = behave_html_formatter:HTMLFormatter

2
tools/nm-guest-data/home-gdb_history.in Normal file
View file

@ -0,0 +1,2 @@
run
run --debug 2>&1 | tee /tmp/nm-log.txt

2
tools/nm-guest-data/home-gdbinit.in Normal file
View file

@ -0,0 +1,2 @@
set history save
set history filename ~/.gdb_history

19
tools/nm-guest-data/nm-90-my.conf.in Normal file
View file

@ -0,0 +1,19 @@
[main]
no-auto-default=*
debug=RLIMIT_CORE,fatal-warnings
[logging]
level=TRACE
domains=ALL,VPN_PLUGIN:TRACE
[device-managed-0]
match-device=interface-name:d_*,interface-name:tap*
managed=0
[device-managed-1]
match-device=interface-name:net*,interface-name:eth*
managed=1
[device-host-net]
match-device=interface-name:host_net
managed=0

0
tools/nm-guest-data/nm-95-user.conf.in Normal file
View file

6
tools/nm-guest-data/systemd-10-host-net.link.in Normal file
View file

@ -0,0 +1,6 @@
[Match]
Driver=virtio_net
[Link]
NamePolicy=
Name=host_net

0
tools/nm-in-container/data/data-etc-systemd-20-nm-in-container.override → tools/nm-guest-data/systemd-20-nm.override.in
View file

14
tools/nm-guest-data/systemd-dhcp-host.service.in Normal file
View file

@ -0,0 +1,14 @@
[Unit]
Description=dhclient service to get connectivity with the host
After=network.target
[Service]
Type=simple
Restart=on-failure
User=root
RestartSec=5
ExecStart=dhclient -d host_net
ExecStop=dhclient -r host_net
[Install]
WantedBy=multi-user.target

248
tools/nm-in-container/nm-in-container → tools/nm-in-container
View file

@ -43,8 +43,8 @@ if [ -z "$BASE_IMAGE" ]; then
BASE_IMAGE=fedora:latest
fi
BASEDIR_NM="$(readlink -f "$(dirname "$(readlink -f "$0")")/../..")"
BASEDIR_DATA="$BASEDIR_NM/tools/nm-in-container/data"
BASEDIR_NM="$(readlink -f "$(dirname "$(readlink -f "$0")")/..")"
BASEDIR_DATA="$BASEDIR_NM/tools/nm-guest-data"
BASEDIR_NM_CI=
if [ -d "$BASEDIR_NM/.git/NetworkManager-ci" ] ; then
@ -100,6 +100,13 @@ tmp_file() {
test -z "$2" || chmod "$2" "$1"
}
gen_file() {
local PERMS
[[ $1 =~ bin-* ]] && PERMS=755 || PERMS=644
sed "s|{{BASEDIR_NM}}|$BASEDIR_NM|g" "$BASEDIR_DATA/$1.in" \
| tmp_file "$BASEDIR_DATA/data-$1" $PERMS
}
bind_files() {
VARIABLE_NAME="$1"
@ -123,208 +130,18 @@ create_dockerfile() {
local CONTAINERFILE="$1"
local BASE_IMAGE="$2"
local GEN_FILES="bin-nm-env-prepare.sh bin-nm-deploy.sh bin-_nm-in-container-setup.sh
etc-rc.local etc-motd-container etc-bashrc.my etc-bashrc-motd.my nm-90-my.conf
nm-95-user.conf home-bash_history home-gdbinit home-gdb_history home-behaverc
systemd-20-nm.override"
cp "$BASEDIR_NM/contrib/scripts/NM-log" "$BASEDIR_DATA/data-NM-log"
cp "$BASEDIR_NM/contrib/scripts/NM-log" "$BASEDIR_DATA/data-bin-NM-log"
CLEANUP_FILES+=( "$BASEDIR_DATA/data-NM-log" )
cat <<EOF | tmp_file "$BASEDIR_DATA/data-motd"
*** nm-in-container:
find NetworkManager bind mounted at $BASEDIR_NM
run \`nm-env-prepare.sh setup --idx 1\` to setup test interfaces
Coredumps: coredumps are not namespaced, so by default they will
be sent to coredumpctl of the outer host, which has no idea where
to get the debugging symbols from. A possible workaround is setting
$ echo '/tmp/core.%e.%p' | sudo tee /proc/sys/kernel/core_pattern
so that core dumps get written to file. Afterwards, restore with
echo '|/usr/lib/systemd/systemd-coredump %P %u %g %s %t %c %h' | sudo tee /proc/sys/kernel/core_pattern
from /usr/lib/sysctl.d/50-coredump.conf.
For example, configure NetworkManager with
\$ ./configure \\
--enable-address-sanitizer=no \\
--enable-compile-warnings=yes \\
--enable-concheck \\
--enable-config-plugin-ibft=yes \\
--enable-gtk-doc \\
--enable-ifcfg-rh=yes \\
--enable-ifcfg-suse \\
--enable-ifnet \\
--enable-ifupdown=yes \\
--enable-introspection \\
--enable-json-validation=yes \\
--enable-maintainer-mode \\
--enable-more-logging \\
--enable-more-warnings=error \\
--enable-ovs=yes \\
--enable-polkit=yes \\
--enable-teamdctl=yes \\
--enable-undefined-sanitizer=no \\
--enable-vala=yes \\
--enable-wimax \\
--localstatedir=/var \\
--prefix=/opt/test \\
--sysconfdir=/etc \\
--with-config-dhcp-default=internal \\
--with-config-dns-rc-manager-default=auto \\
--with-consolekit=yes \\
--with-consolekit=yes \\
--with-crypto=nss \\
--with-dhclient=yes \\
--with-dhcpcanon=yes \\
--with-dhcpcd=yes \\
--with-iwd=yes \\
--with-libnm-glib=yes \\
--with-modem-manager-1 \\
--with-netconfig=/bin/nowhere/netconfig \\
--with-nm-cloud-setup=yes \\
--with-nmcli=yes \\
--with-nmtui=yes \\
--with-ofono=yes \\
--with-resolvconf=/bin/nowhere/resolvconf \\
--with-session-tracking=systemd \\
--with-suspend-resume=systemd \\
--with-systemd-logind=yes \\
--with-valgrind=yes \\
--enable-tests="\${NM_BUILD_TESTS:-yes}" \\
--with-more-asserts="\${NM_BUILD_MORE_ASSERTS:-1000}" \\
"\${NM_CONFIGURE_OTPS[@]}"
Test with:
\$ systemctl stop NetworkManager; /opt/test/sbin/NetworkManager --debug 2>&1 | tee -a /tmp/nm-log.txt
Or better, configure with \`contrib/fedora/rpm/configure-for-system.sh\`,
subsequent \`make && make install\` will overwrite your system's NetworkManager,
and you can test it with \`systemctl daemon-reload ; systemctl restart NetworkManager\`.
Run NM-ci tests after creating eth1 with
\`nm-env-prepare.sh --prefix eth -i 1 && sleep 1 && nmcli device connect eth1\`.
EOF
cat <<EOF | tmp_file "$BASEDIR_DATA/data-bashrc.my"
alias m="make -j 8"
alias n="ninja -C build"
alias l='ls -l --color=auto'
ulimit -c unlimited
export G_DEBUG=fatal-warnings
unset DEBUGINFOD_URLS
export NMCI_DEBUG=1
Clean() {
systemctl stop NetworkManager
rm -i -rf /run/NetworkManager
nm-env-prepare.sh
}
Cat-Timestamp() {
while IFS=$'\n' read line; do
printf "[%s]: %s\n" "$(date '+%s.%N')" "$line"
for f in $GEN_FILES; do
gen_file "$f"
done
}
Journald-clear() {
rm -rf /var/log/journal/????????????????????????????????/*
systemctl restart systemd-journald
}
nm_run_gdb() {
systemctl stop NetworkManager.service
gdb --args "\${1:-/opt/test/sbin/NetworkManager}" --debug
}
nm_run_normal() {
systemctl stop NetworkManager.service
"\${1:-/opt/test/sbin/NetworkManager}" --debug 2>&1 | tee /tmp/nm-log.txt
}
. /usr/share/git-core/contrib/completion/git-prompt.sh
PS1="\[\\033[01;36m\]\u@\h\[\\033[00m\]:\\t:\[\\033[01;34m\]\w\\\$(__git_ps1 \\" \[\\033[01;36m\](%s)\[\\033[00m\]\\")\[\\033[00m\]\$ "
export GIT_PS1_SHOWDIRTYSTATE=1
if test "\$SHOW_MOTD" != 0; then
cat /etc/motd
export SHOW_MOTD=0
fi
EOF
cat <<EOF | tmp_file "$BASEDIR_DATA/data-90-my.conf"
[main]
no-auto-default=*
debug=RLIMIT_CORE,fatal-warnings
[logging]
level=TRACE
domains=ALL,VPN_PLUGIN:TRACE
[device-managed-0]
match-device=interface-name:d_*,interface-name:tap*
managed=0
[device-managed-1]
match-device=interface-name:net*,interface-name:eth*
managed=1
EOF
cat <<EOF | tmp_file "$BASEDIR_DATA/data-95-user.conf"
EOF
cat <<EOF | tmp_file "$BASEDIR_DATA/data-bash_history" 600
NM-log
NM-log /tmp/nm-log.txt
behave -f html --stop -t ipv4_method_static_with_IP ./features/scenarios/ipv4.feature
behave -f html --stop ./features/scenarios/vrf.feature
cd $BASEDIR_NM
cd /NetworkManager-ci
cd /NetworkManager
for i in {1..9}; do nm-env-prepare.sh --prefix eth -i \$i; done
Journald-clear
journalctl | NM-log
journalctl --since '3 min ago' | NM-log
m
make
make install
n
nm-deploy.sh
nm-env-prepare.sh
nm-env-prepare.sh --prefix eth -i 1
nm-env-prepare.sh --prefix eth -i 1 && sleep 1 && nmcli device connect eth1
nm_run_gdb
nm_run_normal
gdb /usr/sbin/NetworkManager /tmp/core.NetworkManager.
nmcli connection add type pppoe con-name ppp-net1 ifname ppp-net1 pppoe.parent net1 service isp username test password networkmanager autoconnect no
nmcli device connect eth1
systemctl stop NetworkManager; /opt/test/sbin/NetworkManager --debug 2>&1 | tee -a ./nm-log.txt
systemctl stop NetworkManager; gdb -ex run --args /opt/test/sbin/NetworkManager --debug
systemctl stop NetworkManager
systemctl daemon-reload ; systemctl restart NetworkManager
(cd /NetworkManager && n && n install && systemctl daemon-reload && systemctl restart NetworkManager.service)
(cd /NetworkManager && m && m install && systemctl daemon-reload && systemctl restart NetworkManager.service)
systemctl status NetworkManager
EOF
cat <<EOF | tmp_file "$BASEDIR_DATA/data-gdbinit"
set history save
set history filename ~/.gdb_history
EOF
cat <<EOF | tmp_file "$BASEDIR_DATA/data-gdb_history" 600
run
run --debug 2>&1 | tee /tmp/nm-log.txt
EOF
cat <<EOF | tmp_file "$BASEDIR_DATA/data-behaverc" 600
[behave.formatters]
html = behave_html_formatter:HTMLFormatter
EOF
chmod 755 "$BASEDIR_DATA/data-etc-rc.local"
RUN_LN_BASEDIR_NM=
if [ -n "$BASEDIR_NM" -a "$BASEDIR_NM" != "/NetworkManager" ] ; then
@ -353,6 +170,7 @@ RUN dnf install -y \\
audit-libs-devel \\
bash-completion \\
bind-utils \\
black \\
bluez-libs-devel \\
ccache \\
clang \\
@ -478,7 +296,7 @@ RUN dnf install -y \\
wireguard-tools \\
wireshark-cli
RUN dnf debuginfo-install --skip-broken \$(ldd /usr/sbin/NetworkManager | sed -n 's/.* => \\(.*\\) (0x[0-9A-Fa-f]*)$/\1/p' | xargs -n1 readlink -f) -y
RUN dnf debuginfo-install --skip-broken NetworkManager \$(ldd /usr/sbin/NetworkManager | sed -n 's/.* => \\(.*\\) (0x[0-9A-Fa-f]*)$/\1/p' | xargs -n1 readlink -f) -y
RUN dnf clean all
@ -486,20 +304,21 @@ RUN pip3 install --user behave_html_formatter || true
RUN mkdir -p /etc/systemd/system/NetworkManager.service.d
COPY data-NM-log "/usr/bin/NM-log"
COPY data-nm-env-prepare.sh "/usr/bin/nm-env-prepare.sh"
COPY data-nm-deploy.sh "/usr/bin/nm-deploy.sh"
COPY data-_nm-in-container-setup.sh "/usr/bin/_nm-in-container-setup.sh"
COPY data-bin-NM-log "/usr/bin/NM-log"
COPY data-bin-nm-env-prepare.sh "/usr/bin/nm-env-prepare.sh"
COPY data-bin-nm-deploy.sh "/usr/bin/nm-deploy.sh"
COPY data-bin-_nm-in-container-setup.sh "/usr/bin/_nm-in-container-setup.sh"
COPY data-etc-rc.local "/etc/rc.d/rc.local"
COPY data-motd /etc/motd
COPY data-bashrc.my /etc/bashrc.my
COPY data-90-my.conf /etc/NetworkManager/conf.d/90-my.conf
COPY data-95-user.conf /etc/NetworkManager/conf.d/95-user.conf
COPY data-bash_history /root/.bash_history
COPY data-gdbinit /root/.gdbinit
COPY data-gdb_history /root/.gdb_history
COPY data-behaverc /root/.behaverc
COPY data-etc-systemd-20-nm-in-container.override /etc/systemd/system/NetworkManager.service.d/20-nm-in-container.override
COPY data-etc-motd-container /etc/motd
COPY data-etc-bashrc.my /etc/bashrc.my
COPY data-etc-bashrc-motd.my /etc/bashrc-motd.my
COPY data-nm-90-my.conf /etc/NetworkManager/conf.d/90-my.conf
COPY data-nm-95-user.conf /etc/NetworkManager/conf.d/95-user.conf
COPY data-home-bash_history /root/.bash_history
COPY data-home-gdbinit /root/.gdbinit
COPY data-home-gdb_history /root/.gdb_history
COPY data-home-behaverc /root/.behaverc
COPY data-systemd-20-nm.override /etc/systemd/system/NetworkManager.service.d/20-nm.override
RUN systemctl enable NetworkManager
@ -522,6 +341,7 @@ $RUN_LN_BASEDIR_NM_CI
RUN rm -rf /etc/NetworkManager/system-connections/*
RUN echo -e '\n. /etc/bashrc.my\n' >> /etc/bashrc
RUN echo -e '\n. /etc/bashrc-motd.my\n' >> /etc/bashrc
RUN updatedb
EOF

9
tools/nm-in-container/README.md
View file

@ -1,9 +0,0 @@
Run NetworkManager in Container for Development
===============================================
Run `nm-in-container` script for running NetworkManager in a non-root,
privileged podman container. This is useful for testing NetworkManager for
development.
Try `./nm-in-container --help` to see options. Inside the container, see the
bash history for useful commands and read the hints in "/etc/motd".

441
tools/nm-in-vm Executable file
View file

@ -0,0 +1,441 @@
#!/bin/bash
set -e
###############################################################################
# Script to create a virtual machine for testing NetworkManager.
#
# Commands:
# - build: build a new VM, named "$VM" ("nm")
# Args: the name of the OS to build, from `virt-builder --list` (Fedora by default)
# - run: start the VM.
# - exec: run bash inside the VM, connecting via ssh (this is the default).
# Args: command to execute inside the VM (then, ssh session won't open).
# - stop: stop the VM.
# - reexec: stop and exec.
# - clean: stop the VM and delete the image.
#
# Options (they MUST go before the command):
# -v | --vm: name of the VM to run the command on (by default 'nm').
# This allows to have more than one VM at the same time
# -h | --help: show this text
#
# NetworkManager directories:
#
# The NetworkManager root directory is mounted in the VM as a filesystem share.
# You can run `make install` and run tests.
#
# Create a symlink ./.git/NetworkManager-ci, to share the CI directory too.
#
# Required packages:
#
# Your host needs libvirt, libvirt-nss and guestfs-tools. To access the VM with
# `ssh root@$VM`, configure /etc/nsswitch.conf as explained in
# https://libvirt.org/nss.html (otherwise, `nm-in-vm exec` won't work, either).
#
# Prepare for testing:
#
# There is a script nm-env-prepare.sh to generate a net1 interface for testing.
# Currently NM-ci requires a working eth1, so use this before running a CI test:
# `nm-env-prepare.sh --prefix eth -i 1 && sleep 1 && nmcli device connect eth1`
#
# Additional VMs:
#
# By default, the VM named 'nm' is created, but additional ones can be created:
# $ nm-in-vm -v nm2 build
# $ nm-in-vm -v nm2 exec
# $ nm-in-vm -v nm2 stop
#
# Choosing a different OS:
#
# By default Fedora is used, but you can choose a different OS. Most from the
# list `virt-builder --list` will work.
# $ nm-in-vm build debian-12
# $ nm-in-vm exec
# $ nm-in-vm stop
###############################################################################
# Check for libvirt
if ! (command -v virsh && command -v virt-builder && command -v virt-install) &>/dev/null; then
echo "libvirt and guestfs-tools are required" >&2
exit 1
fi
# set defaults if user didn't define these values
VM=${VM:="nm"}
OS_VERSION=${OS_VERSION:=}
RAM=${RAM:=2048}
IMAGE_SIZE=${IMAGE_SIZE=20G}
ROOT_PASSWORD=${ROOT_PASSWORD:=nm}
LIBVIRT_POOL=${LIBVIRT_POOL:=default} # only useful if BASEDIR_VM_IMAGE is empty
BASEDIR_VM_IMAGE=${BASEDIR_VM_IMAGE:=}
BASEDIR_NM=${BASEDIR_NM:=}
BASEDIR_NM_CI=${BASEDIR_NM_CI:=}
HOST_BRIDGE=${HOST_BRIDGE:=virbr0}
SSH_LOG_LEVEL=${SSH_LOG_LEVEL:=ERROR}
if [[ -z $OS_VERSION ]]; then
# if running Fedora, select same version, else select latest Fedora
if grep -q "^ID=fedora$" /etc/os-release 2>/dev/null ; then
OS_VERSION="$(sed -n 's/^VERSION_ID=\([0-9]\+\)$/fedora-\1/p' /etc/os-release)"
else
OS_VERSION=$(virt-builder --list | grep '^fedora' | sort | tail -n 1 | cut -d" " -f 1)
fi
fi
if [[ -z $BASEDIR_NM ]]; then
BASEDIR_NM="$(readlink -f "$(dirname -- "$BASH_SOURCE")/..")"
fi
if [[ -z $BASEDIR_NM_CI && -d "$BASEDIR_NM/.git/NetworkManager-ci" ]]; then
BASEDIR_NM_CI="$(readlink -f "$BASEDIR_NM/.git/NetworkManager-ci")"
fi
if [[ -z $BASEDIR_VM_IMAGE ]]; then
libvirt_pool_path_xml=$(virsh pool-dumpxml $LIBVIRT_POOL | grep -F '<path>')
if [[ $libvirt_pool_path_xml =~ \<path\>(.*)\</path\> ]]; then
BASEDIR_VM_IMAGE=${BASH_REMATCH[1]}
else
BASEDIR_VM_IMAGE=$BASEDIR_NM
fi
fi
##############################################################################
do_build() {
local t=$'\t'
local ram
local size
local os_variant
local nm_ci_build_args
local nm_ci_install_args
local extra_pkgs
local install_pkgs
local install_files
local gen_files=(
"bin-nm-env-prepare.sh:/usr/bin/nm-env-prepare.sh"
"bin-nm-deploy.sh:/usr/bin/nm-deploy.sh"
"etc-motd-vm:/etc/motd"
"etc-bashrc.my:/etc/bashrc.my"
"nm-90-my.conf:/etc/NetworkManager/conf.d/90-my.conf"
"nm-95-user.conf:/etc/NetworkManager/conf.d/95-user.conf"
"home-bash_history:/root/.bash_history"
"home-gdbinit:/root/.gdbinit"
"home-gdb_history:/root/.gdb_history"
"home-behaverc:/root/.behaverc"
"systemd-10-host-net.link:/etc/systemd/network/10-host-net.link"
"systemd-dhcp-host.service:/etc/systemd/system/dhcp-host.service"
"systemd-20-nm.override:/etc/systemd/system/NetworkManager.service.d/20-nm.override"
)
(( $# > 1 )) && die "build only accepts one argument"
(( $# > 0 )) && OS_VERSION="$1"
os_variant=${OS_VERSION//-/} # virt-install --os-variant value, deduced from OS_VERSION
os_variant=${os_variant/centosstream/centos-stream}
if [[ ! $VM =~ ^[a-zA-Z0-9\-]*$ ]]; then
echo "Invalid VM name '$VM', use only letters, numbers and '-' character"
return 1
fi
if vm_is_installed; then
echo "The virtual machine '$VM' is already installed, skiping build" >&2
return 0
fi
if vm_image_exists; then
echo "The image '$basedir_vm_image/$vm_image_file' already exists, skiping build" >&2
return 0
fi
if [[ -n $IMAGE_SIZE ]]; then
size=(--size "$IMAGE_SIZE")
fi
if [[ -n $BASEDIR_NM_CI ]]; then
nm_ci_build_args=(
--mkdir "$BASEDIR_NM_CI"
--link "$BASEDIR_NM_CI:/NetworkManager-ci"
--append-line "/etc/fstab:/NM_CI${t}$BASEDIR_NM_CI${t}9p${t}trans=virtio,rw,_netdev${t}0${t}0"
)
nm_ci_install_args=(
--filesystem "$BASEDIR_NM_CI,/NM_CI"
)
fi
if [[ $OS_VERSION =~ fedora || $OS_VERSION =~ centosstream ]]; then
extra_pkgs=(bash-completion bind-utils ccache clang-tools-extra cryptsetup cscope \'dbus\*\'
dhcp-client dhcp-relay dhcp-server dnsmasq dracut-network ethtool firewalld gcc gdb
glibc-langpack-pl hostapd intltool iproute ipsec-tools iputils iscsi-initiator-utils
iw ldns libreswan libselinux-utils libyaml-devel logrotate lvm2 mdadm mlocate net-tools
NetworkManager NetworkManager-openvpn NetworkManager-ovs NetworkManager-ppp
NetworkManager-pptp NetworkManager-strongswan NetworkManager-team NetworkManager-vpnc
NetworkManager-wifi nfs-utils nispor nmap-ncat nmstate nss-tools openvpn
\'openvswitch2\*\' perl-IO-Pty-Easy perl-IO-Tty procps psmisc python3-behave
python3-black python3-devel python3-netaddr python3-pip python3-pyte python3-pyyaml
qemu-kvm radvd rp-pppoe scsi-target-utils strace systemd tcpdump tcpreplay tuned
/usr/bin/debuginfo-install /usr/bin/pytest /usr/bin/python vim wireguard-tools
wireshark-cli)
if [[ $OS_VERSION == centosstream-8 ]]; then
install_pkgs=(
--run-command "dnf -y copr enable nmstate/nm-build-deps"
--run-command "dnf config-manager -y --set-enabled powertools"
--install epel-release,epel-next-release
)
elif [[ $OS_VERSION == centosstream-9 ]]; then
install_pkgs=(
--run-command "dnf -y copr enable nmstate/nm-build-deps"
--run-command "dnf config-manager -y --set-enabled crb"
--install epel-release,epel-next-release
)
fi
install_pkgs+=(
--update
--run "$BASEDIR_NM/contrib/fedora/REQUIRED_PACKAGES"
--run-command "dnf install -y --skip-broken ${extra_pkgs[*]}"
--run-command "pip3 install --user behave_html_formatter"
--run-command "dnf debuginfo-install -y --skip-broken NetworkManager \
\$(ldd /usr/sbin/NetworkManager \
| sed -n 's/.* => \(.*\) (0x[0-9A-Fa-f]*)\$/\1/p' \
| xargs -n1 readlink -f)"
)
elif [[ $OS_VERSION =~ debian || $OS_VERSION =~ ubuntu ]]; then
extra_pkgs=(bash-completion bind9-utils ccache clang-tools cryptsetup cscope \'dbus\*\'
isc-dhcp-client isc-dhcp-relay isc-dhcp-server dnsmasq dracut-network ethtool firewalld
gcc gdb hostapd intltool iproute2 \'iputils-\*\' iw libldns3 libreswan
libyaml-dev logrotate lvm2 mdadm mlocate net-tools network-manager
network-manager-openvpn network-manager-pptp network-manager-strongswan
network-manager-vpnc nfs-common ncat libnss3-tools openvpn \'openvswitch2\*\' procps
psmisc python3-behave black python3-dev python3-netaddr python3-pip python3-pyte
python3-pretty-yaml qemu-kvm radvd pppoe strace systemd tcpdump tcpreplay tuned
debian-goodies python3-pytest python3 vim wireguard-tools tshark)
if [[ $OS_VERSION =~ debian ]]; then
install_pkgs=(
--run-command "echo deb http://deb.debian.org/debian-debug/ \$(lsb_release -cs)-debug main >> /etc/apt/sources.list.d/debug.list"
--run-command "echo deb http://deb.debian.org/debian-debug/ \$(lsb_release -cs)-proposed-updates-debug main >> /etc/apt/sources.list.d/debug.list"
)
elif [[ $OS_VERSION =~ ubuntu ]]; then
install_pkgs=(
--run-command "echo deb http://ddebs.ubuntu.com \$(lsb_release -cs) main restricted universe multiverse >> /etc/apt/sources.list.d/debug.list"
--run-command "echo deb http://ddebs.ubuntu.com \$(lsb_release -cs)-updates main restricted universe multiverse >> /etc/apt/sources.list.d/debug.list"
--run-command "echo deb http://ddebs.ubuntu.com \$(lsb_release -cs)-proposed main restricted universe multiverse >> /etc/apt/sources.list.d/debug.list"
)
fi
install_pkgs+=(
--update
--upload "$BASEDIR_NM/contrib/debian/REQUIRED_PACKAGES:/tmp/REQUIRED_PACKAGES"
--run-command "/bin/bash /tmp/REQUIRED_PACKAGES" # using only --run fails
--run-command "apt-get install -y \$(find-dbgsym-packages NetworkManager 2>/dev/null)"
--edit "/etc/locale.gen:s/^# pl_PL.UTF-8/pl_PL.UTF-8/"
--run-command "locale-gen"
)
for p in "${extra_pkgs[@]}"; do
install_pkgs+=(--run-command "apt-get install -y $p || :")
done
fi
install_files=(--upload "$BASEDIR_NM/contrib/scripts/NM-log:/usr/bin/NM-log")
for f in "${gen_files[@]}"; do
gen_file "${f%:*}"
install_files+=(--upload "$datadir/data-$f")
done
echo "Creating VM"
echo " - VM NAME: $VM"
echo " - OS VERSION: $OS_VERSION"
echo " - SIZE: $([[ -n $IMAGE_SIZE ]] && echo "$IMAGE_SIZE" || echo "don't resize")"
echo " - RAM: $RAM"
echo " - ROOT PASSWORD: $ROOT_PASSWORD"
echo " - IMAGE PATH: $basedir_vm_image/$vm_image_file"
echo " - NM DIR: $BASEDIR_NM"
echo " - NM CI DIR: $([[ -n $BASEDIR_NM_CI ]] && echo "$BASEDIR_NM_CI" || echo '<none>')"
echo " - HOST BRIDGE: $HOST_BRIDGE"
if [[ $OS_VERSION =~ centosstream ]]; then
echo "WARNING: NetworkManager repositories can't be shared with the guest" \
"(CentOS Stream doesn't support 9P filesystem). You'll need to manually" \
"share by NFS or make a new clone of the repository inside the guest." >&2
fi
virt-builder "$OS_VERSION" \
--output "$basedir_vm_image/$vm_image_file" \
"${size[@]}" \
--format qcow2 \
--arch x86_64 \
--hostname "$VM" \
--root-password password:nm \
--ssh-inject root \
--append-line "/etc/ssh/sshd_config:PermitRootLogin yes" \
--run-command "ssh-keygen -A" \
--mkdir "$BASEDIR_NM" \
--link "$BASEDIR_NM:/NetworkManager" \
--append-line "/etc/fstab:/NM${t}$BASEDIR_NM${t}9p${t}trans=virtio,rw,_netdev${t}0${t}0" \
"${nm_ci_build_args[@]}" \
"${install_pkgs[@]}" \
--mkdir "/etc/systemd/system/NetworkManager.service.d" \
--mkdir "/etc/systemd/network" \
"${install_files[@]}" \
--write "/var/lib/NetworkManager/secret_key:nm-in-container-secret-key" \
--chmod "700:/var/lib/NetworkManager" \
--chmod "600:/var/lib/NetworkManager/secret_key" \
--edit "/etc/systemd/journald.conf:s/.*RateLimitBurst=.*/RateLimitBurst=0/" \
--delete "/etc/NetworkManager/system-connections/*" \
--append-line "/etc/bashrc:. /etc/bashrc.my" \
--run-command "updatedb" \
--append-line "/etc/dhcp/dhclient.conf:send host-name = gethostname();" \
--firstboot-command "systemctl enable --now dhcp-host"
virt-install \
--name "$VM" \
--ram "$RAM" \
--disk "path=$basedir_vm_image/$vm_image_file,format=qcow2" \
--os-variant "$os_variant" \
--filesystem "$BASEDIR_NM,/NM" \
"${nm_ci_install_args[@]}" \
--network "bridge=$HOST_BRIDGE" \
--import \
--autoconsole none \
--noreboot
}
do_clean() {
vm_is_running && virsh shutdown "$VM" &>/dev/null
vm_is_installed && virsh undefine "$VM" &>/dev/null
rm -f "$basedir_vm_image/$vm_image_file"
}
do_run() {
vm_is_installed || do_build
vm_is_running && return 0
virsh start "$VM" >&2
}
do_exec() {
do_run
local failed=0
while ! ping -c 1 "$VM" &>/dev/null; do
failed=$((failed + 1))
(( failed < 15 )) || die "Timeout trying to ping the VM"
sleep 1
done
ssh \
-o StrictHostKeyChecking=no \
-o UserKnownHostsFile=/dev/null \
-o LogLevel="$SSH_LOG_LEVEL" \
"root@$VM" "$@"
}
do_reexec() {
vm_is_running && do_stop
local waited=0
while vm_is_running; do
waited=$((waited + 1))
(( waited < 30 )) || die "Timeout waiting for VM shutdown"
sleep 1
done
do_exec "$@"
}
do_stop() {
vm_is_running && virsh shutdown "$VM" >&2
}
###############################################################################
vm_image_exists() {
[[ -f "$basedir_vm_image/$vm_image_file" ]] || return 1
}
vm_is_installed() {
virsh list --all --name | grep --fixed-strings --line-regexp "$VM" &>/dev/null || return 1
}
vm_is_running() {
virsh list --name | grep --fixed-strings --line-regexp "$VM" &>/dev/null || return 1
}
gen_file() {
sed "s|{{BASEDIR_NM}}|$BASEDIR_NM|g" "$datadir/$1.in" > "$datadir/data-$1"
if [[ $1 =~ ^bin- ]]; then
chmod 755 "$datadir/data-$1"
else
chmod 644 "$datadir/data-$1"
fi
}
usage() {
echo "nm-in-vm [options] build|run|exec|stop|reexec|clean [command_args]"
}
help() {
usage
echo
awk '/^####*$/ { if (on) exit; on=-1; } !/^####*$/ { if (on) print(substr($0,3)) }' "$BASH_SOURCE"
echo
}
die() {
echo "$1" >&2
exit 1
}
###############################################################################
cmd=
while (( $# > 0 )); do
case "$1" in
build|run|exec|reexec|stop|clean)
cmd="$1"
shift
;;
-h|--help)
help
exit 0
;;
-v|--vm)
(( $# > 1 )) || die "--vm requires one argument"
VM="$2"
shift 2
;;
--)
shift
break
;;
*)
[[ $cmd != "" ]] && break
echo "Invalid argument '$1'" >&2
echo $(usage) >&2
exit 1
;;
esac
done
# compute some values that depends on user selectable variables
mkdir -p "$BASEDIR_VM_IMAGE"
basedir_vm_image=$(readlink -f "$BASEDIR_VM_IMAGE")
vm_image_file="$VM.qcow2"
datadir="$BASEDIR_NM/tools/nm-guest-data"
if [[ $cmd == "" ]]; then
cmd=exec
fi
if [[ $UID == 0 ]]; then
die "cannot run as root"
fi
if [[ $cmd != exec && $cmd != reexec && $cmd != build && $# != 0 ]]; then
die "Extra arguments are only allowed with exec|reexec|build command"
fi
do_$cmd "$@"