include/kunit/test.h

69  * Speed Attribute is stored as an enum and separated into categories of
89  * struct kunit_case - represents an individual test case.
105  * terminated with an empty test case.
157  * &struct kunit_case for an example on how to use it.
260 /* Stores an array of suites, end points one past the end */
605  * kunit_info() - Prints an INFO level message associated with @test.
610  * Prints an info level message associated with the test suite being run.
628  * kunit_err() - Prints an ERROR level message associated with @test.
633  * Prints an error level message.
651  * The opposite of KUNIT_FAIL(), it is an expectation that cannot fail. In other
695  * @fmt: an informational message to be printed when the assertion is made.
698  * The opposite of KUNIT_SUCCEED(), it is an expectation that always fails. In
709 /* Helper to safely pass around an initializer list to other macros. */
917  * @condition: an arbitrary boolean expression. The test fails when this does
922  * the test case from continuing to run; this is otherwise known as an
938  * @condition: an arbitrary boolean expression. The test fails when this does
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
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
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
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
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
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
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
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
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
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
1221  * @ptr: an arbitrary pointer.
1223  * Sets an expectation that the value that @ptr evaluates to is null. This is
1242  * @ptr: an arbitrary pointer.
1244  * Sets an expectation that the value that @ptr evaluates to is not null. This
1263  * @ptr: an arbitrary pointer.
1265  * Sets an expectation that the value that @ptr evaluates to is not null and not
1266  * an errno stored in a pointer. This is semantically equivalent to
1283  * @fmt: an informational message to be printed when the assertion is made.
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.
1297  * @condition: an arbitrary boolean expression. The test fails and aborts when
1302  * an expectation failure, it will prevent the test case from continuing to run;
1303  * this is otherwise known as an *assertion failure*.
1316  * KUNIT_ASSERT_FALSE() - Sets an assertion that @condition is false.
1318  * @condition: an arbitrary boolean expression.
1320  * Sets an assertion that the value that @condition evaluates to is false. This
1321  * is the same as KUNIT_EXPECT_FALSE(), except it causes an assertion failure
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
1341  * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
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
1361  * equal. This is the same as KUNIT_EXPECT_EQ(), except it causes an assertion
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
1381  * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
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
1402  * equal. This is the same as KUNIT_EXPECT_NE(), except it causes an assertion
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
1422  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1442  * KUNIT_EXPECT_LE(), except it causes an assertion failure (see
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
1463  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1484  * it causes an assertion failure (see KUNIT_ASSERT_TRUE()) when the assertion
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
1504  * equal. This is the same as KUNIT_EXPECT_STREQ(), except it causes an
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
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
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
1595  * @ptr: an arbitrary pointer.
1597  * Sets an assertion that the values that @ptr evaluates to is null. This is
1598  * the same as KUNIT_EXPECT_NULL(), except it causes an assertion
1616  * @ptr: an arbitrary pointer.
1618  * Sets an assertion that the values that @ptr evaluates to is not null. This
1619  * is the same as KUNIT_EXPECT_NOT_NULL(), except it causes an assertion
1637  * @ptr: an arbitrary pointer.
1639  * Sets an assertion that the value that @ptr evaluates to is not null and not
1640  * an errno stored in a pointer. This is the same as
1641  * KUNIT_EXPECT_NOT_ERR_OR_NULL(), except it causes an assertion failure (see
1655  * KUNIT_ARRAY_PARAM() - Define test parameter generator from an array.
1676  * KUNIT_ARRAY_PARAM_DESC() - Define test parameter generator from an array.