aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2018-10-29 18:37:26 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2018-12-11 12:20:32 +0000
commit16922b73bf17b2f23148438957cd3d18542075f4 (patch)
tree20355189f7f5f2262e7fe31be0b7119b07182ab1 /docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md
parent77ca03276ea3bb12873a1b69b1726d4e99f8dead (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> (cherry picked from commit 2f3654275e44f9719818a848da9a0b576d5a1b53)
Diffstat (limited to 'docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md')
-rw-r--r--docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md b/docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md
new file mode 100644
index 0000000..929ec14
--- /dev/null
+++ b/docs/Reference/LuaUnitAssertionFunctions/3_StringAssertions.md
@@ -0,0 +1,38 @@
+# String assertions
+
+Assertions related to string and patterns.
+
+* **_AFT.assertStrContains(str, sub[, useRe])**
+
+ Assert that a string contains the given substring or pattern.
+
+ By default, substring is searched in the string. If useRe is provided and is
+ true, sub is treated as a pattern which is searched inside the string str.
+
+* **_AFT.assertStrIContains(str, sub)**
+
+ Assert that a string contains the given substring, irrespective of the case.
+
+ Not that unlike assertStrcontains(), you can not search for a pattern.
+
+* **_AFT.assertNotStrContains(str, sub, useRe)**
+
+ Assert that a string does not contain a given substring or pattern.
+
+ By default, substring is searched in the string. If useRe is provided and is
+ true, sub is treated as a pattern which is searched inside the string str.
+
+* **_AFT.assertNotStrIContains(str, sub)**
+
+ Assert that a string does not contain the given substring, irrespective of
+ the case.
+
+ Note that unlike assertNotStrcontains(), you can not search for a pattern.
+
+* **_AFT.assertStrMatches(str, pattern[, start[, final]])**
+
+ Assert that a string matches the full pattern pattern.
+
+ If start and final are not provided or are nil, the pattern must match the
+ full string, from start to end. The functions allows to specify the expected
+ start and end position of the pattern in the string. \ No newline at end of file