1#!/usr/bin/env bash
2#
3# Live snapshot tests
4#
5# This tests live snapshots of images on a running QEMU instance, using
6# QMP commands.  Both single disk snapshots, and transactional group
7# snapshots are performed.
8#
9# Copyright (C) 2014 Red Hat, Inc.
10# Copyright (C) 2015 Igalia, S.L.
11#
12# This program is free software; you can redistribute it and/or modify
13# it under the terms of the GNU General Public License as published by
14# the Free Software Foundation; either version 2 of the License, or
15# (at your option) any later version.
16#
17# This program is distributed in the hope that it will be useful,
18# but WITHOUT ANY WARRANTY; without even the implied warranty of
19# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20# GNU General Public License for more details.
21#
22# You should have received a copy of the GNU General Public License
23# along with this program.  If not, see <http://www.gnu.org/licenses/>.
24#
25
26# creator
27owner=jcody@redhat.com
28
29seq=`basename $0`
30echo "QA output created by $seq"
31
32status=1	# failure is the default!
33
34snapshot_virt0="snapshot-v0.qcow2"
35snapshot_virt1="snapshot-v1.qcow2"
36
37SNAPSHOTS=10
38
39_cleanup()
40{
41    _cleanup_qemu
42    for i in $(seq 1 ${SNAPSHOTS})
43    do
44        rm -f "${TEST_DIR}/${i}-${snapshot_virt0}"
45        rm -f "${TEST_DIR}/${i}-${snapshot_virt1}"
46    done
47    rm -f "${TEST_IMG}" "${TEST_IMG}.1" "${TEST_IMG}.2" "${TEST_IMG}.base"
48
49}
50trap "_cleanup; exit \$status" 0 1 2 3 15
51
52# get standard environment, filters and checks
53. ./common.rc
54. ./common.filter
55. ./common.qemu
56
57_supported_fmt qcow2
58_supported_proto file
59
60
61# ${1}: unique identifier for the snapshot filename
62create_single_snapshot()
63{
64    cmd="{ 'execute': 'blockdev-snapshot-sync',
65                      'arguments': { 'device': 'virtio0',
66                                     'snapshot-file':'${TEST_DIR}/${1}-${snapshot_virt0}',
67                                     'format': 'qcow2' } }"
68    _send_qemu_cmd $h "${cmd}" "return"
69}
70
71# ${1}: unique identifier for the snapshot filename
72create_group_snapshot()
73{
74    cmd="{ 'execute': 'transaction', 'arguments':
75           {'actions': [
76               { 'type': 'blockdev-snapshot-sync', 'data' :
77                   { 'device': 'virtio0',
78                      'snapshot-file': '${TEST_DIR}/${1}-${snapshot_virt0}' } },
79               { 'type': 'blockdev-snapshot-sync', 'data' :
80                   { 'device': 'virtio1',
81                       'snapshot-file': '${TEST_DIR}/${1}-${snapshot_virt1}' } } ]
82             } }"
83
84    _send_qemu_cmd $h "${cmd}" "return"
85}
86
87# ${1}: unique identifier for the snapshot filename
88# ${2}: extra_params to the blockdev-add command
89# ${3}: filename
90do_blockdev_add()
91{
92    cmd="{ 'execute': 'blockdev-add', 'arguments':
93           { 'driver': 'qcow2', 'node-name': 'snap_${1}', ${2}
94             'file':
95             { 'driver': 'file', 'filename': '${3}',
96               'node-name': 'file_${1}' } } }"
97    _send_qemu_cmd $h "${cmd}" "return"
98}
99
100# ${1}: unique identifier for the snapshot filename
101add_snapshot_image()
102{
103    base_image="${TEST_DIR}/$((${1}-1))-${snapshot_virt0}"
104    snapshot_file="${TEST_DIR}/${1}-${snapshot_virt0}"
105    _make_test_img -u -b "${base_image}" "$size"
106    mv "${TEST_IMG}" "${snapshot_file}"
107    do_blockdev_add "$1" "'backing': null, " "${snapshot_file}"
108}
109
110# ${1}: unique identifier for the snapshot filename
111# ${2}: expected response, defaults to 'return'
112blockdev_snapshot()
113{
114    cmd="{ 'execute': 'blockdev-snapshot',
115                      'arguments': { 'node': 'virtio0',
116                                     'overlay':'snap_${1}' } }"
117    _send_qemu_cmd $h "${cmd}" "${2:-return}"
118}
119
120size=128M
121
122_make_test_img $size
123mv "${TEST_IMG}" "${TEST_IMG}.1"
124_make_test_img $size
125mv "${TEST_IMG}" "${TEST_IMG}.2"
126
127echo
128echo === Running QEMU ===
129echo
130
131qemu_comm_method="qmp"
132_launch_qemu -drive file="${TEST_IMG}.1",if=virtio -drive file="${TEST_IMG}.2",if=virtio
133h=$QEMU_HANDLE
134
135echo
136echo === Sending capabilities ===
137echo
138
139_send_qemu_cmd $h "{ 'execute': 'qmp_capabilities' }" "return"
140
141# Tests for the blockdev-snapshot-sync command
142
143echo
144echo === Create a single snapshot on virtio0 ===
145echo
146
147create_single_snapshot 1
148
149
150echo
151echo === Invalid command - missing device and nodename ===
152echo
153
154_send_qemu_cmd $h "{ 'execute': 'blockdev-snapshot-sync',
155                         'arguments': { 'snapshot-file':'${TEST_DIR}/1-${snapshot_virt0}',
156                                     'format': 'qcow2' } }" "error"
157
158echo
159echo === Invalid command - missing snapshot-file ===
160echo
161
162_send_qemu_cmd $h "{ 'execute': 'blockdev-snapshot-sync',
163                         'arguments': { 'device': 'virtio0',
164                                     'format': 'qcow2' } }" "error"
165echo
166echo
167echo === Create several transactional group snapshots ===
168echo
169
170for i in $(seq 2 ${SNAPSHOTS})
171do
172    create_group_snapshot ${i}
173done
174
175# Tests for the blockdev-snapshot command
176
177echo
178echo === Create a couple of snapshots using blockdev-snapshot ===
179echo
180
181SNAPSHOTS=$((${SNAPSHOTS}+1))
182add_snapshot_image ${SNAPSHOTS}
183blockdev_snapshot ${SNAPSHOTS}
184
185SNAPSHOTS=$((${SNAPSHOTS}+1))
186add_snapshot_image ${SNAPSHOTS}
187blockdev_snapshot ${SNAPSHOTS}
188
189echo
190echo === Invalid command - cannot create a snapshot using a file BDS ===
191echo
192
193_send_qemu_cmd $h "{ 'execute': 'blockdev-snapshot',
194                     'arguments': { 'node':'virtio0',
195                                    'overlay':'file_${SNAPSHOTS}' }
196                   }" "error"
197
198echo
199echo === Invalid command - snapshot node used as active layer ===
200echo
201
202blockdev_snapshot ${SNAPSHOTS} error
203
204_send_qemu_cmd $h "{ 'execute': 'blockdev-snapshot',
205                     'arguments': { 'node':'virtio0',
206                                    'overlay':'virtio0' }
207                   }" "error"
208
209_send_qemu_cmd $h "{ 'execute': 'blockdev-snapshot',
210                     'arguments': { 'node':'virtio0',
211                                    'overlay':'virtio1' }
212                   }" "error"
213
214echo
215echo === Invalid command - snapshot node used as backing hd ===
216echo
217
218blockdev_snapshot $((${SNAPSHOTS}-1)) error
219
220echo
221echo === Invalid command - snapshot node has a backing image ===
222echo
223
224SNAPSHOTS=$((${SNAPSHOTS}+1))
225
226TEST_IMG="$TEST_IMG.base" _make_test_img "$size"
227_make_test_img -b "${TEST_IMG}.base" "$size"
228do_blockdev_add ${SNAPSHOTS} "" "${TEST_IMG}"
229blockdev_snapshot ${SNAPSHOTS} error
230
231echo
232echo === Invalid command - The node does not exist ===
233echo
234
235blockdev_snapshot $((${SNAPSHOTS}+1)) error
236
237_send_qemu_cmd $h "{ 'execute': 'blockdev-snapshot',
238                     'arguments': { 'node':'nodevice',
239                                    'overlay':'snap_${SNAPSHOTS}' }
240                   }" "error"
241
242# success, all done
243echo "*** done"
244rm -f $seq.full
245status=0
246