Package rpm-build-vm: Specfile

# SPDX-License-Identifier: GPL-2.0-only
# Copyright (C) 2019-2023 Vitaly Chikunov <vt@altlinux.org>
%define _unpackaged_files_terminate_build 1
%define _stripped_files_terminate_build 1

%ifndef _priority_distbranch
# We have it defined in macros but not in buildmacros.
%define _priority_distbranch %(rpm --eval %%_priority_distbranch)
%endif

Name: rpm-build-vm
Version: 1.65
Release: alt2

Summary: RPM helper to run tests in virtualised environment
License: GPL-2.0-only
Group: Development/Other
Url: https://www.altlinux.org/Hasher/vm-run
Vcs: https://github.com/vt-alt/vm-run

Source: %name-%version.tar

%define supported_arches %ix86 x86_64 ppc64le aarch64 armh

%ifarch %supported_arches
BuildRequires: glibc-devel-static
BuildRequires: libblkid-devel-static
# For %%check. This does not verify the package but verifies
# that girar on supported_arches have writable /dev/kvm
# This should run even if check is disabled.
BuildRequires: /dev/kvm
# shellchek is used in %%build as pre-install syntax check.
%ifarch %ix86 x86_64
# There is no shellcheck on other arches in p9. 'make shellcheck' below can
# handle absence of shellcheck binary using only 'bash -n'.
BuildRequires: shellcheck
%endif

# Try to load un-def kernel this way to avoid "forbidden dependencies"
# from sisyphus_check.
Requires(pre): kernel >= 5.7
%endif

Requires(pre): %name-run = %EVR

%ifarch %supported_arches
%description
RPM helper to run QEMU inside hasher. This is mainly intended
for %%check section to test software under better emulated root
than fakeroot.

This is similar to multiple vm scripts, virtme, vido, and eudyptula-boot.
%else
%description
This package is a stub instead of RPM helper to run QEMU inside hasher
on supported architectures (this one (%_arch) is unsupported).
%endif

%package run
Summary: vm-run virtualized runner
Group: Development/Other

# Other arches will get a stub which will always return success
%ifarch %supported_arches
Requires: mount

# /proc is required for qemu 9p to work, otherwise you'll get
# confusing ENOENT when creating a file. This is because
# `qemu/hw/9pfs/9p-local.c:fchmodat_nofollow' is doing chmod
# over `/proc/self/fd/%%d'.
Requires: /proc
Requires: /dev/kvm

%ifarch %ix86 x86_64
Requires: qemu-system-x86-core
%endif
%ifarch ppc64le
Requires: qemu-system-ppc-core
%endif
%ifarch aarch64
Requires: qemu-system-aarch64-core
%endif
%ifarch armh
# No KVM support in the kernel for this arch.
Requires: qemu-system-arm-core
# AArch64-native qemu-system-aarch64 binary to use KVM.
Requires: qemu-system-aarch64-core-bundle
%endif

%endif

%ifarch %supported_arches
%description run
RPM helper to run QEMU inside hasher. This is mainly intended
for %%check section to test software under better emulated root
than fakeroot.

This is similar to multiple vm scripts, virtme, vido, and eudyptula-boot.

This package is vm-run scripts only (without requirement on the kernel).
%else
%description run
This package is a stub instead of RPM helper to run QEMU inside hasher
on supported architectures (this one (%_arch) is unsupported).
%endif

%package createimage
Summary: Filetrigger to create ext4 image for vm-run
Group: Development/Other
BuildArch: noarch
Requires: %name = %EVR

%description createimage
This is optional package containing a filetrigger to create an ext4 image
at "/tmp/vm-ext4.img" out of your hasher root to run vm-run with it as rootfs.

%package checkinstall
Summary: Checkinstall for vm-run
Group: Development/Other
BuildArch: noarch
%if "%_priority_distbranch" == "sisyphus"
%ifarch %supported_arches
Requires(post): busybox
%endif
%endif
Requires(post): %name-createimage = %EVR
Requires(post): procps
Requires(post): time

%description checkinstall
Run checkinstall tests for vm-run.

