From nobody Sun Jan 26 17:36:19 2025 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4YgzHR5G1Fz5m4kP; Sun, 26 Jan 2025 17:36:19 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4YgzHR4gYWz3sBS; Sun, 26 Jan 2025 17:36:19 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1737912979; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Ztdmw5560le/0j3HaGoIt0ixrYlz0jTT2YIpvOTAAM4=; b=nspKFJBmGAfAxicVzm2OlAMPsmrHjLoa5lroPhnF0DshfXGsa709Mqd9dKdiLp/Efoowhn 4iyvJeKqpTvURQj4FWAvY8Wm74Eu/4vLu7XXr2DA2oBsuzb+kwTEcJEuNr9U8HyyO5NK7y 75gBGNm+gPUJCtT9wK9VJXd4LqNDKIQN1HEKRbyrpsue6TIyHZT3W3DHop9/4o9u8hRquz 9FTt2vfnmd0npHrw7CYgVnsnTSPYjM9Al8gLoquqNcBdfqoND/Eh9tS7Q/u1kwV73iytfS LfEaH8gyClCJ4zmj1KRZzux0stnjYWUu/jVME9y++fZ4+1hyK3CdB4OyOon6Dw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1737912979; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Ztdmw5560le/0j3HaGoIt0ixrYlz0jTT2YIpvOTAAM4=; b=nF6Jj4kHPftE44pa6K8ZvYxehDEESGPulc+cymUCw40OsXjp3xntoWcioitz+jZ4pSRBHr Uvs2cOTcmrERC6iwQn+xQY3PvnlKRJkHd73u/bWPEne4TFqMD5Y+u57sJfu8zWlzgB3Xh7 YW59ZBoA+Jkatd4DSQvpjnPc/ujosx2vJnk596I9IgoiUHVeIXmkDFexB7b+Mfw9XdGgg7 1/m2+ozVAOV60CsabwUV0NtqK7FwkWehuGJMeolYb+Pcro36tG3xbYi3znuGSUerxH4lnI /uniS8XTUtK1Qa+MuvOC4plNRYs505v5xKnsUGv67+OL1JENbq7FvpmN2xmVTw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1737912979; a=rsa-sha256; cv=none; b=r89EcbGLr9Ox2m/ExN/CMktbprTkBfArQEWNoKLcxym3nZ84VMp4z287U0ldMytzGu1ptA wEZW76v4kAcR2USWnotL0mqy+X85+iCL0C0pz9eeI77X3KBQ9zYt0lDvykEw9hmZ3sUunc KRuuROQhBGN+3cx1/uY7XS7NuxjLv6TLBRQtlnv7yOasY7dfV/OQETHT+pDXyavipz+LHF PO+AqTjLT1VAkBFmEHJ/mpac+WinxoYc7L5lzE92vulY0O+dhdPf3bv5kYCj+pL23nI7Vt fYR7kq20+UJ9a6IiGaO8OkSRNQXWljjFh5OXnkWaXJSaFUOC5LXgsklvoHwvdA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4YgzHR3nHTzsQT; Sun, 26 Jan 2025 17:36:19 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 50QHaJZ2028480; Sun, 26 Jan 2025 17:36:19 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 50QHaJqt028477; Sun, 26 Jan 2025 17:36:19 GMT (envelope-from git) Date: Sun, 26 Jan 2025 17:36:19 GMT Message-Id: <202501261736.50QHaJqt028477@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Igor Ostapenko Subject: git: 68206add1173 - main - kyuafile.5: ATF metadata mapping reference List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: igoro X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 68206add1173920065092c06eea40c90bb73b5c5 Auto-Submitted: auto-generated The branch main has been updated by igoro: URL: https://cgit.FreeBSD.org/src/commit/?id=68206add1173920065092c06eea40c90bb73b5c5 commit 68206add1173920065092c06eea40c90bb73b5c5 Author: Igor Ostapenko AuthorDate: 2025-01-26 17:15:32 +0000 Commit: Igor Ostapenko CommitDate: 2025-01-26 17:15:32 +0000 kyuafile.5: ATF metadata mapping reference Reviewed by: ngie MFC after: 1 month Differential Revision: https://reviews.freebsd.org/D48190 --- contrib/kyua/doc/kyuafile.5.in | 45 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/contrib/kyua/doc/kyuafile.5.in b/contrib/kyua/doc/kyuafile.5.in index a667f5dc2816..4fe5f12fd9b1 100644 --- a/contrib/kyua/doc/kyuafile.5.in +++ b/contrib/kyua/doc/kyuafile.5.in @@ -122,6 +122,7 @@ of the test program and a collection of optional metadata settings for all the test cases in the test program. Any metadata properties defined by the test cases themselves override the metadata values defined here. +The mapping to ATF metadata naming for each property is provided below. .Pp .Em Plain test programs are those that return 0 on success and non-0 on failure; in general, most test @@ -153,10 +154,16 @@ The following metadata properties can be passed to any test program definition: Whitespace-separated list of machine architecture names allowed by the test. If empty or not defined, the test is allowed to run on any machine architecture. +.Pp +ATF: +.Va require.arch .It Va allowed_platforms Whitespace-separated list of machine platform names allowed by the test. If empty or not defined, the test is allowed to run on any machine platform. +.Pp +ATF: +.Va require.machine .It Va custom.NAME Custom variable defined by the test where .Sq NAME @@ -171,8 +178,14 @@ in it, you will have to use a special Lua syntax to define the property. Refer to the .Sx EXAMPLES section below for clarification. +.Pp +ATF: +.Va X-NAME .It Va description Textual description of the test. +.Pp +ATF: +.Va descr .It Va execenv The name of the execution environment to be used for running the test. If empty or not defined, the @@ -220,6 +233,9 @@ All non-alphanumeric characters are replaced with .Sq kyua_usr_tests_sys_netpfil_pf_pass_block_v4 is an example for /usr/tests/sys/netpfil/pf/pass_block:v4 test case. .El +.Pp +ATF: +.Va execenv .It Va execenv_jail_params Additional test-specific whitespace-separated parameters of .Fx @@ -242,6 +258,9 @@ configuration. It can be overridden via .Va execenv_jail_params if needed. +.Pp +ATF: +.Va execenv.jail.params .It Va is_exclusive If true, indicates that this test program cannot be executed along any other programs at the same time. @@ -251,19 +270,36 @@ value of a setting, must set themselves as exclusive to prevent failures due to race conditions. Defaults to false. +.Pp +ATF: +.Va is.exclusive .It Va required_configs Whitespace-separated list of configuration variables that the test requires to be defined before it can run. +.Pp +ATF: +.Va require.config .It Va required_disk_space Amount of available disk space that the test needs to run successfully. +.Pp +ATF: not mapped .It Va required_files Whitespace-separated list of paths that the test requires to exist before it can run. +.Pp +ATF: +.Va require.files .It Va required_memory Amount of physical memory that the test needs to run successfully. +.Pp +ATF: +.Va require.memory .It Va required_programs Whitespace-separated list of basenames or absolute paths pointing to executable binaries that the test requires to exist before it can run. +.Pp +ATF: +.Va require.progs .It Va required_user If empty, the test has no restrictions on the calling user for it to run. If set to @@ -272,8 +308,14 @@ the test needs to not run as root. If set to .Sq root , the test must run as root. +.Pp +ATF: +.Va require.user .It Va timeout Amount of seconds that the test is allowed to execute before being killed. +.Pp +ATF: +.Va timeout .El .Ss Recursion To reference test programs in another subdirectory, a different @@ -450,7 +492,8 @@ but required_user='root' metadata property reminds that the jail execution environment requires .Xr kyua 1 being running with root privileges, and the test is skipped otherwise with -the respective message. The combination of +the respective message. +The combination of .Va execenv set to .Sq jail