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
38
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
71
72
73
74
75
76
77
78
79
80
81
82
83
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
|
#!/usr/bin/env sh
# ============LICENSE_START=======================================================
# ONAP
# ================================================================================
# Copyright (C) 2017-2021 AT&T Intellectual Property. All rights reserved.
# Modifications Copyright (C) 2021 Nordix Foundation.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ============LICENSE_END=========================================================
# #####################################################################
#
# Upgrade/Downgrade SQL File Name Format:
#
# <VERSION>-<pdp|feature-name>[-description](.upgrade|.downgrade).sql
#
# This tool operates on a migration working directory at
#
# $POLICY_HOME/etc/db/migration
#
# Upgrade/Downgrade files for each schema (aka database) names to be maintained
# by this tool are located at
#
# $POLICY_HOME/etc/db/migration/<schema-name>/sql
#
# The nature of the migration directories is dynamic.
# A number of environment variables needs to be initialized
# prior to running db-migrator.
# These vaiables specifiy the connection details for the database
# to be upgraded/downgraded.
#
# The repository of upgrade/downgrade scripts is located in the
# /home/policy/sql directory.
# Two additional scripts have been provided to prepare the directories/files
# needed to perform the upgrade/downgrade.
#
# At any given time the following invariant must be preserved in any given
# $POLICY_HOME/etc/db/migration/<schema-name>/sql directory
#
# There is only upgrade scripts, or only downgrade scripts, or none.
#
# #####################################################################
source ${POLICY_HOME}/etc/profile.d/env.sh
METADATA_DB=migration
METADATA_TABLE=${METADATA_DB}.db_metadata_versions
MIGRATION_DIR=${POLICY_HOME}/etc/db/migration
ZERO_VERSION="0"
UPGRADE_SQL_SUFFIX=".upgrade.sql"
DOWNGRADE_SQL_SUFFIX=".downgrade.sql"
SQL_QUOTES="SET SESSION SQL_MODE=ANSI_QUOTES;"
#####################################################
# usage
#####################################################
function usage() {
echo
echo -e "syntax: $(basename "$0") "
echo -e "\t -s <schema-name> "
echo -e "\t [-b <migration-dir>] "
echo -e "\t [-f <from-version>]"
echo -e "\t [-t <target-version>]"
echo -e "\t -o <operations> "
echo
echo -e "\t where <operations>=upgrade|downgrade|auto|version|erase|report"
echo
echo
echo -e "Configuration Options:"
echo -e "\t -s|--schema|--database: schema to operate on ('ALL' to apply on all)"
echo -e "\t -b|--basedir: overrides base DB migration directory"
echo -e "\t -f|--from: overrides current release version for operations"
echo -e "\t -t|--target: overrides target release to upgrade/downgrade"
echo
echo -e "Operations:"
echo -e "\t upgrade: upgrade operation"
echo -e "\t downgrade: performs a downgrade operation"
echo -e "\t auto: autonomous operation, determines upgrade or downgrade"
echo -e "\t version: returns current version, and in conjunction if '-f' sets the current version"
echo -e "\t erase: erase all data related <schema> (use with care)"
echo -e "\t report: migration detailed report on an schema"
echo -e "\t ok: is the migration status valid"
echo
echo
}
#####################################################
# ensure global metadata
#####################################################
function ensure_metadata
{
if [ "${DEBUG}" = "y" ]; then
echo "-- ensure_metadata --"
set -x
fi
local sql rc
sql="CREATE DATABASE IF NOT EXISTS ${METADATA_DB};"
${MYSQL} --execute "${sql}"
rc=$?
if [ ${rc} -ne 0 ]; then
return ${rc}
fi
sql="CREATE TABLE IF NOT EXISTS ${METADATA_TABLE} "
sql=${sql}"(name VARCHAR(60) NOT NULL, version VARCHAR(20), "
sql=${sql}"PRIMARY KEY(name));"
${MYSQL} --execute "${sql}"
return $?
}
#####################################################
# ensure metadata on a per schema basis
#####################################################
function ensure_metadata_schema
{
if [ "${DEBUG}" = "y" ]; then
echo "-- ensure_metadata_schema --"
set -x
fi
local sql rc
sql="CREATE TABLE IF NOT EXISTS ${METADATA_HISTORY} "
sql=${sql}"(script VARCHAR(80) NOT NULL, "
sql=${sql}"operation VARCHAR(10), from_version VARCHAR(20), to_version VARCHAR(20), success VARCHAR(1), "
sql=${sql}"atTime TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, "
sql=${sql}"PRIMARY KEY(to_version, script, operation));"
${MYSQL} --execute "${sql}"
rc=$?
if [ ${rc} -ne 0 ]; then
return ${rc}
fi
sql="CREATE DATABASE IF NOT EXISTS ${SCHEMA_DB};"
${MYSQL} --execute "${sql}"
return $?
}
#####################################################
# target_release
#####################################################
function target_release
{
if [ "${DEBUG}" = "y" ]; then
echo "-- target_release --"
set -x
fi
local sql sqlName upgradeSqls downgradeSqls
TARGET_UPGRADE_RELEASE=${ZERO_VERSION}
TARGET_DOWNGRADE_RELEASE=${ZERO_VERSION}
upgradeSqls=$(ls -v -r "${UPGRADE_DIR}"/*/upgrade/*.sql 2> /dev/null)
for sql in ${upgradeSqls}; do
TARGET_UPGRADE_RELEASE="$(basename $(dirname $(dirname $sql)))"
break
done
# default unless overriden
TARGET_DOWNGRADE_RELEASE="${ZERO_VERSION}"
}
#####################################################
# is_upgrade
#####################################################
function is_upgrade
{
if [ "${DEBUG}" = "y" ]; then
echo "-- is_upgrade --"
set -x
fi
local upgradeSqls
upgradeSqls=$(ls -v "${UPGRADE_DIR}"/*/upgrade/*.sql 2> /dev/null)
if [ -z "${upgradeSqls}" ]; then
return 1
else
return 0
fi
}
#####################################################
# is_downgrade
#####################################################
function is_downgrade
{
if [ "${DEBUG}" = "y" ]; then
echo "-- is_downgrade --"
set -x
fi
local downgradeSqls
downgradeSqls=$(ls -v -r "${DOWNGRADE_DIR}"/*/downgrade/*.sql 2> /dev/null)
if [ -z "${downgradeSqls}" ]; then
return 1
else
return 0
fi
}
#####################################################
# set_current_release
#####################################################
function set_current_release
{
if [ "${DEBUG}" = "y" ]; then
echo "-- set_current_release --"
set -x
fi
CURRENT_RELEASE="${1}"
local sql
sql="INSERT INTO ${METADATA_TABLE} (name, version) "
sql=${sql}"VALUES('${SCHEMA}', '${CURRENT_RELEASE}') "
sql=${sql}"ON DUPLICATE KEY UPDATE version='${CURRENT_RELEASE}';"
${MYSQL} --execute "${sql}"
return $?
}
#####################################################
# current_release
#####################################################
function current_release
{
if [ "${DEBUG}" = "y" ]; then
echo "-- current_release --"
set -x
fi
local rc
local query="SELECT version FROM ${METADATA_TABLE} WHERE name='${SCHEMA}'"
CURRENT_RELEASE=$(${MYSQL} --skip-column-names --silent --execute "${query}")
if [ -z "${CURRENT_RELEASE}" ]; then
set_current_release "${ZERO_VERSION}"
return $?
fi
return 0
}
#####################################################
# execute sql script history
#####################################################
function track_script
{
if [ "${DEBUG}" = "y" ]; then
echo "-- track_script $* --"
set -x
fi
local script="${1}" operation="${2}" success="${3}" to_version="${4}"
if [ $operation == "downgrade" ]; then
to_version=${TARGET_DOWNGRADE_RELEASE}
fi
from_version=${CURRENT_RELEASE}
local sql="INSERT INTO ${METADATA_HISTORY}(script,operation,from_version,to_version,success,atTime) "
sql=${sql}"VALUES ('${script}','${operation}','${from_version}','${to_version}','${success}',now()) "
sql=${sql}"ON DUPLICATE KEY UPDATE operation=values(operation),from_version=values(from_version),"
sql=${sql}"success=values(success), atTime=values(atTime);"
${MYSQL} --execute "${sql}"
return $?
}
#####################################################
# execute sql script
#####################################################
function run_script
{
if [ "${DEBUG}" == "y" ]; then
echo "-- run_script $* --"
set -x
fi
local operation="${1}" script="${2}" scriptPath="${3}" schemaVersion="${4}"
echo
echo "> ${operation} ${script}"
${MYSQL} ${SCHEMA} --verbose < "${scriptPath}"
local rc=$?
if [ ${rc} -ne 0 ]; then
success="0"
else
success="1"
fi
track_script "${script}" "${operation}" "${success}" "${schemaVersion}"
return ${rc}
}
#####################################################
# upgrade
#####################################################
function upgrade
{
if [ "${DEBUG}" = "y" ]; then
echo "-- upgrade --"
set -x
fi
local sqlName sqlFile schemaVersion upgradeSqls rc
${MYSQL} --execute "USE ${SCHEMA_DB}"
echo "upgrade: ${CURRENT_RELEASE} -> ${TARGET_UPGRADE_RELEASE}"
if [ ${CURRENT_RELEASE} \< ${TARGET_UPGRADE_RELEASE} ]; then
upgradeSqls=$(ls -v "${UPGRADE_DIR}"/*/upgrade/*.sql 2> /dev/null)
for sqlFile in ${upgradeSqls}; do
sqlName=$(basename "${sqlFile}")
schemaVersion="$(basename $(dirname $(dirname $sqlFile)))"
if [ "${schemaVersion}" -gt "${CURRENT_RELEASE}" ] && \
[ "${schemaVersion}" -le "${TARGET_UPGRADE_RELEASE}" ]; then
run_script "upgrade" "${sqlName}" "${sqlFile}" "${schemaVersion}"
rc=$?
if [ ${rc} -ne 0 ]; then
echo "${SCHEMA}: upgrade aborted at ${schemaVersion} by script ${sqlName}"
set_current_release "${schemaVersion}"
return ${rc}
fi
fi
done
set_current_release "${TARGET_UPGRADE_RELEASE}"
fi
return 0
}
#####################################################
# downgrade
#####################################################
function downgrade
{
if [ "${DEBUG}" = "y" ]; then
echo "-- downgrade --"
set -x
fi
local sqlName sqlFile schemaVersion downgradeSqls rc
${MYSQL} --execute "USE ${SCHEMA_DB}"
echo "downgrade: ${CURRENT_RELEASE} -> ${TARGET_DOWNGRADE_RELEASE}"
if [ ${CURRENT_RELEASE} \> ${TARGET_DOWNGRADE_RELEASE} ]; then
downgradeSqls=$(ls -v -r "${DOWNGRADE_DIR}"/*/downgrade/*.sql 2> /dev/null)
for sqlFile in ${downgradeSqls}; do
sqlName=$(basename "${sqlFile}")
schemaVersion="$(basename $(dirname $(dirname $sqlFile)))"
if [ "${schemaVersion}" -le "${CURRENT_RELEASE}" ] && \
[ "${schemaVersion}" -gt "${TARGET_DOWNGRADE_RELEASE}" ]; then
run_script "downgrade" "${sqlName}" "${sqlFile}" "${schemaVersion}"
rc=$?
if [ ${rc} -ne 0 ]; then
echo "${SCHEMA}: downgrade aborted at ${schemaVersion} by script ${sqlName}"
set_current_release "${schemaVersion}"
return ${rc}
fi
fi
done
set_current_release "${TARGET_DOWNGRADE_RELEASE}"
fi
return 0
}
#####################################################
# erase
#####################################################
function erase
{
if [ "${DEBUG}" = "y" ]; then
echo "-- erase --"
set -x
fi
local updateMetadata="UPDATE ${METADATA_TABLE} SET version='${ZERO_VERSION}';"
${MYSQL} --execute "${updateMetadata}"
local deleteHistory="DELETE FROM ${METADATA_HISTORY};"
${MYSQL} --execute "${deleteHistory}"
local dropDB="DROP DATABASE IF EXISTS ${SCHEMA_DB}";
${MYSQL} --execute "${dropDB}"
}
#####################################################
# report
#####################################################
function report
{
if [ "${DEBUG}" = "y" ]; then
echo "-- report --"
set -x
fi
local versionSql="SELECT * FROM ${METADATA_TABLE} WHERE name='${SCHEMA}';"
${MYSQL} --execute "${versionSql}"
local historySql="SELECT * FROM ${METADATA_HISTORY} ORDER BY atTime ASC;"
${MYSQL} --execute "${historySql}"
okay
}
function okay
{
if [ "${DEBUG}" = "y" ]; then
echo "-- okay --"
set -x
fi
local rc=0
if is_upgrade; then
if [ "${CURRENT_RELEASE}" = "${TARGET_UPGRADE_RELEASE}" ]; then
echo "${SCHEMA}: OK @ ${CURRENT_RELEASE}"
else
echo "${SCHEMA}: upgrade available: ${CURRENT_RELEASE} -> ${TARGET_UPGRADE_RELEASE}"
rc=1
fi
else
if [ "${CURRENT_RELEASE}" = "${TARGET_DOWNGRADE_RELEASE}" ]; then
echo "${SCHEMA}: OK @ ${CURRENT_RELEASE}"
else
echo "${SCHEMA}: downgrade available: ${CURRENT_RELEASE} -> ${TARGET_DOWNGRADE_RELEASE}"
rc=1
fi
fi
return ${rc}
}
#####################################################
# MAIN
#####################################################
if [ "${DEBUG}" = "y" ]; then
echo "-- $0 $* --"
set -x
fi
until [ -z "$1" ]; do
case $1 in
-s|--schema|--database) shift
SCHEMA=$1
;;
-b|--basedir) shift
MIGRATION_DIR=$1
;;
-t|--target) shift
INPUT_TARGET_RELEASE=$1
;;
-f|--from) shift
INPUT_CURRENT_RELEASE=$1
;;
-o|--operation) shift
OPERATION=$1
;;
*) usage
exit 1
;;
esac
shift
done
case ${OPERATION} in
upgrade) ;;
downgrade) ;;
auto) ;;
version) ;;
erase) ;;
report) ;;
ok) ;;
*) echo "error: invalid operation provided"
usage
exit 1
;;
esac
if [ -z "${SCHEMA}" ]; then
echo "error: a database name must be provided"
usage
exit 2
fi
source "${POLICY_HOME}"/etc/profile.d/env.sh
if [ -z "${SQL_HOST}" ] || [ -z "${SQL_USER}" ] || [ -z "${SQL_PASSWORD}" ]; then
echo "error: no database has been set up"
exit 4
fi
MYSQL="mysql -u${SQL_USER} -p${SQL_PASSWORD} -h ${SQL_HOST}";
if ! ${MYSQL} -h"${SQL_HOST}" --execute "show databases;" > /dev/null 2>&1; then
echo "error: No DB connectivity to ${SQL_HOST} for ${SQL_USER}"
exit 5
fi
if [ "${SCHEMA}" = "ALL" ]; then
SCHEMA="*"
fi
SCHEMA_S=$(ls -d "${MIGRATION_DIR}"/${SCHEMA}/ 2> /dev/null)
if [ -z "${SCHEMA_S}" ]; then
echo "error: no databases available"
exit 0
fi
if ! ensure_metadata; then
echo "error: migration metadata not accessible"
exit 7
fi
rc=0
for dbPath in ${SCHEMA_S}; do
SCHEMA=$(basename "${dbPath}")
SCHEMA_DB="\`${SCHEMA}\`"
UPGRADE_DIR="${MIGRATION_DIR}"/"${SCHEMA}"/sql
DOWNGRADE_DIR=${UPGRADE_DIR}
METADATA_HISTORY="${METADATA_DB}.\`${SCHEMA}_change_history\`"
TARGET_RELEASE=${INPUT_TARGET_RELEASE}
CURRENT_RELEASE=${INPUT_CURRENT_RELEASE}
if is_upgrade && is_downgrade; then
echo "${SCHEMA}: failure: invalid configuration: ${UPGRADE_SQL_SUFFIX} and "\
"${DOWNGRADE_SQL_SUFFIX} exist under ${DOWNGRADE_DIR}"
rc=1
continue
fi
if [ "${operation}" = "auto" ]; then
if is_upgrade; then
operation=upgrade
else
operation=downgrade
fi
fi
if ! ensure_metadata_schema; then
echo "${SCHEMA}: failure: metadata not accessible for this schema"
continue
fi
if [ -z "${TARGET_RELEASE}" ]; then
target_release
else
# user asked to override
TARGET_UPGRADE_RELEASE="${TARGET_RELEASE}"
TARGET_DOWNGRADE_RELEASE="${TARGET_RELEASE}"
fi
if [ -z "${CURRENT_RELEASE}" ]; then
if ! current_release; then
echo "${SCHEMA}: failure: cannot obtain current release"
continue
fi
else
if ! set_current_release "${CURRENT_RELEASE}"; then
echo "${SCHEMA}: failure: cannot set current release"
continue
fi
fi
case ${OPERATION} in
upgrade) if upgrade; then
echo "${SCHEMA}: OK: upgrade (${CURRENT_RELEASE})"
else
rc=1
echo "${SCHEMA}: failure: upgrade to release ${TARGET_UPGRADE_RELEASE} (${CURRENT_RELEASE})"
fi
;;
downgrade) if downgrade; then
echo "${SCHEMA}: OK: downgrade (${CURRENT_RELEASE})"
else
rc=1
echo "${SCHEMA}: failure: downgrade to release ${TARGET_DOWNGRADE_RELEASE} (${CURRENT_RELEASE})"
fi
;;
version) echo "${SCHEMA}: ${CURRENT_RELEASE}"
;;
erase) erase
;;
report) report
;;
ok) okay
;;
esac
done
exit $rc
|