[qemu.git] / tests / qemu-iotests / 155

#!/usr/bin/env python
#
# Test whether the backing BDSs are correct after completion of a
# mirror block job; in "existing" modes (drive-mirror with
# mode=existing and blockdev-mirror) the backing chain should not be
# overridden.
#
# Copyright (C) 2016 Red Hat, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import os
import iotests
from iotests import qemu_img

back0_img = os.path.join(iotests.test_dir, 'back0.' + iotests.imgfmt)
back1_img = os.path.join(iotests.test_dir, 'back1.' + iotests.imgfmt)
back2_img = os.path.join(iotests.test_dir, 'back2.' + iotests.imgfmt)
source_img = os.path.join(iotests.test_dir, 'source.' + iotests.imgfmt)
target_img = os.path.join(iotests.test_dir, 'target.' + iotests.imgfmt)


# Class variables for controlling its behavior:
#
# existing: If True, explicitly create the target image and blockdev-add it
# target_backing: If existing is True: Use this filename as the backing file
#                 of the target image
#                 (None: no backing file)
# target_blockdev_backing: If existing is True: Pass this dict as "backing"
#                          for the blockdev-add command
#                          (None: do not pass "backing")
# target_real_backing: If existing is True: The real filename of the backing
#                      image during runtime, only makes sense if
#                      target_blockdev_backing is not None
#                      (None: same as target_backing)

class BaseClass(iotests.QMPTestCase):
    target_blockdev_backing = None
    target_real_backing = None

    def setUp(self):
        qemu_img('create', '-f', iotests.imgfmt, back0_img, '1440K')
        qemu_img('create', '-f', iotests.imgfmt, '-b', back0_img, back1_img)
        qemu_img('create', '-f', iotests.imgfmt, '-b', back1_img, back2_img)
        qemu_img('create', '-f', iotests.imgfmt, '-b', back2_img, source_img)

        self.vm = iotests.VM()
        # Add the BDS via blockdev-add so it stays around after the mirror block
        # job has been completed
        blockdev = {'node-name': 'source',
                    'driver': iotests.imgfmt,
                    'file': {'driver': 'file',
                             'filename': source_img}}
        self.vm.add_blockdev(self.vm.qmp_to_opts(blockdev))
        self.vm.add_device('virtio-blk,id=qdev0,drive=source')
        self.vm.launch()

        self.assertIntactSourceBackingChain()

        if self.existing:
            if self.target_backing:
                qemu_img('create', '-f', iotests.imgfmt,
                         '-b', self.target_backing, target_img, '1440K')
            else:
                qemu_img('create', '-f', iotests.imgfmt, target_img, '1440K')

            if self.cmd == 'blockdev-mirror':
                options = { 'node-name': 'target',
                            'driver': iotests.imgfmt,
                            'file': { 'driver': 'file',
                                      'filename': target_img } }
                if self.target_blockdev_backing:
                    options['backing'] = self.target_blockdev_backing

                result = self.vm.qmp('blockdev-add', **options)
                self.assert_qmp(result, 'return', {})

    def tearDown(self):
        self.vm.shutdown()
        os.remove(source_img)
        os.remove(back2_img)
        os.remove(back1_img)
        os.remove(back0_img)
        try:
            os.remove(target_img)
        except OSError:
            pass

    def findBlockNode(self, node_name, qdev=None):
        if qdev:
            result = self.vm.qmp('query-block')
            for device in result['return']:
                if device['qdev'] == qdev:
                    if node_name:
                        self.assert_qmp(device, 'inserted/node-name', node_name)
                    return device['inserted']
        else:
            result = self.vm.qmp('query-named-block-nodes')
            for node in result['return']:
                if node['node-name'] == node_name:
                    return node

        self.fail('Cannot find node %s/%s' % (qdev, node_name))

    def assertIntactSourceBackingChain(self):
        node = self.findBlockNode('source')

        self.assert_qmp(node, 'image' + '/backing-image' * 0 + '/filename',
                        source_img)
        self.assert_qmp(node, 'image' + '/backing-image' * 1 + '/filename',
                        back2_img)
        self.assert_qmp(node, 'image' + '/backing-image' * 2 + '/filename',
                        back1_img)
        self.assert_qmp(node, 'image' + '/backing-image' * 3 + '/filename',
                        back0_img)
        self.assert_qmp_absent(node, 'image' + '/backing-image' * 4)

    def assertCorrectBackingImage(self, node, default_image):
        if self.existing:
            if self.target_real_backing:
                image = self.target_real_backing
            else:
                image = self.target_backing
        else:
            image = default_image

        if image:
            self.assert_qmp(node, 'image/backing-image/filename', image)
        else:
            self.assert_qmp_absent(node, 'image/backing-image')


