Documentation/dev-tools/kunit/index.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 =========================================
   4 KUnit - Unit Testing for the Linux Kernel
   5 =========================================
   6
   7 .. toctree::
   8         :maxdepth: 2
   9
  10         start
  11         usage
  12         kunit-tool
  13         api/index
  14         faq
  15
  16 What is KUnit?
  17 ==============
  18
  19 KUnit is a lightweight unit testing and mocking framework for the Linux kernel.
  20 These tests are able to be run locally on a developer's workstation without a VM
  21 or special hardware.
  22
  23 KUnit is heavily inspired by JUnit, Python's unittest.mock, and
  24 Googletest/Googlemock for C++. KUnit provides facilities for defining unit test
  25 cases, grouping related test cases into test suites, providing common
  26 infrastructure for running tests, and much more.
  27
  28 Get started now: :doc:`start`
  29
  30 Why KUnit?
  31 ==========
  32
  33 A unit test is supposed to test a single unit of code in isolation, hence the
  34 name. A unit test should be the finest granularity of testing and as such should
  35 allow all possible code paths to be tested in the code under test; this is only
  36 possible if the code under test is very small and does not have any external
  37 dependencies outside of the test's control like hardware.
  38
  39 Outside of KUnit, there are no testing frameworks currently
  40 available for the kernel that do not require installing the kernel on a test
  41 machine or in a VM and all require tests to be written in userspace running on
  42 the kernel; this is true for Autotest, and kselftest, disqualifying
  43 any of them from being considered unit testing frameworks.
  44
  45 KUnit addresses the problem of being able to run tests without needing a virtual
  46 machine or actual hardware with User Mode Linux. User Mode Linux is a Linux
  47 architecture, like ARM or x86; however, unlike other architectures it compiles
  48 to a standalone program that can be run like any other program directly inside
  49 of a host operating system; to be clear, it does not require any virtualization
  50 support; it is just a regular program.
  51
  52 Alternatively, kunit and kunit tests can be built as modules and tests will
  53 run when the test module is loaded.
  54
  55 KUnit is fast. Excluding build time, from invocation to completion KUnit can run
  56 several dozen tests in only 10 to 20 seconds; this might not sound like a big
  57 deal to some people, but having such fast and easy to run tests fundamentally
  58 changes the way you go about testing and even writing code in the first place.
  59 Linus himself said in his `git talk at Google
  60 <https://gist.github.com/lorn/1272686/revisions#diff-53c65572127855f1b003db4064a94573R874>`_:
  61
  62         "... a lot of people seem to think that performance is about doing the
  63         same thing, just doing it faster, and that is not true. That is not what
  64         performance is all about. If you can do something really fast, really
  65         well, people will start using it differently."
  66
  67 In this context Linus was talking about branching and merging,
  68 but this point also applies to testing. If your tests are slow, unreliable, are
  69 difficult to write, and require a special setup or special hardware to run,
  70 then you wait a lot longer to write tests, and you wait a lot longer to run
  71 tests; this means that tests are likely to break, unlikely to test a lot of
  72 things, and are unlikely to be rerun once they pass. If your tests are really
  73 fast, you run them all the time, every time you make a change, and every time
  74 someone sends you some code. Why trust that someone ran all their tests
  75 correctly on every change when you can just run them yourself in less time than
  76 it takes to read their test log?
  77
  78 How do I use it?
  79 ================
  80
  81 *   :doc:`start` - for new users of KUnit
  82 *   :doc:`usage` - for a more detailed explanation of KUnit features
  83 *   :doc:`api/index` - for the list of KUnit APIs used for testing