include/kunit/test.h

68  * Speed Attribute is stored as an enum and separated into categories of
88  * struct kunit_case - represents an individual test case.
104  * terminated with an empty test case.
156  * &struct kunit_case for an example on how to use it.
259 /* Stores an array of suites, end points one past the end */
537  * kunit_info() - Prints an INFO level message associated with @test.
542  * Prints an info level message associated with the test suite being run.
560  * kunit_err() - Prints an ERROR level message associated with @test.
565  * Prints an error level message.
574  * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other
616  * @fmt: an informational message to be printed when the assertion is made.
619  * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In
630 /* Helper to safely pass around an initializer list to other macros. */
833  * @condition: an arbitrary boolean expression. The test fails when this does
838  * the test case from continuing to run; this is otherwise known as an
854  * @condition: an arbitrary boolean expression. The test fails when this does
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
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
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
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
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
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
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
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
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
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
1137  * @ptr: an arbitrary pointer.
1139  * Sets an expectation that the value that @ptr evaluates to is null. This is
1158  * @ptr: an arbitrary pointer.
1160  * Sets an expectation that the value that @ptr evaluates to is not null. This
1179  * @ptr: an arbitrary pointer.
1181  * Sets an expectation that the value that @ptr evaluates to is not null and not
1182  * an errno stored in a pointer. This is semantically equivalent to
1200  * KUNIT_ASSERT_TRUE() - Sets an assertion that @condition is true.
1202  * @condition: an arbitrary boolean expression. The test fails and aborts when
1207  * an expectation failure, it will prevent the test case from continuing to run;
1208  * this is otherwise known as an *assertion failure*.
1221  * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false.
1223  * @condition: an arbitrary boolean expression.
1225  * Sets an assertion that the value that @condition evaluates to is false. This
1226  * is the same as KUNIT_EXPECT_FALSE(), except it causes an assertion failure
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
1246  * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
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
1266  * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
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
1286  * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
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
1307  * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
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
1327  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1347  * KUNIT_EXPECT_LE(), except it causes an assertion failure (see
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
1368  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1389  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1409  * equal. This is the same as KUNIT_EXPECT_STREQ(), except it causes an
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
1446  * @ptr: an arbitrary pointer.
1448  * Sets an assertion that the values that @ptr evaluates to is null. This is
1449  * the same as KUNIT_EXPECT_NULL(), except it causes an assertion
1467  * @ptr: an arbitrary pointer.
1469  * Sets an assertion that the values that @ptr evaluates to is not null. This
1470  * is the same as KUNIT_EXPECT_NOT_NULL(), except it causes an assertion
1488  * @ptr: an arbitrary pointer.
1490  * Sets an assertion that the value that @ptr evaluates to is not null and not
1491  * an errno stored in a pointer. This is the same as
1492  * KUNIT_EXPECT_NOT_ERR_OR_NULL(), except it causes an assertion failure (see
1506  * KUNIT_ARRAY_PARAM() - Define test parameter generator from an array.
1527  * KUNIT_ARRAY_PARAM_DESC() - Define test parameter generator from an array.