include/kunit/test.h

97  * that makes expectations and assertions (see KUNIT_EXPECT_TRUE() and
195  * is used to lazily generate a series of arbitrarily typed values that fit into
231  * A kunit_suite is a collection of related &struct kunit_case s, such that
236  * Note that @exit and @suite_exit will run even if @init or @suite_init
297 	 * Because resources is a list that may be updated multiple times (with
390  * This functions similar to kunit_test_suites() except that it compiles the
394  * _probe; so that modpost suppresses warnings about referencing init data
426  * Note that some internal context data is also allocated with GFP_KERNEL,
439  * Note that some internal context data is also allocated with GFP_KERNEL,
574  * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other
619  * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In
673  * Unfortunately, there is no common type that all types can be promoted to for
675  * (for example, there is no type that long long and unsigned long long can
857  * Sets an expectation that @condition evaluates to false. See
871  * KUNIT_EXPECT_EQ() - Sets an expectation that @left and @right are equal.
873  * @left: an arbitrary expression that evaluates to a primitive C type.
874  * @right: an arbitrary expression that evaluates to a primitive C type.
876  * Sets an expectation that the values that @left and @right evaluate to are
892  * KUNIT_EXPECT_PTR_EQ() - Expects that pointers @left and @right are equal.
894  * @left: an arbitrary expression that evaluates to a pointer.
895  * @right: an arbitrary expression that evaluates to a pointer.
897  * Sets an expectation that the values that @left and @right evaluate to are
913  * KUNIT_EXPECT_NE() - An expectation that @left and @right are not equal.
915  * @left: an arbitrary expression that evaluates to a primitive C type.
916  * @right: an arbitrary expression that evaluates to a primitive C type.
918  * Sets an expectation that the values that @left and @right evaluate to are not
934  * KUNIT_EXPECT_PTR_NE() - Expects that pointers @left and @right are not equal.
936  * @left: an arbitrary expression that evaluates to a pointer.
937  * @right: an arbitrary expression that evaluates to a pointer.
939  * Sets an expectation that the values that @left and @right evaluate to are not
955  * KUNIT_EXPECT_LT() - An expectation that @left is less than @right.
957  * @left: an arbitrary expression that evaluates to a primitive C type.
958  * @right: an arbitrary expression that evaluates to a primitive C type.
960  * Sets an expectation that the value that @left evaluates to is less than the
961  * value that @right evaluates to. This is semantically equivalent to
976  * KUNIT_EXPECT_LE() - Expects that @left is less than or equal to @right.
978  * @left: an arbitrary expression that evaluates to a primitive C type.
979  * @right: an arbitrary expression that evaluates to a primitive C type.
981  * Sets an expectation that the value that @left evaluates to is less than or
982  * equal to the value that @right evaluates to. Semantically this is equivalent
997  * KUNIT_EXPECT_GT() - An expectation that @left is greater than @right.
999  * @left: an arbitrary expression that evaluates to a primitive C type.
1000  * @right: an arbitrary expression that evaluates to a primitive C type.
1002  * Sets an expectation that the value that @left evaluates to is greater than
1003  * the value that @right evaluates to. This is semantically equivalent to
1018  * KUNIT_EXPECT_GE() - Expects that @left is greater than or equal to @right.
1020  * @left: an arbitrary expression that evaluates to a primitive C type.
1021  * @right: an arbitrary expression that evaluates to a primitive C type.
1023  * Sets an expectation that the value that @left evaluates to is greater than
1024  * the value that @right evaluates to. This is semantically equivalent to
1039  * KUNIT_EXPECT_STREQ() - Expects that strings @left and @right are equal.
1041  * @left: an arbitrary expression that evaluates to a null terminated string.
1042  * @right: an arbitrary expression that evaluates to a null terminated string.
1044  * Sets an expectation that the values that @left and @right evaluate to are
1060  * KUNIT_EXPECT_STRNEQ() - Expects that strings @left and @right are not equal.
1062  * @left: an arbitrary expression that evaluates to a null terminated string.
1063  * @right: an arbitrary expression that evaluates to a null terminated string.
1065  * Sets an expectation that the values that @left and @right evaluate to are
1081  * KUNIT_EXPECT_MEMEQ() - Expects that the first @size bytes of @left and @right are equal.
1083  * @left: An arbitrary expression that evaluates to the specified size.
1084  * @right: An arbitrary expression that evaluates to the specified size.
1087  * Sets an expectation that the values that @left and @right evaluate to are
1108  * KUNIT_EXPECT_MEMNEQ() - Expects that the first @size bytes of @left and @right are not equal.
1110  * @left: An arbitrary expression that evaluates to the specified size.
1111  * @right: An arbitrary expression that evaluates to the specified size.
1114  * Sets an expectation that the values that @left and @right evaluate to are
1135  * KUNIT_EXPECT_NULL() - Expects that @ptr is null.
1139  * Sets an expectation that the value that @ptr evaluates to is null. This is
1156  * KUNIT_EXPECT_NOT_NULL() - Expects that @ptr is not null.
1160  * Sets an expectation that the value that @ptr evaluates to is not null. This
1177  * KUNIT_EXPECT_NOT_ERR_OR_NULL() - Expects that @ptr is not null and not err.
1181  * Sets an expectation that the value that @ptr evaluates to is not null and not
1200  * KUNIT_ASSERT_TRUE() - Sets an assertion that @condition is true.
1221  * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false.
1225  * Sets an assertion that the value that @condition evaluates to is false. This
1240  * KUNIT_ASSERT_EQ() - Sets an assertion that @left and @right are equal.
1242  * @left: an arbitrary expression that evaluates to a primitive C type.
1243  * @right: an arbitrary expression that evaluates to a primitive C type.
1245  * Sets an assertion that the values that @left and @right evaluate to are
1260  * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
1262  * @left: an arbitrary expression that evaluates to a pointer.
1263  * @right: an arbitrary expression that evaluates to a pointer.
1265  * Sets an assertion that the values that @left and @right evaluate to are
1280  * KUNIT_ASSERT_NE() - An assertion that @left and @right are not equal.
1282  * @left: an arbitrary expression that evaluates to a primitive C type.
1283  * @right: an arbitrary expression that evaluates to a primitive C type.
1285  * Sets an assertion that the values that @left and @right evaluate to are not
1300  * KUNIT_ASSERT_PTR_NE() - Asserts that pointers @left and @right are not equal.
1301  * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
1303  * @left: an arbitrary expression that evaluates to a pointer.
1304  * @right: an arbitrary expression that evaluates to a pointer.
1306  * Sets an assertion that the values that @left and @right evaluate to are not
1320  * KUNIT_ASSERT_LT() - An assertion that @left is less than @right.
1322  * @left: an arbitrary expression that evaluates to a primitive C type.
1323  * @right: an arbitrary expression that evaluates to a primitive C type.
1325  * Sets an assertion that the value that @left evaluates to is less than the
1326  * value that @right evaluates to. This is the same as KUNIT_EXPECT_LT(), except
1340  * KUNIT_ASSERT_LE() - An assertion that @left is less than or equal to @right.
1342  * @left: an arbitrary expression that evaluates to a primitive C type.
1343  * @right: an arbitrary expression that evaluates to a primitive C type.
1345  * Sets an assertion that the value that @left evaluates to is less than or
1346  * equal to the value that @right evaluates to. This is the same as
1361  * KUNIT_ASSERT_GT() - An assertion that @left is greater than @right.
1363  * @left: an arbitrary expression that evaluates to a primitive C type.
1364  * @right: an arbitrary expression that evaluates to a primitive C type.
1366  * Sets an assertion that the value that @left evaluates to is greater than the
1367  * value that @right evaluates to. This is the same as KUNIT_EXPECT_GT(), except
1382  * KUNIT_ASSERT_GE() - Assertion that @left is greater than or equal to @right.
1384  * @left: an arbitrary expression that evaluates to a primitive C type.
1385  * @right: an arbitrary expression that evaluates to a primitive C type.
1387  * Sets an assertion that the value that @left evaluates to is greater than the
1388  * value that @right evaluates to. This is the same as KUNIT_EXPECT_GE(), except
1403  * KUNIT_ASSERT_STREQ() - An assertion that strings @left and @right are equal.
1405  * @left: an arbitrary expression that evaluates to a null terminated string.
1406  * @right: an arbitrary expression that evaluates to a null terminated string.
1408  * Sets an assertion that the values that @left and @right evaluate to are
1423  * KUNIT_ASSERT_STRNEQ() - Expects that strings @left and @right are not equal.
1425  * @left: an arbitrary expression that evaluates to a null terminated string.
1426  * @right: an arbitrary expression that evaluates to a null terminated string.
1428  * Sets an expectation that the values that @left and @right evaluate to are
1444  * KUNIT_ASSERT_NULL() - Asserts that pointers @ptr is null.
1448  * Sets an assertion that the values that @ptr evaluates to is null. This is
1465  * KUNIT_ASSERT_NOT_NULL() - Asserts that pointers @ptr is not null.
1469  * Sets an assertion that the values that @ptr evaluates to is not null. This
1486  * KUNIT_ASSERT_NOT_ERR_OR_NULL() - Assertion that @ptr is not null and not err.
1490  * Sets an assertion that the value that @ptr evaluates to is not null and not