From patchwork Wed Jul 10 17:06:25 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Chan X-Patchwork-Id: 13729496 X-Patchwork-Delegate: brendanhiggins@google.com 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 2042619249E for ; Wed, 10 Jul 2024 17:06:32 +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=1720631194; cv=none; b=WzZQQYcOB/6TkBLh6wcajxf5HNdSvE8euYrLH6NIemOgCBSxFS3f+Zt64fy7ltL/42rXHbPujJWvulWzLwaQOIUy2/c8O86ms2OLcbYjgHmzWXNGIk4usYJTzFhqAeZLx3JpyzNjC+uj/f0DQjKBppjvytD35EtzkO8gK94iw5I= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720631194; c=relaxed/simple; bh=4wT2jC6PAkErIVyGGjb3mnQZSgwRN62Cp3V1tfbR5v0=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=K5wVUfN7EhXXyL6f7yMX9C+DeDz43DD+3RJrgz17fu+4+z6SF6cPCJDOB7FmR1E13KLilbQchq7NXF6qeh9P5GwoDOopjr5MZQvcIqUR7ZtaWkHqNRw1m897oi/3twWsXR1ZhGtoGCL0POgVTVrrauxrJUsvVz9x6Vu5VRWzKMA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--ericchancf.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=mCM42+K9; 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--ericchancf.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="mCM42+K9" Received: by mail-yw1-f202.google.com with SMTP id 00721157ae682-64b9800b377so12961687b3.0 for ; Wed, 10 Jul 2024 10:06:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1720631192; x=1721235992; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=0HbPsmQ0gN/q3U8COOHnxX2fTOdZkrHtTrBhyd2/ae4=; b=mCM42+K9eLzedGLr0PvjQ1xZ3Lw0rfCggM5MF85K8mdVB3zTA95unoZW2u+f5pN7n2 BvNSbD4psijHPVF4aUVyLxEoo8fPcWIr3Fmqd0ZYc3uEn7Yf/wRtFhVzRNq3M8Aygpre HkDQ14UZo7YczdMzPoZj2KMLx7EUpWYB5ihw2WrLjugcnMB8bq8uncXIbAtL2ZAUDCm0 1TpjA6JWeefqbn5rmdvcTqd5JSzzlnFr/BdUMN3LeAdUMTeMrjXdCmvBir/j8UuOV6fr t/soGLeZv6yli4c/waNaBxvlkjUzS6vlQbWfOKxe0of9twiWTMzvxZB1Veecz33qynWx dnFQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720631192; x=1721235992; h=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=0HbPsmQ0gN/q3U8COOHnxX2fTOdZkrHtTrBhyd2/ae4=; b=jBbMyBme8eMF6GmqpO63tU0lQhY9LN8W/DD6qXz9Ma7sVQab43yKPIErGAOQQLjOxc Nle3YnsfcqXmqP/FUqMFIuNHyMTg22YyBfdYl4+01Fii08uA/oFtciijpCofK+wErFL0 aGMLLKrWbFuPCZkeeNhusxlwKzSeYSuyeFtJruzypssZPUrfsMvefmg8GB1Ys1oPOfAM bGxJQp7o1q1Ke8pBHP3xevs1Am/E3kYTMWd0vXwXNY0PqRP4R6q4UaxM7q8x/QO1l5fq 6lXWhzkJxeB9m4huuG0yGH5VD9dgOQECnJfaVQlK8x570oFT7ltwuO1vVRpxr1v8CaCq Ldhw== X-Gm-Message-State: AOJu0YxZBOiDftbJQNAooddtjSvYIeofkeKXpWh0rDN2OtYM9Lk37F4g nRQ2H2gMC/PeA0akg2Z7aNJviRSFkw0/3Y0NtT4JYvDaVUnmBevQe+ke3U1pQtuiolfbhHY3Xy1 yyBJJ4X2XNlFCBRjKAQ== X-Google-Smtp-Source: AGHT+IFrIOvkkPKpRQh+/bL3Bjds/gNme8/diuIke7SGwoMFYK93/GkFdth9JHVvr6t2O2es4BoqOqb855CwFjvG X-Received: from ericchancf.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:4139]) (user=ericchancf job=sendgmr) by 2002:a05:6902:1002:b0:e02:f35c:d398 with SMTP id 3f1490d57ef6-e0577cd7b4fmr5197276.0.1720631192033; Wed, 10 Jul 2024 10:06:32 -0700 (PDT) Date: Wed, 10 Jul 2024 17:06:25 +0000 In-Reply-To: <20240710170448.1399967-1-ericchancf@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20240710170448.1399967-1-ericchancf@google.com> X-Mailer: git-send-email 2.45.2.803.g4e1b14247a-goog Message-ID: <20240710170625.1400724-1-ericchancf@google.com> Subject: [PATCH 1/3] kunit: Fix the comment of KUNIT_ASSERT_STRNEQ as assertion From: Eric Chan To: brendan.higgins@linux.dev, davidgow@google.com, rmoar@google.com Cc: linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, ericchancf@google.com The current comment for KUNIT_ASSERT_STRNEQ incorrectly describes it as an expectation. Since KUNIT_ASSERT_STRNEQ is an assertion, updates the comment to correctly refer to it as such. Signed-off-by: Eric Chan Reviewed-by: David Gow --- include/kunit/test.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/include/kunit/test.h b/include/kunit/test.h index 61637ef32302..87a232421089 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -1420,12 +1420,12 @@ do { \ ##__VA_ARGS__) /** - * KUNIT_ASSERT_STRNEQ() - Expects that strings @left and @right are not equal. + * KUNIT_ASSERT_STRNEQ() - An assertion that strings @left and @right are not equal. * @test: The test context object. * @left: an arbitrary expression that evaluates to a null terminated string. * @right: an arbitrary expression that evaluates to a null terminated string. * - * Sets an expectation that the values that @left and @right evaluate to are + * Sets an assertion that the values that @left and @right evaluate to are * not equal. This is semantically equivalent to * KUNIT_ASSERT_TRUE(@test, strcmp((@left), (@right))). See KUNIT_ASSERT_TRUE() * for more information. From patchwork Wed Jul 10 17:06:43 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Chan X-Patchwork-Id: 13729497 Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com [209.85.219.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 F04A5195B35 for ; Wed, 10 Jul 2024 17:06:49 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720631212; cv=none; b=XZD7IEw7fzl2RQDXzt0KpPLJAJnlZ6OhmfsW5TFBo8HgvVtfjzZNklMzRKxtOzWVNFCdAvW4Y1iTdfd6u28CyNR9xXbITNaO8gvHTYOqoJQn/QyWUNdulZhDUbIBBjpAiPuSvcFTTCrTVpsDG3zjimIj1Uc6tXwWtn4xHghbrg0= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720631212; c=relaxed/simple; bh=55IgR9SW1v2kkYXqH0kYD4+uvDouI7DdE0FHu/jM0R0=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=rVi9/HYmAVgl6YMyCiHci8qFggx4/9VP976y1W6AVkXhxfQlGt9lYZ3R6GQohTWMlrfhETlKC1AmhlclIeSOUwYqQEfjy1diNr2tU4utoDXATVCKavn/6gjVsZ6Jnx6KuihfViKkZhJ9GxQmUKNG7DnrEFqFUD7X8W/eAdl5DHc= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--ericchancf.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=B1Kg3oww; arc=none smtp.client-ip=209.85.219.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--ericchancf.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="B1Kg3oww" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e037c3d20a6so11654554276.0 for ; Wed, 10 Jul 2024 10:06:49 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1720631209; x=1721236009; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=HEsXihW5jwk6/3bgpeafAIIwL8vXDyFBDI7gKiAkO+8=; b=B1Kg3owwOJCFLyekFvKzfMGY0w4B0je/8/WbpfO5FBfAQOKPaga5/MtWoTbzYyH00/ bvQYSFYlDUrYtdna0vEYQB3rraVBlV8kPxp1i0Gwmh5ThKb5afdu795zvITSCU+mTD+p GLBBPg49AWnq7QNXMuJdqT0JmZ/I92Ml6Xyw0mhXetrxNDZf4Jyo6nwi7cA1kDfJciDT YSX3vnAJ1dBI05sx7Hvah+ZtIpMg4WU0HwaSKn93viCEwsJe8wdN8IlWTIgn3ocKO7e5 CmP4YcJDXW+s5ZGDVuS6+OphI2lzzK086LRGFWWNJdxuJ2YckFvg5Qx0sv3nBlhCgJ8G zobA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720631209; x=1721236009; h=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=HEsXihW5jwk6/3bgpeafAIIwL8vXDyFBDI7gKiAkO+8=; b=pQhBws+K+DXbJx3rE+9y9KRgjxg4M10+blTkxxzCaIuZuiygVW/EvibXS6NblYDv/k dWd9/rjCy6cULBexLCiwX4B8yMHYxd33kei+CtVpx/2EhOxUckMrNd81HHTTGAe8phI4 MUwniHPXXkW349TdzESYgVeMvM05+ZqikGW/KLnoafylwvtj5HwbuQT+vPrfScPKfOuw 03QPZTTUXqIrJJCIOixhsvPDSMDO84+OVxj10TfKCPjlVBithB4S1Y5b+7JOSvTvWBAC TQFqJFr42yro6SknkC+iJOEZvRJZx+M64fUZL9z3fZndsUGM4oZpWKgB7hjqMSmy+aoZ fIwg== X-Gm-Message-State: AOJu0YzJfG9jLdqI9xZ+2Yk8Z2lO8PalucK3Y31DUsRHBcCYWjr239+C a1ZMONADHBGQsxhstgHAmad8myjWQdHk5867iILKOk9pV7rJ1gO+vn3nIgvwEixsTcdQ/zBTVbb giGUl3kLm287xMm+dcg== X-Google-Smtp-Source: AGHT+IEq/wR5+VeC8A5+fxYk+p1J3dHwGgRcpRCuVIqTPzMyO+vneMFxBdM5MYtCfrduY0GmcBLkw8kc8I7DT8vj X-Received: from ericchancf.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:4139]) (user=ericchancf job=sendgmr) by 2002:a05:6902:138d:b0:e02:c84e:61a3 with SMTP id 3f1490d57ef6-e041b05317bmr12250276.6.1720631209022; Wed, 10 Jul 2024 10:06:49 -0700 (PDT) Date: Wed, 10 Jul 2024 17:06:43 +0000 In-Reply-To: <20240710170448.1399967-1-ericchancf@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20240710170448.1399967-1-ericchancf@google.com> X-Mailer: git-send-email 2.45.2.803.g4e1b14247a-goog Message-ID: <20240710170643.1401358-1-ericchancf@google.com> Subject: [PATCH 2/3] kunit: Rename KUNIT_ASSERT_FAILURE to KUNIT_ASSERT for readability From: Eric Chan To: brendan.higgins@linux.dev, davidgow@google.com, rmoar@google.com Cc: linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, ericchancf@google.com Both KUNIT_FAIL and KUNIT_ASSERT_FAILURE defined to KUNIT_FAIL_ASSERTION with different tpye of kunit_assert_type. The current naming of KUNIT_ASSERT_FAILURE and KUNIT_FAIL_ASSERTION is confusing due to their similarities. To improve readability and symmetry, renames KUNIT_ASSERT_FAILURE to KUNIT_ASSERT. Makes the naming consistent, with KUNIT_FAIL and KUNIT_ASSERT being symmetrical. Additionally, an explanation for KUNIT_ASSERT has been added to clarify its usage. Signed-off-by: Eric Chan --- drivers/input/tests/input_test.c | 2 +- include/kunit/assert.h | 2 +- include/kunit/test.h | 13 ++++++++++++- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/drivers/input/tests/input_test.c b/drivers/input/tests/input_test.c index 2fa5b725ae0a..cbab24a265fa 100644 --- a/drivers/input/tests/input_test.c +++ b/drivers/input/tests/input_test.c @@ -31,7 +31,7 @@ static int input_test_init(struct kunit *test) ret = input_register_device(input_dev); if (ret) { input_free_device(input_dev); - KUNIT_ASSERT_FAILURE(test, "Register device failed: %d", ret); + KUNIT_ASSERT(test, "Register device failed: %d", ret); } test->priv = input_dev; diff --git a/include/kunit/assert.h b/include/kunit/assert.h index 24c2b9fa61e8..02c6f7bb1d26 100644 --- a/include/kunit/assert.h +++ b/include/kunit/assert.h @@ -60,7 +60,7 @@ void kunit_assert_prologue(const struct kunit_loc *loc, * struct kunit_fail_assert - Represents a plain fail expectation/assertion. * @assert: The parent of this type. * - * Represents a simple KUNIT_FAIL/KUNIT_ASSERT_FAILURE that always fails. + * Represents a simple KUNIT_FAIL/KUNIT_ASSERT that always fails. */ struct kunit_fail_assert { struct kunit_assert assert; diff --git a/include/kunit/test.h b/include/kunit/test.h index 87a232421089..d1b085fd5dc3 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -1193,7 +1193,18 @@ do { \ fmt, \ ##__VA_ARGS__) -#define KUNIT_ASSERT_FAILURE(test, fmt, ...) \ +/** + * KUNIT_ASSERT() - Always causes a test to assert when evaluated. + * @test: The test context object. + * @fmt: an informational message to be printed when the assertion is made. + * @...: string format arguments. + * + * The opposite of KUNIT_SUCCEED(), it is an assertion that always fails. In + * other words, it always results in a failed assertion, and consequently + * always causes the test case to assert when evaluated. See KUNIT_ASSERT_TRUE() + * for more information. + */ +#define KUNIT_ASSERT(test, fmt, ...) \ KUNIT_FAIL_ASSERTION(test, KUNIT_ASSERTION, fmt, ##__VA_ARGS__) /** From patchwork Wed Jul 10 17:06:59 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Chan X-Patchwork-Id: 13729498 X-Patchwork-Delegate: brendanhiggins@google.com Received: from mail-yb1-f201.google.com (mail-yb1-f201.google.com [209.85.219.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 675B21953AB for ; Wed, 10 Jul 2024 17:07:06 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720631227; cv=none; b=AFcqNhjvDjkOmVEL9FDDvhiHeoCbzaLMLYLD9aiAlHHBPjNTEfC8pRAAwSuLOenBTsGsXHLXI+GFegbhqJhXUAyVjQkCa6+rF7NgnxYSAtXXsBT090jTFiMcDKYm0VjGCfn0Pn5Grngd/v25bXTav7u2VHn3YpCSHKqyGn8m+VI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1720631227; c=relaxed/simple; bh=i5uDpxJn8lGXZBfDUqgPSGzmiwpXROrGnB6v1/kDFNs=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=Cztc3ug+otj2Hd2zr7yyXtw7IxenVkW3XUgM7iHo1SWSEqRF79E3MZ9lO1FJdW0piZJTlGzs/Dd5Wv5ANBbI6t2wWIyC8T4WpsvwwtyAavQPrCHMeAdI/0Y89UWwySUoAWQhPXAFN+u2eHyFiYgHP4qqctCwyUDUr4sRLMMA3oQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--ericchancf.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=pe4Ux1HZ; arc=none smtp.client-ip=209.85.219.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--ericchancf.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="pe4Ux1HZ" Received: by mail-yb1-f201.google.com with SMTP id 3f1490d57ef6-e056166e0a6so1555477276.2 for ; Wed, 10 Jul 2024 10:07:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1720631225; x=1721236025; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=rdXM5tSTVLgVD6pOaOrVugKKH4Crf9pI4FNGQGLq9Pw=; b=pe4Ux1HZBQKM9wRYlkAlqdgeBXGgDTYdGez68NrR/dLcPmDA253Qb1juYj7wrXVIsd xymBVjO5Si1YGXLyDfYCbTzKnZUcK166TOnXze9WUO5SZ6EWi7v6WZ9gGkVM+UzQStD4 C0lzCblSgdGJnzglwKFoPRY2uVRbs/Ocg0FS5lB0pjWoJodszoC8/P1AtRQLxVsbKIa6 gOStv+b9m813ESurN7FpjGrVAYQGMOqyfkK+PITmAltG7MTYhKy0I1ymt4fTIeJLpYn5 C3KJtrvGd79mg90hlP2DsHUPSUgsiWkXgFDwECt72IupH5j+W8HHKJ8KZQqc/tMXfubV 3uTw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720631225; x=1721236025; h=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=rdXM5tSTVLgVD6pOaOrVugKKH4Crf9pI4FNGQGLq9Pw=; b=i64W/iH1Rk/BpBUvRZ44LMMgiexTTysl/V8Gag1HK9mlCHR2wOFHjPb4hmKIOQT0ZU o3wJnNyQifjJEvn3dJ7Dm2halKTkr1PQOwAvd1bDNTWwmR/AOvv9UkiIzjQaDZc5P8YS tfbARQevNcTOe8BO2nlmTlEnfNQPYdNhKQeEcHrDZ5PySZXlIG/gqYxpki6Z7Stj/GTw 96A0PLk+zfkgJfqKW7iUpXot//yRQNVKr238V+EYqwfEsAK1FhNtCd703aQcYrAmepM+ I7v2DHrdl9aojtX0opAr1s+A5uIuGm9i1qDr5+Wdg77a8MkNu7dkuCvo55j0NOnHRIMF p8eQ== X-Gm-Message-State: AOJu0YxoWAVk23HvD7aX/OajQ4m+2GoA7fGEW6t0XcnLah2NjfJQ/KxV UxtlSBRF7U7WBx2i8DlxtGabM5e9U2V948f52Uf1zeBcYxdth2z+6hvNwBrNHAQF2RxnVY1rch7 VmWgq588hCafkw+CsnQ== X-Google-Smtp-Source: AGHT+IGgxHOkY64Jyi/bUvq82+S3Z45vzDAUlZ7FDf3Cmd4kyTEHEwajQRskDY6gPPrkHYUSfcHrOOeL6zQ8nFfq X-Received: from ericchancf.c.googlers.com ([fda3:e722:ac3:cc00:4f:4b78:c0a8:4139]) (user=ericchancf job=sendgmr) by 2002:a05:6902:2b0d:b0:e03:3cfa:1aa9 with SMTP id 3f1490d57ef6-e041b1134afmr14166276.8.1720631225297; Wed, 10 Jul 2024 10:07:05 -0700 (PDT) Date: Wed, 10 Jul 2024 17:06:59 +0000 In-Reply-To: <20240710170448.1399967-1-ericchancf@google.com> Precedence: bulk X-Mailing-List: linux-kselftest@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20240710170448.1399967-1-ericchancf@google.com> X-Mailer: git-send-email 2.45.2.803.g4e1b14247a-goog Message-ID: <20240710170659.1402746-1-ericchancf@google.com> Subject: [PATCH 3/3] kunit: Introduce KUNIT_ASSERT_MEMEQ and KUNIT_ASSERT_MEMNEQ macros From: Eric Chan To: brendan.higgins@linux.dev, davidgow@google.com, rmoar@google.com Cc: linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org, ericchancf@google.com Introduces KUNIT_ASSERT_MEMEQ and KUNIT_ASSERT_MEMNEQ macros to provide assert-type equivalents for memory comparison. While KUNIT_EXPECT_MEMEQ and KUNIT_EXPECT_MEMNEQ are available for expectations, the addition of these new macros ensures that assertions can also be used for memory comparisons, enhancing the consistency and completeness of the kunit framework. Signed-off-by: Eric Chan Reviewed-by: David Gow --- include/kunit/test.h | 54 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/include/kunit/test.h b/include/kunit/test.h index d1b085fd5dc3..52bd50d2b150 100644 --- a/include/kunit/test.h +++ b/include/kunit/test.h @@ -1451,6 +1451,60 @@ do { \ fmt, \ ##__VA_ARGS__) +/** + * KUNIT_ASSERT_MEMEQ() - Asserts that the first @size bytes of @left and @right are equal. + * @test: The test context object. + * @left: An arbitrary expression that evaluates to the specified size. + * @right: An arbitrary expression that evaluates to the specified size. + * @size: Number of bytes compared. + * + * Sets an assertion that the values that @left and @right evaluate to are + * equal. This is semantically equivalent to + * KUNIT_ASSERT_TRUE(@test, !memcmp((@left), (@right), (@size))). See + * KUNIT_ASSERT_TRUE() for more information. + * + * Although this assertion works for any memory block, it is not recommended + * for comparing more structured data, such as structs. This assertion is + * recommended for comparing, for example, data arrays. + */ +#define KUNIT_ASSERT_MEMEQ(test, left, right, size) \ + KUNIT_ASSERT_MEMEQ_MSG(test, left, right, size, NULL) + +#define KUNIT_ASSERT_MEMEQ_MSG(test, left, right, size, fmt, ...) \ + KUNIT_MEM_ASSERTION(test, \ + KUNIT_ASSERTION, \ + left, ==, right, \ + size, \ + fmt, \ + ##__VA_ARGS__) + +/** + * KUNIT_ASSERT_MEMNEQ() - Asserts that the first @size bytes of @left and @right are not equal. + * @test: The test context object. + * @left: An arbitrary expression that evaluates to the specified size. + * @right: An arbitrary expression that evaluates to the specified size. + * @size: Number of bytes compared. + * + * Sets an assertion that the values that @left and @right evaluate to are + * not equal. This is semantically equivalent to + * KUNIT_ASSERT_TRUE(@test, memcmp((@left), (@right), (@size))). See + * KUNIT_ASSERT_TRUE() for more information. + * + * Although this assertion works for any memory block, it is not recommended + * for comparing more structured data, such as structs. This assertion is + * recommended for comparing, for example, data arrays. + */ +#define KUNIT_ASSERT_MEMNEQ(test, left, right, size) \ + KUNIT_ASSERT_MEMNEQ_MSG(test, left, right, size, NULL) + +#define KUNIT_ASSERT_MEMNEQ_MSG(test, left, right, size, fmt, ...) \ + KUNIT_MEM_ASSERTION(test, \ + KUNIT_ASSERTION, \ + left, !=, right, \ + size, \ + fmt, \ + ##__VA_ARGS__) + /** * KUNIT_ASSERT_NULL() - Asserts that pointers @ptr is null. * @test: The test context object.