%prep
%setup

%ifarch %supported_arches
%build
%{?optflags_lto:%global optflags_lto %optflags_lto -ffat-lto-objects}
CFLAGS="%optflags" make

# This is pre-install syntax check for bash scripts. This does not
# run any functional tests.
make shellcheck
%else
# Still useful to verify stub script even in absence of shellcheck.
bash -n vm-run
%endif

%install
%ifnarch %supported_arches
install -D -p -m 0755 vm-run-stub %buildroot%_bindir/vm-run
%else
install -D -p -m 0755 vm-run      %buildroot%_bindir/vm-run
install -D -p -m 0755 vm-create-image %buildroot%_bindir/vm-create-image
install -D -p -m 0755 vm-initrd   %buildroot%_bindir/vm-initrd
install -D -p -m 0755 vm-init     %buildroot%_libexecdir/vm-run/vm-init
install -D -p -m 0755 initrd-init %buildroot%_libexecdir/vm-run/initrd-init
install -D -p -m 0755 fakesudo    %buildroot%_libexecdir/vm-run/vm-fakesudo
install -D -p -m 0755 filetrigger %buildroot%_rpmlibdir/vm-run.filetrigger
install -D -p -m 0755 createimage %buildroot%_rpmlibdir/z-vm-createimage.filetrigger
install -Dp bash_completion %buildroot%_sysconfdir/bashrc.d/vm_completion.sh
install -D -p -m 0755 vm-resize   %buildroot%_bindir/vm-resize
%endif
install -D -p -m 0755 kvm-ok      %buildroot%_bindir/kvm-ok
install -Dp checkinstall.sh %buildroot%_libexecdir/vm-run.ci/checkinstall

%pre run
# Only allow to install inside of hasher.
[ -d /.host -a -d /.in -a -d /.out ] || {
        echo >&2 'rpm-build-vm-run is not allowed outside hasher environments'
        exit 1
}

%files

%files checkinstall
%_libexecdir/vm-run.ci

%files createimage
%ifarch %supported_arches
%_rpmlibdir/z-vm-createimage.filetrigger
%endif

%files run
%_bindir/vm-run
%_bindir/kvm-ok

%ifarch %supported_arches
%_bindir/vm-initrd
%_bindir/vm-resize
%_bindir/vm-create-image
%_libexecdir/vm-run
%_rpmlibdir/vm-run.filetrigger
%_sysconfdir/bashrc.d/vm*.sh

%post run
# u&mount should to be readable to use inside vm
control mount unprivileged

# Useful for enable audit for some kernel-modules tests
[ ! -x /sbin/auditctl ] || chmod a+rx /sbin/auditctl

# For --overlay=
chmod a+twx /mnt

# Allow user creation (for openssh)
chmod a+r /etc/login.defs

# Call filetrigger for the past kernels.
find /boot | %_rpmlibdir/vm-run.filetrigger

%post checkinstall -p %_libexecdir/vm-run.ci/checkinstall

%check
# Verify availability of KVM in girar & beehiver.
ls -l /dev/kvm && test -w /dev/kvm

%else
# Test stub.
%post checkinstall
set -ex
vm-run --unknown-option date
vm-run -- exit 1
vm-run --stub-exit=7 && exit 1 || test $? -eq 7
%endif

%changelog
* Mon Mar 11 2024 Vitaly Chikunov <vt@altlinux.org> 1.65-alt2
- Fix rebuild with gcc-10.
- Remove BR:busybox for non-sisyphus branches.

* Mon Feb 26 2024 Vitaly Chikunov <vt@altlinux.org> 1.65-alt1
- i586: Avoid 'mce: Unable to init MCE device' warning.

* Fri Feb 02 2024 Vitaly Chikunov <vt@altlinux.org> 1.64-alt1
- vm-run: Limit memory below RLIMIT_AS. Add --maxmem and --maxcpu to
  workaround potential problems with it.

* Thu Nov 23 2023 Vitaly Chikunov <vt@altlinux.org> 1.63-alt1
- microvm: Detect CONFIG_SERCON=n.

