1 /*
2 * Copyright (c) 2018, The OpenThread Authors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of the copyright holder nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 #include "test_platform.h"
30
31 #include <openthread/config.h>
32
33 #include "test_util.h"
34 #include "common/code_utils.hpp"
35 #include "common/string.hpp"
36
37 namespace ot {
38
39 enum
40 {
41 kStringSize = 10,
42 };
43
PrintString(const char * aName,const String<kSize> aString)44 template <uint16_t kSize> void PrintString(const char *aName, const String<kSize> aString)
45 {
46 printf("\t%s = [%zu] \"%s\"\n", aName, strlen(aString.AsCString()), aString.AsCString());
47 }
48
TestStringWriter(void)49 void TestStringWriter(void)
50 {
51 String<kStringSize> str;
52 const char kLongString[] = "abcdefghijklmnopqratuvwxyzabcdefghijklmnopqratuvwxyz";
53
54 printf("\nTest 1: StringWriter constructor\n");
55
56 VerifyOrQuit(str.GetSize() == kStringSize);
57 VerifyOrQuit(str.GetLength() == 0, "failed for empty string");
58
59 VerifyOrQuit(strcmp(str.AsCString(), "") == 0);
60
61 PrintString("str", str);
62
63 printf(" -- PASS\n");
64
65 printf("\nTest 2: StringWriter::Append() method\n");
66
67 str.Append("Hi");
68 VerifyOrQuit(str.GetLength() == 2);
69 VerifyOrQuit(strcmp(str.AsCString(), "Hi") == 0);
70 PrintString("str", str);
71
72 str.Append("%s%d", "!", 12);
73 VerifyOrQuit(str.GetLength() == 5);
74 VerifyOrQuit(strcmp(str.AsCString(), "Hi!12") == 0);
75 PrintString("str", str);
76
77 str.Append(kLongString);
78 VerifyOrQuit(str.IsTruncated() && str.GetLength() == 5 + sizeof(kLongString) - 1,
79 "String::Append() did not handle overflow buffer correctly");
80 PrintString("str", str);
81
82 printf("\nTest 3: StringWriter::Clear() method\n");
83
84 str.Clear();
85 str.Append("Hello");
86 VerifyOrQuit(str.GetLength() == 5);
87 VerifyOrQuit(strcmp(str.AsCString(), "Hello") == 0);
88 PrintString("str", str);
89
90 str.Clear();
91 VerifyOrQuit(str.GetLength() == 0, "failed after Clear()");
92 VerifyOrQuit(strcmp(str.AsCString(), "") == 0);
93
94 str.Append("%d", 12);
95 VerifyOrQuit(str.GetLength() == 2);
96 VerifyOrQuit(strcmp(str.AsCString(), "12") == 0);
97 PrintString("str", str);
98
99 str.Clear();
100 str.Append(kLongString);
101 VerifyOrQuit(str.IsTruncated() && str.GetLength() == sizeof(kLongString) - 1,
102 "String::Clear() + String::Append() did not handle overflow buffer correctly");
103 PrintString("str", str);
104
105 printf(" -- PASS\n");
106 }
107
TestStringLength(void)108 void TestStringLength(void)
109 {
110 char string_a[5] = "\0foo";
111 char string_b[8] = "foo\0bar";
112
113 printf("\nTest 4: String::StringLength() method\n");
114
115 VerifyOrQuit(StringLength(string_a, 0) == 0);
116 VerifyOrQuit(StringLength(string_a, 1) == 0);
117 VerifyOrQuit(StringLength(string_a, 2) == 0);
118
119 VerifyOrQuit(StringLength(string_b, 0) == 0);
120 VerifyOrQuit(StringLength(string_b, 1) == 1);
121 VerifyOrQuit(StringLength(string_b, 2) == 2);
122 VerifyOrQuit(StringLength(string_b, 3) == 3);
123 VerifyOrQuit(StringLength(string_b, 4) == 3);
124 VerifyOrQuit(StringLength(string_b, 5) == 3);
125 VerifyOrQuit(StringLength(string_b, 6) == 3);
126
127 printf(" -- PASS\n");
128 }
129
TestUtf8(void)130 void TestUtf8(void)
131 {
132 printf("\nTest 5: IsValidUtf8String() function\n");
133
134 VerifyOrQuit(IsValidUtf8String("An ASCII string"));
135 VerifyOrQuit(IsValidUtf8String(u8"Строка UTF-8"));
136 VerifyOrQuit(!IsValidUtf8String("\xbf"));
137 VerifyOrQuit(!IsValidUtf8String("\xdf"));
138 VerifyOrQuit(!IsValidUtf8String("\xef\x80"));
139 VerifyOrQuit(!IsValidUtf8String("\xf7\x80\x80"));
140 VerifyOrQuit(!IsValidUtf8String("\xff"));
141 VerifyOrQuit(!IsValidUtf8String("NUL\x00NUL", 7)); // UTF-8 NUL
142 VerifyOrQuit(!IsValidUtf8String("abcde\x11")); // control character
143
144 printf(" -- PASS\n");
145 }
146
TestStringFind(void)147 void TestStringFind(void)
148 {
149 char emptyString[1] = {'\0'};
150 char testString[] = "Foo.bar.bar\\.";
151 char testString2[] = "abcabcabcdabc";
152
153 printf("\nTest 6: StringFind() function\n");
154
155 VerifyOrQuit(StringFind(testString, 'F') == testString);
156 VerifyOrQuit(StringFind(testString, 'o') == &testString[1]);
157 VerifyOrQuit(StringFind(testString, '.') == &testString[3]);
158 VerifyOrQuit(StringFind(testString, 'r') == &testString[6]);
159 VerifyOrQuit(StringFind(testString, '\\') == &testString[11]);
160 VerifyOrQuit(StringFind(testString, 'x') == nullptr);
161 VerifyOrQuit(StringFind(testString, ',') == nullptr);
162
163 VerifyOrQuit(StringFind(emptyString, 'F') == nullptr);
164 VerifyOrQuit(StringFind(emptyString, '.') == nullptr);
165
166 VerifyOrQuit(StringFind(testString, "Foo") == &testString[0]);
167 VerifyOrQuit(StringFind(testString, "oo") == &testString[1]);
168 VerifyOrQuit(StringFind(testString, "bar") == &testString[4]);
169 VerifyOrQuit(StringFind(testString, "bar\\") == &testString[8]);
170 VerifyOrQuit(StringFind(testString, "\\.") == &testString[11]);
171 VerifyOrQuit(StringFind(testString, testString) == testString);
172 VerifyOrQuit(StringFind(testString, "Fooo") == nullptr);
173 VerifyOrQuit(StringFind(testString, "Far") == nullptr);
174 VerifyOrQuit(StringFind(testString, "FOO") == nullptr);
175 VerifyOrQuit(StringFind(testString, "BAR") == nullptr);
176 VerifyOrQuit(StringFind(testString, "bar\\..") == nullptr);
177 VerifyOrQuit(StringFind(testString, "") == &testString[0]);
178
179 VerifyOrQuit(StringFind(emptyString, "foo") == nullptr);
180 VerifyOrQuit(StringFind(emptyString, "bar") == nullptr);
181 VerifyOrQuit(StringFind(emptyString, "") == &emptyString[0]);
182
183 // Verify when sub-string has repeated patterns
184 VerifyOrQuit(StringFind(testString2, "abcabc") == &testString2[0]);
185 VerifyOrQuit(StringFind(testString2, "abcabcd") == &testString2[3]);
186
187 VerifyOrQuit(StringFind(testString, "FOO", kStringCaseInsensitiveMatch) == &testString[0]);
188 VerifyOrQuit(StringFind(testString, "OO", kStringCaseInsensitiveMatch) == &testString[1]);
189 VerifyOrQuit(StringFind(testString, "BAR", kStringCaseInsensitiveMatch) == &testString[4]);
190 VerifyOrQuit(StringFind(testString, "BAR\\", kStringCaseInsensitiveMatch) == &testString[8]);
191 VerifyOrQuit(StringFind(testString, "\\.", kStringCaseInsensitiveMatch) == &testString[11]);
192 VerifyOrQuit(StringFind(testString, testString) == testString);
193 VerifyOrQuit(StringFind(testString, "FOOO", kStringCaseInsensitiveMatch) == nullptr);
194 VerifyOrQuit(StringFind(testString, "FAR", kStringCaseInsensitiveMatch) == nullptr);
195 VerifyOrQuit(StringFind(testString, "BAR\\..", kStringCaseInsensitiveMatch) == nullptr);
196 VerifyOrQuit(StringFind(testString, "", kStringCaseInsensitiveMatch) == &testString[0]);
197
198 VerifyOrQuit(StringFind(emptyString, "FOO", kStringCaseInsensitiveMatch) == nullptr);
199 VerifyOrQuit(StringFind(emptyString, "BAR", kStringCaseInsensitiveMatch) == nullptr);
200 VerifyOrQuit(StringFind(emptyString, "", kStringCaseInsensitiveMatch) == &emptyString[0]);
201
202 // Verify when sub-string has repeated patterns
203 VerifyOrQuit(StringFind(testString2, "ABCABC", kStringCaseInsensitiveMatch) == &testString2[0]);
204 VerifyOrQuit(StringFind(testString2, "ABCABCD", kStringCaseInsensitiveMatch) == &testString2[3]);
205
206 printf(" -- PASS\n");
207 }
208
TestStringStartsWith(void)209 void TestStringStartsWith(void)
210 {
211 printf("\nTest 7: StringStartsWith() function\n");
212
213 VerifyOrQuit(StringStartsWith("FooBar", "Foo"));
214 VerifyOrQuit(!StringStartsWith("FooBar", "Ba"));
215 VerifyOrQuit(StringStartsWith("FooBar", "FooBar"));
216 VerifyOrQuit(!StringStartsWith("FooBar", "FooBarr"));
217 VerifyOrQuit(!StringStartsWith("FooBar", "foo"));
218 VerifyOrQuit(!StringStartsWith("FooBar", "FoO"));
219
220 VerifyOrQuit(!StringStartsWith("", "foo"));
221
222 VerifyOrQuit(StringStartsWith("FooBar", "FOO", kStringCaseInsensitiveMatch));
223 VerifyOrQuit(!StringStartsWith("FooBar", "BA", kStringCaseInsensitiveMatch));
224 VerifyOrQuit(StringStartsWith("FooBar", "FOOBAR", kStringCaseInsensitiveMatch));
225 VerifyOrQuit(!StringStartsWith("FooBar", "FooBarr", kStringCaseInsensitiveMatch));
226 VerifyOrQuit(StringStartsWith("FooBar", "foO", kStringCaseInsensitiveMatch));
227
228 VerifyOrQuit(!StringStartsWith("", "foo", kStringCaseInsensitiveMatch));
229
230 printf(" -- PASS\n");
231 }
232
TestStringEndsWith(void)233 void TestStringEndsWith(void)
234 {
235 printf("\nTest 8: StringEndsWith() function\n");
236
237 VerifyOrQuit(StringEndsWith("FooBar", 'r'));
238 VerifyOrQuit(!StringEndsWith("FooBar", 'a'));
239 VerifyOrQuit(!StringEndsWith("FooBar", '\0'));
240 VerifyOrQuit(StringEndsWith("a", 'a'));
241 VerifyOrQuit(!StringEndsWith("a", 'b'));
242
243 VerifyOrQuit(StringEndsWith("FooBar", "Bar"));
244 VerifyOrQuit(!StringEndsWith("FooBar", "Ba"));
245 VerifyOrQuit(StringEndsWith("FooBar", "FooBar"));
246 VerifyOrQuit(!StringEndsWith("FooBar", "FooBarr"));
247
248 VerifyOrQuit(!StringEndsWith("", 'a'));
249 VerifyOrQuit(!StringEndsWith("", "foo"));
250
251 VerifyOrQuit(StringEndsWith("FooBar", "baR", kStringCaseInsensitiveMatch));
252 VerifyOrQuit(!StringEndsWith("FooBar", "bA", kStringCaseInsensitiveMatch));
253 VerifyOrQuit(StringEndsWith("FooBar", "fOOBar", kStringCaseInsensitiveMatch));
254 VerifyOrQuit(!StringEndsWith("FooBar", "Foobarr", kStringCaseInsensitiveMatch));
255 VerifyOrQuit(!StringEndsWith("", "Foo", kStringCaseInsensitiveMatch));
256
257 printf(" -- PASS\n");
258 }
259
TestStringMatch(void)260 void TestStringMatch(void)
261 {
262 printf("\nTest 9: StringMatch() function\n");
263
264 VerifyOrQuit(StringMatch("", ""));
265 VerifyOrQuit(StringMatch("FooBar", "FooBar"));
266 VerifyOrQuit(!StringMatch("FooBar", "FooBa"));
267 VerifyOrQuit(!StringMatch("FooBa", "FooBar"));
268 VerifyOrQuit(!StringMatch("FooBa", "FooBar"));
269 VerifyOrQuit(!StringMatch("FooBar", "fooBar"));
270 VerifyOrQuit(!StringMatch("FooBaR", "FooBar"));
271
272 VerifyOrQuit(StringMatch("", "", kStringCaseInsensitiveMatch));
273 VerifyOrQuit(StringMatch("FooBar", "fOObAR", kStringCaseInsensitiveMatch));
274 VerifyOrQuit(!StringMatch("FooBar", "fOObA", kStringCaseInsensitiveMatch));
275 VerifyOrQuit(!StringMatch("FooBa", "FooBar", kStringCaseInsensitiveMatch));
276 VerifyOrQuit(!StringMatch("FooBa", "FooBar", kStringCaseInsensitiveMatch));
277 VerifyOrQuit(!StringMatch("Fooba", "fooBar", kStringCaseInsensitiveMatch));
278 VerifyOrQuit(StringMatch("FooBar", "FOOBAR", kStringCaseInsensitiveMatch));
279 VerifyOrQuit(StringMatch("FoobaR", "FooBar", kStringCaseInsensitiveMatch));
280 VerifyOrQuit(StringMatch("FOOBAR", "foobar", kStringCaseInsensitiveMatch));
281
282 printf(" -- PASS\n");
283 }
284
TestStringToLowercase(void)285 void TestStringToLowercase(void)
286 {
287 const uint16_t kMaxSize = 100;
288
289 const char kTestString[] = "!@#$%^&*()_+=[].,<>//;:\"'`~ \t\r\n";
290 const char kUppercaseString[] = "ABCDEFGHIJKLMNOPQRATUVWXYZABCDEFGHIJKLMNOPQRATUVWXYZ";
291 const char kLowercaseString[] = "abcdefghijklmnopqratuvwxyzabcdefghijklmnopqratuvwxyz";
292
293 char string[kMaxSize];
294
295 printf("\nTest 10: StringConvertToLowercase() function\n");
296
297 memcpy(string, kTestString, sizeof(kTestString));
298 StringConvertToLowercase(string);
299 VerifyOrQuit(memcmp(string, kTestString, sizeof(kTestString)) == 0);
300 StringConvertToUppercase(string);
301 VerifyOrQuit(memcmp(string, kTestString, sizeof(kTestString)) == 0);
302
303 memcpy(string, kUppercaseString, sizeof(kUppercaseString));
304 StringConvertToLowercase(string);
305 VerifyOrQuit(memcmp(string, kLowercaseString, sizeof(kLowercaseString)) == 0);
306 StringConvertToUppercase(string);
307 VerifyOrQuit(memcmp(string, kUppercaseString, sizeof(kUppercaseString)) == 0);
308
309 printf(" -- PASS\n");
310 }
311
TestStringParseUint8(void)312 void TestStringParseUint8(void)
313 {
314 struct TestCase
315 {
316 const char *mString;
317 Error mError;
318 uint8_t mExpectedValue;
319 uint16_t mParsedLength;
320 };
321
322 static const TestCase kTestCases[] = {
323 {"0", kErrorNone, 0, 1},
324 {"1", kErrorNone, 1, 1},
325 {"12", kErrorNone, 12, 2},
326 {"91", kErrorNone, 91, 2},
327 {"200", kErrorNone, 200, 3},
328 {"00000", kErrorNone, 0, 5},
329 {"00000255", kErrorNone, 255, 8},
330 {"2 00", kErrorNone, 2, 1},
331 {"77a12", kErrorNone, 77, 2},
332 {"", kErrorParse}, // Does not start with digit char ['0'-'9']
333 {"a12", kErrorParse}, // Does not start with digit char ['0'-'9']
334 {" 12", kErrorParse}, // Does not start with digit char ['0'-'9']
335 {"256", kErrorParse}, // Larger than max `uint8_t`
336 {"1000", kErrorParse}, // Larger than max `uint8_t`
337 {"0256", kErrorParse}, // Larger than max `uint8_t`
338 };
339
340 uint8_t digit;
341
342 printf("\nTest 11: TestStringParseUint8() function\n");
343
344 for (const TestCase &testCase : kTestCases)
345 {
346 const char *string = testCase.mString;
347 Error error;
348 uint8_t u8;
349
350 error = StringParseUint8(string, u8);
351
352 VerifyOrQuit(error == testCase.mError);
353
354 if (testCase.mError == kErrorNone)
355 {
356 printf("\n%-10s -> %-3u (expect: %-3u), len:%u (expect:%u)", testCase.mString, u8, testCase.mExpectedValue,
357 static_cast<uint8_t>(string - testCase.mString), testCase.mParsedLength);
358
359 VerifyOrQuit(u8 == testCase.mExpectedValue);
360 VerifyOrQuit(string - testCase.mString == testCase.mParsedLength);
361 }
362 else
363 {
364 printf("\n%-10s -> kErrorParse", testCase.mString);
365 }
366 }
367
368 for (char c = '0'; c <= '9'; c++)
369 {
370 VerifyOrQuit(IsDigit(c));
371 VerifyOrQuit(!IsUppercase(c));
372 VerifyOrQuit(!IsLowercase(c));
373
374 SuccessOrQuit(ParseDigit(c, digit));
375 VerifyOrQuit(digit == (c - '0'));
376
377 SuccessOrQuit(ParseHexDigit(c, digit));
378 VerifyOrQuit(digit == (c - '0'));
379 }
380
381 for (char c = 'A'; c <= 'Z'; c++)
382 {
383 VerifyOrQuit(!IsDigit(c));
384 VerifyOrQuit(IsUppercase(c));
385 VerifyOrQuit(!IsLowercase(c));
386 VerifyOrQuit(ParseDigit(c, digit) != kErrorNone);
387
388 if (c <= 'F')
389 {
390 SuccessOrQuit(ParseHexDigit(c, digit));
391 VerifyOrQuit(digit == (c - 'A' + 10));
392 }
393 else
394 {
395 VerifyOrQuit(ParseHexDigit(c, digit) != kErrorNone);
396 }
397 }
398
399 for (char c = 'a'; c <= 'z'; c++)
400 {
401 VerifyOrQuit(!IsDigit(c));
402 VerifyOrQuit(!IsUppercase(c));
403 VerifyOrQuit(IsLowercase(c));
404 VerifyOrQuit(ParseDigit(c, digit) != kErrorNone);
405
406 if (c <= 'f')
407 {
408 SuccessOrQuit(ParseHexDigit(c, digit));
409 VerifyOrQuit(digit == (c - 'a' + 10));
410 }
411 else
412 {
413 VerifyOrQuit(ParseHexDigit(c, digit) != kErrorNone);
414 }
415 }
416
417 VerifyOrQuit(!IsDigit(static_cast<char>('0' - 1)));
418 VerifyOrQuit(!IsDigit(static_cast<char>('9' + 1)));
419
420 VerifyOrQuit(!IsUppercase(static_cast<char>('A' - 1)));
421 VerifyOrQuit(!IsUppercase(static_cast<char>('Z' + 1)));
422
423 VerifyOrQuit(!IsLowercase(static_cast<char>('a' - 1)));
424 VerifyOrQuit(!IsLowercase(static_cast<char>('z' + 1)));
425
426 printf("\n\n -- PASS\n");
427 }
428
TestStringCopy(void)429 void TestStringCopy(void)
430 {
431 char buffer[10];
432 char smallBuffer[1];
433
434 printf("\nTest 11: StringCopy() function\n");
435
436 SuccessOrQuit(StringCopy(buffer, "foo", kStringCheckUtf8Encoding));
437 VerifyOrQuit(StringMatch(buffer, "foo"));
438
439 SuccessOrQuit(StringCopy(buffer, nullptr, kStringCheckUtf8Encoding));
440 VerifyOrQuit(StringMatch(buffer, ""));
441
442 SuccessOrQuit(StringCopy(buffer, "", kStringCheckUtf8Encoding));
443 VerifyOrQuit(StringMatch(buffer, ""));
444
445 SuccessOrQuit(StringCopy(buffer, "123456789", kStringCheckUtf8Encoding));
446 VerifyOrQuit(StringMatch(buffer, "123456789"));
447
448 VerifyOrQuit(StringCopy(buffer, "1234567890") == kErrorInvalidArgs);
449 VerifyOrQuit(StringCopy(buffer, "1234567890abcdef") == kErrorInvalidArgs);
450
451 SuccessOrQuit(StringCopy(smallBuffer, "", kStringCheckUtf8Encoding));
452 VerifyOrQuit(StringMatch(smallBuffer, ""));
453
454 VerifyOrQuit(StringCopy(smallBuffer, "a") == kErrorInvalidArgs);
455
456 printf(" -- PASS\n");
457 }
458
459 // gcc-4 does not support constexpr function
460 #if __GNUC__ > 4
461 static_assert(ot::AreStringsInOrder("a", "b"), "AreStringsInOrder() failed");
462 static_assert(ot::AreStringsInOrder("aa", "aaa"), "AreStringsInOrder() failed");
463 static_assert(ot::AreStringsInOrder("", "a"), "AreStringsInOrder() failed");
464 static_assert(!ot::AreStringsInOrder("cd", "cd"), "AreStringsInOrder() failed");
465 static_assert(!ot::AreStringsInOrder("z", "abcd"), "AreStringsInOrder() failed");
466 static_assert(!ot::AreStringsInOrder("0", ""), "AreStringsInOrder() failed");
467 #endif
468
469 } // namespace ot
470
main(void)471 int main(void)
472 {
473 ot::TestStringWriter();
474 ot::TestStringLength();
475 ot::TestUtf8();
476 ot::TestStringFind();
477 ot::TestStringStartsWith();
478 ot::TestStringEndsWith();
479 ot::TestStringMatch();
480 ot::TestStringToLowercase();
481 ot::TestStringParseUint8();
482 ot::TestStringCopy();
483 printf("\nAll tests passed.\n");
484 return 0;
485 }
486