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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
sql / database_unittest.cc [blame]
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40285824): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
#include "sql/database.h"
#include <stddef.h>
#include <stdint.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <memory>
#include <optional>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
#include "base/check.h"
#include "base/containers/contains.h"
#include "base/containers/span.h"
#include "base/files/file.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/functional/bind.h"
#include "base/functional/callback_helpers.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/scoped_refptr.h"
#include "base/ranges/algorithm.h"
#include "base/run_loop.h"
#include "base/sequence_checker.h"
#include "base/strings/cstring_view.h"
#include "base/strings/string_number_conversions.h"
#include "base/task/sequenced_task_runner.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "base/test/bind.h"
#include "base/test/gtest_util.h"
#include "base/test/metrics/histogram_tester.h"
#include "base/test/task_environment.h"
#include "base/thread_annotations.h"
#include "base/trace_event/memory_dump_request_args.h"
#include "base/trace_event/process_memory_dump.h"
#include "build/build_config.h"
#include "sql/database_memory_dump_provider.h"
#include "sql/meta_table.h"
#include "sql/recovery.h"
#include "sql/statement.h"
#include "sql/statement_id.h"
#include "sql/test/scoped_error_expecter.h"
#include "sql/test/test_helpers.h"
#include "sql/transaction.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "third_party/abseil-cpp/absl/cleanup/cleanup.h"
#include "third_party/sqlite/sqlite3.h"
#if BUILDFLAG(IS_WIN)
#include "base/strings/strcat.h"
#endif
namespace sql {
namespace {
using sql::test::ExecuteWithResult;
// Helper to return the count of items in sqlite_schema. Return -1 in
// case of error.
int SqliteSchemaCount(Database* db) {
static constexpr char kSchemaCount[] = "SELECT COUNT(*) FROM sqlite_schema";
Statement s(db->GetUniqueStatement(kSchemaCount));
return s.Step() ? s.ColumnInt(0) : -1;
}
// Handle errors by blowing away the database.
void RazeErrorCallback(Database* db,
int expected_error,
int error,
Statement* stmt) {
// Nothing here needs extended errors at this time.
EXPECT_EQ(expected_error, expected_error & 0xff);
EXPECT_EQ(expected_error, error & 0xff);
db->RazeAndPoison();
}
#if BUILDFLAG(IS_POSIX)
// Set a umask and restore the old mask on destruction. Cribbed from
// shared_memory_unittest.cc. Used by POSIX-only UserPermission test.
class ScopedUmaskSetter {
public:
explicit ScopedUmaskSetter(mode_t target_mask) {
old_umask_ = umask(target_mask);
}
~ScopedUmaskSetter() { umask(old_umask_); }
ScopedUmaskSetter(const ScopedUmaskSetter&) = delete;
ScopedUmaskSetter& operator=(const ScopedUmaskSetter&) = delete;
private:
mode_t old_umask_;
};
#endif // BUILDFLAG(IS_POSIX)
bool IsOpenedInCorrectJournalMode(Database* db, bool is_wal) {
std::string expected_mode = is_wal ? "wal" : "truncate";
return ExecuteWithResult(db, "PRAGMA journal_mode") == expected_mode;
}
} // namespace
// We use the parameter to run all tests with WAL mode on and off.
class SQLDatabaseTest : public testing::Test,
public testing::WithParamInterface<bool> {
public:
enum class OverwriteType {
kTruncate,
kOverwrite,
};
~SQLDatabaseTest() override = default;
void SetUp() override {
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
db_path_ = temp_dir_.GetPath().AppendASCII("database_test.sqlite");
CreateFreshDB();
}
// Resets the database handle and deletes the backing file. On return, `db_`
// has just been opened on a fresh temp file named by `db_path_`.
void CreateFreshDB() {
ASSERT_FALSE(db_path_.empty());
db_.reset();
ASSERT_TRUE(base::DeleteFile(db_path_));
db_ = std::make_unique<Database>(GetDBOptions(), test::kTestTag);
ASSERT_TRUE(db_->Open(db_path_));
ASSERT_TRUE(base::PathExists(db_path_));
}
DatabaseOptions GetDBOptions() {
DatabaseOptions options;
options.wal_mode = IsWALEnabled();
// TODO(crbug.com/40146017): Remove after switching to exclusive mode on by
// default.
options.exclusive_locking = false;
#if BUILDFLAG(IS_FUCHSIA) // Exclusive mode needs to be enabled to enter WAL
// mode on Fuchsia
if (IsWALEnabled()) {
options.exclusive_locking = true;
}
#endif // BUILDFLAG(IS_FUCHSIA)
return options;
}
bool IsWALEnabled() { return GetParam(); }
bool TruncateDatabase() {
base::File file(db_path_,
base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE);
return file.SetLength(0);
}
bool OverwriteDatabaseHeader(OverwriteType type) {
base::File file(db_path_,
base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE);
if (type == OverwriteType::kTruncate) {
if (!file.SetLength(0))
return false;
}
static constexpr char kText[] = "Now is the winter of our discontent.";
constexpr int kTextBytes = sizeof(kText) - 1;
return file.Write(0, kText, kTextBytes) == kTextBytes;
}
protected:
base::ScopedTempDir temp_dir_;
base::FilePath db_path_;
std::unique_ptr<Database> db_;
};
TEST_P(SQLDatabaseTest, Execute_ValidStatement) {
ASSERT_TRUE(db_->Execute("CREATE TABLE data(contents TEXT)"));
EXPECT_EQ(SQLITE_OK, db_->GetErrorCode());
}
TEST_P(SQLDatabaseTest, Execute_InvalidStatement) {
{
sql::test::ScopedErrorExpecter error_expecter;
error_expecter.ExpectError(SQLITE_ERROR);
EXPECT_FALSE(db_->Execute("CREATE TABLE data("));
EXPECT_TRUE(error_expecter.SawExpectedErrors());
}
EXPECT_EQ(SQLITE_ERROR, db_->GetErrorCode());
}
TEST_P(SQLDatabaseTest, ExecuteScriptForTesting_OneLineValid) {
ASSERT_TRUE(db_->ExecuteScriptForTesting("CREATE TABLE data(contents TEXT)"));
EXPECT_EQ(SQLITE_OK, db_->GetErrorCode());
}
TEST_P(SQLDatabaseTest, ExecuteScriptForTesting_OneLineInvalid) {
ASSERT_FALSE(db_->ExecuteScriptForTesting("CREATE TABLE data("));
EXPECT_EQ(SQLITE_ERROR, db_->GetErrorCode());
}
TEST_P(SQLDatabaseTest, ExecuteScriptForTesting_ExtraContents) {
EXPECT_TRUE(db_->ExecuteScriptForTesting("CREATE TABLE data1(id)"))
<< "Minimal statement";
EXPECT_TRUE(db_->ExecuteScriptForTesting("CREATE TABLE data2(id);"))
<< "Extra semicolon";
EXPECT_TRUE(db_->ExecuteScriptForTesting("CREATE TABLE data3(id) -- Comment"))
<< "Trailing comment";
EXPECT_TRUE(db_->ExecuteScriptForTesting(
"CREATE TABLE data4(id);CREATE TABLE data5(id)"))
<< "Extra statement without whitespace";
EXPECT_TRUE(db_->ExecuteScriptForTesting(
"CREATE TABLE data6(id); CREATE TABLE data7(id)"))
<< "Extra statement separated by whitespace";
EXPECT_TRUE(db_->ExecuteScriptForTesting("CREATE TABLE data8(id);-- Comment"))
<< "Comment without whitespace";
EXPECT_TRUE(
db_->ExecuteScriptForTesting("CREATE TABLE data9(id); -- Comment"))
<< "Comment sepatated by whitespace";
}
TEST_P(SQLDatabaseTest, ExecuteScriptForTesting_MultipleValidLines) {
EXPECT_TRUE(db_->ExecuteScriptForTesting(R"(
CREATE TABLE data1(contents TEXT);
CREATE TABLE data2(contents TEXT);
CREATE TABLE data3(contents TEXT);
)"));
EXPECT_EQ(SQLITE_OK, db_->GetErrorCode());
// DoesColumnExist() is implemented directly on top of a SQLite call. The
// other schema functions use sql::Statement infrastructure to query the
// schema table.
EXPECT_TRUE(db_->DoesColumnExist("data1", "contents"));
EXPECT_TRUE(db_->DoesColumnExist("data2", "contents"));
EXPECT_TRUE(db_->DoesColumnExist("data3", "contents"));
}
TEST_P(SQLDatabaseTest, ExecuteScriptForTesting_StopsOnCompileError) {
EXPECT_FALSE(db_->ExecuteScriptForTesting(R"(
CREATE TABLE data1(contents TEXT);
CREATE TABLE data1();
CREATE TABLE data3(contents TEXT);
)"));
EXPECT_EQ(SQLITE_ERROR, db_->GetErrorCode());
EXPECT_TRUE(db_->DoesColumnExist("data1", "contents"));
EXPECT_FALSE(db_->DoesColumnExist("data3", "contents"));
}
TEST_P(SQLDatabaseTest, ExecuteScriptForTesting_StopsOnStepError) {
EXPECT_FALSE(db_->ExecuteScriptForTesting(R"(
CREATE TABLE data1(contents TEXT UNIQUE);
INSERT INTO data1(contents) VALUES('value1');
INSERT INTO data1(contents) VALUES('value1');
CREATE TABLE data3(contents TEXT);
)"));
EXPECT_EQ(SQLITE_CONSTRAINT_UNIQUE, db_->GetErrorCode());
EXPECT_TRUE(db_->DoesColumnExist("data1", "contents"));
EXPECT_FALSE(db_->DoesColumnExist("data3", "contents"));
}
TEST_P(SQLDatabaseTest, CachedStatement) {
StatementID id1 = SQL_FROM_HERE;
StatementID id2 = SQL_FROM_HERE;
static constexpr char kId1Sql[] = "SELECT a FROM foo";
static constexpr char kId2Sql[] = "SELECT b FROM foo";
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (a, b)"));
ASSERT_TRUE(db_->Execute("INSERT INTO foo(a, b) VALUES (12, 13)"));
sqlite3_stmt* raw_id1_statement;
sqlite3_stmt* raw_id2_statement;
{
scoped_refptr<Database::StatementRef> ref_from_id1 =
db_->GetCachedStatement(id1, kId1Sql);
raw_id1_statement = ref_from_id1->stmt();
Statement from_id1(std::move(ref_from_id1));
ASSERT_TRUE(from_id1.is_valid());
ASSERT_TRUE(from_id1.Step());
EXPECT_EQ(12, from_id1.ColumnInt(0));
scoped_refptr<Database::StatementRef> ref_from_id2 =
db_->GetCachedStatement(id2, kId2Sql);
raw_id2_statement = ref_from_id2->stmt();
EXPECT_NE(raw_id1_statement, raw_id2_statement);
Statement from_id2(std::move(ref_from_id2));
ASSERT_TRUE(from_id2.is_valid());
ASSERT_TRUE(from_id2.Step());
EXPECT_EQ(13, from_id2.ColumnInt(0));
}
{
scoped_refptr<Database::StatementRef> ref_from_id1 =
db_->GetCachedStatement(id1, kId1Sql);
EXPECT_EQ(raw_id1_statement, ref_from_id1->stmt())
<< "statement was not cached";
Statement from_id1(std::move(ref_from_id1));
ASSERT_TRUE(from_id1.is_valid());
ASSERT_TRUE(from_id1.Step()) << "cached statement was not reset";
EXPECT_EQ(12, from_id1.ColumnInt(0));
scoped_refptr<Database::StatementRef> ref_from_id2 =
db_->GetCachedStatement(id2, kId2Sql);
EXPECT_EQ(raw_id2_statement, ref_from_id2->stmt())
<< "statement was not cached";
Statement from_id2(std::move(ref_from_id2));
ASSERT_TRUE(from_id2.is_valid());
ASSERT_TRUE(from_id2.Step()) << "cached statement was not reset";
EXPECT_EQ(13, from_id2.ColumnInt(0));
}
EXPECT_DCHECK_DEATH(db_->GetCachedStatement(id1, kId2Sql))
<< "Using a different SQL with the same statement ID should DCHECK";
EXPECT_DCHECK_DEATH(db_->GetCachedStatement(id2, kId1Sql))
<< "Using a different SQL with the same statement ID should DCHECK";
}
TEST_P(SQLDatabaseTest, IsSQLValidTest) {
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (a, b)"));
ASSERT_TRUE(db_->IsSQLValid("SELECT a FROM foo"));
ASSERT_FALSE(db_->IsSQLValid("SELECT no_exist FROM foo"));
}
TEST_P(SQLDatabaseTest, DoesTableExist) {
EXPECT_FALSE(db_->DoesTableExist("foo"));
EXPECT_FALSE(db_->DoesTableExist("foo_index"));
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (a, b)"));
ASSERT_TRUE(db_->Execute("CREATE INDEX foo_index ON foo (a)"));
EXPECT_TRUE(db_->DoesTableExist("foo"));
EXPECT_FALSE(db_->DoesTableExist("foo_index"));
// DoesTableExist() is case-sensitive.
EXPECT_FALSE(db_->DoesTableExist("Foo"));
EXPECT_FALSE(db_->DoesTableExist("FOO"));
}
TEST_P(SQLDatabaseTest, DoesIndexExist) {
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (a, b)"));
EXPECT_FALSE(db_->DoesIndexExist("foo"));
EXPECT_FALSE(db_->DoesIndexExist("foo_ubdex"));
ASSERT_TRUE(db_->Execute("CREATE INDEX foo_index ON foo (a)"));
EXPECT_TRUE(db_->DoesIndexExist("foo_index"));
EXPECT_FALSE(db_->DoesIndexExist("foo"));
// DoesIndexExist() is case-sensitive.
EXPECT_FALSE(db_->DoesIndexExist("Foo_index"));
EXPECT_FALSE(db_->DoesIndexExist("Foo_Index"));
EXPECT_FALSE(db_->DoesIndexExist("FOO_INDEX"));
}
TEST_P(SQLDatabaseTest, DoesViewExist) {
EXPECT_FALSE(db_->DoesViewExist("voo"));
ASSERT_TRUE(db_->Execute("CREATE VIEW voo (a) AS SELECT 1"));
EXPECT_FALSE(db_->DoesIndexExist("voo"));
EXPECT_FALSE(db_->DoesTableExist("voo"));
EXPECT_TRUE(db_->DoesViewExist("voo"));
// DoesTableExist() is case-sensitive.
EXPECT_FALSE(db_->DoesViewExist("Voo"));
EXPECT_FALSE(db_->DoesViewExist("VOO"));
}
TEST_P(SQLDatabaseTest, DoesColumnExist) {
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (a, b)"));
EXPECT_FALSE(db_->DoesColumnExist("foo", "bar"));
EXPECT_TRUE(db_->DoesColumnExist("foo", "a"));
ASSERT_FALSE(db_->DoesTableExist("bar"));
EXPECT_FALSE(db_->DoesColumnExist("bar", "b"));
// SQLite resolves table/column names without case sensitivity.
EXPECT_TRUE(db_->DoesColumnExist("FOO", "A"));
EXPECT_TRUE(db_->DoesColumnExist("FOO", "a"));
EXPECT_TRUE(db_->DoesColumnExist("foo", "A"));
}
TEST_P(SQLDatabaseTest, GetLastInsertRowId) {
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (id INTEGER PRIMARY KEY, value)"));
ASSERT_TRUE(db_->Execute("INSERT INTO foo (value) VALUES (12)"));
// Last insert row ID should be valid.
int64_t row = db_->GetLastInsertRowId();
EXPECT_LT(0, row);
// It should be the primary key of the row we just inserted.
Statement s(db_->GetUniqueStatement("SELECT value FROM foo WHERE id=?"));
s.BindInt64(0, row);
ASSERT_TRUE(s.Step());
EXPECT_EQ(12, s.ColumnInt(0));
}
// Test the scoped error expecter by attempting to insert a duplicate
// value into an index.
TEST_P(SQLDatabaseTest, ScopedErrorExpecter) {
static constexpr char kCreateSql[] = "CREATE TABLE foo (id INTEGER UNIQUE)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_TRUE(db_->Execute("INSERT INTO foo (id) VALUES (12)"));
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_CONSTRAINT);
ASSERT_FALSE(db_->Execute("INSERT INTO foo (id) VALUES (12)"));
ASSERT_TRUE(expecter.SawExpectedErrors());
}
}
TEST_P(SQLDatabaseTest, SchemaIntrospectionUsesErrorExpecter) {
static constexpr char kCreateSql[] = "CREATE TABLE foo (id INTEGER UNIQUE)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_FALSE(db_->DoesTableExist("bar"));
ASSERT_TRUE(db_->DoesTableExist("foo"));
ASSERT_TRUE(db_->DoesColumnExist("foo", "id"));
db_->Close();
// Corrupt the database so that nothing works, including PRAGMAs.
ASSERT_TRUE(sql::test::CorruptSizeInHeader(db_path_));
{
base::HistogramTester tester;
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_CORRUPT);
ASSERT_FALSE(db_->Open(db_path_));
ASSERT_FALSE(db_->DoesTableExist("bar"));
ASSERT_FALSE(db_->DoesTableExist("foo"));
ASSERT_FALSE(db_->DoesColumnExist("foo", "id"));
ASSERT_TRUE(expecter.SawExpectedErrors());
tester.ExpectUniqueSample("Sql.Database.Open.FirstAttempt.Error.Test",
SqliteResultCode::kCorrupt, 1);
}
}
TEST_P(SQLDatabaseTest, SetErrorCallback) {
static constexpr char kCreateSql[] =
"CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
bool error_callback_called = false;
int error = SQLITE_OK;
db_->set_error_callback(base::BindLambdaForTesting(
[&](int sqlite_error, sql::Statement* statement) {
error_callback_called = true;
error = sqlite_error;
}));
EXPECT_FALSE(db_->Execute("INSERT INTO rows(id) VALUES(12)"))
<< "Inserting a duplicate primary key should have failed";
EXPECT_TRUE(error_callback_called)
<< "Execute() should report errors to the database error callback";
EXPECT_EQ(SQLITE_CONSTRAINT_PRIMARYKEY, error)
<< "Execute() should report errors to the database error callback";
}
TEST_P(SQLDatabaseTest, SetErrorCallbackDchecksOnExistingCallback) {
db_->set_error_callback(base::DoNothing());
EXPECT_DCHECK_DEATH(db_->set_error_callback(base::DoNothing()))
<< "set_error_callback() should DCHECK if error callback already exists";
}
TEST_P(SQLDatabaseTest, ResetErrorCallback) {
static constexpr char kCreateSql[] =
"CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
bool error_callback_called = false;
int error = SQLITE_OK;
db_->set_error_callback(
base::BindLambdaForTesting([&](int sqlite_error, Statement* statement) {
error_callback_called = true;
error = sqlite_error;
}));
db_->reset_error_callback();
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_CONSTRAINT);
EXPECT_FALSE(db_->Execute("INSERT INTO rows(id) VALUES(12)"))
<< "Inserting a duplicate primary key should have failed";
EXPECT_TRUE(expecter.SawExpectedErrors())
<< "Inserting a duplicate primary key should have failed";
}
EXPECT_FALSE(error_callback_called)
<< "Execute() should not report errors after reset_error_callback()";
EXPECT_EQ(SQLITE_OK, error)
<< "Execute() should not report errors after reset_error_callback()";
}
// Regression test for https://crbug.com/1522873
TEST_P(SQLDatabaseTest, ErrorCallbackThatClosesDb) {
for (const bool reopen_db : {false, true}) {
SCOPED_TRACE(::testing::Message() << "reopen_db: " << reopen_db);
// Ensure that `db_` is fresh in this iteration.
CreateFreshDB();
static constexpr char kCreateSql[] =
"CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
bool error_callback_called = false;
int error = SQLITE_OK;
db_->set_error_callback(
base::BindLambdaForTesting([&](int sqlite_error, Statement* statement) {
error_callback_called = true;
error = sqlite_error;
db_->Close();
if (reopen_db) {
ASSERT_TRUE(db_->Open(db_path_));
}
}));
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_CONSTRAINT);
EXPECT_FALSE(db_->Execute("INSERT INTO rows(id) VALUES(12)"))
<< "Inserting a duplicate primary key should have failed";
EXPECT_TRUE(expecter.SawExpectedErrors())
<< "Inserting a duplicate primary key should have failed";
}
EXPECT_TRUE(error_callback_called);
EXPECT_EQ(SQLITE_CONSTRAINT_PRIMARYKEY, error);
EXPECT_EQ(db_->is_open(), reopen_db);
}
}
TEST_P(SQLDatabaseTest, DetachFromSequence) {
base::test::TaskEnvironment task_environment;
// Get a task runner so we can post tasks to different sequence.
scoped_refptr<base::SequencedTaskRunner> task_runner =
base::ThreadPool::CreateSequencedTaskRunner({base::MayBlock()});
ASSERT_FALSE(task_runner->RunsTasksInCurrentSequence());
// The database's sequence checker is already implicitly attached to the
// current sequence because the test fixture opened it.
ASSERT_TRUE(db_->is_open());
// Detach before moving the Database instance to another sequence. Note that
// it will be destroyed on the other sequence.
db_->DetachFromSequence();
base::RunLoop run_loop;
task_runner->PostTaskAndReply(
FROM_HERE,
base::BindOnce(
[](std::unique_ptr<Database> db) {
static constexpr char kCreateSql[] =
"CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)";
ASSERT_TRUE(db->Execute(kCreateSql));
},
std::move(db_)),
run_loop.QuitClosure());
run_loop.Run();
}
// Regression test for https://crbug.com/1522873
TEST_P(SQLDatabaseTest, ErrorCallbackThatFreesDatabase) {
static constexpr char kCreateSql[] =
"CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
bool error_callback_called = false;
int error = SQLITE_OK;
db_->set_error_callback(
base::BindLambdaForTesting([&](int sqlite_error, Statement* statement) {
error_callback_called = true;
error = sqlite_error;
db_.reset();
}));
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_CONSTRAINT);
EXPECT_FALSE(db_->Execute("INSERT INTO rows(id) VALUES(12)"))
<< "Inserting a duplicate primary key should have failed";
EXPECT_TRUE(expecter.SawExpectedErrors())
<< "Inserting a duplicate primary key should have failed";
}
EXPECT_TRUE(error_callback_called);
EXPECT_EQ(SQLITE_CONSTRAINT_PRIMARYKEY, error);
}
// Sets a flag to true/false to track being alive.
class LifeTracker {
public:
explicit LifeTracker(bool* flag_ptr) : flag_ptr_(flag_ptr) {
DCHECK(flag_ptr != nullptr);
DCHECK(!*flag_ptr)
<< "LifeTracker's flag should be set to false prior to construction";
*flag_ptr_ = true;
}
LifeTracker(LifeTracker&& rhs) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK_CALLED_ON_VALID_SEQUENCE(rhs.sequence_checker_);
flag_ptr_ = rhs.flag_ptr_;
rhs.flag_ptr_ = nullptr;
}
// base::RepeatingCallback only requires move-construction support.
LifeTracker& operator=(const LifeTracker& rhs) = delete;
~LifeTracker() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (flag_ptr_)
*flag_ptr_ = false;
}
private:
SEQUENCE_CHECKER(sequence_checker_);
raw_ptr<bool> flag_ptr_ GUARDED_BY_CONTEXT(sequence_checker_);
};
int TestVfsOpen(sqlite3_vfs* vfs,
const char* full_path,
sqlite3_file* result_file,
int requested_flags,
int* granted_flags) {
uint64_t* call_count = reinterpret_cast<uint64_t*>(vfs->pAppData);
++*call_count;
return SQLITE_ERROR;
}
int TestVfsFullPathname(sqlite3_vfs* vfs,
const char* file_path,
int result_size,
char* result) {
uint64_t* call_count = reinterpret_cast<uint64_t*>(vfs->pAppData);
++*call_count;
if (result_size < 0) {
return SQLITE_CANTOPEN;
}
const size_t expected_result_size = result_size;
base::cstring_view file_path_view(file_path);
if (expected_result_size < file_path_view.size() + sizeof(*file_path)) {
return SQLITE_CANTOPEN;
}
// `copy()` returns an output iterator just past the last char copied. Write
// the string terminator to that location.
*base::ranges::copy(file_path_view,
base::span(result, expected_result_size).begin()) = 0;
return SQLITE_OK;
}
TEST_P(SQLDatabaseTest, UseVfs) {
uint64_t call_count = 0;
constexpr const char kVFSName[] = "test_vfs";
static constexpr int kSqliteVfsApiVersion = 3;
static constexpr int kSqliteMaxPathSize = 512;
sqlite3_vfs vfs{
kSqliteVfsApiVersion,
sizeof(sqlite3_vfs),
kSqliteMaxPathSize,
/*pNext=*/nullptr,
kVFSName,
// Provide pointer to `call_count` so it can be modified from within calls
// to the VFS and used in test assertions.
/*pAppData=*/&call_count,
TestVfsOpen,
/*xDelete*/ nullptr,
/*xAccess*/ nullptr,
TestVfsFullPathname,
/*xDlOpen=*/nullptr,
/*xDlError=*/nullptr,
/*xDlSym=*/nullptr,
/*xDlClose=*/nullptr,
/*xRandomness*/ nullptr,
/*xSleep*/ nullptr,
/*xCurrentTime=*/nullptr,
/*xGetLastError*/ nullptr,
/*xCurrentTimeInt64*/ nullptr,
/*xSetSystemCall=*/nullptr,
/*xGetSystemCall=*/nullptr,
/*xNextSystemCall=*/nullptr,
};
sqlite3_vfs_register(&vfs, /*makeDflt=*/false);
absl::Cleanup vfs_unregisterer = [&vfs]() { sqlite3_vfs_unregister(&vfs); };
DatabaseOptions options = GetDBOptions();
options.vfs_name_discouraged = kVFSName;
Database other_db(options, test::kTestTag);
// Since the vfs's Open function is not implemented `Open()` will fail.
ASSERT_FALSE(other_db.Open(db_path_));
// Vfs implementation called twice, once for open and once for path name.
ASSERT_EQ(call_count, 2ull);
}
// base::BindRepeating() can curry arguments to be passed by const reference to
// the callback function. If the error callback function calls
// reset_error_callback() and the Database doesn't hang onto the callback while
// running it, the storage for those arguments may be deleted while the callback
// function is executing. This test ensures that the database is hanging onto
// the callback while running it.
TEST_P(SQLDatabaseTest, ErrorCallbackStorageProtectedWhileRun) {
bool is_alive = false;
db_->set_error_callback(base::BindRepeating(
[](Database* db, bool* life_tracker_is_alive,
const LifeTracker& life_tracker, int sqlite_error,
Statement* statement) {
EXPECT_TRUE(*life_tracker_is_alive)
<< "The error callback storage should be alive when it is Run()";
db->reset_error_callback();
EXPECT_TRUE(*life_tracker_is_alive)
<< "The error storage should remain alive during Run() after "
<< "reset_error_callback()";
},
base::Unretained(db_.get()), base::Unretained(&is_alive),
LifeTracker(&is_alive)));
EXPECT_TRUE(is_alive)
<< "The error callback storage should be alive after creation";
EXPECT_FALSE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
EXPECT_FALSE(is_alive)
<< "The error callback storage should be released after Run() completes";
}
TEST_P(SQLDatabaseTest, Execute_CompilationError) {
bool error_callback_called = false;
db_->set_error_callback(base::BindLambdaForTesting([&](int error,
sql::Statement*
statement) {
EXPECT_EQ(SQLITE_ERROR, error);
EXPECT_EQ(nullptr, statement);
EXPECT_FALSE(error_callback_called)
<< "SQL compilation errors should call the error callback exactly once";
error_callback_called = true;
}));
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_ERROR);
EXPECT_FALSE(db_->Execute("SELECT missing_column FROM missing_table"));
EXPECT_TRUE(expecter.SawExpectedErrors());
}
EXPECT_TRUE(error_callback_called)
<< "SQL compilation errors should call the error callback";
}
TEST_P(SQLDatabaseTest, GetUniqueStatement_CompilationError) {
bool error_callback_called = false;
db_->set_error_callback(base::BindLambdaForTesting([&](int error,
sql::Statement*
statement) {
EXPECT_EQ(SQLITE_ERROR, error);
EXPECT_EQ(nullptr, statement);
EXPECT_FALSE(error_callback_called)
<< "SQL compilation errors should call the error callback exactly once";
error_callback_called = true;
}));
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_ERROR);
sql::Statement statement(
db_->GetUniqueStatement("SELECT missing_column FROM missing_table"));
EXPECT_FALSE(statement.is_valid());
EXPECT_TRUE(expecter.SawExpectedErrors());
}
EXPECT_TRUE(error_callback_called)
<< "SQL compilation errors should call the error callback";
}
TEST_P(SQLDatabaseTest, GetCachedStatement_CompilationError) {
bool error_callback_called = false;
db_->set_error_callback(base::BindLambdaForTesting([&](int error,
sql::Statement*
statement) {
EXPECT_EQ(SQLITE_ERROR, error);
EXPECT_EQ(nullptr, statement);
EXPECT_FALSE(error_callback_called)
<< "SQL compilation errors should call the error callback exactly once";
error_callback_called = true;
}));
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_ERROR);
sql::Statement statement(db_->GetCachedStatement(
SQL_FROM_HERE, "SELECT missing_column FROM missing_table"));
EXPECT_FALSE(statement.is_valid());
EXPECT_TRUE(expecter.SawExpectedErrors());
}
EXPECT_TRUE(error_callback_called)
<< "SQL compilation errors should call the error callback";
}
TEST_P(SQLDatabaseTest, GetUniqueStatement_ExtraContents) {
sql::Statement minimal(db_->GetUniqueStatement("SELECT 1"));
sql::Statement extra_semicolon(db_->GetUniqueStatement("SELECT 1;"));
// It would be nice to flag trailing comments too, as they cost binary size.
// However, there's no easy way of doing that.
sql::Statement trailing_comment(
db_->GetUniqueStatement("SELECT 1 -- Comment"));
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement("SELECT 1;SELECT 2"))
<< "Extra statement without whitespace";
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement("SELECT 1; SELECT 2"))
<< "Extra statement separated by whitespace";
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement("SELECT 1;-- Comment"))
<< "Comment without whitespace";
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement("SELECT 1; -- Comment"))
<< "Comment separated by whitespace";
}
TEST_P(SQLDatabaseTest, GetCachedStatement_ExtraContents) {
sql::Statement minimal(db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1"));
sql::Statement extra_semicolon(
db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1;"));
// It would be nice to flag trailing comments too, as they cost binary size.
// However, there's no easy way of doing that.
sql::Statement trailing_comment(
db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1 -- Comment"));
EXPECT_DCHECK_DEATH(
db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1;SELECT 2"))
<< "Extra statement without whitespace";
EXPECT_DCHECK_DEATH(
db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1; SELECT 2"))
<< "Extra statement separated by whitespace";
EXPECT_DCHECK_DEATH(
db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1;-- Comment"))
<< "Comment without whitespace";
EXPECT_DCHECK_DEATH(
db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1; -- Comment"))
<< "Comment separated by whitespace";
}
TEST_P(SQLDatabaseTest, IsSQLValid_ExtraContents) {
EXPECT_TRUE(db_->IsSQLValid("SELECT 1"));
EXPECT_TRUE(db_->IsSQLValid("SELECT 1;"))
<< "Trailing semicolons are currently tolerated";
// It would be nice to flag trailing comments too, as they cost binary size.
// However, there's no easy way of doing that.
EXPECT_TRUE(db_->IsSQLValid("SELECT 1 -- Comment"))
<< "Trailing comments are currently tolerated";
EXPECT_DCHECK_DEATH(db_->IsSQLValid("SELECT 1;SELECT 2"))
<< "Extra statement without whitespace";
EXPECT_DCHECK_DEATH(db_->IsSQLValid("SELECT 1; SELECT 2"))
<< "Extra statement separated by whitespace";
EXPECT_DCHECK_DEATH(db_->IsSQLValid("SELECT 1;-- Comment"))
<< "Comment without whitespace";
EXPECT_DCHECK_DEATH(db_->IsSQLValid("SELECT 1; -- Comment"))
<< "Comment separated by whitespace";
}
TEST_P(SQLDatabaseTest, GetUniqueStatement_NoContents) {
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement("")) << "Empty string";
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement(" ")) << "Space";
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement("\n")) << "Newline";
EXPECT_DCHECK_DEATH(db_->GetUniqueStatement("-- Comment")) << "Comment";
}
TEST_P(SQLDatabaseTest, GetCachedStatement_NoContents) {
EXPECT_DCHECK_DEATH(db_->GetCachedStatement(SQL_FROM_HERE, ""))
<< "Empty string";
EXPECT_DCHECK_DEATH(db_->GetCachedStatement(SQL_FROM_HERE, " ")) << "Space";
EXPECT_DCHECK_DEATH(db_->GetCachedStatement(SQL_FROM_HERE, "\n"))
<< "Newline";
EXPECT_DCHECK_DEATH(db_->GetCachedStatement(SQL_FROM_HERE, "-- Comment"))
<< "Comment";
}
TEST_P(SQLDatabaseTest, GetReadonlyStatement) {
static constexpr char kCreateSql[] =
"CREATE TABLE foo (id INTEGER PRIMARY KEY, value)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_TRUE(db_->Execute("INSERT INTO foo (value) VALUES (12)"));
// PRAGMA statements do not change the database file.
{
Statement s(db_->GetReadonlyStatement("PRAGMA analysis_limit"));
ASSERT_TRUE(s.Step());
}
{
Statement s(db_->GetReadonlyStatement("PRAGMA analysis_limit=100"));
ASSERT_TRUE(s.is_valid());
}
// Create and insert statements should fail, while the same queries as unique
// statement succeeds.
{
Statement s(db_->GetReadonlyStatement(
"CREATE TABLE IF NOT EXISTS foo (id INTEGER PRIMARY KEY, value)"));
ASSERT_FALSE(s.is_valid());
Statement s1(db_->GetUniqueStatement(
"CREATE TABLE IF NOT EXISTS foo (id INTEGER PRIMARY KEY, value)"));
ASSERT_TRUE(s1.is_valid());
}
{
Statement s(
db_->GetReadonlyStatement("INSERT INTO foo (value) VALUES (12)"));
ASSERT_FALSE(s.is_valid());
Statement s1(
db_->GetUniqueStatement("INSERT INTO foo (value) VALUES (12)"));
ASSERT_TRUE(s1.is_valid());
}
{
Statement s(
db_->GetReadonlyStatement("CREATE VIRTUAL TABLE bar USING module"));
ASSERT_FALSE(s.is_valid());
Statement s1(
db_->GetUniqueStatement("CREATE VIRTUAL TABLE bar USING module"));
ASSERT_TRUE(s1.is_valid());
}
// Select statement is successful.
{
Statement s(db_->GetReadonlyStatement("SELECT * FROM foo"));
ASSERT_TRUE(s.Step());
EXPECT_EQ(s.ColumnInt(1), 12);
}
}
TEST_P(SQLDatabaseTest, IsSQLValid_NoContents) {
EXPECT_DCHECK_DEATH(db_->IsSQLValid("")) << "Empty string";
EXPECT_DCHECK_DEATH(db_->IsSQLValid(" ")) << "Space";
EXPECT_DCHECK_DEATH(db_->IsSQLValid("\n")) << "Newline";
EXPECT_DCHECK_DEATH(db_->IsSQLValid("-- Comment")) << "Comment";
}
// Test that Database::Raze() results in a database without the
// tables from the original database.
TEST_P(SQLDatabaseTest, Raze) {
static constexpr char kCreateSql[] =
"CREATE TABLE foo (id INTEGER PRIMARY KEY, value)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_TRUE(db_->Execute("INSERT INTO foo (value) VALUES (12)"));
int pragma_auto_vacuum = 0;
{
Statement s(db_->GetUniqueStatement("PRAGMA auto_vacuum"));
ASSERT_TRUE(s.Step());
pragma_auto_vacuum = s.ColumnInt(0);
ASSERT_TRUE(pragma_auto_vacuum == 0 || pragma_auto_vacuum == 1);
}
// If auto_vacuum is set, there's an extra page to maintain a freelist.
const int kExpectedPageCount = 2 + pragma_auto_vacuum;
{
Statement s(db_->GetUniqueStatement("PRAGMA page_count"));
ASSERT_TRUE(s.Step());
EXPECT_EQ(kExpectedPageCount, s.ColumnInt(0));
}
{
Statement s(db_->GetUniqueStatement("SELECT * FROM sqlite_schema"));
ASSERT_TRUE(s.Step());
EXPECT_EQ("table", s.ColumnString(0));
EXPECT_EQ("foo", s.ColumnString(1));
EXPECT_EQ("foo", s.ColumnString(2));
// Table "foo" is stored in the last page of the file.
EXPECT_EQ(kExpectedPageCount, s.ColumnInt(3));
EXPECT_EQ(kCreateSql, s.ColumnString(4));
}
ASSERT_TRUE(db_->Raze());
{
Statement s(db_->GetUniqueStatement("PRAGMA page_count"));
ASSERT_TRUE(s.Step());
EXPECT_EQ(1, s.ColumnInt(0));
}
ASSERT_EQ(0, SqliteSchemaCount(db_.get()));
{
Statement s(db_->GetUniqueStatement("PRAGMA auto_vacuum"));
ASSERT_TRUE(s.Step());
// The new database has the same auto_vacuum as a fresh database.
EXPECT_EQ(pragma_auto_vacuum, s.ColumnInt(0));
}
}
TEST_P(SQLDatabaseTest, RazeDuringSelect) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(1)"));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(2)"));
{
// SELECT implicitly creates a transaction while it's executing. This
// implicit transaction will not be caught by Raze()'s checks.
Statement select(db_->GetUniqueStatement("SELECT id FROM rows"));
ASSERT_TRUE(select.Step());
EXPECT_FALSE(db_->Raze()) << "Raze() should fail while SELECT is executing";
}
{
Statement count(db_->GetUniqueStatement("SELECT COUNT(*) FROM rows"));
ASSERT_TRUE(count.Step());
EXPECT_EQ(2, count.ColumnInt(0)) << "Raze() deleted some data";
}
}
// Helper for SQLDatabaseTest.RazePageSize. Creates a fresh db based on
// db_prefix, with the given initial page size, and verifies it against the
// expected size. Then changes to the final page size and razes, verifying that
// the fresh database ends up with the expected final page size.
void TestPageSize(const base::FilePath& db_prefix,
int initial_page_size,
const std::string& expected_initial_page_size,
int final_page_size,
const std::string& expected_final_page_size) {
static constexpr char kCreateSql[] = "CREATE TABLE x (t TEXT)";
static constexpr char kInsertSql1[] =
"INSERT INTO x VALUES ('This is a test')";
static constexpr char kInsertSql2[] =
"INSERT INTO x VALUES ('That was a test')";
const base::FilePath db_path = db_prefix.InsertBeforeExtensionASCII(
base::NumberToString(initial_page_size));
Database::Delete(db_path);
Database db({.page_size = initial_page_size}, test::kTestTag);
ASSERT_TRUE(db.Open(db_path));
ASSERT_TRUE(db.Execute(kCreateSql));
ASSERT_TRUE(db.Execute(kInsertSql1));
ASSERT_TRUE(db.Execute(kInsertSql2));
ASSERT_EQ(expected_initial_page_size,
ExecuteWithResult(&db, "PRAGMA page_size"));
db.Close();
// Re-open the database while setting a new |options.page_size| in the object.
Database razed_db({.page_size = final_page_size}, test::kTestTag);
ASSERT_TRUE(razed_db.Open(db_path));
// Raze will use the page size set in the connection object, which may not
// match the file's page size.
ASSERT_TRUE(razed_db.Raze());
// SQLite 3.10.2 (at least) has a quirk with the sqlite3_backup() API (used by
// Raze()) which causes the destination database to remember the previous
// page_size, even if the overwriting database changed the page_size. Access
// the actual database to cause the cached value to be updated.
EXPECT_EQ("0",
ExecuteWithResult(&razed_db, "SELECT COUNT(*) FROM sqlite_schema"));
EXPECT_EQ(expected_final_page_size,
ExecuteWithResult(&razed_db, "PRAGMA page_size"));
EXPECT_EQ("1", ExecuteWithResult(&razed_db, "PRAGMA page_count"));
}
// Verify that Recovery maintains the page size, and the virtual table
// works with page sizes other than SQLite's default. Also verify the case
// where the default page size has changed.
TEST_P(SQLDatabaseTest, RazePageSize) {
const std::string default_page_size =
ExecuteWithResult(db_.get(), "PRAGMA page_size");
// Sync uses 32k pages.
EXPECT_NO_FATAL_FAILURE(
TestPageSize(db_path_, 32768, "32768", 32768, "32768"));
// Many clients use 4k pages. This is the SQLite default after 3.12.0.
EXPECT_NO_FATAL_FAILURE(TestPageSize(db_path_, 4096, "4096", 4096, "4096"));
// 1k is the default page size before 3.12.0.
EXPECT_NO_FATAL_FAILURE(TestPageSize(db_path_, 1024, "1024", 1024, "1024"));
EXPECT_NO_FATAL_FAILURE(TestPageSize(db_path_, 2048, "2048", 4096, "4096"));
// Databases with no page size specified should result in the default
// page size. 2k has never been the default page size.
ASSERT_NE("2048", default_page_size);
EXPECT_NO_FATAL_FAILURE(TestPageSize(db_path_, 2048, "2048",
DatabaseOptions::kDefaultPageSize,
default_page_size));
}
// Test that Raze() results are seen in other connections.
TEST_P(SQLDatabaseTest, RazeMultiple) {
static constexpr char kCreateSql[] =
"CREATE TABLE foo (id INTEGER PRIMARY KEY, value)";
ASSERT_TRUE(db_->Execute(kCreateSql));
Database other_db(GetDBOptions(), test::kTestTag);
ASSERT_TRUE(other_db.Open(db_path_));
// Check that the second connection sees the table.
ASSERT_EQ(1, SqliteSchemaCount(&other_db));
ASSERT_TRUE(db_->Raze());
// The second connection sees the updated database.
ASSERT_EQ(0, SqliteSchemaCount(&other_db));
}
TEST_P(SQLDatabaseTest, Raze_OtherConnectionHasWriteLock) {
ASSERT_TRUE(db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY)"));
Database other_db(GetDBOptions(), test::kTestTag);
ASSERT_TRUE(other_db.Open(db_path_));
Transaction other_db_transaction(&other_db);
ASSERT_TRUE(other_db_transaction.Begin());
ASSERT_TRUE(other_db.Execute("INSERT INTO rows(id) VALUES(1)"));
EXPECT_FALSE(db_->Raze())
<< "Raze() should fail while another connection has a write lock";
ASSERT_TRUE(other_db_transaction.Commit());
EXPECT_TRUE(db_->Raze())
<< "Raze() should succeed after the other connection releases the lock";
}
TEST_P(SQLDatabaseTest, Raze_OtherConnectionHasReadLock) {
ASSERT_TRUE(db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY)"));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(1)"));
if (IsWALEnabled()) {
// In WAL mode, read transactions in other connections do not block a write
// transaction.
return;
}
Database other_db(GetDBOptions(), test::kTestTag);
ASSERT_TRUE(other_db.Open(db_path_));
Statement select(other_db.GetUniqueStatement("SELECT id FROM rows"));
ASSERT_TRUE(select.Step());
EXPECT_FALSE(db_->Raze())
<< "Raze() should fail while another connection has a read lock";
ASSERT_FALSE(select.Step())
<< "The SELECT statement should not produce more than one row";
EXPECT_TRUE(db_->Raze())
<< "Raze() should succeed after the other connection releases the lock";
}
TEST_P(SQLDatabaseTest, Raze_EmptyDatabaseFile) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
db_->Close();
ASSERT_TRUE(TruncateDatabase());
ASSERT_TRUE(db_->Open(db_path_))
<< "Failed to reopen database after truncating";
EXPECT_TRUE(db_->Raze()) << "Raze() failed on an empty file";
EXPECT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"))
<< "Raze() did not produce a healthy empty database";
}
// Verify that Raze() can handle a file of junk.
// Need exclusive mode off here as there are some subtleties (by design) around
// how the cache is used with it on which causes the test to fail.
TEST_P(SQLDatabaseTest, RazeNOTADB) {
db_->Close();
Database::Delete(db_path_);
ASSERT_FALSE(base::PathExists(db_path_));
ASSERT_TRUE(OverwriteDatabaseHeader(OverwriteType::kTruncate));
ASSERT_TRUE(base::PathExists(db_path_));
// SQLite will successfully open the handle, but fail when running PRAGMA
// statements that access the database.
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_NOTADB);
EXPECT_FALSE(db_->Open(db_path_));
ASSERT_TRUE(expecter.SawExpectedErrors());
}
EXPECT_TRUE(db_->Raze());
db_->Close();
// Now empty, the open should open an empty database.
EXPECT_TRUE(db_->Open(db_path_));
EXPECT_EQ(0, SqliteSchemaCount(db_.get()));
}
// Verify that Raze() can handle a database overwritten with garbage.
TEST_P(SQLDatabaseTest, RazeNOTADB2) {
static constexpr char kCreateSql[] =
"CREATE TABLE foo (id INTEGER PRIMARY KEY, value)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_EQ(1, SqliteSchemaCount(db_.get()));
db_->Close();
ASSERT_TRUE(OverwriteDatabaseHeader(OverwriteType::kOverwrite));
// SQLite will successfully open the handle, but will fail with
// SQLITE_NOTADB on pragma statemenets which attempt to read the
// corrupted header.
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_NOTADB);
EXPECT_FALSE(db_->Open(db_path_));
ASSERT_TRUE(expecter.SawExpectedErrors());
}
EXPECT_TRUE(db_->Raze());
db_->Close();
// Now empty, the open should succeed with an empty database.
EXPECT_TRUE(db_->Open(db_path_));
EXPECT_EQ(0, SqliteSchemaCount(db_.get()));
}
// Test that a callback from Open() can raze the database. This is
// essential for cases where the Open() can fail entirely, so the
// Raze() cannot happen later. Additionally test that when the
// callback does this during Open(), the open is retried and succeeds.
TEST_P(SQLDatabaseTest, RazeCallbackReopen) {
static constexpr char kCreateSql[] =
"CREATE TABLE foo (id INTEGER PRIMARY KEY, value)";
ASSERT_TRUE(db_->Execute(kCreateSql));
ASSERT_EQ(1, SqliteSchemaCount(db_.get()));
db_->Close();
// Corrupt the database so that nothing works, including PRAGMAs.
ASSERT_TRUE(sql::test::CorruptSizeInHeader(db_path_));
// Open() will succeed, even though the PRAGMA calls within will
// fail with SQLITE_CORRUPT, as will this PRAGMA.
{
sql::test::ScopedErrorExpecter expecter;
base::HistogramTester tester;
expecter.ExpectError(SQLITE_CORRUPT);
ASSERT_FALSE(db_->Open(db_path_));
tester.ExpectUniqueSample("Sql.Database.Open.FirstAttempt.Error.Test",
SqliteResultCode::kCorrupt, 1);
ASSERT_FALSE(db_->Execute("PRAGMA auto_vacuum"));
db_->Close();
ASSERT_TRUE(expecter.SawExpectedErrors());
}
db_->set_error_callback(
base::BindRepeating(&RazeErrorCallback, db_.get(), SQLITE_CORRUPT));
// When the PRAGMA calls in Open() raise SQLITE_CORRUPT, the error
// callback will call RazeAndPoison(). Open() will then fail and be
// retried. The second Open() on the empty database will succeed
// cleanly.
ASSERT_TRUE(db_->Open(db_path_));
ASSERT_TRUE(db_->Execute("PRAGMA auto_vacuum"));
EXPECT_EQ(0, SqliteSchemaCount(db_.get()));
}
TEST_P(SQLDatabaseTest, RazeAndPoison_DeletesData) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
ASSERT_TRUE(db_->RazeAndPoison());
// We need to call Close() in order to re-Open().
db_->Close();
ASSERT_TRUE(db_->Open(db_path_))
<< "RazeAndPoison() did not produce a healthy database";
EXPECT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"))
<< "RazeAndPoison() did not produce a healthy empty database";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_IsOpen) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(db_->is_open())
<< "RazeAndPoison() did not mark the database as closed";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_Reopen_NoChanges) {
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"))
<< "Execute() should return false after RazeAndPoison()";
// We need to call Close() in order to re-Open().
db_->Close();
ASSERT_TRUE(db_->Open(db_path_))
<< "RazeAndPoison() did not produce a healthy database";
EXPECT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"))
<< "Execute() returned false but went through after RazeAndPoison()";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_OpenTransaction) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(db_->Execute("INSERT INTO rows(id) VALUES(12)"));
Transaction transaction(db_.get());
ASSERT_TRUE(transaction.Begin());
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(db_->is_open())
<< "RazeAndPoison() did not mark the database as closed";
EXPECT_FALSE(transaction.Commit())
<< "RazeAndPoison() did not cancel the transaction";
// We need to call Close() in order to re-Open().
db_->Close();
ASSERT_TRUE(db_->Open(db_path_));
EXPECT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"))
<< "RazeAndPoison() did not produce a healthy empty database";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_Preload_NoCrash) {
db_->Preload();
db_->RazeAndPoison();
db_->Preload();
}
TEST_P(SQLDatabaseTest, RazeAndPoison_DoesTableExist) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(db_->DoesTableExist("rows")) << "Incorrect test setup";
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(db_->DoesTableExist("rows"))
<< "DoesTableExist() should return false after RazeAndPoison()";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_IsSQLValid) {
ASSERT_TRUE(db_->IsSQLValid("SELECT 1")) << "Incorrect test setup";
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(db_->IsSQLValid("SELECT 1"))
<< "IsSQLValid() should return false after RazeAndPoison()";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_Execute) {
ASSERT_TRUE(db_->Execute("SELECT 1")) << "Incorrect test setup";
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(db_->Execute("SELECT 1"))
<< "Execute() should return false after RazeAndPoison()";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_GetUniqueStatement) {
{
Statement select(db_->GetUniqueStatement("SELECT 1"));
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
}
ASSERT_TRUE(db_->RazeAndPoison());
{
Statement select(db_->GetUniqueStatement("SELECT 1"));
EXPECT_FALSE(select.Step())
<< "GetUniqueStatement() should return an invalid Statement after "
<< "RazeAndPoison()";
}
}
TEST_P(SQLDatabaseTest, RazeAndPoison_GetCachedStatement) {
{
Statement select(db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1"));
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
}
ASSERT_TRUE(db_->RazeAndPoison());
{
Statement select(db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1"));
EXPECT_FALSE(select.Step())
<< "GetCachedStatement() should return an invalid Statement after "
<< "RazeAndPoison()";
}
}
TEST_P(SQLDatabaseTest, RazeAndPoison_InvalidatesUniqueStatement) {
Statement select(db_->GetUniqueStatement("SELECT 1"));
ASSERT_TRUE(select.is_valid()) << "Incorrect test setup";
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
select.Reset(/*clear_bound_vars=*/true);
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(select.is_valid())
<< "RazeAndPoison() should invalidate live Statements";
EXPECT_FALSE(select.Step())
<< "RazeAndPoison() should invalidate live Statements";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_InvalidatesCachedStatement) {
Statement select(db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1"));
ASSERT_TRUE(select.is_valid()) << "Incorrect test setup";
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
select.Reset(/*clear_bound_vars=*/true);
ASSERT_TRUE(db_->RazeAndPoison());
EXPECT_FALSE(select.is_valid())
<< "RazeAndPoison() should invalidate live Statements";
EXPECT_FALSE(select.Step())
<< "RazeAndPoison() should invalidate live Statements";
}
TEST_P(SQLDatabaseTest, RazeAndPoison_TransactionBegin) {
{
Transaction transaction(db_.get());
ASSERT_TRUE(transaction.Begin()) << "Incorrect test setup";
ASSERT_TRUE(transaction.Commit()) << "Incorrect test setup";
}
ASSERT_TRUE(db_->RazeAndPoison());
{
Transaction transaction(db_.get());
EXPECT_FALSE(transaction.Begin())
<< "Transaction::Begin() should return false after RazeAndPoison()";
EXPECT_FALSE(transaction.IsActiveForTesting())
<< "RazeAndPoison() should block transactions from starting";
}
}
TEST_P(SQLDatabaseTest, Close_IsSQLValid) {
ASSERT_TRUE(db_->IsSQLValid("SELECT 1")) << "Incorrect test setup";
db_->Close();
EXPECT_DCHECK_DEATH_WITH({ std::ignore = db_->IsSQLValid("SELECT 1"); },
"Illegal use of Database without a db");
}
// On Windows, truncate silently fails against a memory-mapped file. One goal
// of Raze() is to truncate the file to remove blocks which generate I/O errors.
// Test that Raze() turns off memory mapping so that the file is truncated.
// [This would not cover the case of multiple connections where one of the other
// connections is memory-mapped. That is infrequent in Chromium.]
TEST_P(SQLDatabaseTest, RazeTruncate) {
// The empty database has 0 or 1 pages. Raze() should leave it with exactly 1
// page. Not checking directly because auto_vacuum on Android adds a freelist
// page.
ASSERT_TRUE(db_->Raze());
std::optional<int64_t> expected_size = GetFileSize(db_path_);
ASSERT_TRUE(expected_size.has_value());
EXPECT_GT(*expected_size, 0);
// Cause the database to take a few pages.
static constexpr char kCreateSql[] =
"CREATE TABLE foo (id INTEGER PRIMARY KEY, value)";
ASSERT_TRUE(db_->Execute(kCreateSql));
for (size_t i = 0; i < 24; ++i) {
ASSERT_TRUE(
db_->Execute("INSERT INTO foo (value) VALUES (randomblob(1024))"));
}
// In WAL mode, writes don't reach the database file until a checkpoint
// happens.
ASSERT_TRUE(db_->CheckpointDatabase());
std::optional<int64_t> db_size = GetFileSize(db_path_);
ASSERT_TRUE(db_size.has_value());
EXPECT_GT(*db_size, *expected_size);
// Make a query covering most of the database file to make sure that the
// blocks are actually mapped into memory. Empirically, the truncate problem
// doesn't seem to happen if no blocks are mapped.
EXPECT_EQ("24576",
ExecuteWithResult(db_.get(), "SELECT SUM(LENGTH(value)) FROM foo"));
ASSERT_TRUE(db_->Raze());
db_size = GetFileSize(db_path_);
ASSERT_TRUE(db_size.has_value());
EXPECT_EQ(*expected_size, *db_size);
}
#if BUILDFLAG(IS_ANDROID)
TEST_P(SQLDatabaseTest, SetTempDirForSQL) {
MetaTable meta_table;
// Below call needs a temporary directory in sqlite3
// On Android, it can pass only when the temporary directory is set.
// Otherwise, sqlite3 doesn't find the correct directory to store
// temporary files and will report the error 'unable to open
// database file'.
ASSERT_TRUE(meta_table.Init(db_.get(), 4, 4));
}
#endif // BUILDFLAG(IS_ANDROID)
TEST_P(SQLDatabaseTest, Delete) {
EXPECT_TRUE(db_->Execute("CREATE TABLE x (x)"));
db_->Close();
base::FilePath journal_path = Database::JournalPath(db_path_);
base::FilePath wal_path = Database::WriteAheadLogPath(db_path_);
// Should have both a main database file and a journal file if
// journal_mode is TRUNCATE. There is no WAL file as it is deleted on Close.
ASSERT_TRUE(base::PathExists(db_path_));
if (!IsWALEnabled()) { // TRUNCATE mode
ASSERT_TRUE(base::PathExists(journal_path));
}
Database::Delete(db_path_);
EXPECT_FALSE(base::PathExists(db_path_));
EXPECT_FALSE(base::PathExists(journal_path));
EXPECT_FALSE(base::PathExists(wal_path));
}
#if BUILDFLAG(IS_POSIX) // This test operates on POSIX file permissions.
TEST_P(SQLDatabaseTest, PosixFilePermissions) {
db_->Close();
Database::Delete(db_path_);
ASSERT_FALSE(base::PathExists(db_path_));
// If the bots all had a restrictive umask setting such that databases are
// always created with only the owner able to read them, then the code could
// break without breaking the tests. Temporarily provide a more permissive
// umask.
ScopedUmaskSetter permissive_umask(S_IWGRP | S_IWOTH);
ASSERT_TRUE(db_->Open(db_path_));
// Cause the journal file to be created. If the default journal_mode is
// changed back to DELETE, this test will need to be updated.
EXPECT_TRUE(db_->Execute("CREATE TABLE x (x)"));
int mode;
ASSERT_TRUE(base::PathExists(db_path_));
EXPECT_TRUE(base::GetPosixFilePermissions(db_path_, &mode));
ASSERT_EQ(mode, 0600);
if (IsWALEnabled()) { // WAL mode
// The WAL file is created lazily on first change.
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (a, b)"));
base::FilePath wal_path = Database::WriteAheadLogPath(db_path_);
ASSERT_TRUE(base::PathExists(wal_path));
EXPECT_TRUE(base::GetPosixFilePermissions(wal_path, &mode));
ASSERT_EQ(mode, 0600);
// The shm file doesn't exist in exclusive locking mode.
if (ExecuteWithResult(db_.get(), "PRAGMA locking_mode") == "normal") {
base::FilePath shm_path = Database::SharedMemoryFilePath(db_path_);
ASSERT_TRUE(base::PathExists(shm_path));
EXPECT_TRUE(base::GetPosixFilePermissions(shm_path, &mode));
ASSERT_EQ(mode, 0600);
}
} else { // Truncate mode
base::FilePath journal_path = Database::JournalPath(db_path_);
DLOG(ERROR) << "journal_path: " << journal_path;
ASSERT_TRUE(base::PathExists(journal_path));
EXPECT_TRUE(base::GetPosixFilePermissions(journal_path, &mode));
ASSERT_EQ(mode, 0600);
}
}
#endif // BUILDFLAG(IS_POSIX)
TEST_P(SQLDatabaseTest, Poison_IsOpen) {
db_->Poison();
EXPECT_FALSE(db_->is_open())
<< "Poison() did not mark the database as closed";
}
TEST_P(SQLDatabaseTest, Poison_Close_Reopen_NoChanges) {
db_->Poison();
EXPECT_FALSE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"))
<< "Execute() should return false after Poison()";
db_->Close();
ASSERT_TRUE(db_->Open(db_path_)) << "Poison() damaged the database";
EXPECT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"))
<< "Execute() returned false but went through after Poison()";
}
TEST_P(SQLDatabaseTest, Poison_Preload_NoCrash) {
db_->Preload();
db_->Poison();
db_->Preload();
}
TEST_P(SQLDatabaseTest, Poison_DoesTableExist) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(db_->DoesTableExist("rows")) << "Incorrect test setup";
db_->Poison();
EXPECT_FALSE(db_->DoesTableExist("rows"))
<< "DoesTableExist() should return false after Poison()";
}
TEST_P(SQLDatabaseTest, Poison_IsSQLValid) {
ASSERT_TRUE(db_->IsSQLValid("SELECT 1")) << "Incorrect test setup";
db_->Poison();
EXPECT_FALSE(db_->IsSQLValid("SELECT 1"))
<< "IsSQLValid() should return false after Poison()";
}
TEST_P(SQLDatabaseTest, Poison_Execute) {
ASSERT_TRUE(db_->Execute("SELECT 1")) << "Incorrect test setup";
db_->Poison();
EXPECT_FALSE(db_->Execute("SELECT 1"))
<< "Execute() should return false after Poison()";
}
TEST_P(SQLDatabaseTest, Poison_GetUniqueStatement) {
{
Statement select(db_->GetUniqueStatement("SELECT 1"));
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
}
db_->Poison();
{
Statement select(db_->GetUniqueStatement("SELECT 1"));
EXPECT_FALSE(select.Step())
<< "GetUniqueStatement() should return an invalid Statement after "
<< "Poison()";
}
}
TEST_P(SQLDatabaseTest, Poison_GetCachedStatement) {
{
Statement select(db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1"));
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
}
db_->Poison();
{
Statement select(db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1"));
EXPECT_FALSE(select.Step())
<< "GetCachedStatement() should return an invalid Statement after "
<< "Poison()";
}
}
TEST_P(SQLDatabaseTest, Poison_InvalidatesUniqueStatement) {
Statement select(db_->GetUniqueStatement("SELECT 1"));
ASSERT_TRUE(select.is_valid()) << "Incorrect test setup";
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
select.Reset(/*clear_bound_vars=*/true);
db_->Poison();
EXPECT_FALSE(select.is_valid())
<< "Poison() should invalidate live Statements";
EXPECT_FALSE(select.Step()) << "Poison() should invalidate live Statements";
}
TEST_P(SQLDatabaseTest, Poison_InvalidatesCachedStatement) {
Statement select(db_->GetCachedStatement(SQL_FROM_HERE, "SELECT 1"));
ASSERT_TRUE(select.is_valid()) << "Incorrect test setup";
ASSERT_TRUE(select.Step()) << "Incorrect test setup";
select.Reset(/*clear_bound_vars=*/true);
db_->Poison();
EXPECT_FALSE(select.is_valid())
<< "Poison() should invalidate live Statements";
EXPECT_FALSE(select.Step()) << "Poison() should invalidate live Statements";
}
TEST_P(SQLDatabaseTest, Poison_TransactionBegin) {
{
Transaction transaction(db_.get());
ASSERT_TRUE(transaction.Begin()) << "Incorrect test setup";
ASSERT_TRUE(transaction.Commit()) << "Incorrect test setup";
}
db_->Poison();
{
Transaction transaction(db_.get());
EXPECT_FALSE(transaction.Begin())
<< "Transaction::Begin() should return false after Poison()";
EXPECT_FALSE(transaction.IsActiveForTesting())
<< "Poison() should block transactions from starting";
}
}
TEST_P(SQLDatabaseTest, Poison_OpenTransaction) {
Transaction transaction(db_.get());
ASSERT_TRUE(transaction.Begin());
db_->Poison();
EXPECT_FALSE(transaction.Commit())
<< "Poison() did not cancel the transaction";
}
TEST_P(SQLDatabaseTest, AttachDatabase) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
// Create a database to attach to.
base::FilePath attach_path =
db_path_.DirName().AppendASCII("attach_database_test.db");
static constexpr char kAttachmentPoint[] = "other";
{
Database other_db(test::kTestTag);
ASSERT_TRUE(other_db.Open(attach_path));
ASSERT_TRUE(
other_db.Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(other_db.Execute("INSERT INTO rows VALUES(42)"));
}
// Cannot see the attached database, yet.
EXPECT_FALSE(db_->IsSQLValid("SELECT COUNT(*) from other.rows"));
EXPECT_TRUE(db_->AttachDatabase(attach_path, kAttachmentPoint));
EXPECT_TRUE(db_->IsSQLValid("SELECT COUNT(*) from other.rows"));
// Queries can touch both databases after the ATTACH.
EXPECT_TRUE(db_->Execute("INSERT INTO rows SELECT id FROM other.rows"));
{
Statement select(db_->GetUniqueStatement("SELECT COUNT(*) FROM rows"));
ASSERT_TRUE(select.Step());
EXPECT_EQ(1, select.ColumnInt(0));
}
EXPECT_TRUE(db_->DetachDatabase(kAttachmentPoint));
EXPECT_FALSE(db_->IsSQLValid("SELECT COUNT(*) from other.rows"));
}
TEST_P(SQLDatabaseTest, AttachDatabaseWithOpenTransaction) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
// Create a database to attach to.
base::FilePath attach_path =
db_path_.DirName().AppendASCII("attach_database_test.db");
static constexpr char kAttachmentPoint[] = "other";
{
Database other_db(test::kTestTag);
ASSERT_TRUE(other_db.Open(attach_path));
ASSERT_TRUE(
other_db.Execute("CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(other_db.Execute("INSERT INTO rows VALUES(42)"));
}
// Cannot see the attached database, yet.
EXPECT_FALSE(db_->IsSQLValid("SELECT COUNT(*) from other.rows"));
// Attach succeeds in a transaction.
Transaction transaction(db_.get());
EXPECT_TRUE(transaction.Begin());
EXPECT_TRUE(db_->AttachDatabase(attach_path, kAttachmentPoint));
EXPECT_TRUE(db_->IsSQLValid("SELECT COUNT(*) from other.rows"));
// Queries can touch both databases after the ATTACH.
EXPECT_TRUE(db_->Execute("INSERT INTO rows SELECT id FROM other.rows"));
{
Statement select(db_->GetUniqueStatement("SELECT COUNT(*) FROM rows"));
ASSERT_TRUE(select.Step());
EXPECT_EQ(1, select.ColumnInt(0));
}
// Detaching the same database fails, database is locked in the transaction.
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_ERROR);
EXPECT_FALSE(db_->DetachDatabase(kAttachmentPoint));
ASSERT_TRUE(expecter.SawExpectedErrors());
}
EXPECT_TRUE(db_->IsSQLValid("SELECT COUNT(*) from other.rows"));
// Detach succeeds when the transaction is closed.
transaction.Rollback();
EXPECT_TRUE(db_->DetachDatabase(kAttachmentPoint));
EXPECT_FALSE(db_->IsSQLValid("SELECT COUNT(*) from other.rows"));
}
TEST_P(SQLDatabaseTest, FullIntegrityCheck) {
static constexpr char kTableSql[] =
"CREATE TABLE rows(id INTEGER PRIMARY KEY NOT NULL, value TEXT NOT NULL)";
ASSERT_TRUE(db_->Execute(kTableSql));
ASSERT_TRUE(db_->Execute("CREATE INDEX rows_by_value ON rows(value)"));
{
std::vector<std::string> messages;
EXPECT_TRUE(db_->FullIntegrityCheck(&messages))
<< "FullIntegrityCheck() failed before database was corrupted";
EXPECT_THAT(messages, testing::ElementsAre("ok"))
<< "FullIntegrityCheck() should report ok before database is corrupted";
}
db_->Close();
ASSERT_TRUE(sql::test::CorruptIndexRootPage(db_path_, "rows_by_value"));
ASSERT_TRUE(db_->Open(db_path_));
{
std::vector<std::string> messages;
EXPECT_TRUE(db_->FullIntegrityCheck(&messages))
<< "FullIntegrityCheck() failed on corrupted database";
EXPECT_THAT(messages, testing::Not(testing::ElementsAre("ok")))
<< "FullIntegrityCheck() should not report ok for a corrupted database";
}
}
TEST_P(SQLDatabaseTest, OnMemoryDump) {
base::trace_event::MemoryDumpArgs args = {
base::trace_event::MemoryDumpLevelOfDetail::kDetailed};
base::trace_event::ProcessMemoryDump pmd(args);
ASSERT_TRUE(db_->memory_dump_provider_->OnMemoryDump(args, &pmd));
EXPECT_GE(pmd.allocator_dumps().size(), 1u);
}
// Test that the functions to collect diagnostic data run to completion, without
// worrying too much about what they generate (since that will change).
TEST_P(SQLDatabaseTest, CollectDiagnosticInfo) {
const std::string corruption_info = db_->CollectCorruptionInfo();
EXPECT_TRUE(base::Contains(corruption_info, "SQLITE_CORRUPT"));
EXPECT_TRUE(base::Contains(corruption_info, "integrity_check"));
// A statement to see in the results.
static constexpr char kSimpleSql[] = "SELECT 'mountain'";
Statement s(db_->GetCachedStatement(SQL_FROM_HERE, kSimpleSql));
// Error includes the statement.
{
DatabaseDiagnostics diagnostics;
const std::string readonly_info =
db_->CollectErrorInfo(SQLITE_READONLY, &s, &diagnostics);
EXPECT_TRUE(base::Contains(readonly_info, kSimpleSql));
EXPECT_EQ(diagnostics.sql_statement, kSimpleSql);
}
// Some other error doesn't include the statement.
{
DatabaseDiagnostics diagnostics;
const std::string full_info =
db_->CollectErrorInfo(SQLITE_FULL, nullptr, &diagnostics);
EXPECT_FALSE(base::Contains(full_info, kSimpleSql));
EXPECT_TRUE(diagnostics.sql_statement.empty());
}
// A table to see in the SQLITE_ERROR results.
EXPECT_TRUE(db_->Execute("CREATE TABLE volcano (x)"));
// Version info to see in the SQLITE_ERROR results.
MetaTable meta_table;
ASSERT_TRUE(meta_table.Init(db_.get(), 4, 4));
{
DatabaseDiagnostics diagnostics;
const std::string error_info =
db_->CollectErrorInfo(SQLITE_ERROR, &s, &diagnostics);
EXPECT_TRUE(base::Contains(error_info, kSimpleSql));
EXPECT_TRUE(base::Contains(error_info, "volcano"));
EXPECT_TRUE(base::Contains(error_info, "version: 4"));
EXPECT_EQ(diagnostics.sql_statement, kSimpleSql);
EXPECT_EQ(diagnostics.version, 4);
ASSERT_EQ(diagnostics.schema_sql_rows.size(), 2U);
EXPECT_EQ(diagnostics.schema_sql_rows[0], "CREATE TABLE volcano (x)");
EXPECT_EQ(diagnostics.schema_sql_rows[1],
"CREATE TABLE meta(key LONGVARCHAR NOT NULL UNIQUE PRIMARY KEY, "
"value LONGVARCHAR)");
ASSERT_EQ(diagnostics.schema_other_row_names.size(), 1U);
EXPECT_EQ(diagnostics.schema_other_row_names[0], "sqlite_autoindex_meta_1");
}
// Test that an error message is included in the diagnostics.
{
sql::test::ScopedErrorExpecter error_expecter;
error_expecter.ExpectError(SQLITE_ERROR);
EXPECT_FALSE(
db_->Execute("INSERT INTO volcano VALUES ('bound_value1', 42, 1234)"));
EXPECT_TRUE(error_expecter.SawExpectedErrors());
DatabaseDiagnostics diagnostics;
const std::string error_info =
db_->CollectErrorInfo(SQLITE_ERROR, &s, &diagnostics);
// Expect that the error message contains the table name and a column error.
EXPECT_TRUE(base::Contains(diagnostics.error_message, "table"));
EXPECT_TRUE(base::Contains(diagnostics.error_message, "volcano"));
EXPECT_TRUE(base::Contains(diagnostics.error_message, "column"));
// Expect that bound values are not present.
EXPECT_FALSE(base::Contains(diagnostics.error_message, "bound_value1"));
EXPECT_FALSE(base::Contains(diagnostics.error_message, "42"));
EXPECT_FALSE(base::Contains(diagnostics.error_message, "1234"));
}
}
// Test that a fresh database has mmap enabled by default, if mmap'ed I/O is
// enabled by SQLite.
TEST_P(SQLDatabaseTest, MmapInitiallyEnabled) {
{
Statement s(db_->GetUniqueStatement("PRAGMA mmap_size"));
ASSERT_TRUE(s.Step())
<< "All supported SQLite versions should have mmap support";
// If mmap I/O is not on, attempt to turn it on. If that succeeds, then
// Open() should have turned it on. If mmap support is disabled, 0 is
// returned. If the VFS does not understand SQLITE_FCNTL_MMAP_SIZE (for
// instance MojoVFS), -1 is returned.
if (s.ColumnInt(0) <= 0) {
ASSERT_TRUE(db_->Execute("PRAGMA mmap_size = 1048576"));
s.Reset(true);
ASSERT_TRUE(s.Step());
EXPECT_LE(s.ColumnInt(0), 0);
}
}
// Test that explicit disable prevents mmap'ed I/O.
db_->Close();
Database::Delete(db_path_);
db_->set_mmap_disabled();
ASSERT_TRUE(db_->Open(db_path_));
EXPECT_EQ("0", ExecuteWithResult(db_.get(), "PRAGMA mmap_size"));
}
// Test whether a fresh database gets mmap enabled when using alternate status
// storage.
TEST_P(SQLDatabaseTest, MmapInitiallyEnabledAltStatus) {
// Re-open fresh database with alt-status flag set.
db_->Close();
Database::Delete(db_path_);
DatabaseOptions options = GetDBOptions();
options.mmap_alt_status_discouraged = true;
options.enable_views_discouraged = true;
db_ = std::make_unique<Database>(options, test::kTestTag);
ASSERT_TRUE(db_->Open(db_path_));
{
Statement s(db_->GetUniqueStatement("PRAGMA mmap_size"));
ASSERT_TRUE(s.Step())
<< "All supported SQLite versions should have mmap support";
// If mmap I/O is not on, attempt to turn it on. If that succeeds, then
// Open() should have turned it on. If mmap support is disabled, 0 is
// returned. If the VFS does not understand SQLITE_FCNTL_MMAP_SIZE (for
// instance MojoVFS), -1 is returned.
if (s.ColumnInt(0) <= 0) {
ASSERT_TRUE(db_->Execute("PRAGMA mmap_size = 1048576"));
s.Reset(true);
ASSERT_TRUE(s.Step());
EXPECT_LE(s.ColumnInt(0), 0);
}
}
// Test that explicit disable overrides set_mmap_alt_status().
db_->Close();
Database::Delete(db_path_);
db_->set_mmap_disabled();
ASSERT_TRUE(db_->Open(db_path_));
EXPECT_EQ("0", ExecuteWithResult(db_.get(), "PRAGMA mmap_size"));
}
TEST_P(SQLDatabaseTest, ComputeMmapSizeForOpen) {
const size_t kMmapAlot = 25 * 1024 * 1024;
int64_t mmap_status = MetaTable::kMmapFailure;
// If there is no meta table (as for a fresh database), assume that everything
// should be mapped, and the status of the meta table is not affected.
ASSERT_TRUE(!db_->DoesTableExist("meta"));
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
ASSERT_TRUE(!db_->DoesTableExist("meta"));
// When the meta table is first created, it sets up to map everything.
ASSERT_TRUE(MetaTable().Init(db_.get(), 1, 1));
ASSERT_TRUE(db_->DoesTableExist("meta"));
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
ASSERT_TRUE(MetaTable::GetMmapStatus(db_.get(), &mmap_status));
ASSERT_EQ(MetaTable::kMmapSuccess, mmap_status);
// Preload with partial progress of one page. Should map everything.
ASSERT_TRUE(db_->Execute("REPLACE INTO meta VALUES ('mmap_status', 1)"));
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
ASSERT_TRUE(MetaTable::GetMmapStatus(db_.get(), &mmap_status));
ASSERT_EQ(MetaTable::kMmapSuccess, mmap_status);
// Failure status maps nothing.
ASSERT_TRUE(db_->Execute("REPLACE INTO meta VALUES ('mmap_status', -2)"));
ASSERT_EQ(0UL, db_->ComputeMmapSizeForOpen());
// Re-initializing the meta table does not re-create the key if the table
// already exists.
ASSERT_TRUE(db_->Execute("DELETE FROM meta WHERE key = 'mmap_status'"));
ASSERT_TRUE(MetaTable().Init(db_.get(), 1, 1));
ASSERT_EQ(MetaTable::kMmapSuccess, mmap_status);
ASSERT_TRUE(MetaTable::GetMmapStatus(db_.get(), &mmap_status));
ASSERT_EQ(0, mmap_status);
// With no key, map everything and create the key.
// TODO(shess): This really should be "maps everything after validating it",
// but that is more complicated to structure.
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
ASSERT_TRUE(MetaTable::GetMmapStatus(db_.get(), &mmap_status));
ASSERT_EQ(MetaTable::kMmapSuccess, mmap_status);
}
TEST_P(SQLDatabaseTest, ComputeMmapSizeForOpenAltStatus) {
const size_t kMmapAlot = 25 * 1024 * 1024;
// At this point, Database still expects a future [meta] table.
ASSERT_FALSE(db_->DoesTableExist("meta"));
ASSERT_FALSE(db_->DoesViewExist("MmapStatus"));
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
ASSERT_FALSE(db_->DoesTableExist("meta"));
ASSERT_FALSE(db_->DoesViewExist("MmapStatus"));
// Using alt status, everything should be mapped, with state in the view.
DatabaseOptions options = GetDBOptions();
options.mmap_alt_status_discouraged = true;
options.enable_views_discouraged = true;
db_ = std::make_unique<Database>(options, test::kTestTag);
ASSERT_TRUE(db_->Open(db_path_));
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
ASSERT_FALSE(db_->DoesTableExist("meta"));
ASSERT_TRUE(db_->DoesViewExist("MmapStatus"));
EXPECT_EQ(base::NumberToString(MetaTable::kMmapSuccess),
ExecuteWithResult(db_.get(), "SELECT * FROM MmapStatus"));
// Also maps everything when kMmapSuccess is already in the view.
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
// Preload with partial progress of one page. Should map everything.
ASSERT_TRUE(db_->Execute("DROP VIEW MmapStatus"));
ASSERT_TRUE(db_->Execute("CREATE VIEW MmapStatus (value) AS SELECT 1"));
ASSERT_GT(db_->ComputeMmapSizeForOpen(), kMmapAlot);
EXPECT_EQ(base::NumberToString(MetaTable::kMmapSuccess),
ExecuteWithResult(db_.get(), "SELECT * FROM MmapStatus"));
// Failure status leads to nothing being mapped.
ASSERT_TRUE(db_->Execute("DROP VIEW MmapStatus"));
ASSERT_TRUE(db_->Execute("CREATE VIEW MmapStatus (value) AS SELECT -2"));
ASSERT_EQ(0UL, db_->ComputeMmapSizeForOpen());
EXPECT_EQ(base::NumberToString(MetaTable::kMmapFailure),
ExecuteWithResult(db_.get(), "SELECT * FROM MmapStatus"));
}
TEST_P(SQLDatabaseTest, GetMemoryUsage) {
// Databases with mmap enabled may not follow the assumptions below.
db_->Close();
db_->set_mmap_disabled();
ASSERT_TRUE(db_->Open(db_path_));
int initial_memory = db_->GetMemoryUsage();
EXPECT_GT(initial_memory, 0)
<< "SQLite should always use some memory for a database";
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (a, b)"));
ASSERT_TRUE(db_->Execute("INSERT INTO foo(a, b) VALUES (12, 13)"));
int post_query_memory = db_->GetMemoryUsage();
EXPECT_GT(post_query_memory, initial_memory)
<< "Page cache usage should go up after executing queries";
db_->TrimMemory();
int post_trim_memory = db_->GetMemoryUsage();
EXPECT_GT(post_query_memory, post_trim_memory)
<< "Page cache usage should go down after calling TrimMemory()";
}
TEST_P(SQLDatabaseTest, DoubleQuotedStringLiteralsDisabledByDefault) {
ASSERT_TRUE(db_->Execute("CREATE TABLE data(item TEXT NOT NULL);"));
struct TestCase {
const std::string sql;
bool is_valid;
};
std::vector<TestCase> test_cases = {
// DML tests.
{"SELECT item FROM data WHERE item >= 'string literal'", true},
{"SELECT item FROM data WHERE item >= \"string literal\"", false},
{"INSERT INTO data(item) VALUES('string literal')", true},
{"INSERT INTO data(item) VALUES(\"string literal\")", false},
{"UPDATE data SET item = 'string literal'", true},
{"UPDATE data SET item = \"string literal\"", false},
{"DELETE FROM data WHERE item >= 'string literal'", true},
{"DELETE FROM data WHERE item >= \"string literal\"", false},
// DDL tests.
{"CREATE INDEX data_item ON data(item) WHERE item >= 'string literal'",
true},
{"CREATE INDEX data_item ON data(item) WHERE item >= \"string literal\"",
false},
{"CREATE TABLE data2(item TEXT DEFAULT 'string literal')", true},
// This should be an invalid DDL statement, due to the double-quoted
// string literal. However, SQLite currently parses it.
{"CREATE TABLE data2(item TEXT DEFAULT \"string literal\")", true},
};
for (const TestCase& test_case : test_cases) {
SCOPED_TRACE(test_case.sql);
EXPECT_EQ(test_case.is_valid, db_->IsSQLValid(test_case.sql));
}
}
TEST_P(SQLDatabaseTest, ForeignKeyEnforcementDisabledByDefault) {
ASSERT_TRUE(db_->Execute("CREATE TABLE targets(id INTEGER PRIMARY KEY)"));
// sqlite3_db_config() currently only disables foreign key enforcement. Schema
// operations on foreign keys are still allowed.
ASSERT_TRUE(
db_->Execute("CREATE TABLE refs("
"id INTEGER PRIMARY KEY,"
"target_id INTEGER REFERENCES targets(id))"));
ASSERT_TRUE(db_->Execute("INSERT INTO targets(id) VALUES(42)"));
ASSERT_TRUE(db_->Execute("INSERT INTO refs(id, target_id) VALUES(42, 42)"));
EXPECT_TRUE(db_->Execute("DELETE FROM targets WHERE id=42"))
<< "Foreign key enforcement is not disabled";
}
TEST_P(SQLDatabaseTest, TriggersDisabledByDefault) {
ASSERT_TRUE(db_->Execute("CREATE TABLE data(id INTEGER)"));
// sqlite3_db_config() currently only disables running triggers. Schema
// operations on triggers are still allowed.
EXPECT_TRUE(
db_->Execute("CREATE TRIGGER trigger AFTER INSERT ON data "
"BEGIN DELETE FROM data; END"));
ASSERT_TRUE(db_->Execute("INSERT INTO data(id) VALUES(42)"));
Statement select(db_->GetUniqueStatement("SELECT id FROM data"));
EXPECT_TRUE(select.Step())
<< "If the trigger did not run, the table should not be empty.";
EXPECT_EQ(42, select.ColumnInt64(0));
// sqlite3_db_config() currently only disables running triggers. Schema
// operations on triggers are still allowed.
EXPECT_TRUE(db_->Execute("DROP TRIGGER IF EXISTS trigger"));
}
// This test ensures that a database can be open/create with a journal mode and
// can be re-open later with a different journal mode.
TEST_P(SQLDatabaseTest, ReOpenWithDifferentJournalMode) {
const bool is_wal = IsWALEnabled();
const base::FilePath journal_path = Database::JournalPath(db_path_);
const base::FilePath wal_path = Database::WriteAheadLogPath(db_path_);
ASSERT_TRUE(db_->Execute("CREATE TABLE foo (id INTEGER PRIMARY KEY, value)"));
ASSERT_TRUE(db_->Execute("INSERT INTO foo (value) VALUES (12)"));
// Last insert row ID should be valid.
int64_t row = db_->GetLastInsertRowId();
EXPECT_LT(0, row);
// It should be the primary key of the row we just inserted.
{
Statement s(db_->GetUniqueStatement("SELECT value FROM foo WHERE id=?"));
s.BindInt64(0, row);
ASSERT_TRUE(s.Step());
EXPECT_EQ(12, s.ColumnInt(0));
}
// Ensure appropriate journal mode and the journal file exists.
EXPECT_TRUE(IsOpenedInCorrectJournalMode(db_.get(), is_wal));
EXPECT_EQ(base::PathExists(wal_path), is_wal);
db_->Close();
if (is_wal) {
// The WAL journal file is removed on database close. Database that enable
// WAL mode can use a different journal mode on a subsequent database open.
EXPECT_FALSE(base::PathExists(wal_path));
} else {
// The Rollback journal should have a zero size when pending operations
// are completed.
std::optional<int64_t> journal_size = GetFileSize(journal_path);
EXPECT_THAT(journal_size, testing::Optional(0));
}
// Re-open the database with a different mode (Rollback vs WAL).
DatabaseOptions options = GetDBOptions();
options.wal_mode = !is_wal;
#if BUILDFLAG(IS_FUCHSIA)
// Exclusive mode needs to be enabled to enter WAL mode on Fuchsia.
if (options.wal_mode) {
options.exclusive_locking = true;
}
#endif // BUILDFLAG(IS_FUCHSIA)
db_ = std::make_unique<Database>(options, test::kTestTag);
ASSERT_TRUE(db_->Open(db_path_));
// The value for the last inserted row should be valid.
{
Statement s(db_->GetUniqueStatement("SELECT value FROM foo WHERE id=?"));
s.BindInt64(0, row);
ASSERT_TRUE(s.Step());
EXPECT_EQ(12, s.ColumnInt(0));
}
// Ensure appropriate journal file exists.
EXPECT_TRUE(IsOpenedInCorrectJournalMode(db_.get(), options.wal_mode));
EXPECT_EQ(base::PathExists(wal_path), options.wal_mode);
}
#if BUILDFLAG(IS_WIN)
class SQLDatabaseTestExclusiveFileLockMode
: public testing::Test,
public testing::WithParamInterface<::testing::tuple<bool, bool>> {
public:
~SQLDatabaseTestExclusiveFileLockMode() override = default;
void SetUp() override {
db_ = std::make_unique<Database>(GetDBOptions(), test::kTestTag);
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
db_path_ = temp_dir_.GetPath().AppendASCII("maybelocked.sqlite");
ASSERT_TRUE(db_->Open(db_path_));
}
DatabaseOptions GetDBOptions() {
DatabaseOptions options;
options.wal_mode = IsWALEnabled();
options.exclusive_locking = true;
options.exclusive_database_file_lock = IsExclusivelockEnabled();
return options;
}
bool IsWALEnabled() { return std::get<0>(GetParam()); }
bool IsExclusivelockEnabled() { return std::get<1>(GetParam()); }
protected:
base::ScopedTempDir temp_dir_;
base::FilePath db_path_;
std::unique_ptr<Database> db_;
};
TEST_P(SQLDatabaseTestExclusiveFileLockMode, BasicStatement) {
ASSERT_TRUE(db_->Execute("CREATE TABLE data(contents TEXT)"));
EXPECT_EQ(SQLITE_OK, db_->GetErrorCode());
ASSERT_TRUE(base::PathExists(db_path_));
base::File open_db(db_path_, base::File::Flags::FLAG_OPEN_ALWAYS |
base::File::Flags::FLAG_READ);
// If exclusive lock is enabled, then the test should not be able to re-open
// the database file, on Windows only.
EXPECT_EQ(IsExclusivelockEnabled(), !open_db.IsValid());
}
INSTANTIATE_TEST_SUITE_P(
All,
SQLDatabaseTestExclusiveFileLockMode,
::testing::Combine(::testing::Bool(), ::testing::Bool()),
[](const auto& info) {
return base::StrCat(
{std::get<0>(info.param) ? "WALEnabled" : "WALDisabled",
std::get<1>(info.param) ? "ExclusiveLock" : "NoExclusiveLock"});
});
#else
TEST(SQLInvalidDatabaseFlagsDeathTest, ExclusiveDatabaseLock) {
base::ScopedTempDir temp_dir;
ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
auto db_path = temp_dir.GetPath().AppendASCII("database_test_locked.sqlite");
Database db({.exclusive_database_file_lock = true}, test::kTestTag);
EXPECT_CHECK_DEATH_WITH(
{ std::ignore = db.Open(db_path); },
"exclusive_database_file_lock is only supported on Windows");
}
#endif // BUILDFLAG(IS_WIN)
class SQLDatabaseTestExclusiveMode : public testing::Test,
public testing::WithParamInterface<bool> {
public:
~SQLDatabaseTestExclusiveMode() override = default;
void SetUp() override {
db_ = std::make_unique<Database>(GetDBOptions(), test::kTestTag);
ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
db_path_ = temp_dir_.GetPath().AppendASCII("recovery_test.sqlite");
ASSERT_TRUE(db_->Open(db_path_));
}
DatabaseOptions GetDBOptions() {
DatabaseOptions options;
options.wal_mode = IsWALEnabled();
options.exclusive_locking = true;
return options;
}
bool IsWALEnabled() { return GetParam(); }
protected:
base::ScopedTempDir temp_dir_;
base::FilePath db_path_;
std::unique_ptr<Database> db_;
};
TEST_P(SQLDatabaseTestExclusiveMode, LockingModeExclusive) {
EXPECT_EQ(ExecuteWithResult(db_.get(), "PRAGMA locking_mode"), "exclusive");
}
TEST_P(SQLDatabaseTest, LockingModeNormal) {
EXPECT_EQ(ExecuteWithResult(db_.get(), "PRAGMA locking_mode"), "normal");
}
TEST_P(SQLDatabaseTest, OpenedInCorrectMode) {
EXPECT_TRUE(IsOpenedInCorrectJournalMode(db_.get(), IsWALEnabled()));
}
TEST_P(SQLDatabaseTest, CheckpointDatabase) {
if (!IsWALEnabled())
return;
base::FilePath wal_path = Database::WriteAheadLogPath(db_path_);
// WAL file initially empty.
EXPECT_TRUE(base::PathExists(wal_path));
std::optional<int64_t> wal_size = GetFileSize(wal_path);
EXPECT_THAT(wal_size, testing::Optional(0));
ASSERT_TRUE(
db_->Execute("CREATE TABLE foo (id INTEGER UNIQUE, value INTEGER)"));
ASSERT_TRUE(db_->Execute("INSERT INTO foo VALUES (1, 1)"));
ASSERT_TRUE(db_->Execute("INSERT INTO foo VALUES (2, 2)"));
// Writes reach WAL file but not db file.
wal_size = GetFileSize(wal_path);
ASSERT_TRUE(wal_size.has_value());
EXPECT_GT(wal_size.value(), 0);
std::optional<int64_t> db_size = GetFileSize(db_path_);
ASSERT_TRUE(db_size.has_value());
EXPECT_EQ(db_size.value(), db_->page_size());
// Checkpoint database to immediately propagate writes to DB file.
EXPECT_TRUE(db_->CheckpointDatabase());
db_size = GetFileSize(db_path_);
EXPECT_TRUE(db_size.has_value());
EXPECT_GT(db_size.value(), db_->page_size());
EXPECT_EQ(ExecuteWithResult(db_.get(), "SELECT value FROM foo where id=1"),
"1");
EXPECT_EQ(ExecuteWithResult(db_.get(), "SELECT value FROM foo where id=2"),
"2");
}
TEST_P(SQLDatabaseTest, OpenFailsAfterCorruptSizeInHeader) {
// The database file ends up empty if we don't create at least one table.
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(i INTEGER PRIMARY KEY NOT NULL)"));
db_->Close();
ASSERT_TRUE(sql::test::CorruptSizeInHeader(db_path_));
{
sql::test::ScopedErrorExpecter expecter;
base::HistogramTester tester;
expecter.ExpectError(SQLITE_CORRUPT);
ASSERT_FALSE(db_->Open(db_path_));
tester.ExpectUniqueSample("Sql.Database.Open.FirstAttempt.Error.Test",
SqliteResultCode::kCorrupt, 1);
EXPECT_TRUE(expecter.SawExpectedErrors());
}
}
TEST_P(SQLDatabaseTest, OpenWithRecoveryHandlesCorruption) {
for (const bool corrupt_after_recovery : {false, true}) {
SCOPED_TRACE(::testing::Message()
<< "corrupt_after_recovery: " << corrupt_after_recovery);
// Ensure that `db_` is fresh in this iteration.
CreateFreshDB();
// The database file ends up empty if we don't create at least one table.
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(i INTEGER PRIMARY KEY NOT NULL)"));
db_->Close();
ASSERT_TRUE(sql::test::CorruptSizeInHeader(db_path_));
size_t error_count = 0;
auto callback = base::BindLambdaForTesting([&](int error, Statement* stmt) {
error_count++;
ASSERT_TRUE(Recovery::RecoverIfPossible(
db_.get(), error, sql::Recovery::Strategy::kRecoverOrRaze));
if (corrupt_after_recovery) {
// Corrupt the file again after temporarily recovering it.
ASSERT_TRUE(sql::test::CorruptSizeInHeader(db_path_));
}
});
db_->set_error_callback(std::move(callback));
{
sql::test::ScopedErrorExpecter expecter;
base::HistogramTester tester;
expecter.ExpectError(SQLITE_CORRUPT);
// When `corrupt_after_recovery` is true, `Database::Open()` will return
// false because both attempts at opening the database will fail. When the
// database is *not* corrupted after recovery, recovery will succeed and
// thus `Database::Open()`'s second attempt at opening the database will
// succeed.
ASSERT_EQ(db_->Open(db_path_), !corrupt_after_recovery);
tester.ExpectUniqueSample("Sql.Database.Open.FirstAttempt.Error.Test",
SqliteResultCode::kCorrupt, 1);
if (corrupt_after_recovery) {
tester.ExpectUniqueSample("Sql.Database.Open.SecondAttempt.Error.Test",
SqliteResultCode::kCorrupt, 1);
}
EXPECT_TRUE(expecter.SawExpectedErrors());
}
EXPECT_EQ(error_count, 1u);
EXPECT_FALSE(db_->has_error_callback());
}
}
TEST_P(SQLDatabaseTest, ExecuteFailsAfterCorruptSizeInHeader) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(i INTEGER PRIMARY KEY NOT NULL)"));
constexpr static char kSelectSql[] = "SELECT * from rows";
EXPECT_TRUE(db_->Execute(kSelectSql))
<< "The test Execute() statement fails before the header is corrupted";
db_->Close();
ASSERT_TRUE(sql::test::CorruptSizeInHeader(db_path_));
{
sql::test::ScopedErrorExpecter expecter;
base::HistogramTester tester;
expecter.ExpectError(SQLITE_CORRUPT);
ASSERT_FALSE(db_->Open(db_path_));
tester.ExpectUniqueSample("Sql.Database.Open.FirstAttempt.Error.Test",
SqliteResultCode::kCorrupt, 1);
EXPECT_TRUE(expecter.SawExpectedErrors())
<< "Database::Open() did not encounter SQLITE_CORRUPT";
}
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_CORRUPT);
EXPECT_FALSE(db_->Execute(kSelectSql));
EXPECT_TRUE(expecter.SawExpectedErrors())
<< "Database::Execute() did not encounter SQLITE_CORRUPT";
}
}
TEST_P(SQLDatabaseTest, SchemaFailsAfterCorruptSizeInHeader) {
ASSERT_TRUE(
db_->Execute("CREATE TABLE rows(i INTEGER PRIMARY KEY NOT NULL)"));
ASSERT_TRUE(db_->DoesTableExist("rows"))
<< "The test schema check fails before the header is corrupted";
db_->Close();
ASSERT_TRUE(sql::test::CorruptSizeInHeader(db_path_));
{
sql::test::ScopedErrorExpecter expecter;
base::HistogramTester tester;
expecter.ExpectError(SQLITE_CORRUPT);
ASSERT_FALSE(db_->Open(db_path_));
tester.ExpectUniqueSample("Sql.Database.Open.FirstAttempt.Error.Test",
SqliteResultCode::kCorrupt, 1);
EXPECT_TRUE(expecter.SawExpectedErrors())
<< "Database::Open() did not encounter SQLITE_CORRUPT";
}
{
sql::test::ScopedErrorExpecter expecter;
expecter.ExpectError(SQLITE_CORRUPT);
EXPECT_FALSE(db_->DoesTableExist("rows"));
EXPECT_TRUE(expecter.SawExpectedErrors())
<< "Database::DoesTableExist() did not encounter SQLITE_CORRUPT";
}
}
TEST(SQLEmptyPathDatabaseTest, EmptyPathTest) {
Database db(test::kTestTag);
EXPECT_TRUE(db.OpenInMemory());
EXPECT_TRUE(db.is_open());
EXPECT_TRUE(db.DbPath().empty());
}
// WAL mode is currently not supported on Fuchsia.
#if !BUILDFLAG(IS_FUCHSIA)
INSTANTIATE_TEST_SUITE_P(JournalMode, SQLDatabaseTest, testing::Bool());
INSTANTIATE_TEST_SUITE_P(JournalMode,
SQLDatabaseTestExclusiveMode,
testing::Bool());
#else
INSTANTIATE_TEST_SUITE_P(JournalMode, SQLDatabaseTest, testing::Values(false));
INSTANTIATE_TEST_SUITE_P(JournalMode,
SQLDatabaseTestExclusiveMode,
testing::Values(false));
#endif
} // namespace sql