Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1 | #-*- coding: ISO-8859-1 -*- |
| 2 | # pysqlite2/test/hooks.py: tests for various SQLite-specific hooks |
| 3 | # |
Gerhard Häring | e7ea745 | 2008-03-29 00:45:29 +0000 | [diff] [blame] | 4 | # Copyright (C) 2006-2007 Gerhard Häring <gh@ghaering.de> |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 5 | # |
| 6 | # This file is part of pysqlite. |
| 7 | # |
| 8 | # This software is provided 'as-is', without any express or implied |
| 9 | # warranty. In no event will the authors be held liable for any damages |
| 10 | # arising from the use of this software. |
| 11 | # |
| 12 | # Permission is granted to anyone to use this software for any purpose, |
| 13 | # including commercial applications, and to alter it and redistribute it |
| 14 | # freely, subject to the following restrictions: |
| 15 | # |
| 16 | # 1. The origin of this software must not be misrepresented; you must not |
| 17 | # claim that you wrote the original software. If you use this software |
| 18 | # in a product, an acknowledgment in the product documentation would be |
| 19 | # appreciated but is not required. |
| 20 | # 2. Altered source versions must be plainly marked as such, and must not be |
| 21 | # misrepresented as being the original software. |
| 22 | # 3. This notice may not be removed or altered from any source distribution. |
| 23 | |
Christian Heimes | 05e8be1 | 2008-02-23 18:30:17 +0000 | [diff] [blame] | 24 | import unittest |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 25 | import sqlite3 as sqlite |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 26 | |
| 27 | class CollationTests(unittest.TestCase): |
| 28 | def setUp(self): |
| 29 | pass |
| 30 | |
| 31 | def tearDown(self): |
| 32 | pass |
| 33 | |
| 34 | def CheckCreateCollationNotCallable(self): |
| 35 | con = sqlite.connect(":memory:") |
| 36 | try: |
| 37 | con.create_collation("X", 42) |
| 38 | self.fail("should have raised a TypeError") |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 39 | except TypeError as e: |
Gregory P. Smith | 04cecaf | 2009-07-04 08:32:15 +0000 | [diff] [blame] | 40 | self.assertEqual(e.args[0], "parameter must be callable") |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 41 | |
| 42 | def CheckCreateCollationNotAscii(self): |
| 43 | con = sqlite.connect(":memory:") |
| 44 | try: |
Mark Dickinson | a56c467 | 2009-01-27 18:17:45 +0000 | [diff] [blame] | 45 | con.create_collation("collä", lambda x, y: (x > y) - (x < y)) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 46 | self.fail("should have raised a ProgrammingError") |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 47 | except sqlite.ProgrammingError as e: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 48 | pass |
| 49 | |
| 50 | def CheckCollationIsUsed(self): |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 51 | if sqlite.version_info < (3, 2, 1): # old SQLite versions crash on this test |
| 52 | return |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 53 | def mycoll(x, y): |
| 54 | # reverse order |
Mark Dickinson | a56c467 | 2009-01-27 18:17:45 +0000 | [diff] [blame] | 55 | return -((x > y) - (x < y)) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 56 | |
| 57 | con = sqlite.connect(":memory:") |
| 58 | con.create_collation("mycoll", mycoll) |
| 59 | sql = """ |
| 60 | select x from ( |
| 61 | select 'a' as x |
| 62 | union |
| 63 | select 'b' as x |
| 64 | union |
| 65 | select 'c' as x |
| 66 | ) order by x collate mycoll |
| 67 | """ |
| 68 | result = con.execute(sql).fetchall() |
| 69 | if result[0][0] != "c" or result[1][0] != "b" or result[2][0] != "a": |
| 70 | self.fail("the expected order was not returned") |
| 71 | |
| 72 | con.create_collation("mycoll", None) |
| 73 | try: |
| 74 | result = con.execute(sql).fetchall() |
| 75 | self.fail("should have raised an OperationalError") |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 76 | except sqlite.OperationalError as e: |
Gregory P. Smith | 04cecaf | 2009-07-04 08:32:15 +0000 | [diff] [blame] | 77 | self.assertEqual(e.args[0].lower(), "no such collation sequence: mycoll") |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 78 | |
| 79 | def CheckCollationRegisterTwice(self): |
| 80 | """ |
| 81 | Register two different collation functions under the same name. |
| 82 | Verify that the last one is actually used. |
| 83 | """ |
| 84 | con = sqlite.connect(":memory:") |
Mark Dickinson | a56c467 | 2009-01-27 18:17:45 +0000 | [diff] [blame] | 85 | con.create_collation("mycoll", lambda x, y: (x > y) - (x < y)) |
| 86 | con.create_collation("mycoll", lambda x, y: -((x > y) - (x < y))) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 87 | result = con.execute(""" |
| 88 | select x from (select 'a' as x union select 'b' as x) order by x collate mycoll |
| 89 | """).fetchall() |
| 90 | if result[0][0] != 'b' or result[1][0] != 'a': |
| 91 | self.fail("wrong collation function is used") |
| 92 | |
| 93 | def CheckDeregisterCollation(self): |
| 94 | """ |
| 95 | Register a collation, then deregister it. Make sure an error is raised if we try |
| 96 | to use it. |
| 97 | """ |
| 98 | con = sqlite.connect(":memory:") |
Mark Dickinson | a56c467 | 2009-01-27 18:17:45 +0000 | [diff] [blame] | 99 | con.create_collation("mycoll", lambda x, y: (x > y) - (x < y)) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 100 | con.create_collation("mycoll", None) |
| 101 | try: |
| 102 | con.execute("select 'a' as x union select 'b' as x order by x collate mycoll") |
| 103 | self.fail("should have raised an OperationalError") |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 104 | except sqlite.OperationalError as e: |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 105 | if not e.args[0].startswith("no such collation sequence"): |
| 106 | self.fail("wrong OperationalError raised") |
| 107 | |
Gerhard Häring | e7ea745 | 2008-03-29 00:45:29 +0000 | [diff] [blame] | 108 | class ProgressTests(unittest.TestCase): |
| 109 | def CheckProgressHandlerUsed(self): |
| 110 | """ |
| 111 | Test that the progress handler is invoked once it is set. |
| 112 | """ |
| 113 | con = sqlite.connect(":memory:") |
| 114 | progress_calls = [] |
| 115 | def progress(): |
| 116 | progress_calls.append(None) |
| 117 | return 0 |
| 118 | con.set_progress_handler(progress, 1) |
| 119 | con.execute(""" |
| 120 | create table foo(a, b) |
| 121 | """) |
Gregory P. Smith | 04cecaf | 2009-07-04 08:32:15 +0000 | [diff] [blame] | 122 | self.assertTrue(progress_calls) |
Gerhard Häring | e7ea745 | 2008-03-29 00:45:29 +0000 | [diff] [blame] | 123 | |
| 124 | |
| 125 | def CheckOpcodeCount(self): |
| 126 | """ |
| 127 | Test that the opcode argument is respected. |
| 128 | """ |
| 129 | con = sqlite.connect(":memory:") |
| 130 | progress_calls = [] |
| 131 | def progress(): |
| 132 | progress_calls.append(None) |
| 133 | return 0 |
| 134 | con.set_progress_handler(progress, 1) |
| 135 | curs = con.cursor() |
| 136 | curs.execute(""" |
| 137 | create table foo (a, b) |
| 138 | """) |
| 139 | first_count = len(progress_calls) |
| 140 | progress_calls = [] |
| 141 | con.set_progress_handler(progress, 2) |
| 142 | curs.execute(""" |
| 143 | create table bar (a, b) |
| 144 | """) |
| 145 | second_count = len(progress_calls) |
Gregory P. Smith | 04cecaf | 2009-07-04 08:32:15 +0000 | [diff] [blame] | 146 | self.assertTrue(first_count > second_count) |
Gerhard Häring | e7ea745 | 2008-03-29 00:45:29 +0000 | [diff] [blame] | 147 | |
| 148 | def CheckCancelOperation(self): |
| 149 | """ |
| 150 | Test that returning a non-zero value stops the operation in progress. |
| 151 | """ |
| 152 | con = sqlite.connect(":memory:") |
| 153 | progress_calls = [] |
| 154 | def progress(): |
| 155 | progress_calls.append(None) |
| 156 | return 1 |
| 157 | con.set_progress_handler(progress, 1) |
| 158 | curs = con.cursor() |
| 159 | self.assertRaises( |
| 160 | sqlite.OperationalError, |
| 161 | curs.execute, |
| 162 | "create table bar (a, b)") |
| 163 | |
| 164 | def CheckClearHandler(self): |
| 165 | """ |
| 166 | Test that setting the progress handler to None clears the previously set handler. |
| 167 | """ |
| 168 | con = sqlite.connect(":memory:") |
| 169 | action = 0 |
| 170 | def progress(): |
| 171 | action = 1 |
| 172 | return 0 |
| 173 | con.set_progress_handler(progress, 1) |
| 174 | con.set_progress_handler(None, 1) |
| 175 | con.execute("select 1 union select 2 union select 3").fetchall() |
Gregory P. Smith | 04cecaf | 2009-07-04 08:32:15 +0000 | [diff] [blame] | 176 | self.assertEqual(action, 0, "progress handler was not cleared") |
Gerhard Häring | e7ea745 | 2008-03-29 00:45:29 +0000 | [diff] [blame] | 177 | |
Antoine Pitrou | 5bfa062 | 2011-04-04 00:12:04 +0200 | [diff] [blame] | 178 | class TraceCallbackTests(unittest.TestCase): |
| 179 | def CheckTraceCallbackUsed(self): |
| 180 | """ |
| 181 | Test that the trace callback is invoked once it is set. |
| 182 | """ |
| 183 | con = sqlite.connect(":memory:") |
| 184 | traced_statements = [] |
| 185 | def trace(statement): |
| 186 | traced_statements.append(statement) |
| 187 | con.set_trace_callback(trace) |
| 188 | con.execute("create table foo(a, b)") |
| 189 | self.assertTrue(traced_statements) |
| 190 | self.assertTrue(any("create table foo" in stmt for stmt in traced_statements)) |
| 191 | |
| 192 | def CheckClearTraceCallback(self): |
| 193 | """ |
| 194 | Test that setting the trace callback to None clears the previously set callback. |
| 195 | """ |
| 196 | con = sqlite.connect(":memory:") |
| 197 | traced_statements = [] |
| 198 | def trace(statement): |
| 199 | traced_statements.append(statement) |
| 200 | con.set_trace_callback(trace) |
| 201 | con.set_trace_callback(None) |
| 202 | con.execute("create table foo(a, b)") |
| 203 | self.assertFalse(traced_statements, "trace callback was not cleared") |
| 204 | |
| 205 | def CheckUnicodeContent(self): |
| 206 | """ |
| 207 | Test that the statement can contain unicode literals. |
| 208 | """ |
| 209 | unicode_value = '\xf6\xe4\xfc\xd6\xc4\xdc\xdf\u20ac' |
| 210 | con = sqlite.connect(":memory:") |
| 211 | traced_statements = [] |
| 212 | def trace(statement): |
| 213 | traced_statements.append(statement) |
| 214 | con.set_trace_callback(trace) |
| 215 | con.execute("create table foo(x)") |
Antoine Pitrou | f4e1810 | 2011-04-04 01:50:50 +0200 | [diff] [blame^] | 216 | # Can't execute bound parameters as their values don't appear |
| 217 | # in traced statements before SQLite 3.6.21 |
| 218 | # (cf. http://www.sqlite.org/draft/releaselog/3_6_21.html) |
| 219 | con.execute('insert into foo(x) values ("%s")' % unicode_value) |
Antoine Pitrou | 5bfa062 | 2011-04-04 00:12:04 +0200 | [diff] [blame] | 220 | con.commit() |
| 221 | self.assertTrue(any(unicode_value in stmt for stmt in traced_statements), |
Antoine Pitrou | 43b2168 | 2011-04-04 00:50:01 +0200 | [diff] [blame] | 222 | "Unicode data %s garbled in trace callback: %s" |
| 223 | % (ascii(unicode_value), ', '.join(map(ascii, traced_statements)))) |
Antoine Pitrou | 5bfa062 | 2011-04-04 00:12:04 +0200 | [diff] [blame] | 224 | |
| 225 | |
| 226 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 227 | def suite(): |
| 228 | collation_suite = unittest.makeSuite(CollationTests, "Check") |
Gerhard Häring | e7ea745 | 2008-03-29 00:45:29 +0000 | [diff] [blame] | 229 | progress_suite = unittest.makeSuite(ProgressTests, "Check") |
Antoine Pitrou | 5bfa062 | 2011-04-04 00:12:04 +0200 | [diff] [blame] | 230 | trace_suite = unittest.makeSuite(TraceCallbackTests, "Check") |
| 231 | return unittest.TestSuite((collation_suite, progress_suite, trace_suite)) |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 232 | |
| 233 | def test(): |
| 234 | runner = unittest.TextTestRunner() |
| 235 | runner.run(suite()) |
| 236 | |
| 237 | if __name__ == "__main__": |
| 238 | test() |