{-# LANGUAGE BlockArguments #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
module Main where
import Control.Concurrent
import Control.Exception
import Control.Monad (forM_, liftM3, when)
import Data.ByteString qualified as B
import Data.ByteString.Char8 qualified as B8
import Data.Text (Text)
import Data.Text qualified as T
import Data.Text.Encoding qualified as T
import Data.Text.Encoding.Error (UnicodeException (..), lenientDecode)
import Sqlite
import Sqlite.Direct qualified as Direct
import StrictEq
import System.Directory (doesFileExist, removeFile)
import System.IO
import System.IO.Error (isUserError)
import System.Timeout (timeout)
import Test.Tasty
import Test.Tasty.HUnit
data TestEnv = TestEnv
{ -- | Connection shared by all the tests
conn :: Connection,
-- | Bracket for spawning an additional connection.
-- This connection will be isolated from others.
withConn :: forall a. (Connection -> IO a) -> IO a,
-- | Like 'withConn', but every invocation shares the same Connection.
withConnShared :: forall a. (Connection -> IO a) -> IO a
}
regressionTests :: [IO TestEnv -> TestTree]
regressionTests =
[ testCase "Exec" . testExec,
testCase "ExecCallback" . testExecCallback,
testCase "Simple" . testSimplest,
testCase "Prepare" . testPrepare,
testCase "CloseBusy" . testCloseBusy,
testCase "Params" . testBind,
testCase "Params" . testBindParamCounts,
testCase "Params" . testBindParamName,
testCase "Params" . testBindErrorValidation,
testCase "Params" . testNamedBindParams,
testCase "Columns" . testColumns,
testCase "TypedColumns" . testTypedColumns,
testCase "ColumnName" . testColumnName,
testCase "Errors" . testErrors,
testCase "Integrity" . testIntegrity,
testCase "DecodeError" . testDecodeError,
testCase "ResultStats" . testResultStats,
testCase "GetAutoCommit" . testGetAutoCommit,
testCase "Debug" . testStatementSql,
testCase "Debug" . testTracing,
testCase "CustomFunc" . testCustomFunction,
testCase "CustomFuncErr" . testCustomFunctionError,
testCase "CustomAggr" . testCustomAggragate,
testCase "CustomColl" . testCustomCollation,
testCase "IncrBlobIO" . testIncrementalBlobIO,
testCase "MultiRowInsert" . testMultiRowInsert
]
++ ( if rtsSupportsBoundThreads
then
[ testCase "Interrupt" . testInterrupt
]
else []
)
assertFail :: IO a -> Assertion
assertFail action =
shouldFail action >>= assertBool "assertFail"
-- | Return 'True' if the IO action throws a 'userError',
-- which happens when 'fail' is used.
shouldFail :: IO a -> IO Bool
shouldFail action = do
r <- try action
case r of
Left e -> return $ isUserError e
Right _ -> return False
withStmt :: Connection -> Text -> (PreparedStatement -> IO a) -> IO a
withStmt conn sql = bracket (prepare conn sql) finalize
testExec :: IO TestEnv -> Assertion
testExec envIO = do
TestEnv {..} <- envIO
exec conn ""
exec conn " "
exec conn ";"
exec conn " ; ; ; ; ; "
exec conn "--"
Left SqliteException {sqliteError = ErrorError} <- try $ exec conn "/*"
-- sqlite3_exec does not allow "/*" to be terminated by end of input,
-- but <https://www.sqlite.org/lang_comment.html> says it's fine.
exec conn ";--\n;/**/"
withConn $ \conn -> do
-- Make sure all the statements passed to exec are executed.
-- Test a little value conversion while we're at it.
exec
conn
"CREATE TABLE foo (n FLOAT, t TEXT); \
\INSERT INTO foo VALUES (3.5, null); \
\INSERT INTO foo VALUES (null, 'Ự₦ⓘ₡ợ₫ḝ'); \
\INSERT INTO foo VALUES (null, ''); \
\INSERT INTO foo VALUES (null, 'null'); \
\INSERT INTO foo VALUES (null, null)"
withStmt conn ("SELECT * FROM foo") $ \stmt -> do
Row <- step stmt
[SqlFloat 3.5, SqlNull] <- columns stmt
Row <- step stmt
[SqlNull, SqlText "Ự₦ⓘ₡ợ₫ḝ"] <- columns stmt
Row <- step stmt
[SqlNull, SqlText ""] <- columns stmt
Row <- step stmt
[SqlNull, SqlText "null"] <- columns stmt
Row <- step stmt
[SqlNull, SqlNull] <- columns stmt
Done <- step stmt
return ()
data Ex = Ex
deriving (Show)
instance Exception Ex
testExecCallback :: IO TestEnv -> Assertion
testExecCallback envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
chan <- newChan
let exec' sql = execWithCallback conn sql $ \c n v -> writeChan chan (c, n, v)
exec'
"CREATE TABLE foo (a INT, b TEXT); \
\INSERT INTO foo VALUES (1, 'a'); \
\INSERT INTO foo VALUES (2, 'b'); \
\INSERT INTO foo VALUES (3, null); \
\INSERT INTO foo VALUES (null, 'd'); "
exec' "SELECT 1, 2, 3"
(3, ["1", "2", "3"], [Just "1", Just "2", Just "3"]) <- readChan chan
exec' "SELECT null"
(1, ["null"], [Nothing]) <- readChan chan
exec' "SELECT * FROM foo"
(2, ["a", "b"], [Just "1", Just "a"]) <- readChan chan
(2, ["a", "b"], [Just "2", Just "b"]) <- readChan chan
(2, ["a", "b"], [Just "3", Nothing]) <- readChan chan
(2, ["a", "b"], [Nothing, Just "d"]) <- readChan chan
exec' "SELECT * FROM foo WHERE a < 0; SELECT 123"
(1, ["123"], [Just "123"]) <- readChan chan
exec' "SELECT rowid, f.a, f.b, a || b FROM foo AS f"
(4, ["rowid", "a", "b", "a || b"], [Just "1", Just "1", Just "a", Just "1a"]) <- readChan chan
(4, ["rowid", "a", "b", "a || b"], [Just "2", Just "2", Just "b", Just "2b"]) <- readChan chan
(4, ["rowid", "a", "b", "a || b"], [Just "3", Just "3", Nothing, Nothing]) <- readChan chan
(4, ["rowid", "a", "b", "a || b"], [Just "4", Nothing, Just "d", Nothing]) <- readChan chan
Left Ex <- try $ execWithCallback conn "SELECT 1" $ \_ _ _ -> throwIO Ex
return ()
testTracing :: IO TestEnv -> Assertion
testTracing envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
chan <- newChan
let logger m = writeChan chan m
Direct.setTrace conn (Just logger)
withStmt conn "SELECT null" $ \stmt -> do
Row <- step stmt
res <- columns stmt
Done <- step stmt
assertEqual "tracing" [SqlNull] res
Direct.Utf8 msg <- readChan chan
assertEqual "tracing" "SELECT null" msg
withStmt conn "SELECT 1+?" $ \stmt -> do
bind stmt [SqlInteger 2]
Row <- step stmt
Done <- step stmt
reset stmt
bind stmt [SqlInteger 3]
Row <- step stmt
Done <- step stmt
Direct.Utf8 msg <- readChan chan
assertEqual "tracing" "SELECT 1+2" msg
Direct.Utf8 msg <- readChan chan
assertEqual "tracing" "SELECT 1+3" msg
-- Check that disabling works too
Direct.setTrace conn Nothing
reset stmt
bind stmt [SqlInteger 3]
Row <- step stmt
Done <- step stmt
writeChan chan (Direct.Utf8 "empty")
Direct.Utf8 msg <- readChan chan
assertEqual "tracing" "empty" msg
-- Simplest SELECT
testSimplest :: IO TestEnv -> Assertion
testSimplest envIO = do
TestEnv {..} <- envIO
stmt <- prepare conn "SELECT 1+1"
Row <- step stmt
res <- column stmt 0
Done <- step stmt
finalize stmt
assertEqual "1+1" (SqlInteger 2) res
testPrepare :: IO TestEnv -> Assertion
testPrepare envIO = do
TestEnv {..} <- envIO
True <- shouldFail $ prepare conn ""
True <- shouldFail $ prepare conn ";"
withConn $ \conn -> do
withStmt
conn
"CREATE TABLE foo (a INT, b INT); \
\INSERT INTO foo VALUES (1, 2); \
\INSERT INTO foo VALUES (3, 4)"
$ \stmt -> do
Done <- step stmt
return ()
withStmt
conn
"BEGIN; INSERT INTO foo VALUES (5, 6); COMMIT"
$ \stmt -> do
Done <- step stmt
return ()
withStmt
conn
"SELECT * FROM foo"
$ \stmt -> do
Done <- step stmt -- No row was inserted, because only the CREATE TABLE
-- statement was run. The rest was ignored.
return ()
Left SqliteException {sqliteError = ErrorError} <- try $ exec conn "BEGIN"
-- We're in a transaction already, so this fails.
exec conn "COMMIT"
return ()
testCloseBusy :: IO TestEnv -> Assertion
testCloseBusy _ = do
conn <- open ":memory:"
stmt <- prepare conn "SELECT 1"
Left SqliteException {sqliteError = ErrorBusy} <- try $ close conn
finalize stmt
close conn
testBind :: IO TestEnv -> Assertion
testBind envIO = do
TestEnv {..} <- envIO
bracket (prepare conn "SELECT ?") finalize testBind1
bracket (prepare conn "SELECT ?+?") finalize testBind2
bracket (prepare conn "SELECT ?,?") finalize testBind3
where
testBind1 stmt = do
let params = [SqlInteger 3]
bind stmt params
Row <- step stmt
res <- columns stmt
Done <- step stmt
assertEqual "single param" params res
testBind2 stmt = do
let params = [SqlInteger 1, SqlInteger 1]
bind stmt params
Row <- step stmt
res <- columns stmt
Done <- step stmt
assertEqual "two params param" [SqlInteger 2] res
testBind3 stmt = do
let len = 7
bs = B.replicate len 0
bindBlob stmt 1 bs
bindZeroBlob stmt 2 len
Row <- step stmt
res <- columns stmt
Done <- step stmt
assertEqual "blob vs. zeroblob" [SqlBlob bs, SqlBlob bs] res
-- Test bindParameterCount
testBindParamCounts :: IO TestEnv -> Assertion
testBindParamCounts envIO = do
TestEnv {..} <- envIO
let testCase label query expected =
bracket (prepare conn query) finalize bindParameterCount
>>= assertEqual label expected
testCase "single $a" "SELECT $a" 1
testCase "3 unique ?NNNs" "SELECT (?1+?1+?1+?2+?3)" 3
testCase "3 positional" "SELECT (?+?+?)" 3
testCase "5 params, 2 gaps" "SELECT ?3, ?5, ?1" 5
testCase "6 params, gaps & auto" "SELECT ?3, ?5, ?1, ?" 6
testCase "8 params, auto & overlap" "SELECT ?, ?5, ?, ?2, ?, ?6, ?" 8
-- 8 because ? grabs an index one greater than the highest index of all
-- previous parameters, not just the most recent index.
testCase "0 placeholders" "SELECT 1" 0
-- Test bindParameterName
testBindParamName :: IO TestEnv -> Assertion
testBindParamName envIO = do
TestEnv {..} <- envIO
bracket (prepare conn "SELECT :v + :v2") finalize (testNames [Just ":v", Just ":v2"])
bracket (prepare conn "SELECT ?1 + ?1") finalize (testNames [Just "?1"])
bracket (prepare conn "SELECT ?1 + ?2") finalize (testNames [Just "?1", Just "?2"])
bracket (prepare conn "SELECT ? + ?") finalize (testNames [Nothing, Nothing])
bracket (prepare conn "SELECT $1 + $2") finalize (testNames [Just "$1", Just "$2"])
where
testNames names stmt = do
count <- bindParameterCount stmt
assertEqual "count match" count (fromIntegral $ length names)
mapM_
( \(ndx, expecting) -> do
name <- bindParameterName stmt ndx
assertEqual "name match" expecting name
)
$ zip [1 ..] names
testBindErrorValidation :: IO TestEnv -> Assertion
testBindErrorValidation envIO = do
TestEnv {..} <- envIO
bracket (prepare conn "SELECT ?") finalize (assertFail . testException1)
bracket (prepare conn "SELECT ?") finalize (assertFail . testException2)
where
-- Invalid use, one param in q string, none given
testException1 stmt = bind stmt []
-- Invalid use, one param in q string, 2 given
testException2 stmt = bind stmt [SqlInteger 1, SqlInteger 2]
testNamedBindParams :: IO TestEnv -> Assertion
testNamedBindParams envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
withStmt conn "SELECT :foo / :bar" $ \stmt -> do
-- Test that we get something back for known names
Just fooIdx <- Direct.bindParameterIndex stmt (toUtf8 ":foo")
Just barIdx <- Direct.bindParameterIndex stmt (toUtf8 ":bar")
-- Test that we get Nothing back for unknown names
Nothing <- Direct.bindParameterIndex stmt (toUtf8 "intentionally_undefined")
Right () <- Direct.bindInt64 stmt fooIdx 4
Right () <- Direct.bindInt64 stmt barIdx 2
Row <- step stmt
1 <- columnCount stmt
[SqlInteger 2] <- columns stmt
Done <- step stmt
return ()
withStmt conn "SELECT @n1+@n2" $ \stmt -> do
-- Test that we get something back for known names
Just _n1 <- Direct.bindParameterIndex stmt (toUtf8 "@n1")
Just _n2 <- Direct.bindParameterIndex stmt (toUtf8 "@n2")
-- Here's where things get confusing.. You can't mix different
-- types of :/$/@ parameter conventions.
Nothing <- Direct.bindParameterIndex stmt (toUtf8 ":n1")
Nothing <- Direct.bindParameterIndex stmt (toUtf8 ":n2")
return ()
withStmt conn "SELECT :foo / :bar,:t" $ \stmt -> do
bindNamed stmt [(":t", SqlText "txt"), (":foo", SqlInteger 6), (":bar", SqlInteger 2)]
Row <- step stmt
2 <- columnCount stmt
[SqlInteger 3, SqlText "txt"] <- columns stmt
Done <- step stmt
return ()
testColumns :: IO TestEnv -> Assertion
testColumns envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
withStmt conn "CREATE TABLE foo (a INT)" command
withStmt conn "SELECT * FROM foo" $ \stmt -> do
1 <- columnCount stmt
exec conn "ALTER TABLE foo ADD COLUMN b INT"
Done <- step stmt
2 <- columnCount stmt
return ()
withStmt conn "SELECT * FROM foo" $ \stmt -> do
2 <- columnCount stmt
Done <- step stmt
2 <- columnCount stmt
return ()
withStmt conn "INSERT INTO foo VALUES (1, 2)" command
withStmt conn "SELECT * FROM foo" $ \stmt -> do
2 <- columnCount stmt
Row <- step stmt
2 <- columnCount stmt
[SqlInteger 1, SqlInteger 2] <- columns stmt
Done <- step stmt
2 <- columnCount stmt
return ()
withStmt conn "INSERT INTO foo VALUES (3, 4)" command
withStmt conn "INSERT INTO foo VALUES (5, 6)" command
withStmt conn "SELECT * FROM foo" $ \stmt -> do
2 <- columnCount stmt
exec conn "ALTER TABLE foo ADD COLUMN c INT"
Row <- step stmt
3 <- columnCount stmt
[SqlInteger 1, SqlInteger 2, SqlNull] <- columns stmt
exec conn "ALTER TABLE foo ADD COLUMN d INT NOT NULL DEFAULT 42"
-- ignored by this prepared statement, now that it has stepped.
Row <- step stmt
3 <- columnCount stmt
[SqlInteger 3, SqlInteger 4, SqlNull] <- columns stmt
Row <- step stmt
3 <- columnCount stmt
[SqlInteger 5, SqlInteger 6, SqlNull] <- columns stmt
Done <- step stmt
3 <- columnCount stmt
reset stmt
3 <- columnCount stmt -- The prepared statement *still* doesn't know
-- about the new column.
Row <- step stmt
4 <- columnCount stmt -- That's better.
[SqlInteger 1, SqlInteger 2, SqlNull, SqlInteger 42] <- columns stmt
return ()
where
command stmt = do
0 <- columnCount stmt
Done <- step stmt
0 <- columnCount stmt
return ()
testTypedColumns :: IO TestEnv -> Assertion
testTypedColumns envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
withStmt conn "CREATE TABLE foo (a INT, b INT)" command
withStmt conn "INSERT INTO foo VALUES (1, 2)" command
withStmt conn "INSERT INTO foo VALUES (3, 4)" command
withStmt conn "SELECT * FROM foo" $ \stmt -> do
Row <- step stmt
2 <- columnCount stmt
[SqlInteger 1, SqlInteger 2] <- typedColumns stmt [Nothing, Nothing]
Row <- step stmt
2 <- columnCount stmt
[SqlInteger 3, SqlInteger 4] <- typedColumns stmt [Just IntegerColumn, Just IntegerColumn]
Done <- step stmt
2 <- columnCount stmt
return ()
withStmt conn "SELECT * FROM foo" $ \stmt -> do
Row <- step stmt
2 <- columnCount stmt
[SqlText "1", SqlText "2"] <- typedColumns stmt [Just TextColumn, Just TextColumn]
Row <- step stmt
2 <- columnCount stmt
[SqlFloat 3.0, SqlFloat 4.0] <- typedColumns stmt [Just FloatColumn, Just FloatColumn]
Done <- step stmt
2 <- columnCount stmt
return ()
where
command stmt = do
0 <- columnCount stmt
Done <- step stmt
0 <- columnCount stmt
return ()
testColumnName :: IO TestEnv -> Assertion
testColumnName envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE foo (id INTEGER PRIMARY KEY, abc TEXT, \"123\" REAL, über INT)"
exec conn "INSERT INTO foo (abc, \"123\", über) VALUES ('hello', 3.14, 456)"
withStmt conn "SELECT id AS id, abc AS x, \"123\" AS y, über AS ü FROM foo" $
\stmt -> do
let checkNames = do
4 <- columnCount stmt
Nothing <- columnName stmt (-1)
Just "id" <- columnName stmt 0
Just "x" <- columnName stmt 1
Just "y" <- columnName stmt 2
Just "ü" <- columnName stmt 3
Nothing <- columnName stmt 4
Nothing <- columnName stmt minBound
Nothing <- columnName stmt maxBound
return ()
checkNames
Row <- step stmt
checkNames
[SqlInteger 1, SqlText "hello", SqlFloat 3.14, SqlInteger 456] <- columns stmt
Done <- step stmt
checkNames
-- Column names without AS clauses may change in future versions of Sqlite.
-- This test will fail if they do.
withStmt conn "SELECT * FROM foo" $ \stmt -> do
4 <- columnCount stmt
Nothing <- columnName stmt (-1)
Just "id" <- columnName stmt 0
Just "abc" <- columnName stmt 1
Just "123" <- columnName stmt 2
Just "über" <- columnName stmt 3
Nothing <- columnName stmt 4
Nothing <- columnName stmt minBound
Nothing <- columnName stmt maxBound
return ()
-- Testing for specific error codes:
--
-- * ErrorConstraint
--
-- * ErrorRange
--
-- * ErrorLocked
-- * ErrorBusy
testErrors :: IO TestEnv -> Assertion
testErrors envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE foo (n INT UNIQUE)"
exec conn "INSERT INTO foo VALUES (3)"
expectError ErrorConstraint $
exec conn "INSERT INTO foo VALUES (3)"
-- Multiple NULLs are allowed when there's a UNIQUE constraint
exec conn "INSERT INTO foo VALUES (null)"
exec conn "INSERT INTO foo VALUES (null)"
exec conn "CREATE TABLE bar (n INT NOT NULL)"
expectError ErrorConstraint $
exec conn "INSERT INTO bar VALUES (null)"
withStmt conn "SELECT ?" $ \stmt -> do
forM_ [-1, 0, 2] $ \i -> do
expectError ErrorRange $ bindSqlData stmt i $ SqlInteger 42
expectError ErrorRange $ bindSqlData stmt i SqlNull
bindSqlData stmt 1 $ SqlInteger 42
Row <- step stmt
-- If column index is out of range, it returns SqlNull.
-- This may or may not be the desired behavior, but at least we know.
SqlNull <- column stmt (-1)
SqlNull <- column stmt 1
SqlInteger 42 <- column stmt 0
return ()
withStmt conn "SELECT 1" $ \stmt -> do
forM_ [-1, 0, 1, 2] $ \i -> do
expectError ErrorRange $ bindSqlData stmt i $ SqlInteger 42
expectError ErrorRange $ bindSqlData stmt i SqlNull
bind stmt [] -- This should succeed. Don't whine that there aren't any
-- parameters to bind!
Row <- step stmt
SqlInteger 1 <- column stmt 0
return ()
withStmt conn "SELECT :bar" $ \stmt -> do
shouldFail $ bindNamed stmt [(":missing", SqlInteger 42)]
bindNamed stmt [(":bar", SqlInteger 1)]
Row <- step stmt
SqlInteger 1 <- column stmt 0
return ()
withStmt conn "SELECT ?5" $ \stmt -> do
forM_ [-1, 0, 6, 7] $ \i -> do
expectError ErrorRange $ bindSqlData stmt i $ SqlInteger 42
expectError ErrorRange $ bindSqlData stmt i SqlNull
bind stmt $ map SqlInteger [1 .. 5]
-- This succeeds, even though 1..4 aren't used.
Row <- step stmt
[SqlInteger 5] <- columns stmt
return ()
-- Need to access the database with multiple connections.
-- "BEGIN; ROLLBACK" causes running statements in the same connection to
-- throw SqlITE_ABORT.
withConnShared $ \conn -> do
foo123456 conn
withStmt conn "SELECT * FROM foo" $ \stmt -> do
-- "DROP TABLE foo" should succeed, since the statement
-- isn't running yet.
exec conn "DROP TABLE foo"
foo123456 conn
Row <- step stmt
2 <- columnCount stmt
[SqlInteger 1, SqlInteger 2] <- columns stmt
-- "DROP TABLE foo" should fail, now that the statement is running.
expectError ErrorLocked $ exec conn "DROP TABLE foo"
withConnShared $ \conn -> do
expectError ErrorBusy $ exec conn "DROP TABLE foo"
-- Apparently, we can pretend to drop the table, but we get ErrorBusy
-- if we try to actually COMMIT it.
exec conn "BEGIN; DROP TABLE foo"
expectError ErrorBusy $ exec conn "COMMIT"
exec conn "ROLLBACK"
Row <- step stmt
2 <- columnCount stmt
[SqlInteger 3, SqlInteger 4] <- columns stmt
Row <- step stmt
2 <- columnCount stmt
[SqlInteger 5, SqlInteger 6] <- columns stmt
expectError ErrorLocked $ exec conn "DROP TABLE foo"
withConnShared $ \conn ->
expectError ErrorBusy $ exec conn "DROP TABLE foo"
Done <- step stmt
2 <- columnCount stmt
exec conn "DROP TABLE foo"
-- Regular 'reset' throws away the error. Make sure sqlite3_reset did
-- not return an error because foo is now gone. sqlite3_reset should
-- only return an error if the most recent 'step' failed.
Right () <- Direct.reset stmt
-- But trying to 'step' again should fail.
Left SqliteException {sqliteError = err} <- try $ step stmt
assertBool
"Step after table vanishes should fail with SqlITE_ERROR or SqlITE_SCHEMA"
( err == ErrorError
|| err == ErrorSchema -- Sqlite 3.7.13
-- Sqlite 3.6.22
)
where
expectError err io = do
Left SqliteException {sqliteError = err'} <- try io
assertEqual "testErrors: expectError" err err'
foo123456 conn =
exec
conn
"CREATE TABLE foo (a INT, b INT); \
\INSERT INTO foo VALUES (1, 2); \
\INSERT INTO foo VALUES (3, 4); \
\INSERT INTO foo VALUES (5, 6)"
-- Make sure data stored in a table comes back as-is.
testIntegrity :: IO TestEnv -> Assertion
testIntegrity envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE foo (i INT, f FLOAT, t TEXT, b BLOB, n TEXT)"
withStmt conn "INSERT INTO foo VALUES (?, ?, ?, ?, ?)" $ \insert ->
withStmt conn "SELECT * FROM foo" $ \select -> do
let test = testWith (===)
testWith f values = do
exec conn "DELETE FROM foo"
reset insert
bind insert values
Done <- step insert
reset select
Row <- step select
values' <- columns select
Done <- step select
return $ f values values'
True <- test [SqlInteger 0, SqlFloat 0.0, SqlText T.empty, SqlBlob B.empty, SqlNull]
True <- test [SqlInteger minBound, SqlFloat (-1 / 0), SqlText "\0", SqlBlob (B8.pack "\0"), SqlNull]
True <- test [SqlInteger maxBound, SqlFloat (1 / 0), SqlText "\1114111", SqlBlob ("\255"), SqlNull]
-- Sqlite3 turns NaN into SqlNull.
True <-
testWith
(\_old new -> new === [SqlNull, SqlNull, SqlNull, SqlNull, SqlNull])
[SqlNull, SqlFloat (0 / 0), SqlNull, SqlNull, SqlNull]
return ()
testDecodeError :: IO TestEnv -> Assertion
testDecodeError envIO = do
TestEnv {..} <- envIO
withStmt conn "SELECT ?" $ \stmt -> do
Right () <- Direct.bindText stmt 1 invalidUtf8
Row <- step stmt
Left (DecodeError "Database.Sqlite3.columnText: Invalid UTF-8" _) <-
try $ column stmt 0
return ()
-- Verify the assertion that Sqlite3 does not validate UTF-8, by writing the
-- data to a table on disk and reading it back.
withConnShared $ \conn -> do
exec conn "CREATE TABLE testDecodeError (a TEXT)"
withStmt conn "INSERT INTO testDecodeError VALUES (?)" $ \stmt -> do
Right () <- Direct.bindText stmt 1 invalidUtf8
Done <- step stmt
return ()
withConnShared $ \conn -> do
withStmt conn "SELECT * FROM testDecodeError" $ \stmt -> do
Row <- step stmt
TextColumn <- columnType stmt 0
txt <- Direct.columnText stmt 0
assertEqual "testDecodeError: Database altered our invalid UTF-8" (fromUtf8Lenient invalidUtf8) (fromUtf8Lenient txt)
Left (DecodeError "Database.Sqlite3.columnText: Invalid UTF-8" _) <-
try $ columnText stmt 0
Done <- step stmt
return ()
where
invalidUtf8 = Direct.Utf8 $ B.pack [0x80]
testResultStats :: IO TestEnv -> Assertion
testResultStats envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
(0, 0, 0) <- stats conn
exec conn "CREATE TABLE tbl (n INTEGER PRIMARY KEY)"
(0, 0, 0) <- stats conn
exec conn "INSERT INTO tbl DEFAULT VALUES"
(1, 1, 1) <- stats conn
exec conn "INSERT INTO tbl VALUES (123)"
(123, 1, 2) <- stats conn
exec conn "INSERT INTO tbl VALUES (9223372036854775807)"
(maxBound, 1, 3) <- stats conn
exec conn "INSERT INTO tbl DEFAULT VALUES" -- picks a rowid at random
(rowid, 1, 4) <- stats conn
True <- return $ (`notElem` [1, 123, maxBound]) rowid
exec conn "UPDATE tbl SET rowid=rowid+1 WHERE rowid=1 OR rowid=123"
(_, 2, 6) <- stats conn
Left SqliteException {sqliteError = ErrorConstraint} <-
try $ exec conn "UPDATE tbl SET rowid=4"
exec conn "DELETE FROM tbl"
(_, 4, 10) <- stats conn
return ()
where
stats conn =
liftM3
(,,)
(lastInsertRowId conn)
(changes conn)
(Direct.totalChanges conn)
testGetAutoCommit :: IO TestEnv -> Assertion
testGetAutoCommit envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
True <- Direct.getAutoCommit conn
exec conn "BEGIN"
False <- Direct.getAutoCommit conn
Left (ErrorError, _) <- Direct.exec conn (toUtf8 "BEGIN")
False <- Direct.getAutoCommit conn
exec conn "ROLLBACK"
True <- Direct.getAutoCommit conn
Left (ErrorError, _) <- Direct.exec conn (toUtf8 "ROLLBACK")
True <- Direct.getAutoCommit conn
-- This commented (because it failed) test seems to check that after a "database
-- or disk is full" type of error, the transaction is rolled back and we return
-- to autocommit mode.
--
-- But the documentation seems to say that the rollback *might* happen in those
-- cases, not that it *always* happens:
-- https://www.sqlite.org/lang_transaction.html
-- https://www.sqlite.org/c3ref/get_autocommit.html
--
-- exec conn "BEGIN"
-- False <- Direct.getAutoCommit conn
-- Left (ErrorFull, _) <-
-- Direct.exec
-- conn
-- "PRAGMA max_page_count=1; CREATE TABLE foo (a INT)"
-- True <- Direct.getAutoCommit conn
-- Left (ErrorError, _) <- Direct.exec conn "ROLLBACK"
return ()
testStatementSql :: IO TestEnv -> Assertion
testStatementSql envIO = do
TestEnv {..} <- envIO
let q1 = "SELECT 1+1"
withStmt conn q1 $ \stmt -> do
Just (Direct.Utf8 sql1) <- Direct.statementSql stmt
T.encodeUtf8 q1 @=? sql1
testCustomFunction :: IO TestEnv -> Assertion
testCustomFunction envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
createFunction conn "repeat" (Just 2) True repeatString
withStmt conn "SELECT repeat(3,'abc')" $ \stmt -> do
Row <- step stmt
[SqlText "abcabcabc"] <- columns stmt
Done <- step stmt
return ()
deleteFunction conn "repeat" (Just 2)
Left SqliteException {sqliteError = ErrorError} <-
try $ exec conn "SELECT repeat(3,'abc')"
return ()
where
repeatString ctx args = do
n <- funcArgInt64 args 0
s <- funcArgText args 1
funcResultText ctx $ T.concat $ replicate (fromIntegral n) s
testCustomFunctionError :: IO TestEnv -> Assertion
testCustomFunctionError envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
createFunction conn "fail" (Just 0) True throwError
Left SqliteException {..} <- try $ exec conn "SELECT fail()"
-- Match only the first 13 characters of the error message here. The
-- error message coming from the use of "error" nowadays contains
-- fragments of the callstack and not just the string we gave it.
assertBool
"Catch exception"
(sqliteError == ErrorError && T.take 13 sqliteErrorDetails == "error message")
where
throwError _ _ = error "error message"
testCustomAggragate :: IO TestEnv -> Assertion
testCustomAggragate envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE tbl (n INT)"
exec conn "INSERT INTO tbl(n) VALUES (12), (-3), (7)"
createAggregate conn "mysum" (Just 1) 0 mySumStep funcResultInt64
withStmt conn "SELECT mysum(n) FROM tbl" $ \stmt -> do
Row <- step stmt
[SqlInteger 16] <- columns stmt
Done <- step stmt
return ()
deleteFunction conn "mysum" (Just 1)
Left SqliteException {sqliteError = ErrorError} <-
try $ exec conn "SELECT mysum(n) FROM tbl"
return ()
where
mySumStep _ args s = do
n <- funcArgInt64 args 0
return (s + n)
testCustomCollation :: IO TestEnv -> Assertion
testCustomCollation envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE tbl (n TEXT)"
exec conn "INSERT INTO tbl(n) VALUES ('dog'),('mouse'),('ox'),('cat')"
createCollation conn "len" cmpLen
withStmt conn "SELECT * FROM tbl ORDER BY n COLLATE len" $ \stmt -> do
Row <- step stmt
[SqlText "ox"] <- columns stmt
Row <- step stmt
[SqlText "cat"] <- columns stmt
Row <- step stmt
[SqlText "dog"] <- columns stmt
Row <- step stmt
[SqlText "mouse"] <- columns stmt
Done <- step stmt
return ()
deleteCollation conn "len"
Left SqliteException {sqliteError = ErrorError} <-
try $ exec conn "SELECT * FROM tbl ORDER BY n COLLATE len"
return ()
where
-- order by length first, then by lexicographical order
cmpLen s1 s2 = compare (T.length s1) (T.length s2) <> compare s1 s2
testIncrementalBlobIO :: IO TestEnv -> Assertion
testIncrementalBlobIO envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE tbl (n BLOB)"
exec conn "INSERT INTO tbl(rowid,n) VALUES (1,'abcdefg')"
blob <- blobOpen conn "main" "tbl" "n" 1 True
l <- blobBytes blob
assertEqual "blobBytes" 7 l
s <- blobRead blob 4 2
assertEqual "blobRead" "cdef" s
blobWrite blob "BC" 1
blobClose blob
withStmt conn "SELECT n FROM tbl" $ \stmt -> do
Row <- step stmt
s' <- columnBlob stmt 0
assertEqual "blobWrite" "aBCdefg" s'
testInterrupt :: IO TestEnv -> Assertion
testInterrupt envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE tbl (n INT)"
withStmt conn "INSERT INTO tbl VALUES (?)" $ \stmt -> do
exec conn "BEGIN"
forM_ [1 .. 200] $ \i -> do
reset stmt
bind stmt [SqlInteger i]
Done <- step stmt
return ()
exec conn "COMMIT"
stmt <- prepare conn tripleSum
_ <- forkIO $ threadDelay 100000 >> interrupt conn
Left ErrorInterrupt <- Direct.step stmt
Left ErrorInterrupt <- Direct.finalize stmt
Nothing <- timeout 100000 $ interruptibly conn $ exec conn tripleSum
return ()
where
tripleSum = "SELECT sum(a.n + b.n + c.n) FROM tbl as a, tbl as b, tbl as c"
testMultiRowInsert :: IO TestEnv -> Assertion
testMultiRowInsert envIO = do
TestEnv {..} <- envIO
withConn $ \conn -> do
exec conn "CREATE TABLE foo (a INT, b INT)"
result <- try $ exec conn "INSERT INTO foo VALUES (1,2), (3,4)"
case result of
Left SqliteException {sqliteError = ErrorError} ->
assertFailure "Installed Sqlite3 does not support multi-row INSERT via the VALUES clause"
Left e ->
assertFailure $ show e
Right () -> do
-- Make sure multi-row insert actually worked
2 <- changes conn
withStmt conn "SELECT * FROM foo" $ \stmt -> do
Row <- step stmt
[SqlInteger 1, SqlInteger 2] <- columns stmt
Row <- step stmt
[SqlInteger 3, SqlInteger 4] <- columns stmt
Done <- step stmt
return ()
testOpenV2CanNotCreate :: IO FilePath -> Assertion
testOpenV2CanNotCreate filepathIO = do
filepath <- filepathIO
Left SqliteException {sqliteError = ErrorCan'tOpen} <- try do
db <- openV2 DefaultVFS [] OpenV2ReadOnly (T.pack filepath)
close db
Left SqliteException {sqliteError = ErrorCan'tOpen} <- try do
db <- openV2 DefaultVFS [] OpenV2ReadWrite (T.pack filepath)
close db
do
db <- openV2 DefaultVFS [] OpenV2ReadWriteCreate (T.pack filepath)
close db
pure ()
testExtendedResultCodes :: IO FilePath -> Assertion
testExtendedResultCodes filepathIO = do
filepath <- filepathIO
db <- openV2 DefaultVFS [] OpenV2ReadWrite (T.pack filepath)
Left SqliteException {sqliteError = ErrorConstraint} <- try do
exec
db
"CREATE TABLE test_ercs (t TEXT PRIMARY KEY); \
\INSERT INTO test_ercs VALUES ('val1'); \
\INSERT INTO test_ercs VALUES ('val1');"
db <- openV2 DefaultVFS [OpenV2ExtendedResultCode] OpenV2ReadWrite (T.pack filepath)
Left SqliteException {sqliteError = ErrorConstraintPrimaryKey} <- try do
exec
db
"CREATE TABLE test_ercs_2 (t TEXT PRIMARY KEY); \
\INSERT INTO test_ercs_2 VALUES ('val1'); \
\INSERT INTO test_ercs_2 VALUES ('val1');"
close db
withDatabaseFile ::
-- | Parent directory to create the file in
FilePath ->
-- | File name template
String ->
(FilePath -> IO ()) ->
(IO FilePath -> TestTree) ->
TestTree
withDatabaseFile dirpath template prepare =
withResource allocFile deallocFile
where
allocFile = do
(filepath, handle) <- openTempFile dirpath template
hClose handle
-- We only need the name. Tests will create the file, if needed.
removeFile filepath
prepare filepath
pure filepath
deallocFile filepath = do
exists <- doesFileExist filepath
when exists $ removeFile filepath
withTestEnv :: IO FilePath -> (IO TestEnv -> TestTree) -> TestTree
withTestEnv tempDbFilePathIO =
withResource allocEnv deallocEnv
where
allocEnv = do
conn <- open ":memory:"
pure $
TestEnv
{ conn,
withConn,
withConnShared = \callback -> do
tempDbFilePath <- tempDbFilePathIO
withConnPath (T.pack tempDbFilePath) callback
}
deallocEnv TestEnv {conn} = do
close conn
withConn = withConnPath ":memory:"
withConnPath path cb = do
conn <- open path
r <- cb conn `onException` Direct.close conn
-- If the callback throws an exception, try to close the DB.
-- If closing fails (usually due to open 'Statement's),
-- throw the original error, not the error produced by 'close'.
-- Direct.close returns the error rather than throwing it.
close conn
return r
main :: IO ()
main = do
defaultMain $
testGroup
"All"
[ withDatabaseFile
"."
"direct-sqlite-test-database"
( \filepath ->
do
db <- open (T.pack filepath)
close db
)
\tempDbNameIO ->
withTestEnv tempDbNameIO \envIO -> do
testGroup "OldTests" $ ($ envIO) <$> regressionTests,
withDatabaseFile
"."
"direct-sqlite-test-database-open-v2"
(\_ -> pure ())
\tempDbNameIO ->
testGroup
"openV2"
[ testCase "openV2 can't create if create mode not set" $ testOpenV2CanNotCreate tempDbNameIO,
testCase "extended result codes are returned when flag is set" $ testExtendedResultCodes tempDbNameIO
]
]
toUtf8 :: Text -> Direct.Utf8
toUtf8 = Direct.Utf8 . T.encodeUtf8
fromUtf8Lenient :: Direct.Utf8 -> Text
fromUtf8Lenient (Direct.Utf8 bs) = T.decodeUtf8With lenientDecode bs