# Class variables for controlling its behavior:
#
# cmd: Mirroring command to execute, either drive-mirror or blockdev-mirror

class MirrorBaseClass(BaseClass):
    def runMirror(self, sync):
        if self.cmd == 'blockdev-mirror':
            result = self.vm.qmp(self.cmd, job_id='mirror-job', device='source',
                                 sync=sync, target='target')
        else:
            if self.existing:
                mode = 'existing'
            else:
                mode = 'absolute-paths'
            result = self.vm.qmp(self.cmd, job_id='mirror-job', device='source',
                                 sync=sync, target=target_img,
                                 format=iotests.imgfmt, mode=mode,
                                 node_name='target')

        self.assert_qmp(result, 'return', {})

        self.vm.event_wait('BLOCK_JOB_READY')

        result = self.vm.qmp('block-job-complete', device='mirror-job')
        self.assert_qmp(result, 'return', {})

        self.vm.event_wait('BLOCK_JOB_COMPLETED')

    def testFull(self):
        self.runMirror('full')

        node = self.findBlockNode('target',
                                  '/machine/peripheral/qdev0/virtio-backend')
        self.assertCorrectBackingImage(node, None)
        self.assertIntactSourceBackingChain()

    def testTop(self):
        self.runMirror('top')

        node = self.findBlockNode('target',
                                  '/machine/peripheral/qdev0/virtio-backend')
        self.assertCorrectBackingImage(node, back2_img)
        self.assertIntactSourceBackingChain()

    def testNone(self):
        self.runMirror('none')

        node = self.findBlockNode('target',
                                  '/machine/peripheral/qdev0/virtio-backend')
        self.assertCorrectBackingImage(node, source_img)
        self.assertIntactSourceBackingChain()


class TestDriveMirrorAbsolutePaths(MirrorBaseClass):
    cmd = 'drive-mirror'
    existing = False

class TestDriveMirrorExistingNoBacking(MirrorBaseClass):
    cmd = 'drive-mirror'
    existing = True
    target_backing = None

class TestDriveMirrorExistingBacking(MirrorBaseClass):
    cmd = 'drive-mirror'
    existing = True
    target_backing = 'null-co://'

class TestBlockdevMirrorNoBacking(MirrorBaseClass):
    cmd = 'blockdev-mirror'
    existing = True
    target_backing = None

class TestBlockdevMirrorBacking(MirrorBaseClass):
    cmd = 'blockdev-mirror'
    existing = True
    target_backing = 'null-co://'

class TestBlockdevMirrorForcedBacking(MirrorBaseClass):
    cmd = 'blockdev-mirror'
    existing = True
    target_backing = None
    target_blockdev_backing = { 'driver': 'null-co' }
    target_real_backing = 'null-co://'


class TestCommit(BaseClass):
    existing = False

    def testCommit(self):
        result = self.vm.qmp('block-commit', job_id='commit-job',
                             device='source', base=back1_img)
        self.assert_qmp(result, 'return', {})

        self.vm.event_wait('BLOCK_JOB_READY')

        result = self.vm.qmp('block-job-complete', device='commit-job')
        self.assert_qmp(result, 'return', {})

        self.vm.event_wait('BLOCK_JOB_COMPLETED')

        node = self.findBlockNode(None,
                                  '/machine/peripheral/qdev0/virtio-backend')
        self.assert_qmp(node, 'image' + '/backing-image' * 0 + '/filename',
                        back1_img)
        self.assert_qmp(node, 'image' + '/backing-image' * 1 + '/filename',
                        back0_img)
        self.assert_qmp_absent(node, 'image' + '/backing-image' * 2 +
                               '/filename')

        self.assertIntactSourceBackingChain()


