# 2006 June 10

#

# The author disclaims copyright to this source code.  In place of

# a legal notice, here is a blessing:

#

#    May you do good and not evil.

#    May you find forgiveness for yourself and forgive others.

#    May you share freely, never taking more than you give.

#

#***********************************************************************

# This file implements regression tests for SQLite library.  The

# focus of this file is creating and dropping virtual tables.

#

# $Id: vtab1.test,v 1.57 2008/08/01 17:51:47 danielk1977 Exp $

set testdir [file dirname $argv0]

source $testdir/tester.tcl

ifcapable !vtab||!schema_pragmas {

  finish_test

  return

}

#----------------------------------------------------------------------

# Organization of tests in this file:

#

# vtab1-1.*: Error conditions and other issues surrounding creation/connection

#            of a virtual module.

# vtab1-2.*: Test sqlite3_declare_vtab() and the xConnect/xDisconnect methods.

# vtab1-3.*: Table scans and WHERE clauses.

# vtab1-4.*: Table scans and ORDER BY clauses.

# vtab1-5.*: Test queries that include joins. This brings the

#            sqlite3_index_info.estimatedCost variable into play.

# vtab1-6.*: Test UPDATE/INSERT/DELETE on vtables.

# vtab1-7.*: Test sqlite3_last_insert_rowid().

#

# This file uses the "echo" module (see src/test8.c). Refer to comments

# in that file for the special behaviour of the Tcl $echo_module variable.

#

# TODO: 

#   * How to test the sqlite3_index_constraint_usage.omit field?

#   * vtab1-5.*

#

# vtab1-14.*: Test 'IN' constraints - i.e. "SELECT * FROM t1 WHERE id IN(...)"

#

#----------------------------------------------------------------------

# Test cases vtab1.1.*

#

# We cannot create a virtual table if the module has not been registered.

#

do_test vtab1-1.1 {

  explain {

    CREATE VIRTUAL TABLE t1 USING echo;

  }

  catchsql {

    CREATE VIRTUAL TABLE t1 USING echo;

  }

} {1 {no such module: echo}}

do_test vtab1-1.2 {

  execsql {

    SELECT name FROM sqlite_master ORDER BY 1

  }

} {}

# Register the module

register_echo_module [sqlite3_connection_pointer db]

# Once a module has been registered, virtual tables using that module

# may be created. However if a module xCreate() fails to call

# sqlite3_declare_vtab() an error will be raised and the table not created.

#

# The "echo" module does not invoke sqlite3_declare_vtab() if it is

# passed zero arguments.

#

do_test vtab1-1.3 {

  catchsql {

    CREATE VIRTUAL TABLE t1 USING echo;

  }

} {1 {vtable constructor did not declare schema: t1}}

do_test vtab1-1.4 {

  execsql {

    SELECT name FROM sqlite_master ORDER BY 1

  }

} {}

# The "echo" module xCreate method returns an error and does not create

# the virtual table if it is passed an argument that does not correspond

# to an existing real table in the same database.

#

do_test vtab1-1.5 {

  catchsql {

    CREATE VIRTUAL TABLE t1 USING echo(no_such_table);

  }

} {1 {vtable constructor failed: t1}}

do_test vtab1-1.6 {

  execsql {

    SELECT name FROM sqlite_master ORDER BY 1

  }

} {}

# Ticket #2156.  Using the sqlite3_prepare_v2() API, make sure that

# a CREATE VIRTUAL TABLE statement can be used multiple times.

#

do_test vtab1-1.2152.1 {

  set DB [sqlite3_connection_pointer db]

  set sql {CREATE VIRTUAL TABLE t2152a USING echo(t2152b)}

  set STMT [sqlite3_prepare_v2 $DB $sql -1 TAIL]

  sqlite3_step $STMT

} SQLITE_ERROR

do_test vtab-1.2152.2 {

  sqlite3_reset $STMT

  sqlite3_step $STMT

} SQLITE_ERROR

do_test vtab-1.2152.3 {

  sqlite3_reset $STMT

  db eval {CREATE TABLE t2152b(x,y)}

  sqlite3_step $STMT

} SQLITE_DONE

