From patchwork Tue May 14 22:16:53 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Brendan Higgins X-Patchwork-Id: 1099785 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="hn4cyLpj"; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="Q5HMOrwb"; 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 453XB83vw6z9s4V for ; Wed, 15 May 2019 08:17:52 +1000 (AEST) 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=zshvS/W5gUkiH074g9B/qL3IJlJ9Xl9s0DujCMGA+HU=; b=hn4cyLpj5Lz1zo FSAezU2mkk7VAaF7wNf3Ml9YNAVkuH6PWz+1YwVOHba9E88mE0LQcmsc2Wzag72XQHSG5pQfNitky qWQGBPlzckiiGEmBEftm4/CT0D/aLpevaI9ffwlzIe7Mb4Wcq/3buQFMxc8U4wGgLyyDqsiswcIXn yUmKbsCmjsc7P9ZgpnhgrdBlRHVVMqkhjPLrqX7B1TewkGivfxXzYbudQE5OVhEH6zGbPfTXyZiuI MJrNznjHCkuOUePxQf7pPTjKbl8eO3zTeU0WDL7qFzegSkxCd2OV9oI0L1eIykQpXU24OhoDXL/Ij vKJqmbTSmI+9RQS+qdKQ==; 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 1hQfk0-0000dm-Cj; Tue, 14 May 2019 22:17:44 +0000 Received: from mail-yw1-xc49.google.com ([2607:f8b0:4864:20::c49]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1hQfjx-0000dH-Bd for linux-um@lists.infradead.org; Tue, 14 May 2019 22:17:43 +0000 Received: by mail-yw1-xc49.google.com with SMTP id j62so712680ywe.3 for ; Tue, 14 May 2019 15:17:40 -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=Wtv/g4YDlWnregZkMuB6vGhT6mZK0s7Z+NfaxgtLekE=; b=Q5HMOrwbJNM89YqHu+vD+8sRwSzKie4sE8pkjwQqXKbmvl8uUCrm4SpuFW4UU8JhnY XeejyhCTCS9puS98uTFx8EFmIo2ivhwCloJ/U0p1hceMXJW+JMLxh7E0E2tQeOq2UuzA uZxI0Ym2j+bs+4rerFEZdMmaFjvrOGk6StJ+TQn+bqsoaYxZ80ISDElTpKf5y0SFPk8h VcJ7yADl/NR3VI+Ila1czReqJ0pnzAfR3bA5HRbf56qnKlhiN8U8YpErBnLxR7gClHqR Qbxvzr+zfsgs5Z9UI/MeioiOkmyTPiLUIyzAE8HdShxJSC99+danDDMnvJhADTYyrN5z MBUg== 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=Wtv/g4YDlWnregZkMuB6vGhT6mZK0s7Z+NfaxgtLekE=; b=RPPD+u6ct4DZP7VTtSRKl+hvwm7nom61q9FFGF0E6BrfgKyggtvaPwKCVETpWPQfBi lCEsGmDwLjLj12Ijrr4yOgf/DvkrP16MLJBkZSZ+c4FnRmRx3lxRZcYNgqkIQoLKEBe/ dtBOJdTo9QepdyQsA5pJwdyYS1GMSwxqmKW/7wNWt1cVzTOizeZKNktHRjQu+bj2XNec TvO091Wih81z/zCE8Chkx3meHZ2MDsuMM4l9tywJFqvmTZIpdnGEQ/gIjWP58VVMksXN eGW9kO3OzDjtDItNIwE5INR6h3Fvh1hr/4nDfNtaAJrkQcbcvM3oHgDJep2IXO4MSy9/ funQ== X-Gm-Message-State: APjAAAWIjTO2v/mPYHh5Ayt0IcWn/mdihShTPRKw0D1p2jH5IkN8bk64 i1o6IEYNUiSFNzWZyvwdyHMKOlHhUuEiT7v9HQrvaQ== X-Google-Smtp-Source: APXvYqzLw2GNR1CD/N7FU0EOf+vQnR8bF44lpYMHhbVCeioD/fNqnQCXEG9eHOkDZWuQz7kMqOBLBdCDFgs1RbGB1Bb/ig== X-Received: by 2002:a25:690d:: with SMTP id e13mr18821319ybc.178.1557872259260; Tue, 14 May 2019 15:17:39 -0700 (PDT) Date: Tue, 14 May 2019 15:16:53 -0700 Message-Id: <20190514221711.248228-1-brendanhiggins@google.com> Mime-Version: 1.0 X-Mailer: git-send-email 2.21.0.1020.gf2820cf01a-goog Subject: [PATCH v4 00/18] kunit: introduce KUnit, the Linux kernel unit testing framework From: Brendan Higgins To: frowand.list@gmail.com, gregkh@linuxfoundation.org, jpoimboe@redhat.com, keescook@google.com, kieran.bingham@ideasonboard.com, mcgrof@kernel.org, peterz@infradead.org, robh@kernel.org, sboyd@kernel.org, shuah@kernel.org, tytso@mit.edu, yamada.masahiro@socionext.com X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20190514_151741_427518_95D76D23 X-CRM114-Status: GOOD ( 14.35 ) 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:c49 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_AU Message has a valid DKIM or DK signature from author's domain -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.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, rientjes@google.com, 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, kunit-dev@googlegroups.com, richard@nod.at, rdunlap@infradead.org, linux-kernel@vger.kernel.org, daniel@ffwll.ch, mpe@ellerman.id.au, linux-fsdevel@vger.kernel.org, logang@deltatee.com Sender: "linux-um" Errors-To: linux-um-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org ## TLDR A quick follow up to yesterday's revision. I got some feedback that I wanted to incorporate before anyone else read the update. For this reason, I will leave a TLDR of the biggest changes since v2. Biggest things to look out for (since v2): - KUnit core now outputs results in TAP14. - Heavily reworked tools/testing/kunit/kunit.py - Changed how parsing works. - Added testing. - Greg, Logan, you might want to re-review this. - Added documentation on how to use KUnit on non-UML kernels. You can see the docs rendered here[1]. There is still some discussion going on on the [PATCH v2 00/17] thread, but I wanted to get some of these updates out before they got too stale (and too difficult for me to keep track of). I hope no one minds. ## Background 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 (however, KUnit still allows you to run tests on test machines or in VMs if you want) 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[2]. Additionally for convenience, I have applied these patches to a branch[3]. The repo may be cloned with: git clone https://kunit.googlesource.com/linux This patchset is on the kunit/rfc/v5.1/v4 branch. ## Changes Since Last Version As I mentioned above, there are a significant number of updates since v2: - Converted KUnit core to print test results in TAP14 format as suggested by Greg and Frank. - Heavily reworked tools/testing/kunit/kunit.py - Changed how parsing works. - Added testing. - Added documentation on how to use KUnit on non-UML kernels. You can see the docs rendered here[1]. - Added a new set of EXPECTs and ASSERTs for pointer comparison. - Removed more function indirection as suggested by Logan. - Added a new patch that adds `kunit_try_catch_throw` to objtool's noreturn list. - Fixed a number of minorish issues pointed out by Shuah, Masahiro, and kbuild bot. Nevertheless, there are only a couple of minor updates since v3: - Added more context to the changelog on the objtool patch, as per Peter's request. - Moved all KUnit documentation under the Documentation/dev-tools/ directory as per Jonathan's suggestion. [1] https://google.github.io/kunit-docs/third_party/kernel/docs/usage.html#kunit-on-non-uml-architectures [2] https://google.github.io/kunit-docs/third_party/kernel/docs/ [3] https://kunit.googlesource.com/linux/+/kunit/rfc/v5.1/v4