forked from MahletNigusse/write-after-read-protocol
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopt_trace-t.cc
1182 lines (1107 loc) · 35.1 KB
/
opt_trace-t.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
/**
@file
Unit test of the Optimizer trace API (WL#5257)
*/
// First include (the generated) my_config.h, to get correct platform defines.
#include "my_config.h"
#include <gtest/gtest.h>
#ifdef OPTIMIZER_TRACE
#include <opt_trace.h>
#include <mysys_err.h> // for testing of OOM
#include "mysqld.h" // system_charset_info
#ifdef HAVE_SYS_WAIT_H
#include <sys/wait.h> // for WEXITSTATUS
#endif
namespace opt_trace_unittest {
const ulonglong all_features= Opt_trace_context::default_features;
/**
@note It is a macro, for proper reporting of line numbers in case of
assertion failure. SCOPED_TRACE will report line number at the
macro expansion site.
*/
#define check_json_compliance(str, length) \
{ \
SCOPED_TRACE(""); \
do_check_json_compliance(str, length); \
}
/**
Checks compliance of a trace with JSON syntax rules.
This is a helper which has interest only when developing the test; once you
know that the produced trace is compliant and has expected content, just
set "expected" to it, add a comparison with "expected", and don't use this
function.
@param str pointer to trace
@param length trace's length
*/
void do_check_json_compliance(const char *str, size_t length)
{
return;
/*
Read from stdin, eliminate comments, parse as JSON. If invalid, an
exception is thrown by Python, uncaught, which produces a non-zero error
code.
*/
#ifndef _WIN32
const char python_cmd[]=
"python -c \""
"import json, re, sys;"
"s= sys.stdin.read();"
"s= re.sub('/\\\\*[ A-Za-z_]* \\\\*/', '', s);"
"json.loads(s, 'utf-8')\"";
// Send the trace to this new process' stdin:
FILE *fd= popen(python_cmd, "w");
ASSERT_TRUE(NULL != fd);
ASSERT_NE(0U, length); // empty is not compliant
ASSERT_EQ(1U, fwrite(str, length, 1, fd));
int rc= pclose(fd);
rc= WEXITSTATUS(rc);
EXPECT_EQ(0, rc);
#endif
}
extern "C"
void my_error_handler(uint error, const char *str, myf MyFlags);
class TraceContentTest : public ::testing::Test
{
public:
Opt_trace_context trace;
static bool oom; ///< whether we got an OOM error from opt trace
protected:
static void SetUpTestCase()
{
system_charset_info= &my_charset_utf8_general_ci;
}
virtual void SetUp()
{
error_handler_hook= my_error_handler;
oom= false;
// Setting debug flags triggers enter/exit trace, so redirect to /dev/null
DBUG_SET("o," IF_WIN("NUL", "/dev/null"));
}
};
bool TraceContentTest::oom;
void my_error_handler(uint error, const char *str, myf MyFlags)
{
const uint EE= static_cast<uint>(EE_OUTOFMEMORY);
EXPECT_EQ(EE, error);
if (error == EE)
TraceContentTest::oom= true;
}
TEST_F(TraceContentTest, ConstructAndDestruct)
{
}
/** Test empty trace */
TEST_F(TraceContentTest, Empty)
{
ASSERT_FALSE(trace.start(true, false, false, false, -1, 1, ULONG_MAX,
all_features));
EXPECT_TRUE(trace.is_started());
EXPECT_TRUE(trace.support_I_S());
/*
Add at least an object to it. A really empty trace ("") is not
JSON-compliant, at least Python's JSON module raises an exception.
*/
{
Opt_trace_object oto(&trace);
}
/* End trace */
trace.end();
/* And verify trace's content */
Opt_trace_iterator it(&trace);
/*
ASSERT here, because a failing EXPECT_FALSE would continue into
it.get_value() and segfault.
*/
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
const char expected[]= "{\n}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
check_json_compliance(info.trace_ptr, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
/* Should be no more traces */
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test normal usage */
TEST_F(TraceContentTest, NormalUsage)
{
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
oto.add_select_number(123456);
{
Opt_trace_array ota(&trace, "one array");
ota.add(200.4);
{
Opt_trace_object oto1(&trace);
oto1.add_alnum("one key", "one value").
add("another key", 100U);
}
ota.add_alnum("one string element");
ota.add(true);
ota.add_hex(12318421343459ULL);
}
oto.add("yet another key", -1000LL);
{
Opt_trace_array ota(&trace, "another array");
ota.add(1LL).add(2).add(3LL).add(4LL);
}
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
const char expected[]=
"{\n"
" \"select#\": 123456,\n"
" \"one array\": [\n"
" 200.4,\n"
" {\n"
" \"one key\": \"one value\",\n"
" \"another key\": 100\n"
" },\n"
" \"one string element\",\n"
" true,\n"
" 0x0b341b20dce3\n"
" ] /* one array */,\n"
" \"yet another key\": -1000,\n"
" \"another array\": [\n"
" 1,\n"
" 2,\n"
" 3,\n"
" 4\n"
" ] /* another array */\n"
"}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
check_json_compliance(info.trace_ptr, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test reaction to malformed JSON (object with value without key) */
TEST_F(TraceContentTest, BuggyObject)
{
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
{
Opt_trace_array ota(&trace, "one array");
ota.add(200.4);
{
Opt_trace_object oto1(&trace);
oto1.add_alnum("one value"); // no key, which is wrong
oto1.add(326); // same
Opt_trace_object oto2(&trace); // same
}
ota.add_alnum("one string element");
ota.add(true);
}
oto.add("yet another key", -1000LL);
{
Opt_trace_array ota(&trace, "another array");
ota.add(1LL).add(2LL).add(3LL).add(4LL);
}
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
const char expected[]=
"{\n"
" \"one array\": [\n"
" 200.4,\n"
" {\n"
" \"unknown_key_1\": \"one value\",\n"
" \"unknown_key_2\": 326,\n"
" \"unknown_key_3\": {\n"
" }\n"
" },\n"
" \"one string element\",\n"
" true\n"
" ] /* one array */,\n"
" \"yet another key\": -1000,\n"
" \"another array\": [\n"
" 1,\n"
" 2,\n"
" 3,\n"
" 4\n"
" ] /* another array */\n"
"}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
check_json_compliance(info.trace_ptr, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test reaction to malformed JSON (array with value with key) */
TEST_F(TraceContentTest, BuggyArray)
{
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
{
Opt_trace_array ota(&trace, "one array");
ota.add("superfluous key", 200.4); // key, which is wrong
ota.add("not necessary", 326); // same
Opt_trace_object oto2(&trace, "not needed"); // same
}
oto.add("yet another key", -1000LL);
{
Opt_trace_array ota(&trace, "another array");
ota.add(1LL).add(2LL).add(3LL).add(4LL);
}
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
const char expected[]=
"{\n"
" \"one array\": [\n"
" 200.4,\n"
" 326,\n"
" {\n"
" } /* not needed */\n"
" ] /* one array */,\n"
" \"yet another key\": -1000,\n"
" \"another array\": [\n"
" 1,\n"
" 2,\n"
" 3,\n"
" 4\n"
" ] /* another array */\n"
"}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
check_json_compliance(info.trace_ptr, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test Opt_trace_disable_I_S */
TEST_F(TraceContentTest, DisableISWithObject)
{
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
{
Opt_trace_array ota(&trace, "one array");
ota.add(200.4);
{
Opt_trace_object oto1(&trace);
oto1.add_alnum("one key", "one value").
add("another key", 100LL);
Opt_trace_disable_I_S otd(&trace, true);
oto1.add("a third key", false);
Opt_trace_object oto2(&trace, "a fourth key");
oto2.add("key inside", 1LL);
/* don't disable... but above layer is stronger */
Opt_trace_disable_I_S otd2(&trace, false);
oto2.add("another key inside", 5LL);
// disabling should apply to substatements too:
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto3(&trace);
}
trace.end();
}
ota.add_alnum("one string element");
ota.add(true);
}
Opt_trace_disable_I_S otd2(&trace, false); // don't disable
oto.add("yet another key", -1000LL);
{
Opt_trace_array ota(&trace, "another array");
ota.add(1LL).add(2LL).add(3LL).add(4LL);
}
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
const char expected[]=
"{\n"
" \"one array\": [\n"
" 200.4,\n"
" {\n"
" \"one key\": \"one value\",\n"
" \"another key\": 100\n"
" },\n"
" \"one string element\",\n"
" true\n"
" ] /* one array */,\n"
" \"yet another key\": -1000,\n"
" \"another array\": [\n"
" 1,\n"
" 2,\n"
" 3,\n"
" 4\n"
" ] /* another array */\n"
"}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
check_json_compliance(info.trace_ptr, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test Opt_trace_context::disable_I_S_for_this_and_children */
TEST_F(TraceContentTest, DisableISWithCall)
{
// Test that it disables even before any start()
trace.disable_I_S_for_this_and_children();
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
{
Opt_trace_array ota(&trace, "one array");
ota.add(200.4);
{
Opt_trace_object oto1(&trace);
oto1.add_alnum("one key", "one value").
add("another key", 100LL);
oto1.add("a third key", false);
Opt_trace_object oto2(&trace, "a fourth key");
oto2.add("key inside", 1LL);
// disabling should apply to substatements too:
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto3(&trace);
}
trace.end();
/* don't disable... but above layer is stronger */
Opt_trace_disable_I_S otd2(&trace, false);
oto2.add("another key inside", 5LL);
// disabling should apply to substatements too:
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto4(&trace);
}
trace.end();
}
ota.add_alnum("one string element");
ota.add(true);
}
oto.add("yet another key", -1000LL);
{
Opt_trace_array ota(&trace, "another array");
ota.add(1LL).add(2LL).add(3LL).add(4LL);
}
}
trace.end();
trace.restore_I_S();
Opt_trace_iterator it(&trace);
ASSERT_TRUE(it.at_end());
}
/** Helper for Trace_settings_test.offset */
void make_one_trace(Opt_trace_context *trace, const char *name,
long offset, long limit)
{
ASSERT_FALSE(trace->start(true, false, true, false, offset, limit,
ULONG_MAX, all_features));
{
Opt_trace_object oto(trace);
oto.add(name, 0LL);
}
trace->end();
}
/**
Helper for Trace_settings_test.offset
@param trace The trace context.
@param names A NULL-terminated array of "names".
Checks that the list of traces is as expected.
This macro checks that the first trace contains names[0], that the second
trace contains names[1], etc. That the number of traces is the same as
the number of elements in "names".
@note It is a macro, for proper reporting of line numbers in case of
assertion failure. SCOPED_TRACE will report line number at the
macro expansion site.
*/
#define check(trace, names) { SCOPED_TRACE(""); do_check(&trace, names); }
void do_check(Opt_trace_context *trace, const char **names)
{
Opt_trace_iterator it(trace);
Opt_trace_info info;
for (const char **name= names ; *name != NULL ; name++)
{
ASSERT_FALSE(it.at_end());
it.get_value(&info);
const size_t name_len= strlen(*name);
EXPECT_EQ(name_len + 11, info.trace_length);
EXPECT_EQ(0, strncmp(info.trace_ptr + 5, *name, name_len));
EXPECT_EQ(0U, info.missing_bytes);
it.next();
}
ASSERT_TRUE(it.at_end());
}
/** Test offset/limit variables */
TEST_F(TraceContentTest, Offset)
{
make_one_trace(&trace, "100", -1 /* offset */, 1 /* limit */);
const char *expected_traces0[]= {"100", NULL};
check(trace, expected_traces0);
make_one_trace(&trace, "101", -1, 1);
/* 101 should have overwritten 100 */
const char *expected_traces1[]= {"101", NULL};
check(trace, expected_traces1);
make_one_trace(&trace, "102", -1, 1);
const char *expected_traces2[]= {"102", NULL};
check(trace, expected_traces2);
trace.reset();
const char *expected_traces_empty[]= {NULL};
check(trace, expected_traces_empty);
make_one_trace(&trace, "103", -3, 2);
make_one_trace(&trace, "104", -3, 2);
make_one_trace(&trace, "105", -3, 2);
make_one_trace(&trace, "106", -3, 2);
make_one_trace(&trace, "107", -3, 2);
make_one_trace(&trace, "108", -3, 2);
make_one_trace(&trace, "109", -3, 2);
const char *expected_traces3[]= {"107", "108", NULL};
check(trace, expected_traces3);
trace.reset();
check(trace, expected_traces_empty);
make_one_trace(&trace, "110", 3, 2);
make_one_trace(&trace, "111", 3, 2);
make_one_trace(&trace, "112", 3, 2);
make_one_trace(&trace, "113", 3, 2);
make_one_trace(&trace, "114", 3, 2);
make_one_trace(&trace, "115", 3, 2);
make_one_trace(&trace, "116", 3, 2);
const char *expected_traces10[]= {"113", "114", NULL};
check(trace, expected_traces10);
trace.reset();
check(trace, expected_traces_empty);
make_one_trace(&trace, "117", 0, 1);
make_one_trace(&trace, "118", 0, 1);
make_one_trace(&trace, "119", 0, 1);
const char *expected_traces17[]= {"117", NULL};
check(trace, expected_traces17);
trace.reset();
make_one_trace(&trace, "120", 0, 0);
make_one_trace(&trace, "121", 0, 0);
make_one_trace(&trace, "122", 0, 0);
const char *expected_traces20[]= {NULL};
check(trace, expected_traces20);
EXPECT_FALSE(oom);
}
/** Test truncation by max_mem_size */
TEST_F(TraceContentTest, MaxMemSize)
{
ASSERT_FALSE(trace.start(true, false, false, false, -1,
1, 1000 /* max_mem_size */, all_features));
/* make a "long" trace */
{
Opt_trace_object oto(&trace);
Opt_trace_array ota(&trace, "one array");
for (int i= 0; i < 100; i++)
{
ota.add_alnum("make it long");
}
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
const char expected[]=
"{\n"
" \"one array\": [\n"
" \"make it long\",\n"
" \"make it long\",\n"
;
/*
Without truncation the trace would take:
2+17+3+1+20*100 = 2023
*/
EXPECT_EQ(996U, info.trace_length);
EXPECT_EQ(1027U, info.missing_bytes); // 996+1027=2023
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
EXPECT_EQ(0, strncmp(expected, info.trace_ptr, sizeof(expected) - 1));
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test how truncation by max_mem_size affects next traces */
TEST_F(TraceContentTest, MaxMemSize2)
{
ASSERT_FALSE(trace.start(true, false, false, false, -2,
2, 21 /* max_mem_size */, all_features));
/* make a "long" trace */
{
Opt_trace_object oto(&trace);
oto.add_alnum("some key1", "make it long");
}
trace.end();
/* A second similar trace */
ASSERT_FALSE(trace.start(true, false, false, false, -2,
2, 21, all_features));
{
Opt_trace_object oto(&trace);
oto.add_alnum("some key2", "make it long");
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
EXPECT_EQ(17U, info.trace_length);
EXPECT_EQ(16U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
it.next();
ASSERT_FALSE(it.at_end());
it.get_value(&info);
/* 2nd trace completely empty as first trace left no room */
EXPECT_EQ(0U, info.trace_length);
EXPECT_EQ(33U, info.missing_bytes);
it.next();
ASSERT_TRUE(it.at_end());
/*
3rd trace; the first one should automatically be purged, thus the 3rd
should have a bit of room.
*/
ASSERT_FALSE(trace.start(true, false, false, false, -2,
2, 21, all_features));
{
Opt_trace_object oto(&trace);
oto.add_alnum("some key3", "make it long");
}
trace.end();
Opt_trace_iterator it2(&trace);
ASSERT_FALSE(it2.at_end());
it2.get_value(&info);
EXPECT_EQ(0U, info.trace_length);
EXPECT_EQ(33U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
it2.next();
it2.get_value(&info);
/*
3rd one had room. A bit less than first, because just reading the second
with the iterator has reallocated the second from 0 to 8 bytes...
*/
EXPECT_EQ(14U, info.trace_length);
EXPECT_EQ(19U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
it2.next();
ASSERT_TRUE(it2.at_end());
}
void open_object(uint count, Opt_trace_context *trace, bool simulate_oom)
{
if (count == 0)
return;
count--;
char key[4];
/*
Add 100 to always have a key of length 3, this matters to
TraceContentTest.Indent.
We could use just a fixed string, but it would cause an assertion failure
(due to invalid JSON, which itself is conceivable in case of OOM).
*/
llstr(100 + count, key);
if (simulate_oom)
{
if (count == 90)
DBUG_SET("+d,opt_trace_oom_in_open_struct");
/*
Now we let 80 objects be created, so that one of them surely hits
re-allocation and OOM failure.
*/
if (count == 10)
DBUG_SET("-d,opt_trace_oom_in_open_struct");
}
Opt_trace_object oto(trace, key);
open_object(count, trace, simulate_oom);
}
#ifndef DBUG_OFF
/// Test reaction to out-of-memory condition in trace buffer
TEST_F(TraceContentTest, OOMinBuffer)
{
ASSERT_FALSE(trace.start(true, false, false, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
{
Opt_trace_array ota(&trace, "one array");
DBUG_SET("+d,opt_trace_oom_in_buffers");
for (int i= 0; i < 30; i++)
ota.add_alnum("_______________________________________________");
DBUG_SET("-d,opt_trace_oom_in_buffers");
}
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
it.next();
ASSERT_TRUE(it.at_end());
EXPECT_TRUE(oom);
}
/// Test reaction to out-of-memory condition in book-keeping data structures
TEST_F(TraceContentTest, OOMinBookKeeping)
{
ASSERT_FALSE(trace.start(true, false, false, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
open_object(100, &trace, true);
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
it.next();
ASSERT_TRUE(it.at_end());
EXPECT_TRUE(oom);
}
/// Test reaction to OOM when purging traces
TEST_F(TraceContentTest, OOMinPurge)
{
make_one_trace(&trace, "103", -3, 2);
make_one_trace(&trace, "104", -3, 2);
DBUG_SET("+d,opt_trace_oom_in_purge");
make_one_trace(&trace, "105", -3, 2);
make_one_trace(&trace, "106", -3, 2);
make_one_trace(&trace, "107", -3, 2);
make_one_trace(&trace, "108", -3, 2);
make_one_trace(&trace, "109", -3, 2);
make_one_trace(&trace, "110", -3, 2);
make_one_trace(&trace, "111", -3, 2);
make_one_trace(&trace, "112", -3, 2);
make_one_trace(&trace, "113", -3, 2);
make_one_trace(&trace, "114", -3, 2);
make_one_trace(&trace, "115", -3, 2);
make_one_trace(&trace, "116", -3, 2);
make_one_trace(&trace, "117", -3, 2);
make_one_trace(&trace, "118", -3, 2);
make_one_trace(&trace, "119", -3, 2);
make_one_trace(&trace, "120", -3, 2);
make_one_trace(&trace, "121", -3, 2);
make_one_trace(&trace, "122", -3, 2); // purge first fails here
DBUG_SET("-d,opt_trace_oom_in_purge");
// 122 could not purge 119, so we should see 119 and 120
const char *expected_traces3[]= {"119", "120", NULL};
check(trace, expected_traces3);
EXPECT_TRUE(oom);
// Back to normal:
oom= false;
make_one_trace(&trace, "123", -3, 2); // purge succeeds
const char *expected_traces4[]= {"121", "122", NULL};
check(trace, expected_traces4);
EXPECT_FALSE(oom);
}
#endif // !DBUG_OFF
/** Test filtering by feature */
TEST_F(TraceContentTest, FilteringByFeature)
{
ASSERT_FALSE(trace.start(true, false, false, false, -1, 1, ULONG_MAX,
Opt_trace_context::MISC));
{
Opt_trace_object oto(&trace);
{
Opt_trace_array ota(&trace, "one array");
ota.add(200.4);
{
Opt_trace_object oto1(&trace, Opt_trace_context::GREEDY_SEARCH);
oto1.add_alnum("one key", "one value").
add("another key", 100LL);
Opt_trace_object oto2(&trace, "a fourth key",
Opt_trace_context::MISC);
oto2.add("another key inside", 5LL);
}
ota.add(true);
}
{
Opt_trace_object oto3(&trace, "key for oto3",
Opt_trace_context::GREEDY_SEARCH);
oto3.add("etc", 25);
}
oto.add("yet another key", -1000LL);
{
Opt_trace_array ota(&trace, "another array");
ota.add(1LL).add(2LL).add(3LL).add(4LL);
}
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
const char expected[]=
"{\n"
" \"one array\": [\n"
" 200.4,\n"
" \"...\",\n"
" true\n"
" ],\n"
" \"key for oto3\": \"...\",\n"
" \"yet another key\": -1000,\n"
" \"another array\": [\n"
" 1,\n"
" 2,\n"
" 3,\n"
" 4\n"
" ]\n"
"}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
check_json_compliance(info.trace_ptr, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test escaping of characters */
TEST_F(TraceContentTest, Escaping)
{
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
// All ASCII 0-127 chars are valid UTF8 encodings
char all_chars[130];
for (uint c= 0; c < sizeof(all_chars) - 2 ; c++)
all_chars[c]= c;
// Now a character with a two-byte code in utf8: ä
all_chars[128]= static_cast<char>(0xc3);
all_chars[129]= static_cast<char>(0xa4);
// all_chars is used both as query...
trace.set_query(all_chars, sizeof(all_chars), system_charset_info);
{
Opt_trace_object oto(&trace);
// ... and inside the trace:
oto.add_utf8("somekey", all_chars, sizeof(all_chars));
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
// we get the trace escaped, JSON-compliant:
const char expected[]=
"{\n"
" \"somekey\": \"\\u0000\\u0001\\u0002\\u0003\\u0004\\u0005\\u0006\\u0007\\u0008\\t\\n\\u000b\\u000c\\r\\u000e\\u000f\\u0010\\u0011\\u0012\\u0013\\u0014\\u0015\\u0016\\u0017\\u0018\\u0019\\u001a\\u001b\\u001c\\u001d\\u001e\\u001f !\\\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\\\]^_`abcdefghijklmnopqrstuvwxyz{|}~ä\"\n"
"}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
check_json_compliance(info.trace_ptr, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
EXPECT_EQ(sizeof(all_chars), info.query_length);
// we get the query unescaped, verbatim, not 0-terminated:
EXPECT_EQ(0, memcmp(all_chars, info.query_ptr, sizeof(all_chars)));
EXPECT_EQ(system_charset_info, info.query_charset);
it.next();
ASSERT_TRUE(it.at_end());
}
/** Test how the system handles non-UTF8 characters, a violation of its API */
TEST_F(TraceContentTest, NonUtf8)
{
ASSERT_FALSE(trace.start(true, false, true, false, -1, 1, ULONG_MAX,
all_features));
/*
A string which starts with invalid utf8 (the four first bytes are éèÄà in
latin1).
In utf8, the following holds
- E0->EF can only be the start of a 3-byte sequence
- C2->DF 2-byte
- ASCII a single-byte sequence
*/
const char all_chars[]= "\xe9\xe8\xc4\xe0" "ABC";
// We declare a query in latin1
trace.set_query(all_chars, sizeof(all_chars), &my_charset_latin1);
{
Opt_trace_object oto(&trace);
/*
We pass the non-utf8-compliant string to add_utf8() (violating the
API). We get it back unchanged. The trace system could try to be robust,
detecting and sanitizing wrong characters (replacing them with '?'); but
it does not bother, as the MySQL Server normally does not violate the
API.
*/
oto.add_utf8("somekey", all_chars, sizeof(all_chars) - 1);
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
// This is not UTF8-compliant and thus not JSON-compliant.
const char expected[]=
"{\n"
" \"somekey\": \"" "\xe9\xe8\xc4\xe0" "ABC\"\n"
"}";
EXPECT_STREQ(expected, info.trace_ptr);
EXPECT_EQ(sizeof(expected) - 1, info.trace_length);
EXPECT_EQ(0U, info.missing_bytes);
EXPECT_FALSE(info.missing_priv);
EXPECT_FALSE(oom);
EXPECT_EQ(sizeof(all_chars), info.query_length);
// we get the query unescaped, verbatim, not 0-terminated:
EXPECT_EQ(0, memcmp(all_chars, info.query_ptr, sizeof(all_chars)));
it.next();
ASSERT_TRUE(it.at_end());
}
/**
Test indentation by many blanks.
By creating a 100-level deep structure, we force an indentation which
enters the while() block in Opt_trace_stmt::next_line().
*/
TEST_F(TraceContentTest, Indent)
{
ASSERT_FALSE(trace.start(true, false, false, false, -1, 1, ULONG_MAX,
all_features));
{
Opt_trace_object oto(&trace);
open_object(100, &trace, false);
}
trace.end();
Opt_trace_iterator it(&trace);
ASSERT_FALSE(it.at_end());
Opt_trace_info info;
it.get_value(&info);
/*
Formula for the expected size.
Before the Nth call to open_object(), indentation inside the innermost
empty object is noted I(N); so the relationship between the size before
Nth call and the size after Nth call is:
S(N+1) = S(N)
+ I(N) (indentation before added '"xxx": {\n' )
+ 9 (length of added '"xxx": {\n' )
+ I(N) (indentation before added '}\n' )
+ 2 (length of added '}\n' )
and the indentation is increased by two as we are one level deeper:
I(N+1) = I(N) + 2
With S(1) = 3 (length of '{\n}') and I(1) = 2.
So I(N) = 2 * N and
S(N+1) - S(N) = 11 + 4 * N
So S(N) = 3 + 11 * (N - 1) + 2 * N * (N - 1).
For 100 calls, the final size is S(101) = 21303.
Each call adds 10 non-space characters, so there should be
21303
- 10 * 100 (added non-spaces characters)
- 3 (non-spaces of initial object before first function call)
= 20300 spaces.
*/
EXPECT_EQ(21303U, info.trace_length);
uint spaces= 0;
for (uint i= 0; i < info.trace_length; i++)
if (info.trace_ptr[i] == ' ')
spaces++;