From patchwork Fri Feb 14 07:40:47 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13974572 Received: from mail-pj1-f73.google.com (mail-pj1-f73.google.com [209.85.216.73]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 66D84215F7D for ; Fri, 14 Feb 2025 07:41:14 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.216.73 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739518877; cv=none; b=e0t1kU2mkN/4+LJa3Y3GHe5J05n+ftxBXLelSaA+Ap67erYINqUCh8Q49LrTKEQxzVCneRSKAGUOEMPVDULMFXVBkg2Wur5y36WWR/Pcy6iWewtsp2rWJCY3CAz3Ym8YY3XMZvpVnPhBcpdvUT20Xy6/Gq8RhL6FEqDMzlINtl8= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1739518877; c=relaxed/simple; bh=mB8RljxRBxmoBJH4cSw2Js1xDICxl9o34q0cGW3ygEE=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=Nrs58fuGW+MQEcprLBWarMnnF2EGJTCHYpMafdy2xzc1nF+7www+oQajhqQgc9w3GY8pogy+RgYRJhMqlwfd/VmJnB8AzJiWOmnzuT2VfhCtNKGIS6likXTCODJFUo8OreCW1Ro7t+M/xK70r/K+NxSdZO1evOqbzDcaITFQLC4= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--davidgow.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=0Epjxrmu; arc=none smtp.client-ip=209.85.216.73 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--davidgow.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="0Epjxrmu" Received: by mail-pj1-f73.google.com with SMTP id 98e67ed59e1d1-2fa6793e8b8so4351183a91.1 for ; Thu, 13 Feb 2025 23:41:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1739518873; x=1740123673; darn=vger.kernel.org; h=content-transfer-encoding:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:from:to:cc:subject:date:message-id :reply-to; bh=z7ik/yYHWC4cSFyE677DFM7MwyWnyFWcIyYE5TmEaZk=; b=0EpjxrmucIq27i/HAgti0AJxdhCQyPG6teOuk5C7pHhF1FJSbOUJi1L94QC6xibrjx Rp2/9GFsVbmGq6btRHMd5VrIv+b7lqaxnIOa/fyKgxpb4gYORjxBB/Apv0M7Y4ddMH6/ w/l10ihZ+eL0x4O0NP5uaE60jcBRRotd/GYoTw2wMN8H7nsJXB+jYyirk1KOdf4OpXH+ rDm6GKYX03GrDXLmBXjZaTcVEDudHNMrZqmNGJFTOFAg175S1SuUL51MgEFH3UsU1zZp 8FN669jn36FvK1jE67nNMWZSHLjry1yxmOyxwaXCwZcAZp+3eQgalJhNXEgJ6ZZoP5OA CnAw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1739518873; x=1740123673; h=content-transfer-encoding:cc:to:from:subject:message-id:references :mime-version:in-reply-to:date:x-gm-message-state:from:to:cc:subject :date:message-id:reply-to; bh=z7ik/yYHWC4cSFyE677DFM7MwyWnyFWcIyYE5TmEaZk=; b=mZdYxIOr3qnV0HRwPqwYTGiAaH3X916jTw6pL7xtM8giH/1bcYBBnE4T06BSqOFEux iOUyAwLoLP59BaVtOu7K5VaaULaO6LJSIGptTDLeBmgqW1gynGgMvKvrrwVzwOrcLMDQ O8ZiK9t2/tf9Ayo8TItBz3KXyCAEurAsQ3NRU1eKiX2voOYLO3q1M+chY7tHwTtHHckG gTW2sixjpO6Z7fb0mLeWLPrCil1Ssz5po18E9Nl/SmDJURPbmGMWCKB5CDzZky+Z/K91 aOhEPWbsyjgnsuK4s+HHzkIup9jY+1S0tQT5w/mrDTNo78Nvy4Ab7vkpLWrqmn7X8PhM qcdA== X-Forwarded-Encrypted: i=1; AJvYcCVbQ3KgQjD2r96Xn6cQjWFp3TawgKAyC4ETNK5VXoll3PX8VaelGOtlcz2tSQoMX+X+0Lh1xY6e3y8G30J18xg=@vger.kernel.org X-Gm-Message-State: AOJu0Yzp/JLWcOJ1GKikItIEe+ZGY2ySpCuWfspXM4qNffmnEuXdCWXc eDkMLFAWQnBsFKH2peOsOIm8+YqDh80JQWhQqfkj90lHWADuMJOJuNajzOFraXqYNVOtjy7GM/O bjIHrRodu6g== X-Google-Smtp-Source: AGHT+IEkq7g/FMyaZ2HZHq6urtv2X+8U7htg+6MlXR2lMQiyIGoEGu0XsGyyloOVG3YGp790KZP49SnDIa8Qsw== X-Received: from pglt1.prod.google.com ([2002:a63:5341:0:b0:ad5:545c:175d]) (user=davidgow job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6a20:d81b:b0:1e0:d837:c929 with SMTP id adf61e73a8af0-1ee5e530df2mr17087125637.9.1739518873649; Thu, 13 Feb 2025 23:41:13 -0800 (PST) Date: Fri, 14 Feb 2025 15:40:47 +0800 In-Reply-To: <20250214074051.1619256-1-davidgow@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20250214074051.1619256-1-davidgow@google.com> X-Mailer: git-send-email 2.48.1.601.g30ceb7b040-goog Message-ID: <20250214074051.1619256-3-davidgow@google.com> Subject: [PATCH v6 2/3] rust: macros: add macro to easily run KUnit tests From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Alice Ryhl , Matt Gilbride , Brendan Higgins Cc: kunit-dev@googlegroups.com, linux-kselftest@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, David Gow From: José Expósito Add a new procedural macro (`#[kunit_tests(kunit_test_suit_name)]`) to run KUnit tests using a user-space like syntax. The macro, that should be used on modules, transforms every `#[test]` in a `kunit_case!` and adds a `kunit_unsafe_test_suite!` registering all of them. The only difference with user-space tests is that instead of using `#[cfg(test)]`, `#[kunit_tests(kunit_test_suit_name)]` is used. Note that `#[cfg(CONFIG_KUNIT)]` is added so the test module is not compiled when `CONFIG_KUNIT` is set to `n`. Reviewed-by: David Gow Signed-off-by: José Expósito Co-developed-by: Boqun Feng Signed-off-by: Boqun Feng Co-developed-by: Miguel Ojeda Signed-off-by: Miguel Ojeda Signed-off-by: David Gow Reviewed-by: Tamir Duberstein --- Changes since v5: https://lore.kernel.org/all/20241213081035.2069066-3-davidgow@google.com/ - Fix some rustfmt-related formatting shenanigans. (Thanks, Miguel) - Fix some documentation comment formatting as well. (Thanks, Miguel) - Tidy up the generated code to avoid unneeded &mut[] everywhere. (Thanks, Miguel) - Fix a new clippy warning for using .as_bytes().len() instead of .len() directly. Changes since v4: https://lore.kernel.org/linux-kselftest/20241101064505.3820737-3-davidgow@google.com/ - Rebased against 6.13-rc1 - "Expect" that the sample assert_eq!(1+1, 2) produces a clippy warning due to a redundant assertion. (Thanks Boqun, Miguel) Changes since v3: https://lore.kernel.org/linux-kselftest/20241030045719.3085147-6-davidgow@google.com/ - The #[kunit_tests()] macro now preserves span information, so errors can be better reported. (Thanks, Boqun!) - The example test has been replaced to no longer use assert_eq!() with a constant bool argument (which triggered a clippy warning now we have the span info). It now checks 1 + 1 == 2, to match the C example. - (The in_kunit_test() test in the next patch uses assert!() to check a bool, so having something different here seemed to make a better example.) Changes since v2: https://lore.kernel.org/linux-kselftest/20241029092422.2884505-3-davidgow@google.com/ - Include missing rust/macros/kunit.rs file from v2. (Thanks Boqun!) - The proc macro now emits an error if the suite name is too long. Changes since v1: https://lore.kernel.org/lkml/20230720-rustbind-v1-2-c80db349e3b5@google.com/ - Rebased on top of rust-next - Make use of the new const functions, rather than the kunit_case!() macro. --- MAINTAINERS | 1 + rust/kernel/kunit.rs | 12 ++++ rust/macros/kunit.rs | 161 +++++++++++++++++++++++++++++++++++++++++++ rust/macros/lib.rs | 29 ++++++++ 4 files changed, 203 insertions(+) create mode 100644 rust/macros/kunit.rs diff --git a/MAINTAINERS b/MAINTAINERS index c8d9e8187eb0..4e7a6d2f2c49 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12677,6 +12677,7 @@ F: Documentation/dev-tools/kunit/ F: include/kunit/ F: lib/kunit/ F: rust/kernel/kunit.rs +F: rust/macros/kunit.rs F: scripts/rustdoc_test_* F: tools/testing/kunit/ diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index d34a92075174..9e27b74a605b 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -40,6 +40,8 @@ pub fn info(args: fmt::Arguments<'_>) { } } +use macros::kunit_tests; + /// Asserts that a boolean expression is `true` at runtime. /// /// Public but hidden since it should only be used from generated tests. @@ -275,6 +277,7 @@ macro_rules! kunit_unsafe_test_suite { }; #[used] + #[allow(unused_unsafe)] #[link_section = ".kunit_test_suites"] static mut KUNIT_TEST_SUITE_ENTRY: *const ::kernel::bindings::kunit_suite = // SAFETY: `KUNIT_TEST_SUITE` is static. @@ -282,3 +285,12 @@ macro_rules! kunit_unsafe_test_suite { }; }; } + +#[kunit_tests(rust_kernel_kunit)] +mod tests { + #[test] + fn rust_test_kunit_example_test() { + #![expect(clippy::eq_op)] + assert_eq!(1 + 1, 2); + } +} diff --git a/rust/macros/kunit.rs b/rust/macros/kunit.rs new file mode 100644 index 000000000000..4f553ecf40c0 --- /dev/null +++ b/rust/macros/kunit.rs @@ -0,0 +1,161 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! Procedural macro to run KUnit tests using a user-space like syntax. +//! +//! Copyright (c) 2023 José Expósito + +use proc_macro::{Delimiter, Group, TokenStream, TokenTree}; +use std::fmt::Write; + +pub(crate) fn kunit_tests(attr: TokenStream, ts: TokenStream) -> TokenStream { + let attr = attr.to_string(); + + if attr.is_empty() { + panic!("Missing test name in `#[kunit_tests(test_name)]` macro") + } + + if attr.len() > 255 { + panic!( + "The test suite name `{}` exceeds the maximum length of 255 bytes", + attr + ) + } + + let mut tokens: Vec<_> = ts.into_iter().collect(); + + // Scan for the `mod` keyword. + tokens + .iter() + .find_map(|token| match token { + TokenTree::Ident(ident) => match ident.to_string().as_str() { + "mod" => Some(true), + _ => None, + }, + _ => None, + }) + .expect("`#[kunit_tests(test_name)]` attribute should only be applied to modules"); + + // Retrieve the main body. The main body should be the last token tree. + let body = match tokens.pop() { + Some(TokenTree::Group(group)) if group.delimiter() == Delimiter::Brace => group, + _ => panic!("Cannot locate main body of module"), + }; + + // Get the functions set as tests. Search for `[test]` -> `fn`. + let mut body_it = body.stream().into_iter(); + let mut tests = Vec::new(); + while let Some(token) = body_it.next() { + match token { + TokenTree::Group(ident) if ident.to_string() == "[test]" => match body_it.next() { + Some(TokenTree::Ident(ident)) if ident.to_string() == "fn" => { + let test_name = match body_it.next() { + Some(TokenTree::Ident(ident)) => ident.to_string(), + _ => continue, + }; + tests.push(test_name); + } + _ => continue, + }, + _ => (), + } + } + + // Add `#[cfg(CONFIG_KUNIT)]` before the module declaration. + let config_kunit = "#[cfg(CONFIG_KUNIT)]".to_owned().parse().unwrap(); + tokens.insert( + 0, + TokenTree::Group(Group::new(Delimiter::None, config_kunit)), + ); + + // Generate the test KUnit test suite and a test case for each `#[test]`. + // The code generated for the following test module: + // + // ``` + // #[kunit_tests(kunit_test_suit_name)] + // mod tests { + // #[test] + // fn foo() { + // assert_eq!(1, 1); + // } + // + // #[test] + // fn bar() { + // assert_eq!(2, 2); + // } + // } + // ``` + // + // Looks like: + // + // ``` + // unsafe extern "C" fn kunit_rust_wrapper_foo(_test: *mut kernel::bindings::kunit) { foo(); } + // unsafe extern "C" fn kunit_rust_wrapper_bar(_test: *mut kernel::bindings::kunit) { bar(); } + // + // static mut TEST_CASES: [kernel::bindings::kunit_case; 3] = [ + // kernel::kunit::kunit_case(kernel::c_str!("foo"), kunit_rust_wrapper_foo), + // kernel::kunit::kunit_case(kernel::c_str!("bar"), kunit_rust_wrapper_bar), + // kernel::kunit::kunit_case_null(), + // ]; + // + // kernel::kunit_unsafe_test_suite!(kunit_test_suit_name, TEST_CASES); + // ``` + let mut kunit_macros = "".to_owned(); + let mut test_cases = "".to_owned(); + for test in &tests { + let kunit_wrapper_fn_name = format!("kunit_rust_wrapper_{}", test); + let kunit_wrapper = format!( + "unsafe extern \"C\" fn {}(_test: *mut kernel::bindings::kunit) {{ {}(); }}", + kunit_wrapper_fn_name, test + ); + writeln!(kunit_macros, "{kunit_wrapper}").unwrap(); + writeln!( + test_cases, + " kernel::kunit::kunit_case(kernel::c_str!(\"{}\"), {}),", + test, kunit_wrapper_fn_name + ) + .unwrap(); + } + + writeln!(kunit_macros).unwrap(); + writeln!( + kunit_macros, + "static mut TEST_CASES: [kernel::bindings::kunit_case; {}] = [\n{test_cases} kernel::kunit::kunit_case_null(),\n];", + tests.len() + 1 + ) + .unwrap(); + + writeln!( + kunit_macros, + "kernel::kunit_unsafe_test_suite!({attr}, TEST_CASES);" + ) + .unwrap(); + + // Remove the `#[test]` macros. + // We do this at a token level, in order to preserve span information. + let mut new_body = vec![]; + let mut body_it = body.stream().into_iter(); + + while let Some(token) = body_it.next() { + match token { + TokenTree::Punct(ref c) if c.as_char() == '#' => match body_it.next() { + Some(TokenTree::Group(group)) if group.to_string() == "[test]" => (), + Some(next) => { + new_body.extend([token, next]); + } + _ => { + new_body.push(token); + } + }, + _ => { + new_body.push(token); + } + } + } + + let mut new_body = TokenStream::from_iter(new_body); + new_body.extend::(kunit_macros.parse().unwrap()); + + tokens.push(TokenTree::Group(Group::new(Delimiter::Brace, new_body))); + + tokens.into_iter().collect() +} diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index d61bc6a56425..50b58259c577 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -10,6 +10,7 @@ mod quote; mod concat_idents; mod helpers; +mod kunit; mod module; mod paste; mod pin_data; @@ -492,3 +493,31 @@ pub fn paste(input: TokenStream) -> TokenStream { pub fn derive_zeroable(input: TokenStream) -> TokenStream { zeroable::derive(input) } + +/// Registers a KUnit test suite and its test cases using a user-space like syntax. +/// +/// This macro should be used on modules. If `CONFIG_KUNIT` (in `.config`) is `n`, the target module +/// is ignored. +/// +/// # Examples +/// +/// ```ignore +/// # use macros::kunit_tests; +/// +/// #[kunit_tests(kunit_test_suit_name)] +/// mod tests { +/// #[test] +/// fn foo() { +/// assert_eq!(1, 1); +/// } +/// +/// #[test] +/// fn bar() { +/// assert_eq!(2, 2); +/// } +/// } +/// ``` +#[proc_macro_attribute] +pub fn kunit_tests(attr: TokenStream, ts: TokenStream) -> TokenStream { + kunit::kunit_tests(attr, ts) +}