From patchwork Fri Nov 1 06:45:00 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13858782 Received: from mail-yw1-f202.google.com (mail-yw1-f202.google.com [209.85.128.202]) (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 F0FBF154457 for ; Fri, 1 Nov 2024 06:45:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443518; cv=none; b=GseKE1pHd0JrQFItxEIcYQ55w27Xz6Q+UY4HZclUatkCnNg0odJC04d84Sd5G7eeRQNG/vNtt2gnt5d+DuKzhFd07PZo5RR+FD6YQENVvcqup2ihgKXJWZuWGBB7yge00yBjbnSt3vtyHr1CfDZYPzubhu6xhWjK8WKstVpSqpk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443518; c=relaxed/simple; bh=1IKZAnyZPpVktxHC9zRma8YOuWXM4MGCEBdsXQkjzIo=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=LiAZ5hqNbsYk2MFssoLRV8CN7+wwTksUaScGn8+4BH03Lm21D0Uk7Aj6XBmHqQGohpKlr/1NPFrBJ2cvA85FQ0I7NRciDpZPnzP+2ASpINTOUh8GY2/2FWilkv3yw7SRKrPKdne8N+3+aNCGeUTbehhFJQ/tC+btlv3pSTwwtjk= 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=fF5YjBoB; arc=none smtp.client-ip=209.85.128.202 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="fF5YjBoB" Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-6e3d6713619so29102637b3.2 for ; Thu, 31 Oct 2024 23:45:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730443515; x=1731048315; 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=HN46+Rtavp3etuaSPyEP0rFqZqnfBVs2LrQ3ai2Thlw=; b=fF5YjBoBAdWQfF7bKOSamDnPodcGGvu0jzwB4wby3JCSBvVipeCiNNoNAyDeLKcdWI OAt7o0OS8/sNtW5yLGwDL8HTwMwAfYZZmDZlgNik8FwpF3eq9TpgGXIbmNqbCiFPgY9E nr/tVHAFBZpRnH/9ARO6nPGWG8jelw78cDLo5XAo2Te13QfZ955ivHEcGhTfzyv6ufyF RAk46s91zUvN54BMm/+Suq9TSx0F34NWYbgQ1hJyVc1nKOny29Cgk4od/PaND4Pc8xTW pg1LDk+oPF2cCwQzYcaTmvH5V0zSSnmO66bgJmjK219CEut/pTkrEHMIi9gaqYzXMqTm CINA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730443515; x=1731048315; 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=HN46+Rtavp3etuaSPyEP0rFqZqnfBVs2LrQ3ai2Thlw=; b=FgKZL7BavTTAuohqiIGqsqz8nbKILO7/AXyGq4Ov9kaMxKftBkehO5mdzIA5RBEiTc 0q4x18DbvTO4DJY41z7gDVmjRCFa/QRB2w22++gyhH8yI2jPnlIpBe0PnmKEqbqdCo5G F+bc9LYM8uTYNVJW8u+4LWyEl6O8cTC8JstOgnTqIfV4cEFjZks61kfogDzgFC0j9lB/ yQVjqZGRYcj66j0XROefsRCufnfD1KjzM9Magq6rmABrUOysShgRKB6PYE3MfEJgYQE6 VldQ7+tRAgWG4g48+Vdp3j5rNZYUN23wsqbif3NRoQLdXUtX/ygKy5czOmSniauzAh+8 9g0g== X-Forwarded-Encrypted: i=1; AJvYcCWcFXpwpciVT8+URvGi1rPlT7Tuufwp16w93zy5DScMHGYx82YtMwExaANPRS4dVk6/49ycG+9BDCYlmFmlmx0=@vger.kernel.org X-Gm-Message-State: AOJu0YwTLNqcjkOFyt9RyTimPMm3AOPwkOlU0mJ6GP8PMWR0FseW7fTA ALtHR2nDMHtx29jwUAFXnWZ+dfOz6VH7fEn5dRDJKfkCUp8/80yXh1MZ06M0qpsKw426sToMlvu rya/M1uoxaA== X-Google-Smtp-Source: AGHT+IHT+oXP1IDEHV+YQkcgyEE3wRqCvILeKKI81XEVSowpz4ckxeKqpkDRwBLTQD+CXRtdhovD3Rs6VjwQDw== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a05:6902:181e:b0:e28:fdfc:b788 with SMTP id 3f1490d57ef6-e30cf4d455bmr6497276.9.1730443515109; Thu, 31 Oct 2024 23:45:15 -0700 (PDT) Date: Fri, 1 Nov 2024 14:45:00 +0800 In-Reply-To: <20241101064505.3820737-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: <20241101064505.3820737-1-davidgow@google.com> X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Message-ID: <20241101064505.3820737-2-davidgow@google.com> Subject: [PATCH v4 1/3] rust: kunit: add KUnit case and suite macros From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Brendan Higgins , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Alice Ryhl , Matt Gilbride 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 couple of Rust const functions and macros to allow to develop KUnit tests without relying on generated C code: - The `kunit_unsafe_test_suite!` Rust macro is similar to the `kunit_test_suite` C macro. It requires a NULL-terminated array of test cases (see below). - The `kunit_case` Rust function is similar to the `KUNIT_CASE` C macro. It generates as case from the name and function. - The `kunit_case_null` Rust function generates a NULL test case, which is to be used as delimiter in `kunit_test_suite!`. While these functions and macros can be used on their own, a future patch will introduce another macro to create KUnit tests using a user-space like syntax. Signed-off-by: José Expósito Co-developed-by: Matt Gilbride Signed-off-by: Matt Gilbride Co-developed-by: David Gow Signed-off-by: David Gow --- Changes since v3: https://lore.kernel.org/linux-kselftest/20241030045719.3085147-4-davidgow@google.com/ - The kunit_unsafe_test_suite!() macro now panic!s if the suite name is too long, triggering a compile error. (Thanks, Alice!) Changes since v2: https://lore.kernel.org/linux-kselftest/20241029092422.2884505-2-davidgow@google.com/ - The kunit_unsafe_test_suite!() macro will truncate the name of the suite if it is too long. (Thanks Alice!) - We no longer needlessly use UnsafeCell<> in kunit_unsafe_test_suite!(). (Thanks Alice!) Changes since v1: https://lore.kernel.org/lkml/20230720-rustbind-v1-1-c80db349e3b5@google.com/ - Rebase on top of rust-next - As a result, KUnit attributes are new set. These are hardcoded to the defaults of "normal" speed and no module name. - Split the kunit_case!() macro into two const functions, kunit_case() and kunit_case_null() (for the NULL terminator). --- rust/kernel/kunit.rs | 112 +++++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 2 files changed, 113 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 824da0e9738a..85bc1faff0d5 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -161,3 +161,115 @@ macro_rules! kunit_assert_eq { $crate::kunit_assert!($name, $file, $diff, $left == $right); }}; } + +/// Represents an individual test case. +/// +/// The test case should have the signature +/// `unsafe extern "C" fn test_case(test: *mut crate::bindings::kunit)`. +/// +/// The `kunit_unsafe_test_suite!` macro expects a NULL-terminated list of test cases. +/// Use `kunit_case_null` to generate such a delimeter. +const fn kunit_case(name: &'static kernel::str::CStr, run_case: unsafe extern "C" fn(*mut kernel::bindings::kunit)) -> kernel::bindings::kunit_case { + kernel::bindings::kunit_case { + run_case: Some(run_case), + name: name.as_char_ptr(), + attr: kernel::bindings::kunit_attributes { + speed: kernel::bindings::kunit_speed_KUNIT_SPEED_NORMAL, + }, + generate_params: None, + status: kernel::bindings::kunit_status_KUNIT_SUCCESS, + module_name: core::ptr::null_mut(), + log: core::ptr::null_mut(), + } +} + +/// Represents the NULL test case delimiter. +/// +/// The `kunit_unsafe_test_suite!` macro expects a NULL-terminated list of test cases. This +/// function retuns such a delimiter. +const fn kunit_case_null() -> kernel::bindings::kunit_case { + kernel::bindings::kunit_case { + run_case: None, + name: core::ptr::null_mut(), + generate_params: None, + attr: kernel::bindings::kunit_attributes { + speed: kernel::bindings::kunit_speed_KUNIT_SPEED_NORMAL, + }, + status: kernel::bindings::kunit_status_KUNIT_SUCCESS, + module_name: core::ptr::null_mut(), + log: core::ptr::null_mut(), + } +} + + +/// Registers a KUnit test suite. +/// +/// # Safety +/// +/// `test_cases` must be a NULL terminated array of test cases. +/// +/// # Examples +/// +/// ```ignore +/// unsafe extern "C" fn test_fn(_test: *mut crate::bindings::kunit) { +/// let actual = 1 + 1; +/// let expected = 2; +/// assert_eq!(actual, expected); +/// } +/// +/// static mut KUNIT_TEST_CASE: crate::bindings::kunit_case = crate::kunit_case(name, test_fn); +/// static mut KUNIT_NULL_CASE: crate::bindings::kunit_case = crate::kunit_case_null(); +/// static mut KUNIT_TEST_CASES: &mut[crate::bindings::kunit_case] = unsafe { +/// &mut[KUNIT_TEST_CASE, KUNIT_NULL_CASE] +/// }; +/// crate::kunit_unsafe_test_suite!(suite_name, KUNIT_TEST_CASES); +/// ``` +#[macro_export] +macro_rules! kunit_unsafe_test_suite { + ($name:ident, $test_cases:ident) => { + const _: () = { + static KUNIT_TEST_SUITE_NAME: [i8; 256] = { + let name_u8 = core::stringify!($name).as_bytes(); + let mut ret = [0; 256]; + + if name_u8.len() > 255 { + panic!(concat!("The test suite name `", core::stringify!($name), "` exceeds the maximum length of 255 bytes.")); + } + + let mut i = 0; + while i < name_u8.len() { + ret[i] = name_u8[i] as i8; + i += 1; + } + + ret + }; + + static mut KUNIT_TEST_SUITE: $crate::bindings::kunit_suite = + $crate::bindings::kunit_suite { + name: KUNIT_TEST_SUITE_NAME, + // SAFETY: User is expected to pass a correct `test_cases`, hence this macro + // named 'unsafe'. + test_cases: unsafe { $test_cases.as_mut_ptr() }, + suite_init: None, + suite_exit: None, + init: None, + exit: None, + attr: $crate::bindings::kunit_attributes { + speed: $crate::bindings::kunit_speed_KUNIT_SPEED_NORMAL, + }, + status_comment: [0; 256usize], + debugfs: core::ptr::null_mut(), + log: core::ptr::null_mut(), + suite_init_err: 0, + is_init: false, + }; + + #[used] + #[link_section = ".kunit_test_suites"] + static mut KUNIT_TEST_SUITE_ENTRY: *const $crate::bindings::kunit_suite = + // SAFETY: `KUNIT_TEST_SUITE` is static. + unsafe { core::ptr::addr_of_mut!(KUNIT_TEST_SUITE) }; + }; + }; +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index b62451f64f6e..d662aa37070f 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -18,6 +18,7 @@ #![feature(inline_const)] #![feature(lint_reasons)] #![feature(unsize)] +#![feature(const_mut_refs)] // Ensure conditional compilation based on the kernel configuration works; // otherwise we may silently break things like initcall handling. From patchwork Fri Nov 1 06:45:01 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13858783 Received: from mail-yw1-f201.google.com (mail-yw1-f201.google.com [209.85.128.201]) (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 5BDE215443C for ; Fri, 1 Nov 2024 06:45:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443523; cv=none; b=PwWBvtVsFzSbC+xP1S7nuizZKLSor/LmicABmIKkGOKrMaboU6EOlA87Ri6DdDbilCSTR378icMlpkVcl3UDqGfxD1dhaCedv7dr9ju1Nrcy19Jby2qnKFgvFskEjDMibWqu0l2Rnh1SAunIlQt/ZK4kpP8XHqwnF2HxvZ/I/7A= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443523; c=relaxed/simple; bh=v0JWh6mI0misBYz0RyrCman5gMCJ1WpGSVem5xwGrw4=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=dnThhCyW64rYB7AX9gFlmeoJXi6TKoLwSUhGAvv+tmarmAfHEwQRQbfg9APEZuEaucTJ8WE3glgbBAmsVhqr+pWm69wCNpU4zxLuc4YAwlmqI4WPg1t1dk/yda4WxihGFuB0mi4xiHvCf/hiqqmVZ8JdrrolWpasTO5EAm/kLsk= 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=etGVuIzq; arc=none smtp.client-ip=209.85.128.201 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="etGVuIzq" Received: by mail-yw1-f201.google.com with SMTP id 00721157ae682-6e3497c8eb0so22718057b3.0 for ; Thu, 31 Oct 2024 23:45:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730443519; x=1731048319; 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=/ZbS75Dycs4k+d5IOrNhPypH5FLb4D2VKY1Jt0cnz5w=; b=etGVuIzqDJs28bL6EBbWr9IfBHiWJtx0z7FlEu+GLMsBd/hVuDCgGz7viZxoWOSZIq FXG46tZB7s18hpOUC+nadVQyTBg8bkmS7cgGrxQWSNbPveGAkV1abOM7qBAPCyWjzEJI 4Jwg4Gw90hiDfJeVzlppE3kJZjLz860KeArDnPznNOg87RATdrnXbHpi49CuOkNL6alF 89ENoUT0RSZJI5E+5TSGbhQ8rvAq9XkQZaE+H5f4NJPSb/Zkl6EFB8aIey/nKDjIgUpH 3f+GNr5AadZ+kGlxQkB0zaNtbB/6DqSr4eVQdJLZXZWYykIrjMHBtEF9MIDhpDLRNLIi jPMQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730443519; x=1731048319; 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=/ZbS75Dycs4k+d5IOrNhPypH5FLb4D2VKY1Jt0cnz5w=; b=FAGA84PZCffXnAzfe4bMnPF+EXqtHpSA/OnGyXI8lje9RX0KE8mTD43upe9/mY38/z EDD+3zPe/wmrEq61plNr3kzkUwl90Ajt2euBhEii5MJf1OeZWBIiRzUycDDvJQWJcDTs YtnyAC8v594iJpLm8SKNm0iKfzk6NcK6nNda6VRPZOlS4CcrMH5Lw/r5p4zd1pRd48qi w/yaG+0WbZ1S0j0H998QF7rASPN7sdjr/mlL4+y1lDz+3oFJF3DRFYiFxeGo90PpiUk9 gs7XYkVeGFP7NP3mm0J5/HIWJFW3N66IEVaK/UzTpAd5ok4ZQ68LbxAQSGdmfmboL5gt JVWg== X-Forwarded-Encrypted: i=1; AJvYcCXAlkqThvgqt8kp7rokkdOeiTEj4hLLdI5YbK6FVbt14kyhb3r5OI9PaRJ+P3VM9g9vkDye1Dawek2zRK6J7Ow=@vger.kernel.org X-Gm-Message-State: AOJu0YxXhIDfAsQnoeY9xFz8NJ1p3oZ1KHyMqUfcndXQYn3IoIjxSIIh Uh9QKqUu0QHiAXpVBcjf1h8aDq6pMJY+yLsiFEJufqAwm2DjgbweLDs/1bUanQTnfgqF9WGCILB j0oS/pe0RZw== X-Google-Smtp-Source: AGHT+IHxZZTQXlNfO5k0ws+jUpv4gaUJ0UXJ7lVBWsEwZtqCS4NybFDz7nc9Jr66DptLBLlha83xvxa6s7Hd1A== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a05:690c:f11:b0:6db:e464:addc with SMTP id 00721157ae682-6ea557c5a77mr560787b3.4.1730443519481; Thu, 31 Oct 2024 23:45:19 -0700 (PDT) Date: Fri, 1 Nov 2024 14:45:01 +0800 In-Reply-To: <20241101064505.3820737-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: <20241101064505.3820737-1-davidgow@google.com> X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Message-ID: <20241101064505.3820737-3-davidgow@google.com> Subject: [PATCH v4 2/3] rust: macros: add macro to easily run KUnit tests From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Brendan Higgins , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Alice Ryhl , Matt Gilbride 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 Signed-off-by: David Gow --- 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 | 10 +++ rust/macros/kunit.rs | 168 +++++++++++++++++++++++++++++++++++++++++++ rust/macros/lib.rs | 29 ++++++++ 4 files changed, 208 insertions(+) create mode 100644 rust/macros/kunit.rs diff --git a/MAINTAINERS b/MAINTAINERS index b77f4495dcf4..b65035ede675 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -12433,6 +12433,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 85bc1faff0d5..71ce1d145be8 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. @@ -273,3 +275,11 @@ macro_rules! kunit_unsafe_test_suite { }; }; } + +#[kunit_tests(rust_kernel_kunit)] +mod tests { + #[test] + fn rust_test_kunit_example_test() { + assert_eq!(1 + 1, 2); + } +} diff --git a/rust/macros/kunit.rs b/rust/macros/kunit.rs new file mode 100644 index 000000000000..c421ff65f7f9 --- /dev/null +++ b/rust/macros/kunit.rs @@ -0,0 +1,168 @@ +// 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 { + if attr.to_string().is_empty() { + panic!("Missing test name in #[kunit_tests(test_name)] macro") + } + + if attr.to_string().as_bytes().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(); + // } + // static mut KUNIT_CASE_FOO: kernel::bindings::kunit_case = + // kernel::kunit::kunit_case(foo, kunit_rust_wrapper_foo); + // + // unsafe extern "C" fn kunit_rust_wrapper_bar(_test: * mut kernel::bindings::kunit) { + // bar(); + // } + // static mut KUNIT_CASE_BAR: kernel::bindings::kunit_case = + // kernel::kunit::kunit_case(bar, kunit_rust_wrapper_bar); + // + // static mut KUNIT_CASE_NULL: kernel::bindings::kunit_case = kernel::kunit::kunit_case_null(); + // + // static mut TEST_CASES : &mut[kernel::bindings::kunit_case] = unsafe { + // &mut [KUNIT_CASE_FOO, KUNIT_CASE_BAR, 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_case_name = format!("KUNIT_CASE_{}", test.to_uppercase()); + let kunit_wrapper = format!( + "unsafe extern \"C\" fn {}(_test: *mut kernel::bindings::kunit) {{ {}(); }}", + kunit_wrapper_fn_name, test + ); + let kunit_case = format!( + "static mut {}: kernel::bindings::kunit_case = kernel::kunit::kunit_case(kernel::c_str!(\"{}\"), {});", + kunit_case_name, test, kunit_wrapper_fn_name + ); + writeln!(kunit_macros, "{kunit_wrapper}").unwrap(); + writeln!(kunit_macros, "{kunit_case}").unwrap(); + writeln!(test_cases, "{kunit_case_name},").unwrap(); + } + + writeln!( + kunit_macros, + "static mut KUNIT_CASE_NULL: kernel::bindings::kunit_case = kernel::kunit::kunit_case_null();" + ) + .unwrap(); + + writeln!( + kunit_macros, + "static mut TEST_CASES : &mut[kernel::bindings::kunit_case] = unsafe {{ &mut[{test_cases} KUNIT_CASE_NULL] }};" + ) + .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 939ae00b723a..098925b99982 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; @@ -430,3 +431,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) +} From patchwork Fri Nov 1 06:45:02 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: David Gow X-Patchwork-Id: 13858784 Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) (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 05CB415535B for ; Fri, 1 Nov 2024 06:45:24 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443527; cv=none; b=Kz0a4fzMRCQxx74rYbzyZcG+ErIMxpe1z+JXbGh1prKvijOkfnZoBW3iSKgl6jg2x+Be9n2rTYHm9sfSEXPL1QUxjrs+doBlVxijyQtqn4unV4b5i4Rb7+SojcR3G729f5knEZRvngdEFeEWUgRk9vkSr9z0K9c3wIegimuG+lI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1730443527; c=relaxed/simple; bh=f3EQWER6RRuCLdLa6B3j/75NplNWzvD63Oagrzez9Kg=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=oviGDYZdaCf4TOLFtTm6UqX34KadZcqVHF7IVAgGXPvRM8qcfoSZeUY19O9/cPz9jNYQWnUpXsnOGBmwi5uviDzTgstF1+7j1EmlJx2/+NmI05Tb8foP67i6/9+peSfAaR4ZHQz9PQdIkBeTMeSqAdddAdX6qah6g/KugU1zIFE= 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=H0FBm8o7; arc=none smtp.client-ip=209.85.219.202 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="H0FBm8o7" Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-e2e3321aae0so2862898276.1 for ; Thu, 31 Oct 2024 23:45:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1730443524; x=1731048324; 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=lHPJiykftORb/g35WFmCs+9SKBvzp/KNUqXI3sEF0e8=; b=H0FBm8o75WDSOJooUUCigqPjMN3jae5MqpmZunAzEgBkm6gJ5vbwxfhq+yKMVTvleH 6Wgc5bsj7iVTFbtCt+xBIQLohnIL68AQJlj1qtD2tuOWBWCEoM+xXulN5cF4PDavEGjT BY3iD0BkUqTXzoI9v4K8gHp+Qp4x4AjYPCahqf/m5gHnOqyBhEp/CkzW1oEVfjNisAqz wfUiU2PkB8X1C7hvzk/t8mLIIkNJF7zclY3M81JI/p5sFJGBYJkXON/ktQbhrN9B7y7M 2WnqMp/HzSgCZd6JAaye4Pstz2ghkF63RktuA11RM+OwsWsIO85tgTCTNX70ivF+CbYD o8uw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1730443524; x=1731048324; 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=lHPJiykftORb/g35WFmCs+9SKBvzp/KNUqXI3sEF0e8=; b=e7WeBX4A/kNZjxVb02GhHV+Bv0Ut2qMnId5b7oOQUfLrVezRyqhhu3NVf8bQf91CG7 aaOMitYc7EWWBQr4u8+yILT4xCAxogoheAWFAisjyuxC7GZcQygxOSl7i4YoMqe3M1jc 9urY5+kw4NFsQn1e+yj57KcaL2Vf6tavA86XcmDU4CntuszWyQUuxUBRrHvnozqRk+OE O4pWYzX5Z5iDX+z76rTV8IfSCjiUgWED1jDbK0Q3z78eZGrOmBgH8dHfJp1GWXsaov3q uj0j+W/neOHqcTE2xQCOwsBCzm86y/GI2yY+81edgi9X5+Kr4qaJftgTW9+dV9N1iw0n EJLg== X-Forwarded-Encrypted: i=1; AJvYcCWi7pnEI8gYWk9N5UVkHDF3uFo4iqJc9UI/EVpKc1wAk1wNFmbPllX5OAP9P3yk8I7AU2TW4eBRr34O6MSHMCY=@vger.kernel.org X-Gm-Message-State: AOJu0YxLdPZOSp8IJNHGOzj/BcdeoTpJr68LL/hoLA5s4TgXEKxBJ8r2 q59D2wOssl5Ajwr4inZKZWnxqDGkMHjui4B9hkdmwdca/6EDwA21zmOlIZ7tCoJlUo80fAyrMs7 TKzWvOh2Hmw== X-Google-Smtp-Source: AGHT+IEIXo3M6l3NU9Qv2uOCk9CnzdlHFgd4U1XPtBHdD4Ek09zM+pvRo5MbMvTvDW7Nu3Tut9Zu4gtndT2qHg== X-Received: from slicestar.c.googlers.com ([fda3:e722:ac3:cc00:b1:7045:ac11:6237]) (user=davidgow job=sendgmr) by 2002:a25:aa83:0:b0:e30:c235:d79f with SMTP id 3f1490d57ef6-e30e5b282d1mr2857276.8.1730443523956; Thu, 31 Oct 2024 23:45:23 -0700 (PDT) Date: Fri, 1 Nov 2024 14:45:02 +0800 In-Reply-To: <20241101064505.3820737-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: <20241101064505.3820737-1-davidgow@google.com> X-Mailer: git-send-email 2.47.0.199.ga7371fff76-goog Message-ID: <20241101064505.3820737-4-davidgow@google.com> Subject: [PATCH v4 3/3] rust: kunit: allow to know if we are in a test From: David Gow To: Miguel Ojeda , " =?utf-8?b?Sm9zw6kgRXhww7NzaXRv?= " , Brendan Higgins , Rae Moar , Boqun Feng , Alex Gaynor , Gary Guo , Benno Lossin , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Alice Ryhl , Matt Gilbride 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 In some cases, we need to call test-only code from outside the test case, for example, to mock a function or a module. In order to check whether we are in a test or not, we need to test if `CONFIG_KUNIT` is set. Unfortunately, we cannot rely only on this condition because: - a test could be running in another thread, - some distros compile KUnit in production kernels, so checking at runtime that `current->kunit_test != NULL` is required. Forturately, KUnit provides an optimised check in `kunit_get_current_test()`, which checks CONFIG_KUNIT, a global static key, and then the current thread's running KUnit test. Add a safe wrapper function around this to know whether or not we are in a KUnit test and examples showing how to mock a function and a module. Signed-off-by: José Expósito Co-developed-by: David Gow Signed-off-by: David Gow --- Changes since v3: https://lore.kernel.org/linux-kselftest/20241030045719.3085147-8-davidgow@google.com/ - The example test has been updated to no longer use assert_eq!() with a constant bool argument (fixes a clippy warning). No changes since v2: https://lore.kernel.org/linux-kselftest/20241029092422.2884505-4-davidgow@google.com/ Changes since v1: https://lore.kernel.org/lkml/20230720-rustbind-v1-3-c80db349e3b5@google.com/ - Rebased on top of rust-next. - Use the `kunit_get_current_test()` C function, which wasn't previously available, instead of rolling our own. - (Thanks also to Boqun for suggesting a nicer way of implementing this, which I tried, but the `kunit_get_current_test()` version obsoleted.) --- rust/kernel/kunit.rs | 72 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 71ce1d145be8..ad38d6d62446 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -276,10 +276,82 @@ macro_rules! kunit_unsafe_test_suite { }; } +/// In some cases, you need to call test-only code from outside the test case, for example, to +/// create a function mock. This function can be invoked to know whether we are currently running a +/// KUnit test or not. +/// +/// # Examples +/// +/// This example shows how a function can be mocked to return a well-known value while testing: +/// +/// ``` +/// # use kernel::kunit::in_kunit_test; +/// # +/// fn fn_mock_example(n: i32) -> i32 { +/// if in_kunit_test() { +/// 100 +/// } else { +/// n + 1 +/// } +/// } +/// +/// let mock_res = fn_mock_example(5); +/// assert_eq!(mock_res, 100); +/// ``` +/// +/// Sometimes, you don't control the code that needs to be mocked. This example shows how the +/// `bindings` module can be mocked: +/// +/// ``` +/// // Import our mock naming it as the real module. +/// #[cfg(CONFIG_KUNIT)] +/// use bindings_mock_example as bindings; +/// +/// // This module mocks `bindings`. +/// mod bindings_mock_example { +/// use kernel::kunit::in_kunit_test; +/// use kernel::bindings::u64_; +/// +/// // Make the other binding functions available. +/// pub(crate) use kernel::bindings::*; +/// +/// // Mock `ktime_get_boot_fast_ns` to return a well-known value when running a KUnit test. +/// pub(crate) unsafe fn ktime_get_boot_fast_ns() -> u64_ { +/// if in_kunit_test() { +/// 1234 +/// } else { +/// unsafe { kernel::bindings::ktime_get_boot_fast_ns() } +/// } +/// } +/// } +/// +/// // This is the function we want to test. Since `bindings` has been mocked, we can use its +/// // functions seamlessly. +/// fn get_boot_ns() -> u64 { +/// unsafe { bindings::ktime_get_boot_fast_ns() } +/// } +/// +/// let time = get_boot_ns(); +/// assert_eq!(time, 1234); +/// ``` +pub fn in_kunit_test() -> bool { + // SAFETY: kunit_get_current_test() is always safe to call from C (it has fallbacks for + // when KUnit is not enabled), and we're only comparing the result to NULL. + unsafe { !bindings::kunit_get_current_test().is_null() } +} + #[kunit_tests(rust_kernel_kunit)] mod tests { + use super::*; + #[test] fn rust_test_kunit_example_test() { assert_eq!(1 + 1, 2); } + + #[test] + fn rust_test_kunit_in_kunit_test() { + let in_kunit = in_kunit_test(); + assert!(in_kunit); + } }