Merge pull request #39 from GE-fighting/main

add testing framework for kipsql

Author: KKould

Cargo.toml

@@ -47,3 +47,8 @@ ctor = "0.2.0"
 env_logger = "0.10"
 paste = "^1.0"
 rstest = "0.17"
+
+[workspace]
+members = [
+  "tests/sqllogictest",
+]

src/execution/executor_graph.rs

@@ -196,6 +196,7 @@ impl ExecutorGraph {
         Ok(())
     }
 
+    #[allow(invalid_reference_casting)]
     pub async fn init_schedule_event_queue(&self, global_execution_queue: &mut ExecutionQueue) {
         // Schedule source node.
         for node_idx in self.graph.externals(Direction::Outgoing) {

src/lib.rs

@@ -14,4 +14,5 @@ pub mod parser;
 pub mod planner;
 pub mod storage;
 pub mod types;
+pub mod util;
 mod execution_v1;

src/util/mod.rs

@@ -0,0 +1,34 @@
+
+use arrow::record_batch::RecordBatch;
+use arrow::datatypes::{DataType, Field, Schema, SchemaRef};
+use arrow::error::ArrowError;
+use arrow::util::display::array_value_to_string;
+
+pub fn record_batch_to_string(batch: &RecordBatch) -> Result<String, ArrowError> {
+    let mut output = String::new();
+    for row in 0..batch.num_rows() {
+        for col in 0..batch.num_columns() {
+            if col != 0 {
+                output.push(' ');
+            }
+            let column = batch.column(col);
+
+            // NULL values are rendered as "NULL".
+            if column.is_null(row) {
+                output.push_str("NULL");
+                continue;
+            }
+            let string = array_value_to_string(column, row)?;
+
+            // Empty strings are rendered as "(empty)".
+            if *column.data_type() == DataType::Utf8 && string.is_empty() {
+                output.push_str("(empty)");
+                continue;
+            }
+            output.push_str(&string);
+        }
+        output.push('\n');
+    }
+
+    Ok(output)
+}

tests/slt/create_table.slt

@@ -0,0 +1,39 @@
+statement ok
+create table t1(v1 varchar, v2 varchar, v3 varchar);
+
+statement ok
+insert into t1 values('a', 'b', 'c');
+
+statement error
+create table t1(v1 int);
+
+
+statement ok
+create table t2(v1 boolean, v2 tinyint, v3 smallint, v4 int, v5 bigint, v6 float, v7 double, v8 varchar);
+
+statement ok
+insert into t2 values(true, 1, 2, 3, 4, 5.1, 6.2, '7');
+
+
+statement ok
+create table t3(v1 boolean, v2 tinyint unsigned, v3 smallint unsigned, v4 int unsigned, v5 bigint unsigned, v6 float, v7 double, v8 varchar);
+
+statement ok
+insert into t3 values(true, 1, 2, 3, 4, 5.1, 6.2, '7');
+
+
+statement ok
+create table t4(v1 int);
+
+statement ok
+select v1 from t4;
+
+
+statement ok
+create table read_csv_table as select * from read_csv('tests/csv/t2.csv');
+
+
+query I
+select a from read_csv_table limit 1;
+----
+10

tests/slt/insert_table.slt

@@ -0,0 +1,93 @@
+# Test common insert case
+
+statement ok
+create table t1(v1 varchar, v2 varchar, v3 varchar);
+
+
+statement error
+insert into t1(v3) values ('0','4');
+
+
+statement ok
+insert into t1(v3, v2) values ('0','4'), ('1','5');
+
+
+statement ok
+insert into t1 values ('2','7','9');
+
+
+query III
+select v1, v3, v2 from t1;
+----
+NULL 0 4
+NULL 1 5
+2    9 7
+
+
+# Test insert value cast type
+
+statement ok
+create table t2(v1 int, v2 int, v3 int);
+
+
+statement ok
+insert into t2(v3, v2, v1) values (0, 4, 1), (1, 5, 2);
+
+
+query III
+select v3, v2, v1 from t2;
+----
+0 4 1
+1 5 2
+
+
+# Test insert type cast
+
+statement ok
+create table t3(v1 TINYINT UNSIGNED);
+
+
+statement error
+insert into t3(v1) values (1481);
+
+
+# Test insert null values
+
+statement ok
+create table t4(v1 varchar, v2 smallint unsigned, v3 bigint unsigned);
+
+
+statement ok
+insert into t4 values (NULL, 1, 2), ('', 3, NULL);
+
+
+statement ok
+insert into t4 values (NULL, NULL, NULL);
+
+
+query III
+select v1, v2, v3 from t4;
+----
+NULL 1 2
+(empty) 3 NULL
+NULL NULL NULL
+
+
+# Test insert from select
+
+statement ok
+CREATE TABLE integers(i INTEGER);
+
+
+statement ok
+INSERT INTO integers SELECT 42;
+
+statement ok
+INSERT INTO integers SELECT null;
+
+
+query I
+SELECT * FROM integers
+----
+42
+NULL

tests/slt/select.slt

@@ -0,0 +1,46 @@
+# test insert projection with cast expression
+
+statement ok
+create table t2(v1 tinyint);
+
+statement ok
+insert into t2(v1) values (1), (5);
+
+
+statement ok
+create table t1(v1 int, v2 int, v3 int);
+
+statement ok
+insert into t1(v3, v2, v1) values (0, 4, 1), (1, 5, 2);
+
+
+
+query III
+select t1.v1, v2 from t1;
+----
+1 4
+2 5
+
+
+
+query III
+select *, t1.* from t1;
+----
+1 4 0 1 4 0
+2 5 1 2 5 1
+
+
+# TODO: use alias function to verify output column names
+
+query III
+select t.v1 as a, v2 as b from t1 as t;
+----
+1 4
+2 5
+
+
+
+query III
+select 1, 2.3, '😇', true, null;
+----
+1 2.3 😇 true NULL

tests/sqllogictest/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "sqllogictest-test"
+version = "0.4.0"
+edition = "2021"
+
+[dependencies]
+"kip-sql" = { path = "../.." }
+sqllogictest = "0.6"
+glob = "0.3"
+async-trait = "0.1"
+libtest-mimic = "0.6"
+anyhow = { version = "1.0.71", features = ["std"] }
+[[test]]
+name = "sqllogictest"
+harness = false

tests/sqllogictest/src/lib.rs

@@ -0,0 +1,25 @@
+#![feature(iterator_try_collect)]
+use std::sync::Arc;
+
+use kip_sql::db::{Database, DatabaseError};
+use kip_sql::util::record_batch_to_string;
+use sqllogictest::{AsyncDB, Runner};
+pub fn test_run(sqlfile: &str) {
+    let db = Arc::new(Database::new_on_mem());
+    let mut tester = Runner::new(DatabaseWrapper { db });
+    tester.run_file(sqlfile).unwrap()
+}
+
+struct DatabaseWrapper {
+    db: Arc<Database>,
+}
+
+#[async_trait::async_trait]
+impl AsyncDB for DatabaseWrapper {
+    type Error = DatabaseError;
+    async fn run(&mut self, sql: &str) -> Result<String, Self::Error> {
+        let chunks = self.db.run(sql).await.unwrap();
+        let output = chunks.iter().map(record_batch_to_string).try_collect();
+        Ok(output?)
+    }
+}

tests/sqllogictest/tests/sqllogictest.rs

@@ -0,0 +1,35 @@
+use std::path::Path;
+
+use libtest_mimic::{Arguments, Trial};
+use sqllogictest_test::test_run;
+
+fn main() {
+    let path = Path::new(env!("CARGO_MANIFEST_DIR")).join("..").join("..");
+    std::env::set_current_dir(path).unwrap();
+
+    const SLT_PATTERN: &str = "tests/slt/**/*.slt";
+
+    let args = Arguments::from_args();
+    let mut tests = vec![];
+
+    let slt_files = glob::glob(SLT_PATTERN).expect("failed to find slt files");
+    for slt_file in slt_files {
+        let filepath = slt_file.expect("failed to read slt file");
+        let filename = filepath
+            .file_stem()
+            .expect("failed to get file name")
+            .to_str()
+            .unwrap()
+            .to_string();
+        let filepath = filepath.to_str().unwrap().to_string();
+
+        let test = Trial::test(filename, move || {
+            test_run(filepath.as_str());
+            Ok(())
+        });
+
+        tests.push(test);
+    }
+
+    libtest_mimic::run(&args, tests).exit();
+}