standardize flag handling
[sqlcipher.git] / test / uri.test
blob2b388c40073aac10cdcce4336ebbc265a667663c
1 # 2011 April 22
3 # The author disclaims copyright to this source code.  In place of
4 # a legal notice, here is a blessing:
6 #    May you do good and not evil.
7 #    May you find forgiveness for yourself and forgive others.
8 #    May you share freely, never taking more than you give.
10 #***********************************************************************
13 set testdir [file dirname $argv0]
14 source $testdir/tester.tcl
16 # Test organization:
18 #   1.*: That file names are correctly extracted from URIs.
19 #   2.*: That URI options (query parameters) are correctly extracted from URIs.
20 #   3.*: That specifying an unknown VFS causes an error.
21 #   4.*: Tests for specifying other options (other than "vfs").
22 #   5.*: Test using a different VFS with an attached database.
23 #   6.*: Test that authorities other than "" and localhost cause errors.
24 #   7.*: Test that a read-write db can be attached to a read-only connection.
27 set testprefix uri
28 db close
29 sqlite3_shutdown
30 sqlite3_config_uri 1
32 #-------------------------------------------------------------------------
33 # Test that file names are correctly extracted from URIs.
35 foreach {tn uri file} {
36   1      test.db                              test.db
37   2      file:test.db                         test.db
38   3      file://PWD/test.db                   test.db
39   4      file:PWD/test.db                     test.db
40   5      file:test.db?mork=1                  test.db
41   6      file:test.db?mork=1&tonglor=2        test.db
42   7      file:test.db?mork=1#boris            test.db
43   8      file:test.db#boris                   test.db
44   9      test.db#boris                        test.db#boris
45   10     file:test%2Edb                       test.db
46   11     file                                 file
47   12     http:test.db                         http:test.db
48   13     file:test.db%00extra                 test.db
49   14     file:testdb%00.db%00extra            testdb
51   15     test.db?mork=1#boris                 test.db?mork=1#boris
52   16     file://localhostPWD/test.db%3Fhello  test.db?hello
53 } {
54   
56   ifcapable !curdir { if {$tn==3} break }
58   ifcapable uri_00_error {
59     if {[string first %00 $uri]>=0} continue
60   }
62   if {$tcl_platform(platform)=="windows"} {
63     #
64     # NOTE: Due to limits on legal characters for file names imposed by
65     #       Windows, we must skip the final two tests here (i.e. the
66     #       question mark is illegal in a file name on Windows).
67     #
68     if {$tn>14} break
70     #
71     # NOTE: When running on Tcl 8.6 (or higher?) on Windows, a colon within
72     #       the file name no longer tries to access an alternate data stream
73     #       (ADS) named "test.db" for the "http" file, causing some spurious
74     #       failures of this test.
75     #
76     if {$tn==12 && $::tcl_version>=8.6} continue
78     #
79     # NOTE: On Windows, we need to account for the fact that the current
80     #       directory does not start with a forward slash.
81     #
82     set uri  [string map [list PWD/ /[test_pwd /]] $uri]
83   } else {
84     set uri  [string map [list PWD/ [test_pwd /]] $uri]
85   }
87   if {[file isdir $file]} {error "$file is a directory"}
88   forcedelete $file
89   do_test 1.$tn.1 { file exists $file } 0
90   set DB [sqlite3_open $uri]
91   do_test 1.$tn.2 { file exists $file } 1
92   sqlite3_close $DB
93   forcedelete $file
95   do_test 1.$tn.3 { file exists $file } 0
96   sqlite3 db xxx.db
97   catchsql { ATTACH $uri AS aux }
98   do_test 1.$tn.4 { file exists $file } 1
99   db close
102 #-------------------------------------------------------------------------
103 # Test that URI query parameters are passed through to the VFS layer
104 # correctly.
106 testvfs tvfs2
107 testvfs tvfs -default 1
108 tvfs filter xOpen
109 tvfs script open_method
110 proc open_method {method file arglist} {
111   set ::arglist $arglist
113 foreach {tn uri kvlist} {
114   1      file:test.db?hello=world                     {hello world}
115   2      file:test.db?hello&world                     {hello {} world {}}
116   3      file:test.db?hello=1&world=2&vfs=tvfs        {hello 1 world 2 vfs tvfs}
117   4      file:test.db?hello=1&world=2&vfs=tvfs2        {}
118   5      file:test.db?%68%65%6C%6C%6F=%77%6F%72%6C%64 {hello world}
119   6      file:testdb%00.db?hello%00extra=world%00ex   {hello world}
120   7      file:testdb%00.db?hello%00=world%00          {hello world}
121   8      file:testdb%00.db?=world&xyz=abc             {xyz abc}
122   9      file:test.db?%00hello=world&xyz=abc          {xyz abc}
123   10     file:test.db?hello=%00world&xyz=             {hello {} xyz {}}
124   11     file:test.db?=#ravada                        {}
125   12     file:test.db?&&&&&&&&hello=world&&&&&&&      {hello world}
127   13     test.db?&&&&&&&&hello=world&&&&&&&           {}
128   14     http:test.db?hello&world                     {}
129 } {
131   ifcapable uri_00_error {
132     if {[string first %00 $uri]>=0} continue
133   }
135   if {$tcl_platform(platform) == "windows" && $tn>12} {
136     continue
137   }
139   set ::arglist ""
140   set DB [sqlite3_open $uri]
141   do_test 2.$tn.1 { set ::arglist } $kvlist
142   sqlite3_close $DB
144   sqlite3 db xxx.db
145   set ::arglist ""
146   execsql { ATTACH $uri AS aux }
147   do_test 2.$tn.2 { set ::arglist } $kvlist
148   db close
150 tvfs delete
151 tvfs2 delete
153 #-------------------------------------------------------------------------
154 # Test that specifying a non-existent VFS raises an error.
156 do_test 3.1 {
157   list [catch { sqlite3 db "file:test.db?vfs=nosuchvfs" } msg] $msg
158 } {1 {no such vfs: nosuchvfs}}
160 #-------------------------------------------------------------------------
161 # Test some of the other options (other than "vfs").
163 foreach {tn mode create_ok write_ok readonly_ok} {
164   1    ro    0   0   1
165   2    rw    0   1   0
166   3    rwc   1   1   0
167 } {
168   catch { db close }
169   forcedelete test.db
171   set A(1) {0 {}}
172   set A(0) {1 {unable to open database file}}
173   do_test 4.1.$tn.1 {
174     list [catch {sqlite3 db "file:test.db?mode=$mode"} msg] $msg
175   } $A($create_ok)
177   catch { db close }
178   forcedelete test.db
179   sqlite3 db test.db
180   db eval { CREATE TABLE t1(a, b) }
181   db close
183   set A(1) {0 {}}
184   set A(0) {1 {attempt to write a readonly database}}
185   do_test 4.1.$tn.2 {
186     sqlite3 db "file:test.db?mode=$mode"
187     catchsql { INSERT INTO t1 VALUES(1, 2) }
188   } $A($write_ok)
190   set A(1) {0 {}}
191   set A(0) [list 1 "access mode not allowed: $mode"]
192   do_test 4.1.$tn.3 {
193     list [catch {sqlite3 db "file:test.db?mode=$mode" -readonly 1} msg] $msg
194   } $A($readonly_ok)
197 ifcapable shared_cache {
198 set orig [sqlite3_enable_shared_cache]
199 foreach {tn options sc_default is_shared} {
200   1    ""                1   1
201   2    "cache=private"   1   0
202   3    "cache=shared"    1   1
203   4    ""                0   0
204   5    "cache=private"   0   0
205   6    "cache=shared"    0   1
206 } {
207   catch { db close }
208   forcedelete test.db
210   sqlite3_enable_shared_cache 1
211   sqlite3 db2 test.db
212   db2 eval {CREATE TABLE t1(a, b)}
214   sqlite3_enable_shared_cache $sc_default
215   sqlite3 db "file:test.db?$options"
216   db eval {SELECT * FROM t1}
218   set A(1) {1 {database table is locked: t1}}
219   set A(0) {0 {}}
220   do_test 4.2.$tn {
221     db2 eval {BEGIN; INSERT INTO t1 VALUES(1, 2);}
222     catchsql { SELECT * FROM t1 }
223   } $A($is_shared)
225   db2 close
227 } ;# end ifcapable shared_cache
229 do_test 4.3.1 {
230   list [catch {sqlite3 db "file:test.db?mode=rc"} msg] $msg
231 } {1 {no such access mode: rc}}
232 do_test 4.3.2 {
233   list [catch {sqlite3 db "file:test.db?cache=public"} msg] $msg
234 } {1 {no such cache mode: public}}
236 #-------------------------------------------------------------------------
237 # Test that things work if an ATTACHed database uses a different VFS than
238 # the main database. The important point is that for all operations 
239 # involving the ATTACHed database, the correct versions of the following
240 # VFS are used for all operations involving the attached database.
242 #     xOpen
243 #     xDelete
244 #     xAccess
245 #     xFullPathname
248 # This block of code creates two VFS - "tvfs1" and "tvfs2". Each time one
249 # of the above methods is called using "tvfs1", global variable ::T1(X) is
250 # set, where X is the file-name the method is called on. Calls to the above
251 # methods using "tvfs2" set entries in the global T2 array.
253 ifcapable wal {
254   testvfs tvfs1 
255   tvfs1 filter {xOpen xDelete xAccess xFullPathname}
256   tvfs1 script tvfs1_callback
257   proc tvfs1_callback {method filename args} { 
258     set ::T1([file tail $filename]) 1 
259     return SQLITE_OK
260   }
261   testvfs tvfs2 
262   tvfs2 filter {xOpen xDelete xAccess xFullPathname}
263   tvfs2 script tvfs2_callback
264   proc tvfs2_callback {method filename args} { 
265     set ::T2([file tail $filename]) 1 
266     return SQLITE_OK
267   }
268   
269   catch {db close}
270   eval forcedelete [glob test.db*]
271   do_test 5.1.1 {
272     sqlite3 db file:test.db1?vfs=tvfs1
273     execsql {
274       ATTACH 'file:test.db2?vfs=tvfs2' AS aux;
275       PRAGMA main.journal_mode = PERSIST;
276       PRAGMA aux.journal_mode = PERSIST;
277       CREATE TABLE t1(a, b);
278       CREATE TABLE aux.t2(a, b);
279       PRAGMA main.journal_mode = WAL;
280       PRAGMA aux.journal_mode = WAL;
281       INSERT INTO t1 VALUES('x', 'y');
282       INSERT INTO t2 VALUES('x', 'y');
283     }
284     lsort [array names ::T1]
285   } {test.db1 test.db1-journal test.db1-wal}
286   
287   do_test 5.1.2 {
288     lsort [array names ::T2]
289   } {test.db2 test.db2-journal test.db2-wal}
290   db close
291   
292   tvfs1 delete
293   tvfs2 delete
296 #-------------------------------------------------------------------------
297 # Check that only "" and "localhost" are acceptable as authorities.
299 catch {db close}
300 foreach {tn uri res} {
301   1     "file://localhost/PWD/test.db"   {not an error}
302   2     "file:///PWD/test.db"            {not an error}
303   3     "file:/PWD/test.db"              {not an error}
304   4     "file://l%6Fcalhost/PWD/test.db" {invalid uri authority: l%6Fcalhost}
305   5     "file://lbcalhost/PWD/test.db"   {invalid uri authority: lbcalhost}
306   6     "file://x/PWD/test.db"           {invalid uri authority: x}
307 } {
309   if {$tcl_platform(platform)=="windows"} {
310     set uri  [string map [list PWD [string range [get_pwd] 3 end]] $uri]
311   } else {
312     set uri  [string map [list PWD [string range [get_pwd] 1 end]] $uri]
313   }
315   do_test 6.$tn {
316     set DB [sqlite3_open $uri]
317     sqlite3_errmsg $DB
318   } $res
319   catch { sqlite3_close $DB }
322 forcedelete test.db test.db2
323 do_test 7.1 {
324   sqlite3 db test.db
325   execsql {
326     CREATE TABLE t1(a, b);
327     INSERT INTO t1 VALUES(1, 2);
328     ATTACH 'test.db2' AS aux;
329     CREATE TABLE aux.t2(a, b);
330     INSERT INTO t1 VALUES('a', 'b');
331   }
332   db close
333 } {}
334 do_test 7.2 {
335   sqlite3 db file:test.db?mode=ro
336   execsql { ATTACH 'file:test.db2?mode=rw' AS aux }
337 } {}
338 do_execsql_test  7.3 { 
339   INSERT INTO t2 VALUES('c', 'd') 
340 } {}
341 do_catchsql_test 7.4 { 
342   INSERT INTO t1 VALUES(3, 4) 
343 } {1 {attempt to write a readonly database}}
345 finish_test