do_test vtab-1.2152.4 {

  sqlite3_finalize $STMT

  db eval {DROP TABLE t2152a; DROP TABLE t2152b}

} {}

# Test to make sure nothing goes wrong and no memory is leaked if we 

# select an illegal table-name (i.e a reserved name or the name of a

# table that already exists).

#

do_test vtab1-1.7 {

  catchsql {

    CREATE VIRTUAL TABLE sqlite_master USING echo;

  }

} {1 {object name reserved for internal use: sqlite_master}}

do_test vtab1-1.8 {

  catchsql {

    CREATE TABLE treal(a, b, c);

    CREATE VIRTUAL TABLE treal USING echo(treal);

  }

} {1 {table treal already exists}}

do_test vtab1-1.9 {

  execsql {

    DROP TABLE treal;

    SELECT name FROM sqlite_master ORDER BY 1

  }

} {}

do_test vtab1-1.10 {

  execsql {

    CREATE TABLE treal(a, b, c);

    CREATE VIRTUAL TABLE techo USING echo(treal);

  }

  db close

  sqlite3 db test.db

  catchsql {

    SELECT * FROM techo;

  }

} {1 {no such module: echo}}

do_test vtab1-1.11 {

  catchsql {

    INSERT INTO techo VALUES(1, 2, 3);

  }

} {1 {no such module: echo}}

do_test vtab1-1.12 {

  catchsql {

    UPDATE techo SET a = 10;

  }

} {1 {no such module: echo}}

do_test vtab1-1.13 {

  catchsql {

    DELETE FROM techo;

  }

} {1 {no such module: echo}}

do_test vtab1-1.14 {

  catchsql {

    PRAGMA table_info(techo)

  }

} {1 {no such module: echo}}

do_test vtab1-1.15 {

  catchsql {

    DROP TABLE techo;

  }

} {1 {no such module: echo}}

register_echo_module [sqlite3_connection_pointer db]

register_echo_module [sqlite3_connection_pointer db]

# Test an error message returned from a v-table constructor.

#

do_test vtab1-1.16 {

  execsql {

    DROP TABLE techo;

    CREATE TABLE logmsg(log);

  }

  catchsql {

    CREATE VIRTUAL TABLE techo USING echo(treal, logmsg);

  }

} {1 {table 'logmsg' already exists}}

do_test vtab1-1.17 {

  execsql {

    DROP TABLE treal;

    DROP TABLE logmsg;

    SELECT sql FROM sqlite_master;

  }

} {}

#----------------------------------------------------------------------

# Test cases vtab1.2.*

#

# At this point, the database is completely empty. The echo module

# has already been registered.

# If a single argument is passed to the echo module during table

# creation, it is assumed to be the name of a table in the same

# database. The echo module attempts to set the schema of the

# new virtual table to be the same as the existing database table.

#

do_test vtab1-2.1 {

  execsql {

    CREATE TABLE template(a, b, c);

  }

  execsql { PRAGMA table_info(template); }

} [list         \

  0 a {} 0 {} 0 \

  1 b {} 0 {} 0 \

  2 c {} 0 {} 0 \

]

do_test vtab1-2.2 {

  execsql {

    CREATE VIRTUAL TABLE t1 USING echo(template);

  }

  execsql { PRAGMA table_info(t1); }

} [list         \

  0 a {} 0 {} 0 \

  1 b {} 0 {} 0 \

  2 c {} 0 {} 0 \

]

# Test that the database can be unloaded. This should invoke the xDisconnect()

# callback for the successfully create virtual table (t1).

#

do_test vtab1-2.3 {

  set echo_module [list]

  db close

  set echo_module

} [list xDisconnect]

# Re-open the database. This should not cause any virtual methods to 

# be called. The invocation of xConnect() is delayed until the virtual

# table schema is first required by the compiler.

#

do_test vtab1-2.4 {

  set echo_module [list]

  sqlite3 db test.db

  db cache size 0

  set echo_module

} {}

# Try to query the virtual table schema. This should fail, as the

# echo module has not been registered with this database connection.

#

