include/kunit/test.h

98  * that makes expectations and assertions (see KUNIT_EXPECT_TRUE() and
196  * is used to lazily generate a series of arbitrarily typed values that fit into
232  * A kunit_suite is a collection of related &struct kunit_case s, such that
237  * Note that @exit and @suite_exit will run even if @init or @suite_init
298 	 * Because resources is a list that may be updated multiple times (with
393  * This functions similar to kunit_test_suites() except that it compiles the
397  * _probe; so that modpost suppresses warnings about referencing init data
429  * Note that some internal context data is also allocated with GFP_KERNEL,
442  * Note that some internal context data is also allocated with GFP_KERNEL,
651  * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other
698  * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In
753  * Unfortunately, there is no common type that all types can be promoted to for
755  * (for example, there is no type that long long and unsigned long long can
941  * Sets an expectation that @condition evaluates to false. See
955  * KUNIT_EXPECT_EQ() - Sets an expectation that @left and @right are equal.
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 values that @left and @right evaluate to are
976  * KUNIT_EXPECT_PTR_EQ() - Expects that pointers @left and @right are equal.
978  * @left: an arbitrary expression that evaluates to a pointer.
979  * @right: an arbitrary expression that evaluates to a pointer.
981  * Sets an expectation that the values that @left and @right evaluate to are
997  * KUNIT_EXPECT_NE() - An expectation that @left and @right are not equal.
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 values that @left and @right evaluate to are not
1018  * KUNIT_EXPECT_PTR_NE() - Expects that pointers @left and @right are not equal.
1020  * @left: an arbitrary expression that evaluates to a pointer.
1021  * @right: an arbitrary expression that evaluates to a pointer.
1023  * Sets an expectation that the values that @left and @right evaluate to are not
1039  * KUNIT_EXPECT_LT() - An expectation that @left is less than @right.
1041  * @left: an arbitrary expression that evaluates to a primitive C type.
1042  * @right: an arbitrary expression that evaluates to a primitive C type.
1044  * Sets an expectation that the value that @left evaluates to is less than the
1045  * value that @right evaluates to. This is semantically equivalent to
1060  * KUNIT_EXPECT_LE() - Expects that @left is less than or equal to @right.
1062  * @left: an arbitrary expression that evaluates to a primitive C type.
1063  * @right: an arbitrary expression that evaluates to a primitive C type.
1065  * Sets an expectation that the value that @left evaluates to is less than or
1066  * equal to the value that @right evaluates to. Semantically this is equivalent
1081  * KUNIT_EXPECT_GT() - An expectation that @left is greater than @right.
1083  * @left: an arbitrary expression that evaluates to a primitive C type.
1084  * @right: an arbitrary expression that evaluates to a primitive C type.
1086  * Sets an expectation that the value that @left evaluates to is greater than
1087  * the value that @right evaluates to. This is semantically equivalent to
1102  * KUNIT_EXPECT_GE() - Expects that @left is greater than or equal to @right.
1104  * @left: an arbitrary expression that evaluates to a primitive C type.
1105  * @right: an arbitrary expression that evaluates to a primitive C type.
1107  * Sets an expectation that the value that @left evaluates to is greater than
1108  * the value that @right evaluates to. This is semantically equivalent to
1123  * KUNIT_EXPECT_STREQ() - Expects that strings @left and @right are equal.
1125  * @left: an arbitrary expression that evaluates to a null terminated string.
1126  * @right: an arbitrary expression that evaluates to a null terminated string.
1128  * Sets an expectation that the values that @left and @right evaluate to are
1144  * KUNIT_EXPECT_STRNEQ() - Expects that strings @left and @right are not equal.
1146  * @left: an arbitrary expression that evaluates to a null terminated string.
1147  * @right: an arbitrary expression that evaluates to a null terminated string.
1149  * Sets an expectation that the values that @left and @right evaluate to are
1165  * KUNIT_EXPECT_MEMEQ() - Expects that the first @size bytes of @left and @right are equal.
1167  * @left: An arbitrary expression that evaluates to the specified size.
1168  * @right: An arbitrary expression that evaluates to the specified size.
1171  * Sets an expectation that the values that @left and @right evaluate to are
1192  * KUNIT_EXPECT_MEMNEQ() - Expects that the first @size bytes of @left and @right are not equal.
1194  * @left: An arbitrary expression that evaluates to the specified size.
1195  * @right: An arbitrary expression that evaluates to the specified size.
1198  * Sets an expectation that the values that @left and @right evaluate to are
1219  * KUNIT_EXPECT_NULL() - Expects that @ptr is null.
1223  * Sets an expectation that the value that @ptr evaluates to is null. This is
1240  * KUNIT_EXPECT_NOT_NULL() - Expects that @ptr is not null.
1244  * Sets an expectation that the value that @ptr evaluates to is not null. This
1261  * KUNIT_EXPECT_NOT_ERR_OR_NULL() - Expects that @ptr is not null and not err.
1265  * Sets an expectation that the value that @ptr evaluates to is not null and not
1286  * The opposite of KUNIT_SUCCEED(), it is an assertion that always fails. In
1295  * KUNIT_ASSERT_TRUE() - Sets an assertion that @condition is true.
1316  * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false.
1320  * Sets an assertion that the value that @condition evaluates to is false. This
1335  * KUNIT_ASSERT_EQ() - Sets an assertion that @left and @right are equal.
1337  * @left: an arbitrary expression that evaluates to a primitive C type.
1338  * @right: an arbitrary expression that evaluates to a primitive C type.
1340  * Sets an assertion that the values that @left and @right evaluate to are
1355  * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
1357  * @left: an arbitrary expression that evaluates to a pointer.
1358  * @right: an arbitrary expression that evaluates to a pointer.
1360  * Sets an assertion that the values that @left and @right evaluate to are
1375  * KUNIT_ASSERT_NE() - An assertion that @left and @right are not equal.
1377  * @left: an arbitrary expression that evaluates to a primitive C type.
1378  * @right: an arbitrary expression that evaluates to a primitive C type.
1380  * Sets an assertion that the values that @left and @right evaluate to are not
1395  * KUNIT_ASSERT_PTR_NE() - Asserts that pointers @left and @right are not equal.
1396  * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
1398  * @left: an arbitrary expression that evaluates to a pointer.
1399  * @right: an arbitrary expression that evaluates to a pointer.
1401  * Sets an assertion that the values that @left and @right evaluate to are not
1415  * KUNIT_ASSERT_LT() - An assertion that @left is less than @right.
1417  * @left: an arbitrary expression that evaluates to a primitive C type.
1418  * @right: an arbitrary expression that evaluates to a primitive C type.
1420  * Sets an assertion that the value that @left evaluates to is less than the
1421  * value that @right evaluates to. This is the same as KUNIT_EXPECT_LT(), except
1435  * KUNIT_ASSERT_LE() - An assertion that @left is less than or equal to @right.
1437  * @left: an arbitrary expression that evaluates to a primitive C type.
1438  * @right: an arbitrary expression that evaluates to a primitive C type.
1440  * Sets an assertion that the value that @left evaluates to is less than or
1441  * equal to the value that @right evaluates to. This is the same as
1456  * KUNIT_ASSERT_GT() - An assertion that @left is greater than @right.
1458  * @left: an arbitrary expression that evaluates to a primitive C type.
1459  * @right: an arbitrary expression that evaluates to a primitive C type.
1461  * Sets an assertion that the value that @left evaluates to is greater than the
1462  * value that @right evaluates to. This is the same as KUNIT_EXPECT_GT(), except
1477  * KUNIT_ASSERT_GE() - Assertion that @left is greater than or equal to @right.
1479  * @left: an arbitrary expression that evaluates to a primitive C type.
1480  * @right: an arbitrary expression that evaluates to a primitive C type.
1482  * Sets an assertion that the value that @left evaluates to is greater than the
1483  * value that @right evaluates to. This is the same as KUNIT_EXPECT_GE(), except
1498  * KUNIT_ASSERT_STREQ() - An assertion that strings @left and @right are equal.
1500  * @left: an arbitrary expression that evaluates to a null terminated string.
1501  * @right: an arbitrary expression that evaluates to a null terminated string.
1503  * Sets an assertion that the values that @left and @right evaluate to are
1518  * KUNIT_ASSERT_STRNEQ() - An assertion that strings @left and @right are not equal.
1520  * @left: an arbitrary expression that evaluates to a null terminated string.
1521  * @right: an arbitrary expression that evaluates to a null terminated string.
1523  * Sets an assertion that the values that @left and @right evaluate to are
1539  * KUNIT_ASSERT_MEMEQ() - Asserts that the first @size bytes of @left and @right are equal.
1541  * @left: An arbitrary expression that evaluates to the specified size.
1542  * @right: An arbitrary expression that evaluates to the specified size.
1545  * Sets an assertion that the values that @left and @right evaluate to are
1566  * KUNIT_ASSERT_MEMNEQ() - Asserts that the first @size bytes of @left and @right are not equal.
1568  * @left: An arbitrary expression that evaluates to the specified size.
1569  * @right: An arbitrary expression that evaluates to the specified size.
1572  * Sets an assertion that the values that @left and @right evaluate to are
1593  * KUNIT_ASSERT_NULL() - Asserts that pointers @ptr is null.
1597  * Sets an assertion that the values that @ptr evaluates to is null. This is
1614  * KUNIT_ASSERT_NOT_NULL() - Asserts that pointers @ptr is not null.
1618  * Sets an assertion that the values that @ptr evaluates to is not null. This
1635  * KUNIT_ASSERT_NOT_ERR_OR_NULL() - Assertion that @ptr is not null and not err.
1639  * Sets an assertion that the value that @ptr evaluates to is not null and not