dbutil_test.sh.in 12.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
#!/bin/sh
# Copyright (C) 2012  Internet Systems Consortium, Inc. ("ISC")
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
# OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.

# Checks that the logger will limit the output of messages less severe than
# the severity/debug setting.

testname="Database Upgrade Test"
echo $testname

failcount=0
tempfile=@abs_builddir@/dbutil_test_tempfile_$$
backupfile=${tempfile}.backup
testdata=@abs_srcdir@/testdata
verfile=@abs_builddir@/dbutil_test_verfile_$$

# @brief Record a success
succeed() {
    echo "--- PASS"
}


# @brief Record a fail
#
# @param $1 Optional additional reason to output
fail() {
Stephen Morris's avatar
Stephen Morris committed
38
    if [ "$1" != "" ]
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
    then
        echo "ERROR: $1"
    fi
    echo "*** FAIL"
    failcount=`expr $failcount + 1`
}


# @brief Record a pass if the argument is zero
#
# @param $1 Value to test
passzero() {
    if [ $1 -eq 0 ]; then
        succeed
    else
        fail
    fi
}


# @brief Record a fail if the argument is non-zero
#
# @param $1 Value to test
failzero() {
    if [ $1 -ne 0 ]; then
        succeed
    else
        fail
    fi
}


Stephen Morris's avatar
Stephen Morris committed
71
72
73
74
75
76
77
78
79
80
81
82
83
# @brief Copy File
#
# Executes a "cp" operation followed by a "chmod" to make the target writeable.
#
# @param $1 Source file
# @param $2 Target file
copy_file () {
    cp $1 $2
    chmod a+w $2
}



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# @brief Check backup file
#
# Record a failure if the backup file does not exist or if it is different
# to the data file. (N.B. No success is recorded if they are the same.)
#
# @param $1 Source database file
# @param $2 Backup file
check_backup() {
    if [ ! -e $1 ]
    then
        fail "database file $1 not found"

    elif [ ! -e $2 ]
    then
        fail "backup file $2 not found"

    else
        diff $1 $2 > /dev/null
        if [ $? -ne 0 ]
        then
            fail "database file $1 different to backup file $2"
        fi
    fi
}


# @brief Check No Backup File
#
# Record a failure if the backup file exists.  (N.B. No success is recorded if
# it does not.)
#
# @param $1 Source database file (unused, present for symmetry)
# @param $2 Backup file
check_no_backup() {
    if [ -e $2 ]
    then
        fail "backup of database $2 exists when it should not"
    fi
}


# @brief Get Database Schema
#
# As the schema stored in the database is format-dependent - how it is printed
# depends on how the commands were entered (on one line, split across two
# lines etc.) - comparing schema is awkward.
#
# The function sets the local variable db_schema to the output of the
# .schema command, with spaces removed and upper converted to lowercase.
#
# The database is copied before the schema is taken (and removed after)
# as SQLite3 assummes a writeable database, which may not be the case if
# getting the schema from a reference copy.
#
# @param $1 Database for which the schema is required
get_schema() {
    db1=@abs_builddir@/dbutil_test_schema_$$
Stephen Morris's avatar
Stephen Morris committed
141
    copy_file $1 $db1
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

    db_schema=`sqlite3 $db1 '.schema' | \
               awk '{line = line $0} END {print line}' | \
               sed -e 's/ //g' | \
               tr [:upper:] [:lower:]`
    rm -f $db1
}


# @brief Successful Schema Upgrade Test
#
# This test is done where the upgrade is expected to be successful - when
# the end result of the test is that the test database is upgraded to a
# database of the expected schema.
#
# Note: the caller must ensure that $tempfile and $backupfile do not exist
#       on entry, and is responsible for removing them afterwards.
#
# @param $1 Database to upgrade
Stephen Morris's avatar
Stephen Morris committed
161
# @param $2 Expected backup file
162
upgrade_ok_test() {
Stephen Morris's avatar
Stephen Morris committed
163
    copy_file $1 $tempfile
Stephen Morris's avatar
Stephen Morris committed
164
    ../run_dbutil.sh --upgrade --noconfirm $tempfile
165
166
167
168
169
170
171
    if [ $? -eq 0 ]
    then
        # Compare schema with the reference
        get_schema $testdata/v2_0.sqlite3
        expected_schema=$db_schema
        get_schema $tempfile
        actual_schema=$db_schema
Stephen Morris's avatar
Stephen Morris committed
172
        if [ "$expected_schema" = "$actual_schema" ]
173
174
175
176
177
178
        then
            succeed
        else
            fail "upgraded schema not as expected"
        fi

Stephen Morris's avatar
Stephen Morris committed
179
        # Check the version is set correctly
180
        check_version $tempfile "V2.0"
Stephen Morris's avatar
Stephen Morris committed
181
182
183

        # Check that a backup was made
        check_backup $1 $2
184
185
186
187
188
189
190
    else
        # Error should have been output already
        fail
    fi
}