BaseClass = None
MirrorBaseClass = None

if __name__ == '__main__':
    iotests.main(supported_fmts=['qcow2'],
                 supported_protocols=['file'])
Commit	Line	Data
298c6009 HR	1	#!/usr/bin/env python
	2	#
	3	# Test whether the backing BDSs are correct after completion of a
	4	# mirror block job; in "existing" modes (drive-mirror with
	5	# mode=existing and blockdev-mirror) the backing chain should not be
	6	# overridden.
	7	#
	8	# Copyright (C) 2016 Red Hat, Inc.
	9	#
	10	# This program is free software; you can redistribute it and/or modify
	11	# it under the terms of the GNU General Public License as published by
	12	# the Free Software Foundation; either version 2 of the License, or
	13	# (at your option) any later version.
	14	#
	15	# This program is distributed in the hope that it will be useful,
	16	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	# GNU General Public License for more details.
	19	#
	20	# You should have received a copy of the GNU General Public License
	21	# along with this program. If not, see <http://www.gnu.org/licenses/>.
	22	#
	23
	24	import os
	25	import iotests
	26	from iotests import qemu_img
	27
	28	back0_img = os.path.join(iotests.test_dir, 'back0.' + iotests.imgfmt)
	29	back1_img = os.path.join(iotests.test_dir, 'back1.' + iotests.imgfmt)
	30	back2_img = os.path.join(iotests.test_dir, 'back2.' + iotests.imgfmt)
	31	source_img = os.path.join(iotests.test_dir, 'source.' + iotests.imgfmt)
	32	target_img = os.path.join(iotests.test_dir, 'target.' + iotests.imgfmt)
	33
	34
	35	# Class variables for controlling its behavior:
	36	#
	37	# existing: If True, explicitly create the target image and blockdev-add it
	38	# target_backing: If existing is True: Use this filename as the backing file
	39	# of the target image
	40	# (None: no backing file)
	41	# target_blockdev_backing: If existing is True: Pass this dict as "backing"
	42	# for the blockdev-add command
	43	# (None: do not pass "backing")
	44	# target_real_backing: If existing is True: The real filename of the backing
	45	# image during runtime, only makes sense if
	46	# target_blockdev_backing is not None
	47	# (None: same as target_backing)
	48
	49	class BaseClass(iotests.QMPTestCase):
	50	target_blockdev_backing = None
	51	target_real_backing = None
	52
	53	def setUp(self):
1d701e0e	54	qemu_img('create', '-f', iotests.imgfmt, back0_img, '1440K')
298c6009 HR	55	qemu_img('create', '-f', iotests.imgfmt, '-b', back0_img, back1_img)
	56	qemu_img('create', '-f', iotests.imgfmt, '-b', back1_img, back2_img)
	57	qemu_img('create', '-f', iotests.imgfmt, '-b', back2_img, source_img)
	58
	59	self.vm = iotests.VM()
298c6009 HR	60	# Add the BDS via blockdev-add so it stays around after the mirror block
298c6009 HR	61	# job has been completed
1d701e0e HR	62	blockdev = {'node-name': 'source',
	63	'driver': iotests.imgfmt,
	64	'file': {'driver': 'file',
	65	'filename': source_img}}