do_test vtab1.2.6 {

  catchsql { PRAGMA table_info(t1); }

} {1 {no such module: echo}}

# Register the module

register_echo_module [sqlite3_connection_pointer db]

# Try to query the virtual table schema again. This time it should

# invoke the xConnect method and succeed.

#

do_test vtab1.2.7 {

  execsql { PRAGMA table_info(t1); }

} [list         \

  0 a {} 0 {} 0 \

  1 b {} 0 {} 0 \

  2 c {} 0 {} 0 \

]

do_test vtab1.2.8 {

  set echo_module

} {xConnect echo main t1 template}

# Drop table t1. This should cause the xDestroy (but not xDisconnect) method 

# to be invoked.

do_test vtab1-2.5 {

  set echo_module ""

  execsql {

    DROP TABLE t1;

  }

  set echo_module

} {xDestroy}

do_test vtab1-2.6 {

  execsql { 

    PRAGMA table_info(t1); 

  }

} {}

do_test vtab1-2.7 {

  execsql {

    SELECT sql FROM sqlite_master;

  }

} [list {CREATE TABLE template(a, b, c)}]

# Clean up other test artifacts:

do_test vtab1-2.8 {

  execsql { 

    DROP TABLE template;

    SELECT sql FROM sqlite_master;

  }

} [list]

#----------------------------------------------------------------------

# Test case vtab1-3 test table scans and the echo module's 

# xBestIndex/xFilter handling of WHERE conditions.

do_test vtab1-3.1 {

  set echo_module ""

  execsql {

    CREATE TABLE treal(a INTEGER, b INTEGER, c); 

    CREATE INDEX treal_idx ON treal(b);

    CREATE VIRTUAL TABLE t1 USING echo(treal);

  }

  set echo_module

} [list xCreate echo main t1 treal   \

        xSync   echo(treal)  \

        xCommit echo(treal)  \

]

# Test that a SELECT on t1 doesn't crash. No rows are returned

# because the underlying real table is currently empty.

#

do_test vtab1-3.2 {

  execsql {

    SELECT a, b, c FROM t1;

  }

} {}

# Put some data into the table treal. Then try a few simple SELECT 

# statements on t1.

#

do_test vtab1-3.3 {

  execsql {

    INSERT INTO treal VALUES(1, 2, 3);

    INSERT INTO treal VALUES(4, 5, 6);

    SELECT * FROM t1;

  }

} {1 2 3 4 5 6}

do_test vtab1-3.4 {

  execsql {

    SELECT a FROM t1;

  }

} {1 4}

do_test vtab1-3.5 {

  execsql {

    SELECT rowid FROM t1;

  }

} {1 2}

do_test vtab1-3.6 {

  set echo_module ""

  execsql {

    SELECT * FROM t1;

  }

} {1 2 3 4 5 6}

do_test vtab1-3.7 {

  execsql {

    SELECT rowid, * FROM t1;

  }

} {1 1 2 3 2 4 5 6}

do_test vtab1-3.8 {

  execsql {

    SELECT a AS d, b AS e, c AS f FROM t1;

  }

} {1 2 3 4 5 6}

# Execute some SELECT statements with WHERE clauses on the t1 table.

# Then check the echo_module variable (written to by the module methods

# in test8.c) to make sure the xBestIndex() and xFilter() methods were

# called correctly.

#

do_test vtab1-3.8 {

  set echo_module ""

  execsql {

    SELECT * FROM t1;

  }

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal'} \

        xFilter    {SELECT rowid, * FROM 'treal'} ]

do_test vtab1-3.9 {

  set echo_module ""

  execsql {

    SELECT * FROM t1 WHERE b = 5;

  }

} {4 5 6}

do_test vtab1-3.10 {

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal' WHERE b = ?}   \

        xFilter    {SELECT rowid, * FROM 'treal' WHERE b = ?} 5 ]

do_test vtab1-3.10 {

  set echo_module ""

  execsql {

    SELECT * FROM t1 WHERE b >= 5 AND b <= 10;

  }

} {4 5 6}

