xref: /freebsd/tests/ci/Makefile (revision 932cf5fa44b7ff3b7ea21ccb32bbbefff11c160c) 
1# SPDX-License-Identifier: BSD-2-Clause
2#
3# Copyright (c) 2024 The FreeBSD Foundation
4#
5# This software was developed by Cybermancer Infosec <bofh@FreeBSD.org>
6# under sponsorship from the FreeBSD Foundation.
7#
8# Makefile for CI testing.
9#
10# User-driven targets:
11#  ci: Run CI tests
12#  ci-smoke: Run smoke tests which is simply booting the image
13#  ci-full: Run full tests
14#
15# Variables affecting the build process:
16#  TARGET/TARGET_ARCH: architecture of built release (default: same as build host)
17#  KERNELCONF: kernel configuration to use
18#  USE_QEMU: Use QEMU for testing rather than bhyve
19#
20
21WORLDDIR?=	${.CURDIR}/../..
22RELEASEDIR=	${WORLDDIR}/release
23MAKECONF?=	/dev/null
24SRCCONF?=	/dev/null
25_MEMORY!=sysctl -n hw.physmem 2>/dev/null
26PARALLEL_JOBS!=sysctl -n hw.ncpu 2>/dev/null || nproc 2>/dev/null
27TOTAL_MEMORY!=expr ${_MEMORY} / 1073741824
28KERNCONF?=	GENERIC
29LOCALBASE?=	/usr/local
30EXTRA_MAKE_FLAGS?=
31
32.if !defined(TARGET) || empty(TARGET)
33TARGET=		${MACHINE}
34.endif
35.if !defined(TARGET_ARCH) || empty(TARGET_ARCH)
36.  if ${TARGET} == ${MACHINE}
37TARGET_ARCH=	${MACHINE_ARCH}
38.  else
39TARGET_ARCH=	${TARGET}
40.  endif
41.endif
42IMAKE=		${MAKE} TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH}
43
44.if !defined(CIENV) || empty(CIENV)
45CIENV=		local
46LOG_TARGET=	> ${.CURDIR}/_.${TARGET_ARCH}.${.TARGET} 2>&1 || (echo "${.TARGET} failed, check _.${TARGET_ARCH}.${.TARGET} for details" ; false)
47.endif
48
49.if defined(CROSS_TOOLCHAIN) || !empty(CROSS_TOOLCHAIN)
50CROSS_TOOLCHAIN_PARAM=	"CROSS_TOOLCHAIN=${CROSS_TOOLCHAIN}"
51.endif
52
53# Define OSRELEASE by using newvers.sh
54.if !defined(OSRELEASE) || empty(OSRELEASE)
55.  for _V in TYPE BRANCH REVISION
56.    if !defined(${_V}) || empty(${_V})
57${_V}!=	eval $$(awk '/^${_V}=/{print}' ${.CURDIR}/../../sys/conf/newvers.sh); echo $$${_V}
58.    endif
59.  endfor
60.  for _V in ${TARGET_ARCH}
61.    if !empty(TARGET:M${_V})
62OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}
63VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET}
64.    else
65OSRELEASE=	${TYPE}-${REVISION}-${BRANCH}-${TARGET}-${TARGET_ARCH}
66VOLUME_LABEL=	${REVISION:C/[.-]/_/g}_${BRANCH:C/[.-]/_/g}_${TARGET_ARCH}
67.    endif
68.  endfor
69.endif
70
71.if exists(${.CURDIR}/tools/ci.conf) && !defined(CICONF)
72CICONF?=	${.CURDIR}/tools/ci.conf
73.endif
74SWAPSIZE?=	1g
75VMFS?=		ufs
76FORMAT=		raw
77CIIMAGE=	ci-${OSRELEASE}-${GITREV}-${KERNCONF}.${FORMAT}
78CIDISK?=	${.OBJDIR}/${CIIMAGE}
79VMSIZE?=	6g
80CITYPE?=	full
81KYUA_TEST_FILTERS?=
82META_TAR!=mktemp /tmp/meta.XXXXXX
83META_DIR!=mktemp -d /tmp/meta.XXXXXX
84META_DIROUT!=mktemp -d /tmp/meta.XXXXXX
85DISC_CAM!=truncate -s 128m /tmp/disk-cam
86EXTRA_DISK_NUM?=5
87DISK_NUMBERS!=jot - 1 ${EXTRA_DISK_NUM}
88BHYVE_EXTRA_DISK_PARAM?=
89BHYVE_EXTRA_DISK_PARAM+=-s 4:0,ahci-hd,/tmp/disk-cam
90.for i in ${DISK_NUMBERS}
91NEW_DISK!=truncate -s 128m /tmp/disk${i}
92BHYVE_EXTRA_DISK_PARAM+=-s $$((${i} + 4)):0,virtio-blk,/tmp/disk${i}
93CLEANFILES+=/tmp/disk${i}
94.endfor
95TEST_VM_NAME=	ci-${OSRELEASE}-${GITREV}-${KERNCONF}
96.if ${TOTAL_MEMORY} >= 16
97VM_MEM=8
98.elif ${TOTAL_MEMORY} >=4
99VM_MEM=${TOTAL_MEMORY}
100.else
101echo "Please increase the memory to at least 4GB"
102exit 0
103.endif
104VM_MEM_SIZE?=${VM_MEM}g
105TIMEOUT_MS?=5400000
106TIMEOUT=$$((${TIMEOUT_MS} / 1000))
107TIMEOUT_EXPECT=$$((${TIMEOUT} - 60))
108TIMEOUT_VM=$$((${TIMEOUT_EXPECT} - 120))
109.if exists(${.CURDIR}/Makefile.${TARGET_ARCH})
110.	include "${.CURDIR}/Makefile.${TARGET_ARCH}"
111.endif
112.if ${TARGET_ARCH} != ${MACHINE_ARCH}
113.  if ( ${TARGET_ARCH} != "i386" ) || ( ${MACHINE_ARCH} != "amd64" )
114QEMUSTATIC=/usr/local/bin/qemu-${QEMU_ARCH}-static
115QEMUTGT=portinstall-qemu
116.  endif
117.endif
118QEMUTGT?=
119QEMU_DEVICES?=
120QEMU_EXTRA_PARAM?=
121QEMU_MACHINE?=virt
122QEMUBIN=/usr/local/bin/qemu-system-${QEMU_ARCH}
123.if ${PARALLEL_JOBS} >= ${QEMU_MAX_CPU_COUNT}
124QEMU_CPU_COUNT=${QEMU_MAX_CPU_COUNT}
125.else
126QEMU_CPU_COUNT=${PARALLEL_JOBS}
127.endif
128.if ${VM_MEM} >= ${QEMU_MAX_MEM_SIZE}
129VM_MEM_SIZE=${QEMU_MAX_MEM_SIZE}g
130.else
131VM_MEM_SIZE=${VM_MEM}g
132.endif
133VMGUEST!=sysctl -n kern.vm_guest 2>/dev/null || true
134.if ${VMGUEST} != "none"
135USE_QEMU?=1
136.endif
137KLDFILEMONISLOADED!=kldload -q -n filemon 2>/dev/null && echo "1" || echo "0"
138.if ${KLDFILEMONISLOADED} == "1"
139METAMODE?=-DWITH_META_MODE
140.endif
141
142CLEANFILES+=	${.OBJDIR}/${CIIMAGE} ${.OBJDIR}/ci.img ${META_TAR}
143IMAGEDIR=	${.OBJDIR}/ci-buildimage
144CLEANDIRS+=	${IMAGEDIR}
145
146portinstall: portinstall-pkg portinstall-qemu portinstall-expect portinstall-${TARGET_ARCH:tl} .PHONY
147
148portinstall-pkg: .PHONY
149.if !exists(/usr/local/sbin/pkg-static)
150	env ASSUME_ALWAYS_YES=yes pkg bootstrap
151.endif
152
153portinstall-qemu: portinstall-pkg .PHONY
154.if !exists(/usr/local/bin/qemu-${QEMU_ARCH}-static)
155	env ASSUME_ALWAYS_YES=yes pkg install emulators/qemu-user-static
156.endif
157.if !exists(${QEMUBIN})
158	env ASSUME_ALWAYS_YES=yes pkg install emulators/qemu@nox11
159.endif
160
161portinstall-expect: portinstall-pkg .PHONY
162.if !exists(/usr/local/bin/expect)
163	env ASSUME_ALWAYS_YES=yes pkg install lang/expect
164.endif
165
166beforeclean: .PHONY
167	chflags -R noschg ${IMAGEDIR}
168
169.include <bsd.obj.mk>
170clean: beforeclean .PHONY
171
172cleandir: beforeclean .PHONY
173
174ci-buildworld: .PHONY
175	@echo "Building world for ${TARGET_ARCH}"
176	${IMAKE} -j${PARALLEL_JOBS} -C ${WORLDDIR} ${METAMODE} \
177		${CROSS_TOOLCHAIN_PARAM} __MAKE_CONF=${MAKECONF} SRCCONF=${SRCCONF} \
178		${EXTRA_MAKE_FLAGS} buildworld ${LOG_TARGET}
179
180ci-buildkernel: ci-buildworld-${TARGET_ARCH:tl} .PHONY
181	@echo "Building kernel for ${TARGET_ARCH}"
182	${IMAKE} -j${PARALLEL_JOBS} -C ${WORLDDIR} ${METAMODE} \
183		${CROSS_TOOLCHAIN_PARAM} __MAKE_CONF=${MAKECONF} SRCCONF=${SRCCONF} \
184		${EXTRA_MAKE_FLAGS} KERNCONF=${KERNCONF} \
185		buildkernel ${LOG_TARGET}
186
187ci-buildimage: ${QEMUTGT} ci-buildkernel-${TARGET_ARCH:tl} .PHONY
188	@echo "Building ci image for ${TARGET_ARCH}"
189	mkdir -p ${.OBJDIR}/${.TARGET}
190	env TARGET=${TARGET} TARGET_ARCH=${TARGET_ARCH} SWAPSIZE=${SWAPSIZE} \
191		QEMUSTATIC=${QEMUSTATIC} CITYPE=${CITYPE} \
192		${RELEASEDIR}/scripts/mk-vmimage.sh \
193		-C ${RELEASEDIR}/tools/vmimage.subr -d ${.OBJDIR}/${.TARGET} -F ${VMFS} \
194		-i ${.OBJDIR}/ci.img -s ${VMSIZE} -f ${FORMAT} \
195		-S ${WORLDDIR} -o ${.OBJDIR}/${CIIMAGE} -c ${CICONF} ${LOG_TARGET}
196	touch ${.TARGET}
197
198ci-set-smoke-var: .PHONY
199CITYPE=smoke
200
201ci-set-full-var: .PHONY
202CITYPE=full
203
204ci-create-meta: .PHONY
205	truncate -s 512M ${META_TAR}
206	tar rvf ${META_TAR} -C ${META_DIR} .
207
208ci-extract-meta: .PHONY
209	tar xfv ${META_TAR} -C ${META_DIROUT}
210	rm -rf ${META_TAR} ${META_DIR}
211	@echo "Extracted kyua reports to ${META_DIROUT}"
212
213ci-runtest: ci-buildimage-${TARGET_ARCH:tl} portinstall .PHONY
214.if ${MACHINE} == "amd64" && ( ${TARGET_ARCH} == "amd64" || ${TARGET_ARCH} == "i386" ) && ( !defined(USE_QEMU) || empty(USE_QEMU) )
215	/usr/sbin/bhyvectl --vm=${TEST_VM_NAME} --destroy || true
216	expect -c "set timeout ${TIMEOUT_EXPECT}; \
217		spawn /usr/bin/timeout -k 5s 30s /usr/sbin/bhyveload \
218		-c stdio -m ${VM_MEM_SIZE} -d ${CIDISK} ${TEST_VM_NAME}; \
219		expect { eof }; \
220		exit [lindex [wait] 3]"
221	expect -c "set timeout ${TIMEOUT_EXPECT}; \
222		spawn /usr/bin/timeout -k 60 ${TIMEOUT_VM} /usr/sbin/bhyve \
223		-c ${PARALLEL_JOBS} -m ${VM_MEM_SIZE} -A -H -P \
224		-s 0:0,hostbridge \
225		-s 1:0,lpc \
226		-s 2:0,virtio-blk,${CIDISK} \
227		-s 3:0,virtio-blk,${META_TAR} \
228		${BHYVE_EXTRA_DISK_PARAM} \
229		-l com1,stdio \
230		${TEST_VM_NAME}; \
231		expect { eof }"
232	/usr/sbin/bhyvectl --vm=${TEST_VM_NAME} --destroy
233.else
234	timeout -k 60 ${TIMEOUT_VM} ${QEMUBIN} \
235		-machine ${QEMU_MACHINE} \
236		-smp ${QEMU_CPU_COUNT} \
237		-m ${VM_MEM_SIZE} \
238		-nographic \
239		-no-reboot \
240		${QEMU_EXTRA_PARAM} \
241		-device virtio-blk,drive=hd0 \
242		-device virtio-blk,drive=hd1 \
243		-blockdev driver=raw,node-name=hd0,file.driver=file,file.filename=${CIDISK} \
244		-blockdev driver=raw,node-name=hd1,file.driver=file,file.filename=${META_TAR} \
245		${QEMU_DEVICES}
246.endif
247
248ci-checktarget: .PHONY
249.if ${TARGET_ARCH} != "aarch64" && \
250	${TARGET_ARCH} != "amd64" && \
251	${TARGET_ARCH} != "armv7" && \
252	${TARGET_ARCH} != "powerpc64" && \
253	${TARGET_ARCH} != "powerpc64le" && \
254	${TARGET_ARCH} != "riscv64"
255	@false
256.ERROR:
257	@echo "Error: ${TARGET_ARCH} is not supported on ${TYPE} ${REVISION} ${BRANCH}"
258.endif
259
260ci-smoke: ci-set-smoke-var ci-create-meta ci-checktarget .WAIT ci-runtest-${TARGET_ARCH:tl} .PHONY
261
262ci-full: ci-set-full-var ci-create-meta ci-checktarget .WAIT ci-runtest-${TARGET_ARCH:tl} .WAIT ci-extract-meta .PHONY
263
264ci: ci-${CITYPE:tl} .PHONY
265
266.include "${RELEASEDIR}/Makefile.inc1"
267