summaryrefslogtreecommitdiffstats
path: root/docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2018-10-29 18:37:26 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2018-10-31 21:03:06 +0000
commit2f3654275e44f9719818a848da9a0b576d5a1b53 (patch)
treeff75764bbb2e3037f73f95a96ac5ed2fcba93465 /docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md
parent2a7b4defe300dfe5eb19f775bd819e2d300b7453 (diff)
Docs reorganization and update
Docs reorganization and update using the latest afb-test improvments and try to make it clearer. Change-Id: If022cdb46364ef250361bdcd420d45b360f10a2e Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md')
-rw-r--r--docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md b/docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md
new file mode 100644
index 0000000..4a719b6
--- /dev/null
+++ b/docs/Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md
@@ -0,0 +1,32 @@
+# General Assertions
+
+* **_AFT.assertEquals(actual, expected)**
+
+ Assert that two values are equal.
+
+ For tables, the comparison is a deep comparison :
+
+ * number of elements must be the same
+ * tables must contain the same keys
+ * each key must contain the same values. The values are also compared recursively with deep comparison.
+
+ LuaUnit provides other table-related assertions, see [Table assertions](http://luaunit.readthedocs.io/en/luaunit_v3_2_1/#assert-table)
+
+* **_AFT.assertNotEquals(actual, expected)**
+
+ Assert that two values are different. The assertion fails if the two values are identical.
+
+ It also uses table deep comparison.
+
+* **_AFT.assertAlmostEquals(actual, expected, margin)**
+
+ Assert that two floating point numbers are almost equal.
+
+ When comparing floating point numbers, strict equality does not work.
+ Computer arithmetic is so that an operation that mathematically yields
+ 1.00000000 might yield 0.999999999999 in lua . That’s why you need an
+ almost equals comparison, where you specify the error margin.
+
+* **_AFT.assertNotAlmostEquals(actual, expected, margin)**
+
+ Assert that two floating point numbers are not almost equal. \ No newline at end of file