do_test vtab1-3.11 {

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal' WHERE b >= ? AND b <= ?}      \

        xFilter    {SELECT rowid, * FROM 'treal' WHERE b >= ? AND b <= ?} 5 10 ]

do_test vtab1-3.12 {

  set echo_module ""

  execsql {

    SELECT * FROM t1 WHERE b BETWEEN 2 AND 10;

  }

} {1 2 3 4 5 6}

do_test vtab1-3.13 {

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal' WHERE b >= ? AND b <= ?}      \

        xFilter    {SELECT rowid, * FROM 'treal' WHERE b >= ? AND b <= ?} 2 10 ]

# Add a function for the MATCH operator. Everything always matches!

#proc test_match {lhs rhs} {

#  lappend ::echo_module MATCH $lhs $rhs

#  return 1

#}

#db function match test_match

set echo_module ""

do_test vtab1-3.12 {

  set echo_module ""

  catchsql {

    SELECT * FROM t1 WHERE a MATCH 'string';

  }

} {1 {unable to use function MATCH in the requested context}}

do_test vtab1-3.13 {

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal'} \

        xFilter    {SELECT rowid, * FROM 'treal'}]

ifcapable subquery {

# The echo module uses a subquery internally to implement the MATCH operator.

do_test vtab1-3.14 {

  set echo_module ""

  execsql {

    SELECT * FROM t1 WHERE b MATCH 'string';

  }

} {}

do_test vtab1-3.15 {

  set echo_module

} [list xBestIndex \

        {SELECT rowid, * FROM 'treal' WHERE b LIKE (SELECT '%'||?||'%')}  \

        xFilter \

        {SELECT rowid, * FROM 'treal' WHERE b LIKE (SELECT '%'||?||'%')} \

        string ]

}; #ifcapable subquery

#----------------------------------------------------------------------

# Test case vtab1-3 test table scans and the echo module's 

# xBestIndex/xFilter handling of ORDER BY clauses.

# This procedure executes the SQL.  Then it checks to see if the OP_Sort

# opcode was executed.  If an OP_Sort did occur, then "sort" is appended

# to the result.  If no OP_Sort happened, then "nosort" is appended.

#

# This procedure is used to check to make sure sorting is or is not

# occurring as expected.

#

proc cksort {sql} {

  set ::sqlite_sort_count 0

  set data [execsql $sql]

  if {$::sqlite_sort_count} {set x sort} {set x nosort}

  lappend data $x

  return $data

}

do_test vtab1-4.1 {

  set echo_module ""

  cksort {

    SELECT b FROM t1 ORDER BY b;

  }

} {2 5 nosort}

do_test vtab1-4.2 {

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal' ORDER BY b ASC} \

        xFilter    {SELECT rowid, * FROM 'treal' ORDER BY b ASC} ]

do_test vtab1-4.3 {

  set echo_module ""

  cksort {

    SELECT b FROM t1 ORDER BY b DESC;

  }

} {5 2 nosort}

do_test vtab1-4.4 {

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal' ORDER BY b DESC} \

        xFilter    {SELECT rowid, * FROM 'treal' ORDER BY b DESC} ]

do_test vtab1-4.3 {

  set echo_module ""

  cksort {

    SELECT b FROM t1 ORDER BY b||'';

  }

} {2 5 sort}

do_test vtab1-4.4 {

  set echo_module

} [list xBestIndex {SELECT rowid, * FROM 'treal'} \

        xFilter    {SELECT rowid, * FROM 'treal'} ]

execsql {

  DROP TABLE t1;

  DROP TABLE treal;

}

#----------------------------------------------------------------------

# Test cases vtab1-5 test SELECT queries that include joins on virtual 

# tables.

proc filter {log} {

  set out [list]

  for {set ii 0} {$ii < [llength $log]} {incr ii} {

    if {[lindex $log $ii] eq "xFilter"} {

      lappend out xFilter

      lappend out [lindex $log [expr $ii+1]]

    }

  }

  return $out

}

do_test vtab1-5-1 {

  execsql { 

    CREATE TABLE t1(a, b, c);

    CREATE TABLE t2(d, e, f);

    INSERT INTO t1 VALUES(1, 'red', 'green');