Stephen Morris's avatar
Stephen Morris committed
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# @brief Unsuccessful Upgrade Test
#
# Checks that an upgrade of the specified database fails.
#
# Note: the caller must ensure that $tempfile and $backupfile do not exist
#       on entry, and is responsible for removing them afterwards.
#
# @param $1 Database to upgrade
# @param $2 Expected backup file
upgrade_fail_test() {
    copy_file $1 $tempfile
    ../run_dbutil.sh --upgrade --noconfirm $tempfile
    failzero $?
    check_backup $1 $backupfile
}


208
209
210
211
212
213
214
215
216
217
# @brief Record Count Test
#
# Checks that the count of records in each table is preserved in the upgrade.
#
# Note 1: This test assumes that the "diffs" table is present.
# Note 2: The caller must ensure that $tempfile and $backupfile do not exist
#         on entry, and is responsible for removing them afterwards.
#
# @brief $1 Database to upgrade
record_count_test() {
Stephen Morris's avatar
Stephen Morris committed
218
    copy_file $1 $tempfile
219
220
221
222
223
224

    diffs_count=`sqlite3 $tempfile 'select count(*) from diffs'`
    nsec3_count=`sqlite3 $tempfile 'select count(*) from nsec3'`
    records_count=`sqlite3 $tempfile 'select count(*) from records'`
    zones_count=`sqlite3 $tempfile 'select count(*) from zones'`

Stephen Morris's avatar
Stephen Morris committed
225
    ../run_dbutil.sh --upgrade --noconfirm $tempfile
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
    if [ $? -ne 0 ]
    then
        # Reason for failure should already have been output
        fail
    else
        new_diffs_count=`sqlite3 $tempfile 'select count(*) from diffs'`
        new_nsec3_count=`sqlite3 $tempfile 'select count(*) from nsec3'`
        new_records_count=`sqlite3 $tempfile 'select count(*) from records'`
        new_zones_count=`sqlite3 $tempfile 'select count(*) from zones'`

        if [ $diffs_count -ne $new_diffs_count ]
        then
            fail "diffs table was not completely copied"
        fi

        if [ $nsec3_count -ne $new_nsec3_count ]
        then
            fail "nsec3 table was not completely copied"
        fi

        if [ $records_count -ne $new_records_count ]
        then
            fail "records table was not completely copied"
        fi

        if [ $zones_count -ne $new_zones_count ]
        then
            fail "zones table was not completely copied"
        fi

        # As an extra check, test that the backup was successful
        check_backup $1 $backupfile
    fi
}


# @brief Version Check
#
# Checks that the database is at the specified version (and so checks the
# --check function).  On success, a pass is recorded.
#
# @param $1 Database to check
# @param $2 Expected version string
check_version() {
Stephen Morris's avatar
Stephen Morris committed
270
    copy_file $1 $verfile
Stephen Morris's avatar
Stephen Morris committed
271
    ../run_dbutil.sh --check $verfile
Jelte Jansen's avatar
Jelte Jansen committed
272
    if [ $? -gt 2 ]
273
    then
Jelte Jansen's avatar
Jelte Jansen committed
274
        fail "version check failed on database $1; return code $?"
275
    else
276
        ../run_dbutil.sh --check $verfile 2>&1 | grep "$2" > /dev/null
277
278
        if [ $? -ne 0 ]
        then
279
            fail "database $1 not at expected version $2 (output: $?)"
280
281
282
283
284
285
286
287
        else
            succeed
        fi
    fi
    rm -f $verfile
}