* Sat Nov 18 2023 Vitaly Chikunov <vt@altlinux.org> 1.62-alt1
- Slightly improve microvm boot and qemu option passing thru.
- initrd: Install tools symlinks for busybox.

* Tue Nov 14 2023 Vitaly Chikunov <vt@altlinux.org> 1.61-alt1
- Add 'exact command' mode (when there is more than single argument).

* Sat Nov 11 2023 Vitaly Chikunov <vt@altlinux.org> 1.60-alt3
- spec: checkinstall: Remove BR:busybox for unsupported architectures.
- spec: checkinstall: Add tests for unsupported architectures.

* Sat Nov 11 2023 Michael Shigorin <mike@altlinux.org> 1.60-alt2
- E2K: no busybox in e2k-alt-linux so far (and no %%checkinstall either).

* Sun Nov 05 2023 Vitaly Chikunov <vt@altlinux.org> 1.60-alt1
- Experimental support for --initrd mode (run script in initrd using busybox).

* Tue Oct 10 2023 Vitaly Chikunov <vt@altlinux.org> 1.59-alt1
- Improve rdshell environment usability.
- Improve busybox/toybox compatibility for rdshell.
- Add --heredoc option (run script from here-document).
- Allow adding out-of-tree modules and arbitrary files to initrd.

* Sat Oct 07 2023 Vitaly Chikunov <vt@altlinux.org> 1.58-alt1
- Fix booting ext4 on kernels where it isn't built-in (ovz-el7).
- Do not ignore initrd generation errors.
- Allow adding arbitrary files into initrd (such as toybox).
- initrd: Add support for rdshell and rddebug.

* Mon Sep 25 2023 Vitaly Chikunov <vt@altlinux.org> 1.57-alt1
- Enhance and document --loglevel= (for boot debugging).
- Run (eval) command in a subshell with 'set -ex' by default.
- armh: Fix 'architecture armv7l is unknown' error.

