// SPDX-License-Identifier: GPL-2.0/* * Example KUnit test to show how to use KUnit. * * Copyright (C) 2019, Google LLC. * Author: Brendan Higgins <brendanhiggins@google.com> */ #include <kunit/test.h> /* * This is the most fundamental element of KUnit, the test case. A test case * makes a set EXPECTATIONs and ASSERTIONs about the behavior of some code; if * any expectations or assertions are not met, the test fails; otherwise, the * test passes. * * In KUnit, a test case is just a function with the signature * `void (*)(struct kunit *)`. `struct kunit` is a context object that stores * information about the current test. */static void example_simple_test(struct kunit *test){	/*	 * This is an EXPECTATION; it is how KUnit tests things. When you want	 * to test a piece of code, you set some expectations about what the	 * code should do. KUnit then runs the test and verifies that the code's	 * behavior matched what was expected.	 */	KUNIT_EXPECT_EQ(test, 1 + 1, 2);} /* * This is run once before each test case, see the comment on * example_test_suite for more information. */static int example_test_init(struct kunit *test){	kunit_info(test, "initializing\n"); 	return 0;} /* * Here we make a list of all the test cases we want to add to the test suite * below. */static struct kunit_case example_test_cases[] = {	/*	 * This is a helper to create a test case object from a test case	 * function; its exact function is not important to understand how to	 * use KUnit, just know that this is how you associate test cases with a	 * test suite.	 */	KUNIT_CASE(example_simple_test),	{}}; /* * This defines a suite or grouping of tests. * * Test cases are defined as belonging to the suite by adding them to * `kunit_cases`. * * Often it is desirable to run some function which will set up things which * will be used by every test; this is accomplished with an `init` function * which runs before each test case is invoked. Similarly, an `exit` function * may be specified which runs after every test case and can be used to for * cleanup. For clarity, running tests in a test suite would behave as follows: * * suite.init(test); * suite.test_case[0](test); * suite.exit(test); * suite.init(test); * suite.test_case[1](test); * suite.exit(test); * ...; */static struct kunit_suite example_test_suite = {	.name = "example",	.init = example_test_init,	.test_cases = example_test_cases,}; /* * This registers the above test suite telling KUnit that this is a suite of * tests that need to be run. */kunit_test_suites(&example_test_suite); MODULE_LICENSE("GPL v2");