62a94288	66	self.vm.add_blockdev(self.vm.qmp_to_opts(blockdev))
2782bb75	67	self.vm.add_device('virtio-blk,id=qdev0,drive=source')
1d701e0e	68	self.vm.launch()
298c6009 HR	69
	70	self.assertIntactSourceBackingChain()
	71
	72	if self.existing:
	73	if self.target_backing:
	74	qemu_img('create', '-f', iotests.imgfmt,
1d701e0e	75	'-b', self.target_backing, target_img, '1440K')
298c6009	76	else:
1d701e0e	77	qemu_img('create', '-f', iotests.imgfmt, target_img, '1440K')
298c6009 HR	78
	79	if self.cmd == 'blockdev-mirror':
	80	options = { 'node-name': 'target',
	81	'driver': iotests.imgfmt,
	82	'file': { 'driver': 'file',
	83	'filename': target_img } }
	84	if self.target_blockdev_backing:
	85	options['backing'] = self.target_blockdev_backing
	86
0153d2f5	87	result = self.vm.qmp('blockdev-add', **options)
298c6009 HR	88	self.assert_qmp(result, 'return', {})
	89
	90	def tearDown(self):
	91	self.vm.shutdown()
	92	os.remove(source_img)
	93	os.remove(back2_img)
	94	os.remove(back1_img)
	95	os.remove(back0_img)
	96	try:
	97	os.remove(target_img)
	98	except OSError:
	99	pass
	100
1d701e0e HR	101	def findBlockNode(self, node_name, qdev=None):
1d701e0e HR	102	if qdev:
298c6009 HR	103	result = self.vm.qmp('query-block')
298c6009 HR	104	for device in result['return']:
1d701e0e	105	if device['qdev'] == qdev:
298c6009 HR	106	if node_name:
	107	self.assert_qmp(device, 'inserted/node-name', node_name)
	108	return device['inserted']
	109	else:
	110	result = self.vm.qmp('query-named-block-nodes')
	111	for node in result['return']:
	112	if node['node-name'] == node_name:
	113	return node
	114
1d701e0e	115	self.fail('Cannot find node %s/%s' % (qdev, node_name))
298c6009 HR	116
	117	def assertIntactSourceBackingChain(self):
	118	node = self.findBlockNode('source')
	119
	120	self.assert_qmp(node, 'image' + '/backing-image' * 0 + '/filename',
	121	source_img)
	122	self.assert_qmp(node, 'image' + '/backing-image' * 1 + '/filename',
	123	back2_img)
	124	self.assert_qmp(node, 'image' + '/backing-image' * 2 + '/filename',
	125	back1_img)
	126	self.assert_qmp(node, 'image' + '/backing-image' * 3 + '/filename',
	127	back0_img)
	128	self.assert_qmp_absent(node, 'image' + '/backing-image' * 4)
	129
	130	def assertCorrectBackingImage(self, node, default_image):
	131	if self.existing:
	132	if self.target_real_backing:
	133	image = self.target_real_backing
	134	else:
	135	image = self.target_backing
	136	else:
	137	image = default_image
	138
	139	if image:
	140	self.assert_qmp(node, 'image/backing-image/filename', image)
	141	else:
	142	self.assert_qmp_absent(node, 'image/backing-image')
	143
	144
	145	# Class variables for controlling its behavior:
	146	#
	147	# cmd: Mirroring command to execute, either drive-mirror or blockdev-mirror
	148
	149	class MirrorBaseClass(BaseClass):
	150	def runMirror(self, sync):
	151	if self.cmd == 'blockdev-mirror':
1d701e0e HR	152	result = self.vm.qmp(self.cmd, job_id='mirror-job', device='source',
1d701e0e HR	153	sync=sync, target='target')
298c6009 HR	154	else:
	155	if self.existing:
	156	mode = 'existing'
	157	else:
	158	mode = 'absolute-paths'
1d701e0e HR	159	result = self.vm.qmp(self.cmd, job_id='mirror-job', device='source',
	160	sync=sync, target=target_img,
	161	format=iotests.imgfmt, mode=mode,
	162	node_name='target')
298c6009 HR	163
	164	self.assert_qmp(result, 'return', {})
	165
	166	self.vm.event_wait('BLOCK_JOB_READY')
	167