* Fri Sep 15 2023 Vitaly Chikunov <vt@altlinux.org> 1.56-alt1
- Add --stub-exit= option for vm-run stub (ALT#47599).

* Sat Jul 15 2023 Vitaly Chikunov <vt@altlinux.org> 1.55-alt1
- Add vm-initrd tool (minimalistic initramfs creator).

* Thu Jun 22 2023 Vitaly Chikunov <vt@altlinux.org> 1.54-alt1
- Add experimental '--stdout' option.
- spec: checkinstall: Delete test disk images.

* Mon May 22 2023 Vitaly Chikunov <vt@altlinux.org> 1.53-alt1
- Prevent SIGTTOU when running rpmbuild in hsh-shell.

* Thu May 11 2023 Vitaly Chikunov <vt@altlinux.org> 1.52-alt1
- Fix processing of pre-installed kernels.

* Sat Mar 11 2023 Vitaly Chikunov <vt@altlinux.org> 1.51-alt1
- Add --ext4[=feature] option (auto-rootfs with no-bind, with fs feature).

* Sat Feb 25 2023 Vitaly Chikunov <vt@altlinux.org> 1.50-alt1
- Add experimental --tmp=size option to pass swap device from the host and set
  guest tmpfs:/tmp size from swap size.
- Workaround boot failure on armh (appeared in v6.1.13).

* Tue Feb 21 2023 Vitaly Chikunov <vt@altlinux.org> 1.49-alt1
- Add --mem=max to lift soft memory restrictions om aarch64 and ppc64le.
- Add --cpu=max to remove soft CPU count limit.

* Fri Jan 13 2023 Vitaly Chikunov <vt@altlinux.org> 1.48-alt1
- Fix TCG mode on non-x86 architectures.

* Fri Jan 13 2023 Vitaly Chikunov <vt@altlinux.org> 1.47-alt1
- kvm-ok: Fix KVM detection for aarch32.
- Remove some temporary noise files.

* Tue Jan 10 2023 Vitaly Chikunov <vt@altlinux.org> 1.46-alt1
- ppc: Fix TCG run on qemu since 6.0.
- Add TCG mode test in checkinstall.

* Sun Jan 08 2023 Vitaly Chikunov <vt@altlinux.org> 1.45-alt1
- Add kvm-ok tool.
- Minor fixes to experimental (EFI) boot options.

* Tue Dec 27 2022 Vitaly Chikunov <vt@altlinux.org> 1.44-alt1
- Make pass-through options similar to qemu's (backward incompatible change).
- Fix vm-create-image bash completion.

* Wed Dec 21 2022 Vitaly Chikunov <vt@altlinux.org> 1.43-alt1
- More image creation options.
- Fix build with old shellcheck (for p9).

* Tue Dec 06 2022 Vitaly Chikunov <vt@altlinux.org> 1.42-alt2
- Fix build on gcc-8.

* Tue Nov 29 2022 Vitaly Chikunov <vt@altlinux.org> 1.42-alt1
- Mount /tmp with size=100%%.
- Add --swap option to add SwapFree to the available memory.
- vm-create-image: List content of the image with --ls, and copy
  files out of image with --cp (to get artifacts).
- vm-create-image: Enforce minimal image size.

* Sat Nov 26 2022 Vitaly Chikunov <vt@altlinux.org> 1.41-alt1
- Set up console earlier (fixes --hvc mode).

* Thu Nov 24 2022 Vitaly Chikunov <vt@altlinux.org> 1.40-alt1
- Enable high speed virtio console with --hvc.
- Add --rsync= option for rootfs.

* Wed Nov 23 2022 Vitaly Chikunov <vt@altlinux.org> 1.39-alt1
- vm-run: --rootfs can be extended with --no-snapshot.
- vm-create-image: Allow relative --size= arguments.

* Fri Nov 18 2022 Vitaly Chikunov <vt@altlinux.org> 1.38-alt1
- Limit maximum CPU to 4 if there's no KVM.
- Add NPROCS/--nprocs support.

* Thu Nov 17 2022 Nikolai Kostrigin <nickel@altlinux.org> 1.37-alt3
- vm-run: Define MAXCPU=255 for x86_64 (closes: #44337).

* Tue Nov 15 2022 Vitaly Chikunov <vt@altlinux.org> 1.37-alt2
- spec: Do not run make check on e2k.

* Wed Nov 09 2022 Vitaly Chikunov <vt@altlinux.org> 1.37-alt1
- Add more rootfs boot testing options (--no-virtio, --scsi). Note: they will
  not work on all architectures equally.
- Add --sudo option (making fake sudo work inside rootfs vm). Requires and
  enables rootfs mode.
- Add --user option to run vm commands under builder instead of root (implies
  --sudo and sudo use).
- Both above options auto-create rootfs if it does not exist.

* Mon Nov 07 2022 Vitaly Chikunov <vt@altlinux.org> 1.36-alt1
- Add vm-create-image tool that can generate ext4 image out of hasher root.
- vm-run: Support for booting from ext4 image using --rootfs=
  (or --create-rootfs=) option(s). This way you have full root access to the
  system tree.
  Note that 9p is still (bind) mounted over '/usr/src', so you can place your
  test artifacts there.
- Add rpm-build-vm-createimage package with filetrigger to automatically
  generate that ext4 rootfs image. (If you need super precise uids/gids on
  the copies of hasher files, otherwise they maybe roughed to root:root.)
- Bunch of small code and help text improvements.
- Simplistic bash completion support.

* Mon Aug 08 2022 Vitaly Chikunov <vt@altlinux.org> 1.35-alt1
- Fix (uninstalled) kernels list.
- Allow to run auditctl.

* Sun Jun 12 2022 Vitaly Chikunov <vt@altlinux.org> 1.34-alt1
- Fix always 0 exit code. (Add build test for this case.)

* Fri May 13 2022 Vitaly Chikunov <vt@altlinux.org> 1.33-alt1
- Replace egrep with grep -E.
- Change default TMPDIR value to /tmp (to be on top-level tmpfs).

* Tue Apr 19 2022 Vitaly Chikunov <vt@altlinux.org> 1.32-alt1
- Modprobe overlay if '--overlay' is used.

* Sat Feb 12 2022 Vitaly Chikunov <vt@altlinux.org> 1.31-alt1
- Allow to vm-run on uninstalled kernels (developer mode).

* Sun Jan 30 2022 Vitaly Chikunov <vt@altlinux.org> 1.30-alt1
- Enable QEMU '-sandbox' (seccomp) by default.
- Run temporary depmod when --depmod is not specified.
- Handle QEMU abnormal exits with explanation to users.

* Tue Jan 25 2022 Vitaly Chikunov <vt@altlinux.org> 1.29-alt1
- Allow core dumps for qemu run (for coredumpctl).

* Sat Jan 22 2022 Vitaly Chikunov <vt@altlinux.org> 1.28-alt1
- Remove stray dependence on qemu-system-aarch64-core-bundle.
- Do not exclude armh from KVM support.

* Thu Dec 16 2021 Vitaly Chikunov <vt@altlinux.org> 1.27-alt1
- Added KVM support for aarch32.

* Sun Dec 05 2021 Vitaly Chikunov <vt@altlinux.org> 1.26-alt1
- Add vm-resize tool (simpler version of resize(1)).

* Sat Oct 23 2021 Vitaly Chikunov <vt@altlinux.org> 1.25-alt1
- Fix `--cpu=' option after previous change.

* Fri Oct 22 2021 Gleb F-Malinovskiy <glebfm@altlinux.org> 1.24-alt1
- vm-run: explicitly pass CPU topology to qemu.

* Wed Aug 25 2021 Vitaly Chikunov <vt@altlinux.org> 1.23-alt2
- Fix compiling with LTO.

* Tue May 11 2021 Vitaly Chikunov <vt@altlinux.org> 1.23-alt1
- Improve `--udevd' support of mount.

* Mon Apr 05 2021 Ivan A. Melnikov <iv@altlinux.org> 1.22-alt2
- Fix checkinstall package on unsupported architectures

* Sun Apr 04 2021 Vitaly Chikunov <vt@altlinux.org> 1.22-alt1
- Add --kvm=cond option for conditional run
- spec: Test /dev/kvm presence in the %%check

* Sun Apr 04 2021 Vitaly Chikunov <vt@altlinux.org> 1.21-alt2
- Add /dev/kvm test in %%check for girar and ALT beekeeper.

* Sun Apr 04 2021 Vitaly Chikunov <vt@altlinux.org> 1.21-alt1
- Allow to use --kernels to list what is available.
- Do not auto-run depmod for %%buildroot kernels.
- Allow to use OVMF firmware.
- Allow to disable KVM with --tcg option.
- Experimental --fat= directory share with guest.
- Support microvm machine boot (without PCI).
- Allow to pass more options to qemu.

* Mon Jan 25 2021 Vitaly Chikunov <vt@altlinux.org> 1.20-alt1
- Try to catch accidental qemu crashes.

* Wed Jan 13 2021 Vitaly Chikunov <vt@altlinux.org> 1.19-alt2
- spec: Add timeout to checkinstall tests.

* Sun Jan 10 2021 Vitaly Chikunov <vt@altlinux.org> 1.19-alt1
- Avoid 9p warning about msize being too low.

* Fri Dec 04 2020 Vitaly Chikunov <vt@altlinux.org> 1.18-alt2
- Warning if there is attempt to install rpm-build-vm-run outside of hasher.

* Sat Nov 14 2020 Vitaly Chikunov <vt@altlinux.org> 1.18-alt1
- Support to find and run uncompressed vmlinux kernels.

* Fri Sep 25 2020 Vitaly Chikunov <vt@altlinux.org> 1.17-alt1
- Skip copying non-existent modules into initramfs.

* Tue Sep 08 2020 Vitaly Chikunov <vt@altlinux.org> 1.16-alt1
- Fix checkinstall.

* Sat Sep 05 2020 Vitaly Chikunov <vt@altlinux.org> 1.15-alt1
- Split into two packages, with kernel dependence and without it.
- Remove dependence on make-initrd by generating own initramfs.

* Mon Aug 17 2020 Vitaly Chikunov <vt@altlinux.org> 1.14-alt1
- armh: Enable tcg support.

* Wed Aug 12 2020 Vitaly Chikunov <vt@altlinux.org> 1.13-alt1
- Make kernel shutdown quicker.

* Mon Aug 10 2020 Vitaly Chikunov <vt@altlinux.org> 1.12-alt1
- Make console output non-truncated on shutdown.
- Fix tty support for console.

* Sat Aug 08 2020 Vitaly Chikunov <vt@altlinux.org> 1.11-alt1
- x86_64,i586: Try to make kernel more robust with 'no_timer_check'.
- spec: Move checkinstall %%pre outside of %%ifarch to fix noarch check.

* Thu Jul 02 2020 Vitaly Chikunov <vt@altlinux.org> 1.10-alt1
- ppc: Use cap-ccf-assist=off for kvm-type=HV.

* Tue Jun 30 2020 Vitaly Chikunov <vt@altlinux.org> 1.9-alt1
- Propagate exported functions into vm subshell.

* Sat Jun 20 2020 Vitaly Chikunov <vt@altlinux.org> 1.8-alt1
- aarch64: Fix `.gic_version not found' (qemu).
- spec: Fix `different set of noarch packages' (girar).

* Mon Feb 24 2020 Vitaly Chikunov <vt@altlinux.org> 1.7-alt2
- Require /dev/kvm.

* Fri Jan 24 2020 Vitaly Chikunov <vt@altlinux.org> 1.7-alt1
- ppc: Make use of KVM.

* Thu Jan 23 2020 Vitaly Chikunov <vt@altlinux.org> 1.6-alt1
- Fix `Multiple devices detected in same VirtFS export' warning.

* Thu Jan 23 2020 Vitaly Chikunov <vt@altlinux.org> 1.5-alt1
- aarch64: Make use of KVM.

* Mon Dec 30 2019 Ivan A. Melnikov <iv@altlinux.org> 1.4.1-alt3
- Fix build on qemu-less architectures (closes: #37629).

* Sat Dec 28 2019 Vitaly Chikunov <vt@altlinux.org> 1.4.1-alt2
- Fix build on unsupported arches.

* Mon Dec 16 2019 Vitaly Chikunov <vt@altlinux.org> 1.4.1-alt1
- Quickfix of 1.4 (MAXMEM handling).

* Mon Dec 16 2019 Vitaly Chikunov <vt@altlinux.org> 1.4-alt2
- Optimize spec.
- Add checkinstall package.

* Mon Dec 16 2019 Vitaly Chikunov <vt@altlinux.org> 1.4-alt1
- Limit 32-bit system memory.

* Thu Dec 12 2019 Vitaly Chikunov <vt@altlinux.org> 1.3-alt1
- Initialize cpu and mem to the max, support share_network=1,
  handle multiple kernels using --kernel= option.

* Sat Aug 31 2019 Vitaly Chikunov <vt@altlinux.org> 1.2-alt1
- Improvements corresponding to v1.2.

* Mon Aug 19 2019 Vitaly Chikunov <vt@altlinux.org> 1.1-alt1
- Do not use `qemu' binary on x86 due to qemu repackage.

* Mon Aug 19 2019 Vitaly Chikunov <vt@altlinux.org> 1.0-alt5
- Make stub vm-run output a warning message

* Sun Aug 18 2019 Michael Shigorin <mike@altlinux.org> 1.0-alt4
- Rework to provide a stub package on qemu-unsupported arches
  (that can be added into BuildRequires: unconditionally).

* Thu Aug 15 2019 Vitaly Chikunov <vt@altlinux.org> 1.0-alt3
- Add ExclusiveArch for only supported arches.

* Mon Aug 12 2019 Vitaly Chikunov <vt@altlinux.org> 1.0-alt2
- Improvements for ppc64le.

* Mon Aug 05 2019 Vitaly Chikunov <vt@altlinux.org> 1.0-alt1
- Initial version.