From patchwork Thu Apr 4 22:06:35 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Brendan Higgins X-Patchwork-Id: 1077765 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=lists.infradead.org (client-ip=2607:7c80:54:e::133; helo=bombadil.infradead.org; envelope-from=linux-um-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org; receiver=) Authentication-Results: ozlabs.org; dmarc=fail (p=reject dis=none) header.from=google.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=lists.infradead.org header.i=@lists.infradead.org header.b="qCVa1qqz"; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="BOYdV3QL"; dkim-atps=neutral Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 44Zxvr5fDMz9sPw for ; Fri, 5 Apr 2019 09:10:15 +1100 (AEDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:To:From:Subject:Mime-Version:Message-Id :Date:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References: List-Owner; bh=kQrT/p58ZR/I2JpUB7e1QKfuoopX48qBBPQWybdlUYo=; b=qCVa1qqzad5EXV zKLMd7cotAL7jzNAiRMu2wul7x0Vn2C7GmY69c7idRz/36uDdbKujXOtGVybr7meHsFRD9vajK2Ul qhNoaLx5ZwSMNpHJFhAGmaiBzglwkTwf8HtsoFvvnta96M01R3SsJtrhMY/kF3mBaTZbwsL6+PYjx GbYWeBkoz32nd0SDhn5e29vnhL6GFWUhmGq/61iifTqndyUlXG94dLP1QomsSc5rRv8KWxw7z0yMP f/7trQHkc7igmAYvBhF9J9Y2cBIOUaY+HoIkGAx4SBWdCbgWalklFEIAAemGPpbw521kFW5Secnhl ROmmIg+TKDPMCKlM/jhg==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1hCAYg-0007ym-BF; Thu, 04 Apr 2019 22:10:06 +0000 Received: from mail-qk1-x749.google.com ([2607:f8b0:4864:20::749]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1hCAYd-0007Mz-S5 for linux-um@lists.infradead.org; Thu, 04 Apr 2019 22:10:05 +0000 Received: by mail-qk1-x749.google.com with SMTP id i124so3438026qkf.14 for ; Thu, 04 Apr 2019 15:10:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:message-id:mime-version:subject:from:to:cc; bh=HMuZC7YhYbbRbZR+3/mPo9a63tVIDjyvayAQ1BEezrw=; b=BOYdV3QLi21QjMDlnUKvGYABbEqanEJfcJeRsukkvZphSbuvalPGxmKl1ZwesWtGNJ TTJ8+3NFmHoU5SmVWtyZMkKu8Nyw/t+NSbDeEz3hnSewQabz9l0TOlahbUKG4mlWW+y7 E+UlRE3Dq9q0QgfZUw/dKPJIhCHc9qqFXPORwlb5KXQFkfpJrRmbLHnuf/2qz+1balrw W0KW7J/Co45M5GP60Z0dSf/SmsF0HJ5koZpxV+84qyBA97hNSw7rj5R/U+3z8Hv1l8hg uCfoyppCCi5h6KNouM/iEP8dlt2A3kMeawzxIGJ44E7EDJ0rNCnaqZhklLOMyyF1HyPk fMUA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:message-id:mime-version:subject:from:to:cc; bh=HMuZC7YhYbbRbZR+3/mPo9a63tVIDjyvayAQ1BEezrw=; b=GG1xDn9a5nOGa1JAdRizZ5JIScEwRwG6smYNLRB5Wwp//izhcoZ2U36ZwjCZyEleIh rYTTMURvBV6RlAHitsyXwkKgB7FS9Ylt7pp2q6ge7hznHowC+6JuBobM5tTYf9E2iWTQ ax8UGzUDoIbbn93R7xYgO417b+LTlOt9f4cHiXQY8/vl4+hrRzF5TKK7pCk6NlLGPQyS BKFyHaRG4APLa6KgajCW4Yi4+gV+xgpM6ddI7eD++1YtoUKl4MI9oyRBk1IHevFw8YzQ o2XlROu9I4LlpBAkvZpofCGAHouXNit8aM+wTdxnV7n+4Nw6W12wT6GxsZZ/5jnFKw34 kPQA== X-Gm-Message-State: APjAAAWJFRFvrg33vYxF9O0SMu24WYXexXMUPauolZO+WpwXpmp20uMS BWimU4TQ5zrN8z2MYqeXTf1CUmWJ6UGTC06063RK2A== X-Google-Smtp-Source: APXvYqy2ky80xlMwOpOXMGTjrYk0Q3P0Z4woKg+c4LxenDRGrU/tuDoXYQsQZWjvMUl2LUV6LFTdSDNe8kgS8hF9kpSiLg== X-Received: by 2002:a0c:ea90:: with SMTP id d16mr1127285qvp.27.1554415802221; Thu, 04 Apr 2019 15:10:02 -0700 (PDT) Date: Thu, 4 Apr 2019 15:06:35 -0700 Message-Id: <20190404220652.19765-1-brendanhiggins@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.21.0.392.gf8f6787159e-goog Subject: [PATCH v1 00/17] kunit: introduce KUnit, the Linux kernel unit testing framework From: Brendan Higgins To: corbet@lwn.net, frowand.list@gmail.com, keescook@google.com, kieran.bingham@ideasonboard.com, mcgrof@kernel.org, robh@kernel.org, shuah@kernel.org, yamada.masahiro@socionext.com X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190404_151003_947032_89F1FA47 X-CRM114-Status: GOOD ( 14.54 ) X-Spam-Score: -7.7 (-------) X-Spam-Report: SpamAssassin version 3.4.2 on bombadil.infradead.org summary: Content analysis details: (-7.7 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2607:f8b0:4864:20:0:0:0:749 listed in] [list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record -7.5 USER_IN_DEF_DKIM_WL From: address is in the default DKIM white-list 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature -0.1 DKIM_VALID_EF Message has a valid DKIM or DK signature from envelope-from domain -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.0 DKIMWL_WL_MED DKIMwl.org - Medium sender X-BeenThere: linux-um@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: pmladek@suse.com, linux-doc@vger.kernel.org, amir73il@gmail.com, Brendan Higgins , dri-devel@lists.freedesktop.org, Alexander.Levin@microsoft.com, linux-kselftest@vger.kernel.org, linux-nvdimm@lists.01.org, khilman@baylibre.com, knut.omang@oracle.com, wfg@linux.intel.com, joel@jms.id.au, jdike@addtoit.com, dan.carpenter@oracle.com, devicetree@vger.kernel.org, linux-kbuild@vger.kernel.org, Tim.Bird@sony.com, linux-um@lists.infradead.org, rostedt@goodmis.org, julia.lawall@lip6.fr, dan.j.williams@intel.com, kunit-dev@googlegroups.com, richard@nod.at, gregkh@linuxfoundation.org, linux-kernel@vger.kernel.org, daniel@ffwll.ch, mpe@ellerman.id.au, linux-fsdevel@vger.kernel.org Sender: "linux-um" Errors-To: linux-um-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org This patch set proposes KUnit, a lightweight unit testing and mocking framework for the Linux kernel. Unlike Autotest and kselftest, KUnit is a true unit testing framework; it does not require installing the kernel on a test machine or in a VM and does not require tests to be written in userspace running on a host kernel. Additionally, KUnit is fast: From invocation to completion KUnit can run several dozen tests in under a second. Currently, the entire KUnit test suite for KUnit runs in under a second from the initial invocation (build time excluded). KUnit is heavily inspired by JUnit, Python's unittest.mock, and Googletest/Googlemock for C++. KUnit provides facilities for defining unit test cases, grouping related test cases into test suites, providing common infrastructure for running tests, mocking, spying, and much more. ## What's so special about unit testing? A unit test is supposed to test a single unit of code in isolation, hence the name. There should be no dependencies outside the control of the test; this means no external dependencies, which makes tests orders of magnitudes faster. Likewise, since there are no external dependencies, there are no hoops to jump through to run the tests. Additionally, this makes unit tests deterministic: a failing unit test always indicates a problem. Finally, because unit tests necessarily have finer granularity, they are able to test all code paths easily solving the classic problem of difficulty in exercising error handling code. ## Is KUnit trying to replace other testing frameworks for the kernel? No. Most existing tests for the Linux kernel are end-to-end tests, which have their place. A well tested system has lots of unit tests, a reasonable number of integration tests, and some end-to-end tests. KUnit is just trying to address the unit test space which is currently not being addressed. ## More information on KUnit There is a bunch of documentation near the end of this patch set that describes how to use KUnit and best practices for writing unit tests. For convenience I am hosting the compiled docs here: https://google.github.io/kunit-docs/third_party/kernel/docs/ Additionally for convenience, I have applied these patches to a branch: https://kunit.googlesource.com/linux/+/kunit/rfc/v5.1-rc2/v1 The repo may be cloned with: git clone https://kunit.googlesource.com/linux This patchset is on the kunit/rfc/v5.1-rc2/v1 branch. ## Changes Since Last Version Last version was RFC v4. It seemed we were pretty much done with the RFC phase, so I started the numbering over again. Sorry if anyone finds that confusing. - Reduced usage of object oriented style of member functions as suggested by Frank. - Did a bunch of heavy clean up of the kunit_abort stuff as suggested by Frank and Stephen: - Biggest change was to reduce the usage of direct calls of member functions. - Added a better explanation of what abort is for and further explained the rationale for KUNIT_ASSERT_* vs. KUNIT_EXPECT_* - Dropped BUG() usage - Also moved try_catch interface to a new file since it seemed obscured by being mixed in with the code that used it. - Fixed some other minor issues pointed out by Stephen. - Updated email address of one of the contributors. - Dropped DT unittest port since it seemed like there was a lot more discussion to be had: it wasn't ready to leave the RFC phase. Instead, I added a KUnit test written by Iurii for PROC SYSCTL that was requested by Luis some time ago. For reference, RFC v4 can be found here: https://lkml.org/lkml/2019/2/14/1144