Stephen Morris's avatar
Stephen Morris committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# @brief Version Check Fail
#
# Does a version check but expected the check to fail
#
# @param $1 Database to check
# @param $2 Backup file
check_version_fail() {
    copy_file $1 $verfile
    ../run_dbutil.sh --check $verfile
    failzero $?
    check_no_backup $tempfile $backupfile
}


302
303
304
305
306
307
# Main test sequence

rm -f $tempfile $backupfile

# Test 1 - check that the utility fails if the database does not exist
echo "1.1. Non-existent database - check"
Stephen Morris's avatar
Stephen Morris committed
308
../run_dbutil.sh --check $tempfile
309
310
311
312
failzero $?
check_no_backup $tempfile $backupfile

echo "1.2. Non-existent database - upgrade"
Stephen Morris's avatar
Stephen Morris committed
313
../run_dbutil.sh --upgrade --noconfirm $tempfile
314
315
316
317
318
319
320
321
failzero $?
check_no_backup $tempfile $backupfile
rm -f $tempfile $backupfile


# Test 2 - should fail to check an empty file and fail to upgrade it
echo "2.1. Database is an empty file - check"
touch $tempfile
Stephen Morris's avatar
Stephen Morris committed
322
check_version_fail $tempfile $backupfile
323
324
325
326
rm -f $tempfile $backupfile

echo "2.2. Database is an empty file - upgrade"
touch $tempfile
Stephen Morris's avatar
Stephen Morris committed
327
../run_dbutil.sh --upgrade --noconfirm $tempfile
328
329
330
331
332
333
334
335
failzero $?
# A backup is performed before anything else, so the backup should exist.
check_backup $tempfile $backupfile
rm -f $tempfile $backupfile


echo "3.1. Database is not an SQLite file - check"
echo "This is not an sqlite3 database" > $tempfile
Stephen Morris's avatar
Stephen Morris committed
336
337
check_version_fail $tempfile $backupfile
rm -f $tempfile $backupfile
338
339

echo "3.2. Database is not an SQLite file - upgrade"
Stephen Morris's avatar
Stephen Morris committed
340
echo "This is not an sqlite3 database" > $tempfile
341
../run_dbutil.sh --upgrade --noconfirm $tempfile
342
343
344
345
346
347
348
failzero $?
# ...and as before, a backup should have been created
check_backup $tempfile $backupfile
rm -f $tempfile $backupfile


echo "4.1. Database is an SQLite3 file without the schema table - check"
Stephen Morris's avatar
Stephen Morris committed
349
check_version_fail $testdata/no_schema.sqlite3 $backupfile
350
351
352
rm -f $tempfile $backupfile

echo "4.1. Database is an SQLite3 file without the schema table - upgrade"
Stephen Morris's avatar
Stephen Morris committed
353
upgrade_fail_test $testdata/no_schema.sqlite3 $backupfile
354
355
356
357
358
359
360
361
362
rm -f $tempfile $backupfile


echo "5.1. Database is an old V1 database - check"
check_version $testdata/old_v1.sqlite3 "V1.0"
check_no_backup $tempfile $backupfile
rm -f $tempfile $backupfile

echo "5.2. Database is an old V1 database - upgrade"
Stephen Morris's avatar
Stephen Morris committed
363
upgrade_ok_test $testdata/old_v1.sqlite3 $backupfile
364
365
366
367
368
369
370
371
372
rm -f $tempfile $backupfile


echo "6.1. Database is new V1 database - check"
check_version $testdata/new_v1.sqlite3 "V1.0"
check_no_backup $tempfile $backupfile
rm -f $tempfile $backupfile

echo "6.2. Database is a new V1 database - upgrade"
Stephen Morris's avatar
Stephen Morris committed
373
upgrade_ok_test $testdata/new_v1.sqlite3 $backupfile
374
375
376
377
378
379
380
381
382
rm -f $tempfile $backupfile


echo "7.1. Database is V2.0 database - check"
check_version $testdata/v2_0.sqlite3 "V2.0"
check_no_backup $tempfile $backupfile
rm -f $tempfile $backupfile

echo "7.2. Database is a V2.0 database - upgrade"
Stephen Morris's avatar
Stephen Morris committed
383
upgrade_ok_test $testdata/v2_0.sqlite3 $backupfile
384
385
386
rm -f $tempfile $backupfile


Stephen Morris's avatar
Stephen Morris committed
387
388
389
390
391
392
echo "8.1. Database is V2.0 database with empty schema table - check"
check_version_fail $testdata/empty_version.sqlite3 $backupfile
rm -f $tempfile $backupfile

