-
Notifications
You must be signed in to change notification settings - Fork 46
/
runner.rs
1660 lines (1502 loc) · 51.9 KB
/
runner.rs
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
//! Sqllogictest runner.
use std::fmt::{Debug, Display};
use std::path::Path;
use std::sync::Arc;
use std::time::Duration;
use std::vec;
use async_trait::async_trait;
use futures::executor::block_on;
use futures::{stream, Future, StreamExt};
use itertools::Itertools;
use md5::Digest;
use owo_colors::OwoColorize;
use regex::Regex;
use similar::{Change, ChangeTag, TextDiff};
use tempfile::{tempdir, TempDir};
use crate::parser::*;
use crate::ColumnType;
#[derive(Debug, Clone)]
pub enum RecordOutput<T: ColumnType> {
Nothing,
Query {
types: Vec<T>,
rows: Vec<Vec<String>>,
error: Option<Arc<dyn std::error::Error + Send + Sync>>,
},
Statement {
count: u64,
error: Option<Arc<dyn std::error::Error + Send + Sync>>,
},
}
#[non_exhaustive]
pub enum DBOutput<T: ColumnType> {
Rows {
types: Vec<T>,
rows: Vec<Vec<String>>,
},
/// A statement in the query has completed.
///
/// The number of rows modified or selected is returned.
///
/// If the test case doesn't specify `statement count <n>`, the number is simply ignored.
StatementComplete(u64),
}
/// The async database to be tested.
#[async_trait]
pub trait AsyncDB: Send {
/// The error type of SQL execution.
type Error: std::error::Error + Send + Sync + 'static;
/// The type of result columns
type ColumnType: ColumnType;
/// Async run a SQL query and return the output.
async fn run(&mut self, sql: &str) -> Result<DBOutput<Self::ColumnType>, Self::Error>;
/// Engine name of current database.
fn engine_name(&self) -> &str {
""
}
/// [`Runner`] calls this function to perform sleep.
///
/// The default implementation is `std::thread::sleep`, which is universial to any async runtime
/// but would block the current thread. If you are running in tokio runtime, you should override
/// this by `tokio::time::sleep`.
async fn sleep(dur: Duration) {
std::thread::sleep(dur);
}
}
/// The database to be tested.
pub trait DB: Send {
/// The error type of SQL execution.
type Error: std::error::Error + Send + Sync + 'static;
/// The type of result columns
type ColumnType: ColumnType;
/// Run a SQL query and return the output.
fn run(&mut self, sql: &str) -> Result<DBOutput<Self::ColumnType>, Self::Error>;
/// Engine name of current database.
fn engine_name(&self) -> &str {
""
}
}
/// Compat-layer for the new AsyncDB and DB trait
#[async_trait]
impl<D> AsyncDB for D
where
D: DB,
{
type Error = D::Error;
type ColumnType = D::ColumnType;
async fn run(&mut self, sql: &str) -> Result<DBOutput<Self::ColumnType>, Self::Error> {
D::run(self, sql)
}
fn engine_name(&self) -> &str {
D::engine_name(self)
}
}
/// The error type for running sqllogictest.
///
/// For colored error message, use `self.display()`.
#[derive(thiserror::Error, Clone)]
#[error("{kind}\nat {loc}\n")]
pub struct TestError {
kind: TestErrorKind,
loc: Location,
}
impl TestError {
pub fn display(&self, colorize: bool) -> TestErrorDisplay<'_> {
TestErrorDisplay {
err: self,
colorize,
}
}
}
/// Overrides the `Display` implementation of [`TestError`] to support controlling colorization.
pub struct TestErrorDisplay<'a> {
err: &'a TestError,
colorize: bool,
}
impl<'a> Display for TestErrorDisplay<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"{}\nat {}\n",
self.err.kind.display(self.colorize),
self.err.loc
)
}
}
/// For colored error message, use `self.display()`.
#[derive(Clone, Debug, thiserror::Error)]
pub struct ParallelTestError {
errors: Vec<TestError>,
}
impl Display for ParallelTestError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
writeln!(f, "parallel test failed")?;
write!(f, "Caused by:")?;
for i in &self.errors {
writeln!(f, "{i}")?;
}
Ok(())
}
}
/// Overrides the `Display` implementation of [`ParallelTestError`] to support controlling
/// colorization.
pub struct ParallelTestErrorDisplay<'a> {
err: &'a ParallelTestError,
colorize: bool,
}
impl<'a> Display for ParallelTestErrorDisplay<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
writeln!(f, "parallel test failed")?;
write!(f, "Caused by:")?;
for i in &self.err.errors {
writeln!(f, "{}", i.display(self.colorize))?;
}
Ok(())
}
}
impl ParallelTestError {
pub fn display(&self, colorize: bool) -> ParallelTestErrorDisplay<'_> {
ParallelTestErrorDisplay {
err: self,
colorize,
}
}
}
impl std::fmt::Debug for TestError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "{self}")
}
}
impl TestError {
/// Returns the corresponding [`TestErrorKind`] for this error.
pub fn kind(&self) -> TestErrorKind {
self.kind.clone()
}
/// Returns the location from which the error originated.
pub fn location(&self) -> Location {
self.loc.clone()
}
}
#[derive(Debug, Clone)]
pub enum RecordKind {
Statement,
Query,
}
impl std::fmt::Display for RecordKind {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
RecordKind::Statement => write!(f, "statement"),
RecordKind::Query => write!(f, "query"),
}
}
}
/// The error kind for running sqllogictest.
///
/// For colored error message, use `self.display()`.
#[derive(thiserror::Error, Debug, Clone)]
pub enum TestErrorKind {
#[error("parse error: {0}")]
ParseError(ParseErrorKind),
#[error("{kind} is expected to fail, but actually succeed:\n[SQL] {sql}")]
Ok { sql: String, kind: RecordKind },
#[error("{kind} failed: {err}\n[SQL] {sql}")]
Fail {
sql: String,
err: Arc<dyn std::error::Error + Send + Sync>,
kind: RecordKind,
},
// Remember to also update [`TestErrorKindDisplay`] if this message is changed.
#[error("{kind} is expected to fail with error:\n\t{expected_err}\nbut got error:\n\t{err}\n[SQL] {sql}")]
ErrorMismatch {
sql: String,
err: Arc<dyn std::error::Error + Send + Sync>,
expected_err: String,
kind: RecordKind,
},
#[error("statement is expected to affect {expected} rows, but actually {actual}\n[SQL] {sql}")]
StatementResultMismatch {
sql: String,
expected: u64,
actual: String,
},
// Remember to also update [`TestErrorKindDisplay`] if this message is changed.
#[error(
"query result mismatch:\n[SQL] {sql}\n[Diff] (-expected|+actual)\n{}",
TextDiff::from_lines(.expected, .actual).iter_all_changes().format_with("\n", |diff, f| format_diff(&diff, f, false))
)]
QueryResultMismatch {
sql: String,
expected: String,
actual: String,
},
#[error(
"query columns mismatch:\n[SQL] {sql}\n{}",
format_column_diff(expected, actual, false)
)]
QueryResultColumnsMismatch {
sql: String,
expected: String,
actual: String,
},
}
impl From<ParseError> for TestError {
fn from(e: ParseError) -> Self {
TestError {
kind: TestErrorKind::ParseError(e.kind()),
loc: e.location(),
}
}
}
impl TestErrorKind {
fn at(self, loc: Location) -> TestError {
TestError { kind: self, loc }
}
pub fn display(&self, colorize: bool) -> TestErrorKindDisplay<'_> {
TestErrorKindDisplay {
error: self,
colorize,
}
}
}
/// Overrides the `Display` implementation of [`TestErrorKind`] to support controlling colorization.
pub struct TestErrorKindDisplay<'a> {
error: &'a TestErrorKind,
colorize: bool,
}
impl<'a> Display for TestErrorKindDisplay<'a> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
if !self.colorize {
return write!(f, "{}", self.error);
}
match self.error {
TestErrorKind::ErrorMismatch {
sql,
err,
expected_err,
kind,
} => write!(
f,
"{kind} is expected to fail with error:\n\t{}\nbut got error:\n\t{}\n[SQL] {sql}",
expected_err.bright_green(),
err.bright_red(),
),
TestErrorKind::QueryResultMismatch {
sql,
expected,
actual,
} => write!(
f,
"query result mismatch:\n[SQL] {sql}\n[Diff] ({}|{})\n{}",
"-expected".bright_red(),
"+actual".bright_green(),
TextDiff::from_lines(expected, actual)
.iter_all_changes()
.format_with("\n", |diff, f| format_diff(&diff, f, true))
),
TestErrorKind::QueryResultColumnsMismatch {
sql,
expected,
actual,
} => {
write!(
f,
"query columns mismatch:\n[SQL] {sql}\n{}",
format_column_diff(expected, actual, true)
)
}
_ => write!(f, "{}", self.error),
}
}
}
fn format_diff(
diff: &Change<&str>,
f: &mut dyn FnMut(&dyn std::fmt::Display) -> std::fmt::Result,
colorize: bool,
) -> std::fmt::Result {
match diff.tag() {
ChangeTag::Equal => f(&diff
.value()
.lines()
.format_with("\n", |line, f| f(&format_args!(" {line}")))),
ChangeTag::Insert => f(&diff.value().lines().format_with("\n", |line, f| {
if colorize {
f(&format_args!("+ {line}").bright_green())
} else {
f(&format_args!("+ {line}"))
}
})),
ChangeTag::Delete => f(&diff.value().lines().format_with("\n", |line, f| {
if colorize {
f(&format_args!("- {line}").bright_red())
} else {
f(&format_args!("- {line}"))
}
})),
}
}
fn format_column_diff(expected: &str, actual: &str, colorize: bool) -> String {
let (expected, actual) = TextDiff::from_chars(expected, actual)
.iter_all_changes()
.fold(
("".to_string(), "".to_string()),
|(expected, actual), change| match change.tag() {
ChangeTag::Equal => (
format!("{}{}", expected, change.value()),
format!("{}{}", actual, change.value()),
),
ChangeTag::Delete => (
if colorize {
format!("{}[{}]", expected, change.value().bright_red())
} else {
format!("{}[{}]", expected, change.value())
},
actual,
),
ChangeTag::Insert => (
expected,
if colorize {
format!("{}[{}]", actual, change.value().bright_green())
} else {
format!("{}[{}]", actual, change.value())
},
),
},
);
format!("[Expected] {expected}\n[Actual ] {actual}")
}
/// Trim and replace multiple whitespaces with one.
#[allow(clippy::ptr_arg)]
fn normalize_string(s: &String) -> String {
s.trim().split_ascii_whitespace().join(" ")
}
/// Validator will be used by [`Runner`] to validate the output.
///
/// # Default
///
/// By default ([`default_validator`]), we will use compare normalized results.
pub type Validator = fn(actual: &[Vec<String>], expected: &[String]) -> bool;
pub fn default_validator(actual: &[Vec<String>], expected: &[String]) -> bool {
let expected_results = expected.iter().map(normalize_string).collect_vec();
// Default, we compare normalized results. Whitespace characters are ignored.
let normalized_rows = actual
.iter()
.map(|strs| strs.iter().map(normalize_string).join(" "))
.collect_vec();
normalized_rows == expected_results
}
/// [`Runner`] uses this validator to check that the expected column types match an actual output.
///
/// # Default
///
/// By default ([`default_column_validator`]), columns are not validated.
pub type ColumnTypeValidator<T> = fn(actual: &Vec<T>, expected: &Vec<T>) -> bool;
/// The default validator always returns success for any inputs of expected and actual sets of
/// columns.
pub fn default_column_validator<T: ColumnType>(_: &Vec<T>, _: &Vec<T>) -> bool {
true
}
/// The strict validator checks:
/// - the number of columns is as expected
/// - each column has the same type as expected
pub fn strict_column_validator<T: ColumnType>(actual: &Vec<T>, expected: &Vec<T>) -> bool {
actual.len() == expected.len()
&& !actual
.iter()
.zip(expected.iter())
.any(|(actual_column, expected_column)| actual_column != expected_column)
}
/// Sqllogictest runner.
pub struct Runner<D: AsyncDB> {
db: D,
// validator is used for validate if the result of query equals to expected.
validator: Validator,
column_type_validator: ColumnTypeValidator<D::ColumnType>,
testdir: Option<TempDir>,
sort_mode: Option<SortMode>,
/// 0 means never hashing
hash_threshold: usize,
}
impl<D: AsyncDB> Runner<D> {
/// Create a new test runner on the database.
pub fn new(db: D) -> Self {
Runner {
db,
validator: default_validator,
column_type_validator: default_column_validator,
testdir: None,
sort_mode: None,
hash_threshold: 0,
}
}
/// Replace the pattern `__TEST_DIR__` in SQL with a temporary directory path.
///
/// This feature is useful in those tests where data will be written to local
/// files, e.g. `COPY`.
pub fn enable_testdir(&mut self) {
self.testdir = Some(tempdir().expect("failed to create testdir"));
}
pub fn with_validator(&mut self, validator: Validator) {
self.validator = validator;
}
pub fn with_column_validator(&mut self, validator: ColumnTypeValidator<D::ColumnType>) {
self.column_type_validator = validator;
}
pub fn with_hash_threshold(&mut self, hash_threshold: usize) {
self.hash_threshold = hash_threshold;
}
pub async fn apply_record(
&mut self,
record: Record<D::ColumnType>,
) -> RecordOutput<D::ColumnType> {
match record {
Record::Statement { conditions, .. } if self.should_skip(&conditions) => {
RecordOutput::Nothing
}
Record::Statement {
conditions: _,
sql,
// compare result in run_async
expected_error: _,
expected_count: _,
loc: _,
} => {
let sql = self.replace_keywords(sql);
let ret = self.db.run(&sql).await;
match ret {
Ok(out) => match out {
DBOutput::Rows { types, rows } => RecordOutput::Query {
types,
rows,
error: None,
},
DBOutput::StatementComplete(count) => {
RecordOutput::Statement { count, error: None }
}
},
Err(e) => RecordOutput::Statement {
count: 0,
error: Some(Arc::new(e)),
},
}
}
Record::Query { conditions, .. } if self.should_skip(&conditions) => {
RecordOutput::Nothing
}
Record::Query {
conditions: _,
sql,
sort_mode,
// compare result in run_async
expected_types: _,
expected_error: _,
expected_results: _,
loc: _,
// not handle yet,
label: _,
} => {
let sql = self.replace_keywords(sql);
let (types, mut rows) = match self.db.run(&sql).await {
Ok(out) => match out {
DBOutput::Rows { types, rows } => (types, rows),
DBOutput::StatementComplete(count) => {
return RecordOutput::Statement { count, error: None };
}
},
Err(e) => {
return RecordOutput::Query {
error: Some(Arc::new(e)),
types: vec![],
rows: vec![],
};
}
};
match sort_mode.as_ref().or(self.sort_mode.as_ref()) {
None | Some(SortMode::NoSort) => {}
Some(SortMode::RowSort) => {
rows.sort_unstable();
}
Some(SortMode::ValueSort) => todo!("value sort"),
};
if self.hash_threshold > 0 && rows.len() * types.len() > self.hash_threshold {
let mut md5 = md5::Md5::new();
for line in &rows {
for value in line {
md5.update(value.as_bytes());
md5.update(b"\n");
}
}
let hash = format!("{:2x}", md5.finalize());
rows = vec![vec![format!(
"{} values hashing to {}",
rows.len() * rows[0].len(),
hash
)]];
}
RecordOutput::Query {
error: None,
types,
rows,
}
}
Record::Sleep { duration, .. } => {
D::sleep(duration).await;
RecordOutput::Nothing
}
Record::Control(control) => match control {
Control::SortMode(sort_mode) => {
self.sort_mode = Some(sort_mode);
RecordOutput::Nothing
}
},
Record::HashThreshold { loc: _, threshold } => {
self.hash_threshold = threshold as usize;
RecordOutput::Nothing
}
Record::Include { .. }
| Record::Comment(_)
| Record::Newline
| Record::Subtest { .. }
| Record::Halt { .. }
| Record::Injected(_)
| Record::Condition(_) => RecordOutput::Nothing,
}
}
/// Run a single record.
pub async fn run_async(&mut self, record: Record<D::ColumnType>) -> Result<(), TestError> {
tracing::debug!(?record, "testing");
match (record.clone(), self.apply_record(record).await) {
(_, RecordOutput::Nothing) => {}
// Tolerate the mismatched return type...
(Record::Statement { .. }, RecordOutput::Query { error: None, .. }) => {}
(
Record::Query {
expected_results,
loc,
sql,
..
},
RecordOutput::Statement { error: None, .. },
) => {
if !expected_results.is_empty() {
return Err(TestErrorKind::QueryResultMismatch {
sql,
expected: expected_results.join("\n"),
actual: "".to_string(),
}
.at(loc));
}
}
(
Record::Statement {
loc,
conditions: _,
expected_error,
sql,
expected_count,
},
RecordOutput::Statement { count, error },
) => match (error, expected_error) {
(None, Some(_)) => {
return Err(TestErrorKind::Ok {
sql,
kind: RecordKind::Statement,
}
.at(loc))
}
(None, None) => {
if let Some(expected_count) = expected_count {
if expected_count != count {
return Err(TestErrorKind::StatementResultMismatch {
sql,
expected: expected_count,
actual: format!("affected {count} rows"),
}
.at(loc));
}
}
}
(Some(e), Some(expected_error)) => {
if !expected_error.is_match(&e.to_string()) {
return Err(TestErrorKind::ErrorMismatch {
sql,
err: Arc::new(e),
expected_err: expected_error.to_string(),
kind: RecordKind::Statement,
}
.at(loc));
}
}
(Some(e), None) => {
return Err(TestErrorKind::Fail {
sql,
err: Arc::new(e),
kind: RecordKind::Statement,
}
.at(loc));
}
},
(
Record::Query {
loc,
conditions: _,
expected_types,
sort_mode: _,
label: _,
expected_error,
sql,
expected_results,
},
RecordOutput::Query { types, rows, error },
) => {
match (error, expected_error) {
(None, Some(_)) => {
return Err(TestErrorKind::Ok {
sql,
kind: RecordKind::Query,
}
.at(loc));
}
(None, None) => {}
(Some(e), Some(expected_error)) => {
if !expected_error.is_match(&e.to_string()) {
return Err(TestErrorKind::ErrorMismatch {
sql,
err: Arc::new(e),
expected_err: expected_error.to_string(),
kind: RecordKind::Query,
}
.at(loc));
}
return Ok(());
}
(Some(e), None) => {
return Err(TestErrorKind::Fail {
sql,
err: Arc::new(e),
kind: RecordKind::Query,
}
.at(loc));
}
};
if !(self.column_type_validator)(&types, &expected_types) {
return Err(TestErrorKind::QueryResultColumnsMismatch {
sql,
expected: expected_types.iter().map(|c| c.to_char()).join(""),
actual: types.iter().map(|c| c.to_char()).join(""),
}
.at(loc));
}
if !(self.validator)(&rows, &expected_results) {
let output_rows = rows
.into_iter()
.map(|strs| strs.iter().join(" "))
.collect_vec();
return Err(TestErrorKind::QueryResultMismatch {
sql,
expected: expected_results.join("\n"),
actual: output_rows.join("\n"),
}
.at(loc));
}
}
_ => unreachable!(),
}
Ok(())
}
/// Run a single record.
pub fn run(&mut self, record: Record<D::ColumnType>) -> Result<(), TestError> {
futures::executor::block_on(self.run_async(record))
}
/// Run multiple records.
///
/// The runner will stop early once a halt record is seen.
pub async fn run_multi_async(
&mut self,
records: impl IntoIterator<Item = Record<D::ColumnType>>,
) -> Result<(), TestError> {
for record in records.into_iter() {
if let Record::Halt { .. } = record {
break;
}
self.run_async(record).await?;
}
Ok(())
}
/// Run multiple records.
///
/// The runner will stop early once a halt record is seen.
pub fn run_multi(
&mut self,
records: impl IntoIterator<Item = Record<D::ColumnType>>,
) -> Result<(), TestError> {
block_on(self.run_multi_async(records))
}
/// Run a sqllogictest script.
pub async fn run_script_async(&mut self, script: &str) -> Result<(), TestError> {
let records = parse(script).expect("failed to parse sqllogictest");
self.run_multi_async(records).await
}
/// Run a sqllogictest script with a given script name.
pub async fn run_script_with_name_async(
&mut self,
script: &str,
name: impl Into<Arc<str>>,
) -> Result<(), TestError> {
let records = parse_with_name(script, name).expect("failed to parse sqllogictest");
self.run_multi_async(records).await
}
/// Run a sqllogictest file.
pub async fn run_file_async(&mut self, filename: impl AsRef<Path>) -> Result<(), TestError> {
let records = parse_file(filename)?;
self.run_multi_async(records).await
}
/// Run a sqllogictest script.
pub fn run_script(&mut self, script: &str) -> Result<(), TestError> {
block_on(self.run_script_async(script))
}
/// Run a sqllogictest script with a given script name.
pub fn run_script_with_name(
&mut self,
script: &str,
name: impl Into<Arc<str>>,
) -> Result<(), TestError> {
block_on(self.run_script_with_name_async(script, name))
}
/// Run a sqllogictest file.
pub fn run_file(&mut self, filename: impl AsRef<Path>) -> Result<(), TestError> {
block_on(self.run_file_async(filename))
}
/// accept the tasks, spawn jobs task to run slt test. the tasks are (AsyncDB, slt filename)
/// pairs.
pub async fn run_parallel_async<Fut>(
&mut self,
glob: &str,
hosts: Vec<String>,
conn_builder: fn(String, String) -> Fut,
jobs: usize,
) -> Result<(), ParallelTestError>
where
Fut: Future<Output = D>,
{
let files = glob::glob(glob).expect("failed to read glob pattern");
let mut tasks = vec![];
// let conn_builder = Arc::new(conn_builder);
for (idx, file) in files.enumerate() {
// for every slt file, we create a database against table conflict
let file = file.unwrap();
let db_name = file
.file_name()
.expect("not a valid filename")
.to_str()
.expect("not a UTF-8 filename");
let db_name = db_name.replace([' ', '.', '-'], "_");
self.db
.run(&format!("CREATE DATABASE {db_name};"))
.await
.expect("create db failed");
let target = hosts[idx % hosts.len()].clone();
tasks.push(async move {
let db = conn_builder(target, db_name).await;
let mut tester = Runner::new(db);
let filename = file.to_string_lossy().to_string();
tester.run_file_async(filename).await
})
}
let tasks = stream::iter(tasks).buffer_unordered(jobs);
let errors: Vec<_> = tasks
.filter_map(|result| async { result.err() })
.collect()
.await;
if errors.is_empty() {
Ok(())
} else {
Err(ParallelTestError { errors })
}
}
/// sync version of `run_parallel_async`
pub fn run_parallel<Fut>(
&mut self,
glob: &str,
hosts: Vec<String>,
conn_builder: fn(String, String) -> Fut,
jobs: usize,
) -> Result<(), ParallelTestError>
where
Fut: Future<Output = D>,
{
block_on(self.run_parallel_async(glob, hosts, conn_builder, jobs))
}
/// Replace all keywords in the SQL.
fn replace_keywords(&self, sql: String) -> String {
if let Some(testdir) = &self.testdir {
sql.replace("__TEST_DIR__", testdir.path().to_str().unwrap())
} else {
sql
}
}
/// Returns whether we should skip this record, according to given `conditions`.
fn should_skip(&self, conditions: &[Condition]) -> bool {
conditions
.iter()
.any(|c| c.should_skip(self.db.engine_name()))
}
/// Updates a test file with the output produced by a Database. It is an utility function
/// wrapping [`update_test_file_with_runner`].
///
/// Specifically, it will create `"{filename}.temp"` to buffer the updated records and then
/// override the original file with it.
///
/// Some other notes:
/// - empty lines at the end of the file are cleaned.
/// - `halt` and `include` are correctly handled.
pub async fn update_test_file(
&mut self,
filename: impl AsRef<Path>,
col_separator: &str,
validator: Validator,
column_type_validator: ColumnTypeValidator<D::ColumnType>,
) -> Result<(), Box<dyn std::error::Error>> {
use std::io::{Read, Seek, SeekFrom, Write};
use std::path::PathBuf;
use fs_err::{File, OpenOptions};
fn create_outfile(filename: impl AsRef<Path>) -> std::io::Result<(PathBuf, File)> {
let filename = filename.as_ref();
let outfilename = filename.file_name().unwrap().to_str().unwrap().to_owned() + ".temp";
let outfilename = filename.parent().unwrap().join(outfilename);
// create a temp file in read-write mode
let outfile = OpenOptions::new()
.write(true)
.create(true)
.truncate(true)
.read(true)
.open(&outfilename)?;
Ok((outfilename, outfile))
}
fn override_with_outfile(
filename: &String,
outfilename: &PathBuf,
outfile: &mut File,
) -> std::io::Result<()> {
// check whether outfile ends with multiple newlines, which happens if
// - the last record is statement/query
// - the original file ends with multiple newlines
const N: usize = 8;
let mut buf = [0u8; N];
loop {
outfile.seek(SeekFrom::End(-(N as i64))).unwrap();
outfile.read_exact(&mut buf).unwrap();
let num_newlines = buf.iter().rev().take_while(|&&b| b == b'\n').count();
assert!(num_newlines > 0);
if num_newlines > 1 {
// if so, remove the last ones
outfile
.set_len(outfile.metadata().unwrap().len() - num_newlines as u64 + 1)
.unwrap();
}
if num_newlines == 1 || num_newlines < N {
break;
}
}
outfile.flush()?;
fs_err::rename(outfilename, filename)?;
Ok(())
}
struct Item {
filename: String,
outfilename: PathBuf,
outfile: File,
halt: bool,
}
let filename = filename.as_ref();
let records = parse_file(filename)?;