1903cb1bfSPhilippe Mathieu-Daudé#!/usr/bin/env python3 29dd003a9SVladimir Sementsov-Ogievskiy# group: rw quick 3342075fdSAlberto Garcia# 479b7a77eSMarkus Armbruster# Test cases for the QMP 'blockdev-del' command 5342075fdSAlberto Garcia# 6342075fdSAlberto Garcia# Copyright (C) 2015 Igalia, S.L. 7342075fdSAlberto Garcia# Author: Alberto Garcia <berto@igalia.com> 8342075fdSAlberto Garcia# 9342075fdSAlberto Garcia# This program is free software; you can redistribute it and/or modify 10342075fdSAlberto Garcia# it under the terms of the GNU General Public License as published by 11342075fdSAlberto Garcia# the Free Software Foundation; either version 2 of the License, or 12342075fdSAlberto Garcia# (at your option) any later version. 13342075fdSAlberto Garcia# 14342075fdSAlberto Garcia# This program is distributed in the hope that it will be useful, 15342075fdSAlberto Garcia# but WITHOUT ANY WARRANTY; without even the implied warranty of 16342075fdSAlberto Garcia# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17342075fdSAlberto Garcia# GNU General Public License for more details. 18342075fdSAlberto Garcia# 19342075fdSAlberto Garcia# You should have received a copy of the GNU General Public License 20342075fdSAlberto Garcia# along with this program. If not, see <http://www.gnu.org/licenses/>. 21342075fdSAlberto Garcia# 22342075fdSAlberto Garcia 23342075fdSAlberto Garciaimport os 24342075fdSAlberto Garciaimport iotests 25342075fdSAlberto Garciaimport time 26342075fdSAlberto Garcia 27342075fdSAlberto Garciabase_img = os.path.join(iotests.test_dir, 'base.img') 28342075fdSAlberto Garcianew_img = os.path.join(iotests.test_dir, 'new.img') 29342075fdSAlberto Garcia 30342075fdSAlberto Garciaclass TestBlockdevDel(iotests.QMPTestCase): 31342075fdSAlberto Garcia 32342075fdSAlberto Garcia def setUp(self): 33342075fdSAlberto Garcia iotests.qemu_img('create', '-f', iotests.imgfmt, base_img, '1M') 34342075fdSAlberto Garcia self.vm = iotests.VM() 3522329f0dSLaurent Vivier self.vm.add_device("{},id=virtio-scsi".format('virtio-scsi')) 36342075fdSAlberto Garcia self.vm.launch() 37342075fdSAlberto Garcia 38342075fdSAlberto Garcia def tearDown(self): 39342075fdSAlberto Garcia self.vm.shutdown() 40342075fdSAlberto Garcia os.remove(base_img) 41342075fdSAlberto Garcia if os.path.isfile(new_img): 42342075fdSAlberto Garcia os.remove(new_img) 43342075fdSAlberto Garcia 44342075fdSAlberto Garcia # Check whether a BlockDriverState exists 45342075fdSAlberto Garcia def checkBlockDriverState(self, node, must_exist = True): 46342075fdSAlberto Garcia result = self.vm.qmp('query-named-block-nodes') 4768474776SMax Reitz nodes = [x for x in result['return'] if x['node-name'] == node] 48342075fdSAlberto Garcia self.assertLessEqual(len(nodes), 1) 49342075fdSAlberto Garcia self.assertEqual(must_exist, len(nodes) == 1) 50342075fdSAlberto Garcia 51342075fdSAlberto Garcia # Add a BlockDriverState without a BlockBackend 52342075fdSAlberto Garcia def addBlockDriverState(self, node): 53342075fdSAlberto Garcia file_node = '%s_file' % node 54342075fdSAlberto Garcia self.checkBlockDriverState(node, False) 55342075fdSAlberto Garcia self.checkBlockDriverState(file_node, False) 56342075fdSAlberto Garcia opts = {'driver': iotests.imgfmt, 57342075fdSAlberto Garcia 'node-name': node, 58342075fdSAlberto Garcia 'file': {'driver': 'file', 59342075fdSAlberto Garcia 'node-name': file_node, 60342075fdSAlberto Garcia 'filename': base_img}} 61*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-add', conv_keys = False, **opts) 62342075fdSAlberto Garcia self.checkBlockDriverState(node) 63342075fdSAlberto Garcia self.checkBlockDriverState(file_node) 64342075fdSAlberto Garcia 65342075fdSAlberto Garcia # Add a BlockDriverState that will be used as overlay for the base_img BDS 66342075fdSAlberto Garcia def addBlockDriverStateOverlay(self, node): 67342075fdSAlberto Garcia self.checkBlockDriverState(node, False) 686e6e55f5SJohn Snow iotests.qemu_img('create', '-u', '-f', iotests.imgfmt, 69b66ff2c2SEric Blake '-b', base_img, '-F', iotests.imgfmt, new_img, '1M') 70342075fdSAlberto Garcia opts = {'driver': iotests.imgfmt, 71342075fdSAlberto Garcia 'node-name': node, 72c42e8742SMarkus Armbruster 'backing': None, 73342075fdSAlberto Garcia 'file': {'driver': 'file', 74342075fdSAlberto Garcia 'filename': new_img}} 75*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-add', conv_keys = False, **opts) 76342075fdSAlberto Garcia self.checkBlockDriverState(node) 77342075fdSAlberto Garcia 78342075fdSAlberto Garcia # Delete a BlockDriverState 79342075fdSAlberto Garcia def delBlockDriverState(self, node, expect_error = False): 80342075fdSAlberto Garcia self.checkBlockDriverState(node) 8179b7a77eSMarkus Armbruster result = self.vm.qmp('blockdev-del', node_name = node) 82342075fdSAlberto Garcia if expect_error: 83342075fdSAlberto Garcia self.assert_qmp(result, 'error/class', 'GenericError') 84342075fdSAlberto Garcia else: 85342075fdSAlberto Garcia self.assert_qmp(result, 'return', {}) 86342075fdSAlberto Garcia self.checkBlockDriverState(node, expect_error) 87342075fdSAlberto Garcia 88342075fdSAlberto Garcia # Add a device model 8922329f0dSLaurent Vivier def addDeviceModel(self, device, backend, driver = 'virtio-blk'): 90*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('device_add', id = device, 9162acae8aSKevin Wolf driver = driver, drive = backend) 92342075fdSAlberto Garcia 93342075fdSAlberto Garcia # Delete a device model 9462acae8aSKevin Wolf def delDeviceModel(self, device, is_virtio_blk = True): 95*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('device_del', id = device) 96342075fdSAlberto Garcia 97*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('system_reset') 98342075fdSAlberto Garcia 9962acae8aSKevin Wolf if is_virtio_blk: 100342075fdSAlberto Garcia device_path = '/machine/peripheral/%s/virtio-backend' % device 101342075fdSAlberto Garcia event = self.vm.event_wait(name="DEVICE_DELETED", 102342075fdSAlberto Garcia match={'data': {'path': device_path}}) 103342075fdSAlberto Garcia self.assertNotEqual(event, None) 104342075fdSAlberto Garcia 105342075fdSAlberto Garcia event = self.vm.event_wait(name="DEVICE_DELETED", 106342075fdSAlberto Garcia match={'data': {'device': device}}) 107342075fdSAlberto Garcia self.assertNotEqual(event, None) 108342075fdSAlberto Garcia 109342075fdSAlberto Garcia # Remove a BlockDriverState 11062acae8aSKevin Wolf def ejectDrive(self, device, node, expect_error = False, 111342075fdSAlberto Garcia destroys_media = True): 112342075fdSAlberto Garcia self.checkBlockDriverState(node) 11362acae8aSKevin Wolf result = self.vm.qmp('eject', id = device) 114342075fdSAlberto Garcia if expect_error: 115342075fdSAlberto Garcia self.assert_qmp(result, 'error/class', 'GenericError') 116342075fdSAlberto Garcia self.checkBlockDriverState(node) 117342075fdSAlberto Garcia else: 118342075fdSAlberto Garcia self.assert_qmp(result, 'return', {}) 119342075fdSAlberto Garcia self.checkBlockDriverState(node, not destroys_media) 120342075fdSAlberto Garcia 121342075fdSAlberto Garcia # Insert a BlockDriverState 12262acae8aSKevin Wolf def insertDrive(self, device, node): 123342075fdSAlberto Garcia self.checkBlockDriverState(node) 124*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-insert-medium', 12562acae8aSKevin Wolf id = device, node_name = node) 126342075fdSAlberto Garcia self.checkBlockDriverState(node) 127342075fdSAlberto Garcia 128342075fdSAlberto Garcia # Create a snapshot using 'blockdev-snapshot-sync' 129342075fdSAlberto Garcia def createSnapshotSync(self, node, overlay): 130342075fdSAlberto Garcia self.checkBlockDriverState(node) 131342075fdSAlberto Garcia self.checkBlockDriverState(overlay, False) 132342075fdSAlberto Garcia opts = {'node-name': node, 133342075fdSAlberto Garcia 'snapshot-file': new_img, 134342075fdSAlberto Garcia 'snapshot-node-name': overlay, 135342075fdSAlberto Garcia 'format': iotests.imgfmt} 136*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-snapshot-sync', conv_keys=False, **opts) 137342075fdSAlberto Garcia self.checkBlockDriverState(node) 138342075fdSAlberto Garcia self.checkBlockDriverState(overlay) 139342075fdSAlberto Garcia 140342075fdSAlberto Garcia # Create a snapshot using 'blockdev-snapshot' 141342075fdSAlberto Garcia def createSnapshot(self, node, overlay): 142342075fdSAlberto Garcia self.checkBlockDriverState(node) 143342075fdSAlberto Garcia self.checkBlockDriverState(overlay) 144*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-snapshot', 145342075fdSAlberto Garcia node = node, overlay = overlay) 146342075fdSAlberto Garcia self.checkBlockDriverState(node) 147342075fdSAlberto Garcia self.checkBlockDriverState(overlay) 148342075fdSAlberto Garcia 149342075fdSAlberto Garcia # Create a mirror 15062acae8aSKevin Wolf def createMirror(self, node, new_node): 151342075fdSAlberto Garcia self.checkBlockDriverState(new_node, False) 15262acae8aSKevin Wolf opts = {'device': node, 15362acae8aSKevin Wolf 'job-id': node, 154342075fdSAlberto Garcia 'target': new_img, 155342075fdSAlberto Garcia 'node-name': new_node, 156342075fdSAlberto Garcia 'sync': 'top', 157342075fdSAlberto Garcia 'format': iotests.imgfmt} 158*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('drive-mirror', conv_keys=False, **opts) 159342075fdSAlberto Garcia self.checkBlockDriverState(new_node) 160342075fdSAlberto Garcia 161342075fdSAlberto Garcia # Complete an existing block job 16262acae8aSKevin Wolf def completeBlockJob(self, id, node_before, node_after): 163*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('block-job-complete', device=id) 16462acae8aSKevin Wolf self.wait_until_completed(id) 165342075fdSAlberto Garcia 166342075fdSAlberto Garcia # Add a BlkDebug node 16779b7a77eSMarkus Armbruster # Note that the purpose of this is to test the blockdev-del 168342075fdSAlberto Garcia # sanity checks, not to create a usable blkdebug drive 169342075fdSAlberto Garcia def addBlkDebug(self, debug, node): 170342075fdSAlberto Garcia self.checkBlockDriverState(node, False) 171342075fdSAlberto Garcia self.checkBlockDriverState(debug, False) 172342075fdSAlberto Garcia image = {'driver': iotests.imgfmt, 173342075fdSAlberto Garcia 'node-name': node, 174342075fdSAlberto Garcia 'file': {'driver': 'file', 175342075fdSAlberto Garcia 'filename': base_img}} 176342075fdSAlberto Garcia opts = {'driver': 'blkdebug', 177342075fdSAlberto Garcia 'node-name': debug, 178342075fdSAlberto Garcia 'image': image} 179*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-add', conv_keys = False, **opts) 180342075fdSAlberto Garcia self.checkBlockDriverState(node) 181342075fdSAlberto Garcia self.checkBlockDriverState(debug) 182342075fdSAlberto Garcia 183342075fdSAlberto Garcia # Add a BlkVerify node 18479b7a77eSMarkus Armbruster # Note that the purpose of this is to test the blockdev-del 185342075fdSAlberto Garcia # sanity checks, not to create a usable blkverify drive 186342075fdSAlberto Garcia def addBlkVerify(self, blkverify, test, raw): 187342075fdSAlberto Garcia self.checkBlockDriverState(test, False) 188342075fdSAlberto Garcia self.checkBlockDriverState(raw, False) 189342075fdSAlberto Garcia self.checkBlockDriverState(blkverify, False) 190342075fdSAlberto Garcia iotests.qemu_img('create', '-f', iotests.imgfmt, new_img, '1M') 191342075fdSAlberto Garcia node_0 = {'driver': iotests.imgfmt, 192342075fdSAlberto Garcia 'node-name': test, 193342075fdSAlberto Garcia 'file': {'driver': 'file', 194342075fdSAlberto Garcia 'filename': base_img}} 195342075fdSAlberto Garcia node_1 = {'driver': iotests.imgfmt, 196342075fdSAlberto Garcia 'node-name': raw, 197342075fdSAlberto Garcia 'file': {'driver': 'file', 198342075fdSAlberto Garcia 'filename': new_img}} 199342075fdSAlberto Garcia opts = {'driver': 'blkverify', 200342075fdSAlberto Garcia 'node-name': blkverify, 201342075fdSAlberto Garcia 'test': node_0, 202342075fdSAlberto Garcia 'raw': node_1} 203*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-add', conv_keys = False, **opts) 204342075fdSAlberto Garcia self.checkBlockDriverState(test) 205342075fdSAlberto Garcia self.checkBlockDriverState(raw) 206342075fdSAlberto Garcia self.checkBlockDriverState(blkverify) 207342075fdSAlberto Garcia 208342075fdSAlberto Garcia # Add a Quorum node 209342075fdSAlberto Garcia def addQuorum(self, quorum, child0, child1): 210342075fdSAlberto Garcia self.checkBlockDriverState(child0, False) 211342075fdSAlberto Garcia self.checkBlockDriverState(child1, False) 212342075fdSAlberto Garcia self.checkBlockDriverState(quorum, False) 213342075fdSAlberto Garcia iotests.qemu_img('create', '-f', iotests.imgfmt, new_img, '1M') 214342075fdSAlberto Garcia child_0 = {'driver': iotests.imgfmt, 215342075fdSAlberto Garcia 'node-name': child0, 216342075fdSAlberto Garcia 'file': {'driver': 'file', 217342075fdSAlberto Garcia 'filename': base_img}} 218342075fdSAlberto Garcia child_1 = {'driver': iotests.imgfmt, 219342075fdSAlberto Garcia 'node-name': child1, 220342075fdSAlberto Garcia 'file': {'driver': 'file', 221342075fdSAlberto Garcia 'filename': new_img}} 222342075fdSAlberto Garcia opts = {'driver': 'quorum', 223342075fdSAlberto Garcia 'node-name': quorum, 224342075fdSAlberto Garcia 'vote-threshold': 1, 225342075fdSAlberto Garcia 'children': [ child_0, child_1 ]} 226*b6aed193SVladimir Sementsov-Ogievskiy self.vm.cmd('blockdev-add', conv_keys = False, **opts) 227342075fdSAlberto Garcia self.checkBlockDriverState(child0) 228342075fdSAlberto Garcia self.checkBlockDriverState(child1) 229342075fdSAlberto Garcia self.checkBlockDriverState(quorum) 230342075fdSAlberto Garcia 231342075fdSAlberto Garcia ######################## 232342075fdSAlberto Garcia # The tests start here # 233342075fdSAlberto Garcia ######################## 234342075fdSAlberto Garcia 235342075fdSAlberto Garcia def testBlockDriverState(self): 236342075fdSAlberto Garcia self.addBlockDriverState('node0') 237342075fdSAlberto Garcia # You cannot delete a file BDS directly 238342075fdSAlberto Garcia self.delBlockDriverState('node0_file', expect_error = True) 239342075fdSAlberto Garcia self.delBlockDriverState('node0') 240342075fdSAlberto Garcia 241342075fdSAlberto Garcia def testDeviceModel(self): 24262acae8aSKevin Wolf self.addBlockDriverState('node0') 24362acae8aSKevin Wolf self.addDeviceModel('device0', 'node0') 24462acae8aSKevin Wolf self.ejectDrive('device0', 'node0', expect_error = True) 24562acae8aSKevin Wolf self.delBlockDriverState('node0', expect_error = True) 246342075fdSAlberto Garcia self.delDeviceModel('device0') 24762acae8aSKevin Wolf self.delBlockDriverState('node0') 248342075fdSAlberto Garcia 249342075fdSAlberto Garcia def testAttachMedia(self): 250342075fdSAlberto Garcia # This creates a BlockBackend and removes its media 25162acae8aSKevin Wolf self.addBlockDriverState('node0') 25262acae8aSKevin Wolf self.addDeviceModel('device0', 'node0', 'scsi-cd') 25362acae8aSKevin Wolf self.ejectDrive('device0', 'node0', destroys_media = False) 25462acae8aSKevin Wolf self.delBlockDriverState('node0') 25562acae8aSKevin Wolf 25662acae8aSKevin Wolf # This creates a new BlockDriverState and inserts it into the device 257342075fdSAlberto Garcia self.addBlockDriverState('node1') 25862acae8aSKevin Wolf self.insertDrive('device0', 'node1') 25962acae8aSKevin Wolf # The node can't be removed: the new device has an extra reference 260342075fdSAlberto Garcia self.delBlockDriverState('node1', expect_error = True) 261342075fdSAlberto Garcia # The BDS still exists after being ejected, but now it can be removed 26262acae8aSKevin Wolf self.ejectDrive('device0', 'node1', destroys_media = False) 263342075fdSAlberto Garcia self.delBlockDriverState('node1') 26462acae8aSKevin Wolf self.delDeviceModel('device0', False) 265342075fdSAlberto Garcia 266342075fdSAlberto Garcia def testSnapshotSync(self): 26762acae8aSKevin Wolf self.addBlockDriverState('node0') 26862acae8aSKevin Wolf self.addDeviceModel('device0', 'node0') 269342075fdSAlberto Garcia self.createSnapshotSync('node0', 'overlay0') 270342075fdSAlberto Garcia # This fails because node0 is now being used as a backing image 271342075fdSAlberto Garcia self.delBlockDriverState('node0', expect_error = True) 27262acae8aSKevin Wolf self.delBlockDriverState('overlay0', expect_error = True) 27362acae8aSKevin Wolf # This succeeds because device0 only has the backend reference 27462acae8aSKevin Wolf self.delDeviceModel('device0') 27562acae8aSKevin Wolf # FIXME Would still be there if blockdev-snapshot-sync took a ref 27662acae8aSKevin Wolf self.checkBlockDriverState('overlay0', False) 27762acae8aSKevin Wolf self.delBlockDriverState('node0') 278342075fdSAlberto Garcia 279342075fdSAlberto Garcia def testSnapshot(self): 28062acae8aSKevin Wolf self.addBlockDriverState('node0') 28162acae8aSKevin Wolf self.addDeviceModel('device0', 'node0', 'scsi-cd') 282342075fdSAlberto Garcia self.addBlockDriverStateOverlay('overlay0') 283342075fdSAlberto Garcia self.createSnapshot('node0', 'overlay0') 284342075fdSAlberto Garcia self.delBlockDriverState('node0', expect_error = True) 285342075fdSAlberto Garcia self.delBlockDriverState('overlay0', expect_error = True) 28662acae8aSKevin Wolf self.ejectDrive('device0', 'overlay0', destroys_media = False) 287342075fdSAlberto Garcia self.delBlockDriverState('node0', expect_error = True) 288342075fdSAlberto Garcia self.delBlockDriverState('overlay0') 28962acae8aSKevin Wolf self.delBlockDriverState('node0') 290342075fdSAlberto Garcia 291342075fdSAlberto Garcia def testMirror(self): 29262acae8aSKevin Wolf self.addBlockDriverState('node0') 29362acae8aSKevin Wolf self.addDeviceModel('device0', 'node0', 'scsi-cd') 29462acae8aSKevin Wolf self.createMirror('node0', 'mirror0') 295342075fdSAlberto Garcia # The block job prevents removing the device 296342075fdSAlberto Garcia self.delBlockDriverState('node0', expect_error = True) 297342075fdSAlberto Garcia self.delBlockDriverState('mirror0', expect_error = True) 29862acae8aSKevin Wolf self.wait_ready('node0') 29962acae8aSKevin Wolf self.completeBlockJob('node0', 'node0', 'mirror0') 300342075fdSAlberto Garcia self.assert_no_active_block_jobs() 30162acae8aSKevin Wolf # This succeeds because the device now points to mirror0 30262acae8aSKevin Wolf self.delBlockDriverState('node0') 30362acae8aSKevin Wolf self.delBlockDriverState('mirror0', expect_error = True) 30462acae8aSKevin Wolf self.delDeviceModel('device0', False) 30562acae8aSKevin Wolf # FIXME mirror0 disappears, drive-mirror doesn't take a reference 30662acae8aSKevin Wolf #self.delBlockDriverState('mirror0') 307342075fdSAlberto Garcia 308d9df28e7SAndrey Shinkevich @iotests.skip_if_unsupported(['blkdebug']) 309342075fdSAlberto Garcia def testBlkDebug(self): 310342075fdSAlberto Garcia self.addBlkDebug('debug0', 'node0') 311342075fdSAlberto Garcia # 'node0' is used by the blkdebug node 312342075fdSAlberto Garcia self.delBlockDriverState('node0', expect_error = True) 313342075fdSAlberto Garcia # But we can remove the blkdebug node directly 314342075fdSAlberto Garcia self.delBlockDriverState('debug0') 315342075fdSAlberto Garcia self.checkBlockDriverState('node0', False) 316342075fdSAlberto Garcia 317d9df28e7SAndrey Shinkevich @iotests.skip_if_unsupported(['blkverify']) 318342075fdSAlberto Garcia def testBlkVerify(self): 319342075fdSAlberto Garcia self.addBlkVerify('verify0', 'node0', 'node1') 320342075fdSAlberto Garcia # We cannot remove the children of a blkverify device 321342075fdSAlberto Garcia self.delBlockDriverState('node0', expect_error = True) 322342075fdSAlberto Garcia self.delBlockDriverState('node1', expect_error = True) 323342075fdSAlberto Garcia # But we can remove the blkverify node directly 324342075fdSAlberto Garcia self.delBlockDriverState('verify0') 325342075fdSAlberto Garcia self.checkBlockDriverState('node0', False) 326342075fdSAlberto Garcia self.checkBlockDriverState('node1', False) 327342075fdSAlberto Garcia 328d9df28e7SAndrey Shinkevich @iotests.skip_if_unsupported(['quorum']) 329342075fdSAlberto Garcia def testQuorum(self): 330342075fdSAlberto Garcia self.addQuorum('quorum0', 'node0', 'node1') 331342075fdSAlberto Garcia # We cannot remove the children of a Quorum device 332342075fdSAlberto Garcia self.delBlockDriverState('node0', expect_error = True) 333342075fdSAlberto Garcia self.delBlockDriverState('node1', expect_error = True) 334342075fdSAlberto Garcia # But we can remove the Quorum node directly 335342075fdSAlberto Garcia self.delBlockDriverState('quorum0') 336342075fdSAlberto Garcia self.checkBlockDriverState('node0', False) 337342075fdSAlberto Garcia self.checkBlockDriverState('node1', False) 338342075fdSAlberto Garcia 339342075fdSAlberto Garcia 340342075fdSAlberto Garciaif __name__ == '__main__': 341103cbc77SMax Reitz iotests.main(supported_fmts=["qcow2"], 342103cbc77SMax Reitz supported_protocols=["file"]) 343