include/kunit/test.h

106  * struct kunit_case - represents an individual test case.
120  * terminated with an empty test case.
162  * &struct kunit_case for an example on how to use it.
266  * an initcall which we don't want as the idea is that for builtins
306  * An alternative is to build the tests as a module.  Because modules do not
307  * support multiple initcall()s, we need to initialize an array of suites for a
382  *	  If an init function is supplied, @data is passed to it instead.
418  * cleaned up at the end of a test case. See &struct kunit_resource for an
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
601  * kunit_info() - Prints an INFO level message associated with @test.
606  * Prints an info level message associated with the test suite being run.
624  * kunit_err() - Prints an ERROR level message associated with @test.
629  * Prints an error level message.
638  * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other
670  * @fmt: an informational message to be printed when the assertion is made.
673  * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In
1185  * @condition: an arbitrary boolean expression. The test fails when this does
1190  * the test case from continuing to run; this is otherwise known as an
1206  * @condition: an arbitrary boolean expression. The test fails when this does
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
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
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
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
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
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
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
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
1451  * @ptr: an arbitrary pointer.
1453  * Sets an expectation that the value that @ptr evaluates to is not null and not
1454  * an errno stored in a pointer. This is semantically equivalent to
1472  * KUNIT_ASSERT_TRUE() - Sets an assertion that @condition is true.
1474  * @condition: an arbitrary boolean expression. The test fails and aborts when
1479  * an expectation failure, it will prevent the test case from continuing to run;
1480  * this is otherwise known as an *assertion failure*.
1493  * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false.
1495  * @condition: an arbitrary boolean expression.
1497  * Sets an assertion that the value that @condition evaluates to is false. This
1498  * is the same as KUNIT_EXPECT_FALSE(), except it causes an assertion failure
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
1518  * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
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
1539  * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
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
1560  * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
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
1582  * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
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
1603  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1624  * KUNIT_EXPECT_LE(), except it causes an assertion failure (see
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
1646  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1668  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1689  * equal. This is the same as KUNIT_EXPECT_STREQ(), except it causes an
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
1728  * @ptr: an arbitrary pointer.
1730  * Sets an assertion that the value that @ptr evaluates to is not null and not
1731  * an errno stored in a pointer. This is the same as
1732  * KUNIT_EXPECT_NOT_ERR_OR_NULL(), except it causes an assertion failure (see