include/kunit/test.h

38  * when finished with it.  Note that kunit_alloc_resource() does not require a
113  * that makes expectations and assertions (see KUNIT_EXPECT_TRUE() and
174  * A kunit_suite is a collection of related &struct kunit_case s, such that
221 	 * Because resources is a list that may be updated multiple times (with
266  * an initcall which we don't want as the idea is that for builtins
325  * object that contains the allocation. This is mostly for testing purposes.
422  * specify an @internal_gfp that is compatible with the use context of your
453  * An instance of kunit_resource_match_t that matches a resource whose
543  * Note that the resource will not be immediately freed since it is likely
638  * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other
673  * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In
726  * Unfortunately, there is no common type that all types can be promoted to for
728  * (for example, there is no type that long long and unsigned long long can
1209  * Sets an expectation that @condition evaluates to false. See
1223  * KUNIT_EXPECT_EQ() - Sets an expectation that @left and @right are equal.
1225  * @left: an arbitrary expression that evaluates to a primitive C type.
1226  * @right: an arbitrary expression that evaluates to a primitive C type.
1228  * Sets an expectation that the values that @left and @right evaluate to are
1245  * KUNIT_EXPECT_PTR_EQ() - Expects that pointers @left and @right are equal.
1247  * @left: an arbitrary expression that evaluates to a pointer.
1248  * @right: an arbitrary expression that evaluates to a pointer.
1250  * Sets an expectation that the values that @left and @right evaluate to are
1270  * KUNIT_EXPECT_NE() - An expectation that @left and @right are not equal.
1272  * @left: an arbitrary expression that evaluates to a primitive C type.
1273  * @right: an arbitrary expression that evaluates to a primitive C type.
1275  * Sets an expectation that the values that @left and @right evaluate to are not
1292  * KUNIT_EXPECT_PTR_NE() - Expects that pointers @left and @right are not equal.
1294  * @left: an arbitrary expression that evaluates to a pointer.
1295  * @right: an arbitrary expression that evaluates to a pointer.
1297  * Sets an expectation that the values that @left and @right evaluate to are not
1317  * KUNIT_EXPECT_LT() - An expectation that @left is less than @right.
1319  * @left: an arbitrary expression that evaluates to a primitive C type.
1320  * @right: an arbitrary expression that evaluates to a primitive C type.
1322  * Sets an expectation that the value that @left evaluates to is less than the
1323  * value that @right evaluates to. This is semantically equivalent to
1339  * KUNIT_EXPECT_LE() - Expects that @left is less than or equal to @right.
1341  * @left: an arbitrary expression that evaluates to a primitive C type.
1342  * @right: an arbitrary expression that evaluates to a primitive C type.
1344  * Sets an expectation that the value that @left evaluates to is less than or
1345  * equal to the value that @right evaluates to. Semantically this is equivalent
1361  * KUNIT_EXPECT_GT() - An expectation 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 expectation that the value that @left evaluates to is greater than
1367  * the value that @right evaluates to. This is semantically equivalent to
1383  * KUNIT_EXPECT_GE() - Expects that @left is greater than or equal to @right.
1385  * @left: an arbitrary expression that evaluates to a primitive C type.
1386  * @right: an arbitrary expression that evaluates to a primitive C type.
1388  * Sets an expectation that the value that @left evaluates to is greater than
1389  * the value that @right evaluates to. This is semantically equivalent to
1405  * KUNIT_EXPECT_STREQ() - Expects that strings @left and @right are equal.
1407  * @left: an arbitrary expression that evaluates to a null terminated string.
1408  * @right: an arbitrary expression that evaluates to a null terminated string.
1410  * Sets an expectation that the values that @left and @right evaluate to are
1427  * KUNIT_EXPECT_STRNEQ() - Expects that strings @left and @right are not equal.
1429  * @left: an arbitrary expression that evaluates to a null terminated string.
1430  * @right: an arbitrary expression that evaluates to a null terminated string.
1432  * Sets an expectation that the values that @left and @right evaluate to are
1449  * KUNIT_EXPECT_NOT_ERR_OR_NULL() - Expects that @ptr is not null and not err.
1453  * Sets an expectation that the value that @ptr evaluates to is not null and not
1472  * KUNIT_ASSERT_TRUE() - Sets an assertion that @condition is true.
1493  * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false.
1497  * Sets an assertion that the value that @condition evaluates to is false. This
1512  * KUNIT_ASSERT_EQ() - Sets an assertion that @left and @right are equal.
1514  * @left: an arbitrary expression that evaluates to a primitive C type.
1515  * @right: an arbitrary expression that evaluates to a primitive C type.
1517  * Sets an assertion that the values that @left and @right evaluate to are
1533  * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
1535  * @left: an arbitrary expression that evaluates to a pointer.
1536  * @right: an arbitrary expression that evaluates to a pointer.
1538  * Sets an assertion that the values that @left and @right evaluate to are
1554  * KUNIT_ASSERT_NE() - An assertion that @left and @right are not equal.
1556  * @left: an arbitrary expression that evaluates to a primitive C type.
1557  * @right: an arbitrary expression that evaluates to a primitive C type.
1559  * Sets an assertion that the values that @left and @right evaluate to are not
1575  * KUNIT_ASSERT_PTR_NE() - Asserts that pointers @left and @right are not equal.
1576  * KUNIT_ASSERT_PTR_EQ() - Asserts that pointers @left and @right are equal.
1578  * @left: an arbitrary expression that evaluates to a pointer.
1579  * @right: an arbitrary expression that evaluates to a pointer.
1581  * Sets an assertion that the values that @left and @right evaluate to are not
1596  * KUNIT_ASSERT_LT() - An assertion that @left is less than @right.
1598  * @left: an arbitrary expression that evaluates to a primitive C type.
1599  * @right: an arbitrary expression that evaluates to a primitive C type.
1601  * Sets an assertion that the value that @left evaluates to is less than the
1602  * value that @right evaluates to. This is the same as KUNIT_EXPECT_LT(), except
1617  * KUNIT_ASSERT_LE() - An assertion that @left is less than or equal to @right.
1619  * @left: an arbitrary expression that evaluates to a primitive C type.
1620  * @right: an arbitrary expression that evaluates to a primitive C type.
1622  * Sets an assertion that the value that @left evaluates to is less than or
1623  * equal to the value that @right evaluates to. This is the same as
1639  * KUNIT_ASSERT_GT() - An assertion that @left is greater than @right.
1641  * @left: an arbitrary expression that evaluates to a primitive C type.
1642  * @right: an arbitrary expression that evaluates to a primitive C type.
1644  * Sets an assertion that the value that @left evaluates to is greater than the
1645  * value that @right evaluates to. This is the same as KUNIT_EXPECT_GT(), except
1661  * KUNIT_ASSERT_GE() - Assertion that @left is greater than or equal to @right.
1663  * @left: an arbitrary expression that evaluates to a primitive C type.
1664  * @right: an arbitrary expression that evaluates to a primitive C type.
1666  * Sets an assertion that the value that @left evaluates to is greater than the
1667  * value that @right evaluates to. This is the same as KUNIT_EXPECT_GE(), except
1683  * KUNIT_ASSERT_STREQ() - An assertion that strings @left and @right are equal.
1685  * @left: an arbitrary expression that evaluates to a null terminated string.
1686  * @right: an arbitrary expression that evaluates to a null terminated string.
1688  * Sets an assertion that the values that @left and @right evaluate to are
1704  * KUNIT_ASSERT_STRNEQ() - Expects that strings @left and @right are not equal.
1706  * @left: an arbitrary expression that evaluates to a null terminated string.
1707  * @right: an arbitrary expression that evaluates to a null terminated string.
1709  * Sets an expectation that the values that @left and @right evaluate to are
1726  * KUNIT_ASSERT_NOT_ERR_OR_NULL() - Assertion that @ptr is not null and not err.
1730  * Sets an assertion that the value that @ptr evaluates to is not null and not