1d701e0e	168	result = self.vm.qmp('block-job-complete', device='mirror-job')
298c6009 HR	169	self.assert_qmp(result, 'return', {})
	170
	171	self.vm.event_wait('BLOCK_JOB_COMPLETED')
	172
	173	def testFull(self):
	174	self.runMirror('full')
	175
2782bb75 HR	176	node = self.findBlockNode('target',
2782bb75 HR	177	'/machine/peripheral/qdev0/virtio-backend')
298c6009 HR	178	self.assertCorrectBackingImage(node, None)
	179	self.assertIntactSourceBackingChain()
	180
	181	def testTop(self):
	182	self.runMirror('top')
	183
2782bb75 HR	184	node = self.findBlockNode('target',
2782bb75 HR	185	'/machine/peripheral/qdev0/virtio-backend')
298c6009 HR	186	self.assertCorrectBackingImage(node, back2_img)
	187	self.assertIntactSourceBackingChain()
	188
	189	def testNone(self):
	190	self.runMirror('none')
	191
2782bb75 HR	192	node = self.findBlockNode('target',
2782bb75 HR	193	'/machine/peripheral/qdev0/virtio-backend')
298c6009 HR	194	self.assertCorrectBackingImage(node, source_img)
	195	self.assertIntactSourceBackingChain()
	196
	197
	198	class TestDriveMirrorAbsolutePaths(MirrorBaseClass):
	199	cmd = 'drive-mirror'
	200	existing = False
	201
	202	class TestDriveMirrorExistingNoBacking(MirrorBaseClass):
	203	cmd = 'drive-mirror'
	204	existing = True
	205	target_backing = None
	206
	207	class TestDriveMirrorExistingBacking(MirrorBaseClass):
	208	cmd = 'drive-mirror'
	209	existing = True
	210	target_backing = 'null-co://'
	211
	212	class TestBlockdevMirrorNoBacking(MirrorBaseClass):
	213	cmd = 'blockdev-mirror'
	214	existing = True
	215	target_backing = None
	216
	217	class TestBlockdevMirrorBacking(MirrorBaseClass):
	218	cmd = 'blockdev-mirror'
	219	existing = True
	220	target_backing = 'null-co://'
	221
	222	class TestBlockdevMirrorForcedBacking(MirrorBaseClass):
	223	cmd = 'blockdev-mirror'
	224	existing = True
	225	target_backing = None
	226	target_blockdev_backing = { 'driver': 'null-co' }
	227	target_real_backing = 'null-co://'
	228
	229
	230	class TestCommit(BaseClass):
	231	existing = False
	232
	233	def testCommit(self):
1d701e0e HR	234	result = self.vm.qmp('block-commit', job_id='commit-job',
1d701e0e HR	235	device='source', base=back1_img)
298c6009 HR	236	self.assert_qmp(result, 'return', {})
	237
	238	self.vm.event_wait('BLOCK_JOB_READY')
	239
1d701e0e	240	result = self.vm.qmp('block-job-complete', device='commit-job')
298c6009 HR	241	self.assert_qmp(result, 'return', {})
	242
	243	self.vm.event_wait('BLOCK_JOB_COMPLETED')
	244
2782bb75 HR	245	node = self.findBlockNode(None,
2782bb75 HR	246	'/machine/peripheral/qdev0/virtio-backend')
298c6009 HR	247	self.assert_qmp(node, 'image' + '/backing-image' * 0 + '/filename',
	248	back1_img)
	249	self.assert_qmp(node, 'image' + '/backing-image' * 1 + '/filename',
	250	back0_img)
	251	self.assert_qmp_absent(node, 'image' + '/backing-image' * 2 +
	252	'/filename')
	253
	254	self.assertIntactSourceBackingChain()
	255
	256
	257	BaseClass = None
	258	MirrorBaseClass = None
	259
	260	if __name__ == '__main__':
103cbc77 HR	261	iotests.main(supported_fmts=['qcow2'],
103cbc77 HR	262	supported_protocols=['file'])