echo "8.2. Database is V2.0 database with empty schema table - upgrade"
upgrade_fail_test $testdata/empty_version.sqlite3 $backupfile
393
394
395
rm -f $tempfile $backupfile


Stephen Morris's avatar
Stephen Morris committed
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
echo "9.1. Database is V2.0 database with over-full schema table - check"
check_version_fail $testdata/too_many_version.sqlite3 $backupfile
rm -f $tempfile $backupfile

echo "9.2. Database is V2.0 database with over-full schema table - upgrade"
upgrade_fail_test $testdata/too_many_version.sqlite3 $backupfile
rm -f $tempfile $backupfile


echo "10.0. Upgrade corrupt database"
upgrade_fail_test $testdata/corrupt.sqlite3 $backupfile
rm -f $tempfile $backupfile


echo "11. Record count test"
record_count_test $testdata/new_v1.sqlite3
rm -f $tempfile $backupfile


echo "12. Backup file already exists"
416
417
touch $backupfile
touch ${backupfile}-1
Stephen Morris's avatar
Stephen Morris committed
418
upgrade_ok_test $testdata/v2_0.sqlite3 ${backupfile}-2
419
420
421
rm -f $tempfile $backupfile ${backupfile}-1 ${backupfile}-2


Stephen Morris's avatar
Stephen Morris committed
422
423
echo "13.1 Command-line errors"
copy_file $testdata/old_v1.sqlite3 $tempfile
Stephen Morris's avatar
Stephen Morris committed
424
../run_dbutil.sh $tempfile
425
failzero $?
Stephen Morris's avatar
Stephen Morris committed
426
../run_dbutil.sh --upgrade --check $tempfile
427
failzero $?
Stephen Morris's avatar
Stephen Morris committed
428
429
../run_dbutil.sh --noconfirm --check $tempfile
failzero $?
Stephen Morris's avatar
Stephen Morris committed
430
431
432
433
../run_dbutil.sh --check
failzero $?
../run_dbutil.sh --upgrade --noconfirm
failzero $?
Stephen Morris's avatar
Stephen Morris committed
434
../run_dbutil.sh --check $tempfile $backupfile
435
failzero $?
Stephen Morris's avatar
Stephen Morris committed
436
437
../run_dbutil.sh --upgrade --noconfirm $tempfile $backupfile
failzero $?
438
439
rm -f $tempfile $backupfile

Stephen Morris's avatar
Stephen Morris committed
440
441
echo "13.2 verbose flag"
copy_file $testdata/old_v1.sqlite3 $tempfile
Stephen Morris's avatar
Stephen Morris committed
442
../run_dbutil.sh --upgrade --noconfirm --verbose $tempfile
443
444
445
passzero $?
rm -f $tempfile $backupfile

446
447
448
449
450
451
echo "13.3 quiet flag"
copy_file $testdata/old_v1.sqlite3 $tempfile
../run_dbutil.sh --check --quiet $tempfile 2>&1 | grep dbutil
failzero $?
rm -f $tempfile $backupfile

Stephen Morris's avatar
Stephen Morris committed
452
453
echo "13.3 Interactive prompt - yes"
copy_file $testdata/old_v1.sqlite3 $tempfile
Stephen Morris's avatar
Stephen Morris committed
454
../run_dbutil.sh --upgrade $tempfile << .
455
456
457
458
459
460
Yes
.
passzero $?
check_version $tempfile "V2.0"
rm -f $tempfile $backupfile

Stephen Morris's avatar
Stephen Morris committed
461
462
echo "13.4 Interactive prompt - no"
copy_file $testdata/old_v1.sqlite3 $tempfile
Stephen Morris's avatar
Stephen Morris committed
463
../run_dbutil.sh --upgrade $tempfile << .
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
no
.
passzero $?
diff $testdata/old_v1.sqlite3 $tempfile > /dev/null
passzero $?
rm -f $tempfile $backupfile


# Report the result
if [ $failcount -eq 0 ]; then
    echo "PASS: $testname"
elif [ $failcount -eq 1 ]; then
    echo "FAIL: $testname - 1 test failed"
else
    echo "FAIL: $testname - $failcount tests failed"
fi

# Exit with appropriate error status
exit $failcount