xref: /openbmc/qemu/tests/qemu-iotests/040 (revision 4de43470f2f35762b4b3e6a59b4aed55e239024a)
1747051cdSJeff Cody#!/usr/bin/env python
2747051cdSJeff Cody#
3747051cdSJeff Cody# Tests for image block commit.
4747051cdSJeff Cody#
5747051cdSJeff Cody# Copyright (C) 2012 IBM, Corp.
6747051cdSJeff Cody# Copyright (C) 2012 Red Hat, Inc.
7747051cdSJeff Cody#
8747051cdSJeff Cody# This program is free software; you can redistribute it and/or modify
9747051cdSJeff Cody# it under the terms of the GNU General Public License as published by
10747051cdSJeff Cody# the Free Software Foundation; either version 2 of the License, or
11747051cdSJeff Cody# (at your option) any later version.
12747051cdSJeff Cody#
13747051cdSJeff Cody# This program is distributed in the hope that it will be useful,
14747051cdSJeff Cody# but WITHOUT ANY WARRANTY; without even the implied warranty of
15747051cdSJeff Cody# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16747051cdSJeff Cody# GNU General Public License for more details.
17747051cdSJeff Cody#
18747051cdSJeff Cody# You should have received a copy of the GNU General Public License
19747051cdSJeff Cody# along with this program.  If not, see <http://www.gnu.org/licenses/>.
20747051cdSJeff Cody#
21747051cdSJeff Cody# Test for live block commit
22747051cdSJeff Cody# Derived from Image Streaming Test 030
23747051cdSJeff Cody
24747051cdSJeff Codyimport time
25747051cdSJeff Codyimport os
26747051cdSJeff Codyimport iotests
27747051cdSJeff Codyfrom iotests import qemu_img, qemu_io
28747051cdSJeff Codyimport struct
296bf0d1f4SJeff Codyimport errno
30747051cdSJeff Cody
31747051cdSJeff Codybacking_img = os.path.join(iotests.test_dir, 'backing.img')
32747051cdSJeff Codymid_img = os.path.join(iotests.test_dir, 'mid.img')
33747051cdSJeff Codytest_img = os.path.join(iotests.test_dir, 'test.img')
34747051cdSJeff Cody
35747051cdSJeff Codyclass ImageCommitTestCase(iotests.QMPTestCase):
36747051cdSJeff Cody    '''Abstract base class for image commit test cases'''
37747051cdSJeff Cody
38747051cdSJeff Cody    def assert_no_active_commit(self):
39747051cdSJeff Cody        result = self.vm.qmp('query-block-jobs')
40747051cdSJeff Cody        self.assert_qmp(result, 'return', [])
41747051cdSJeff Cody
42*4de43470SFam Zheng    def run_commit_test(self, top, base):
43*4de43470SFam Zheng        self.assert_no_active_commit()
44*4de43470SFam Zheng        result = self.vm.qmp('block-commit', device='drive0', top=top, base=base)
45*4de43470SFam Zheng        self.assert_qmp(result, 'return', {})
46*4de43470SFam Zheng
47*4de43470SFam Zheng        completed = False
48*4de43470SFam Zheng        while not completed:
49*4de43470SFam Zheng            for event in self.vm.get_qmp_events(wait=True):
50*4de43470SFam Zheng                if event['event'] == 'BLOCK_JOB_COMPLETED':
51*4de43470SFam Zheng                    self.assert_qmp(event, 'data/type', 'commit')
52*4de43470SFam Zheng                    self.assert_qmp(event, 'data/device', 'drive0')
53*4de43470SFam Zheng                    self.assert_qmp(event, 'data/offset', self.image_len)
54*4de43470SFam Zheng                    self.assert_qmp(event, 'data/len', self.image_len)
55*4de43470SFam Zheng                    completed = True
56*4de43470SFam Zheng                elif event['event'] == 'BLOCK_JOB_READY':
57*4de43470SFam Zheng                    self.assert_qmp(event, 'data/type', 'commit')
58*4de43470SFam Zheng                    self.assert_qmp(event, 'data/device', 'drive0')
59*4de43470SFam Zheng                    self.assert_qmp(event, 'data/len', self.image_len)
60*4de43470SFam Zheng                    self.vm.qmp('block-job-complete', device='drive0')
61*4de43470SFam Zheng
62*4de43470SFam Zheng        self.assert_no_active_commit()
63*4de43470SFam Zheng        self.vm.shutdown()
64*4de43470SFam Zheng
65747051cdSJeff Codyclass TestSingleDrive(ImageCommitTestCase):
66747051cdSJeff Cody    image_len = 1 * 1024 * 1024
67747051cdSJeff Cody    test_len = 1 * 1024 * 256
68747051cdSJeff Cody
69747051cdSJeff Cody    def setUp(self):
70915365a9SFam Zheng        iotests.create_image(backing_img, TestSingleDrive.image_len)
71747051cdSJeff Cody        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, mid_img)
72747051cdSJeff Cody        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % mid_img, test_img)
73747051cdSJeff Cody        qemu_io('-c', 'write -P 0xab 0 524288', backing_img)
74747051cdSJeff Cody        qemu_io('-c', 'write -P 0xef 524288 524288', mid_img)
75747051cdSJeff Cody        self.vm = iotests.VM().add_drive(test_img)
76747051cdSJeff Cody        self.vm.launch()
77747051cdSJeff Cody
78747051cdSJeff Cody    def tearDown(self):
79747051cdSJeff Cody        self.vm.shutdown()
80747051cdSJeff Cody        os.remove(test_img)
81747051cdSJeff Cody        os.remove(mid_img)
82747051cdSJeff Cody        os.remove(backing_img)
83747051cdSJeff Cody
84747051cdSJeff Cody    def test_commit(self):
85*4de43470SFam Zheng        self.run_commit_test(mid_img, backing_img)
86747051cdSJeff Cody        self.assertEqual(-1, qemu_io('-c', 'read -P 0xab 0 524288', backing_img).find("verification failed"))
87747051cdSJeff Cody        self.assertEqual(-1, qemu_io('-c', 'read -P 0xef 524288 524288', backing_img).find("verification failed"))
88747051cdSJeff Cody
89747051cdSJeff Cody    def test_device_not_found(self):
90747051cdSJeff Cody        result = self.vm.qmp('block-commit', device='nonexistent', top='%s' % mid_img)
91747051cdSJeff Cody        self.assert_qmp(result, 'error/class', 'DeviceNotFound')
92747051cdSJeff Cody
93747051cdSJeff Cody    def test_top_same_base(self):
94747051cdSJeff Cody        self.assert_no_active_commit()
95747051cdSJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='%s' % backing_img, base='%s' % backing_img)
96747051cdSJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
97d5208c45SJeff Cody        self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % backing_img)
98747051cdSJeff Cody
99747051cdSJeff Cody    def test_top_invalid(self):
100747051cdSJeff Cody        self.assert_no_active_commit()
101747051cdSJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='badfile', base='%s' % backing_img)
102747051cdSJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
103747051cdSJeff Cody        self.assert_qmp(result, 'error/desc', 'Top image file badfile not found')
104747051cdSJeff Cody
105747051cdSJeff Cody    def test_base_invalid(self):
106747051cdSJeff Cody        self.assert_no_active_commit()
107747051cdSJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='%s' % mid_img, base='badfile')
108747051cdSJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
109747051cdSJeff Cody        self.assert_qmp(result, 'error/desc', 'Base \'badfile\' not found')
110747051cdSJeff Cody
111747051cdSJeff Cody    def test_top_is_active(self):
112*4de43470SFam Zheng        self.run_commit_test(test_img, backing_img)
113*4de43470SFam Zheng        self.assertEqual(-1, qemu_io('-c', 'read -P 0xab 0 524288', backing_img).find("verification failed"))
114*4de43470SFam Zheng        self.assertEqual(-1, qemu_io('-c', 'read -P 0xef 524288 524288', backing_img).find("verification failed"))
115747051cdSJeff Cody
116747051cdSJeff Cody    def test_top_and_base_reversed(self):
117747051cdSJeff Cody        self.assert_no_active_commit()
118747051cdSJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='%s' % backing_img, base='%s' % mid_img)
119747051cdSJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
120d5208c45SJeff Cody        self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % mid_img)
121747051cdSJeff Cody
122747051cdSJeff Cody    def test_top_omitted(self):
123747051cdSJeff Cody        self.assert_no_active_commit()
124747051cdSJeff Cody        result = self.vm.qmp('block-commit', device='drive0')
125747051cdSJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
126747051cdSJeff Cody        self.assert_qmp(result, 'error/desc', "Parameter 'top' is missing")
127747051cdSJeff Cody
1286bf0d1f4SJeff Codyclass TestRelativePaths(ImageCommitTestCase):
1296bf0d1f4SJeff Cody    image_len = 1 * 1024 * 1024
1306bf0d1f4SJeff Cody    test_len = 1 * 1024 * 256
1316bf0d1f4SJeff Cody
1326bf0d1f4SJeff Cody    dir1 = "dir1"
1336bf0d1f4SJeff Cody    dir2 = "dir2/"
1346bf0d1f4SJeff Cody    dir3 = "dir2/dir3/"
1356bf0d1f4SJeff Cody
1366bf0d1f4SJeff Cody    test_img = os.path.join(iotests.test_dir, dir3, 'test.img')
1376bf0d1f4SJeff Cody    mid_img = "../mid.img"
1386bf0d1f4SJeff Cody    backing_img = "../dir1/backing.img"
1396bf0d1f4SJeff Cody
1406bf0d1f4SJeff Cody    backing_img_abs = os.path.join(iotests.test_dir, dir1, 'backing.img')
1416bf0d1f4SJeff Cody    mid_img_abs = os.path.join(iotests.test_dir, dir2, 'mid.img')
1426bf0d1f4SJeff Cody
1436bf0d1f4SJeff Cody    def setUp(self):
1446bf0d1f4SJeff Cody        try:
1456bf0d1f4SJeff Cody            os.mkdir(os.path.join(iotests.test_dir, self.dir1))
1466bf0d1f4SJeff Cody            os.mkdir(os.path.join(iotests.test_dir, self.dir2))
1476bf0d1f4SJeff Cody            os.mkdir(os.path.join(iotests.test_dir, self.dir3))
1486bf0d1f4SJeff Cody        except OSError as exception:
1496bf0d1f4SJeff Cody            if exception.errno != errno.EEXIST:
1506bf0d1f4SJeff Cody                raise
151915365a9SFam Zheng        iotests.create_image(self.backing_img_abs, TestRelativePaths.image_len)
1526bf0d1f4SJeff Cody        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % self.backing_img_abs, self.mid_img_abs)
1536bf0d1f4SJeff Cody        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % self.mid_img_abs, self.test_img)
1546bf0d1f4SJeff Cody        qemu_img('rebase', '-u', '-b', self.backing_img, self.mid_img_abs)
1556bf0d1f4SJeff Cody        qemu_img('rebase', '-u', '-b', self.mid_img, self.test_img)
1566bf0d1f4SJeff Cody        qemu_io('-c', 'write -P 0xab 0 524288', self.backing_img_abs)
1576bf0d1f4SJeff Cody        qemu_io('-c', 'write -P 0xef 524288 524288', self.mid_img_abs)
1586bf0d1f4SJeff Cody        self.vm = iotests.VM().add_drive(self.test_img)
1596bf0d1f4SJeff Cody        self.vm.launch()
1606bf0d1f4SJeff Cody
1616bf0d1f4SJeff Cody    def tearDown(self):
1626bf0d1f4SJeff Cody        self.vm.shutdown()
1636bf0d1f4SJeff Cody        os.remove(self.test_img)
1646bf0d1f4SJeff Cody        os.remove(self.mid_img_abs)
1656bf0d1f4SJeff Cody        os.remove(self.backing_img_abs)
1666bf0d1f4SJeff Cody        try:
1676bf0d1f4SJeff Cody            os.rmdir(os.path.join(iotests.test_dir, self.dir1))
1686bf0d1f4SJeff Cody            os.rmdir(os.path.join(iotests.test_dir, self.dir3))
1696bf0d1f4SJeff Cody            os.rmdir(os.path.join(iotests.test_dir, self.dir2))
1706bf0d1f4SJeff Cody        except OSError as exception:
1716bf0d1f4SJeff Cody            if exception.errno != errno.EEXIST and exception.errno != errno.ENOTEMPTY:
1726bf0d1f4SJeff Cody                raise
1736bf0d1f4SJeff Cody
1746bf0d1f4SJeff Cody    def test_commit(self):
175*4de43470SFam Zheng        self.run_commit_test(self.mid_img, self.backing_img)
1766bf0d1f4SJeff Cody        self.assertEqual(-1, qemu_io('-c', 'read -P 0xab 0 524288', self.backing_img_abs).find("verification failed"))
1776bf0d1f4SJeff Cody        self.assertEqual(-1, qemu_io('-c', 'read -P 0xef 524288 524288', self.backing_img_abs).find("verification failed"))
1786bf0d1f4SJeff Cody
1796bf0d1f4SJeff Cody    def test_device_not_found(self):
1806bf0d1f4SJeff Cody        result = self.vm.qmp('block-commit', device='nonexistent', top='%s' % self.mid_img)
1816bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/class', 'DeviceNotFound')
1826bf0d1f4SJeff Cody
1836bf0d1f4SJeff Cody    def test_top_same_base(self):
1846bf0d1f4SJeff Cody        self.assert_no_active_commit()
1856bf0d1f4SJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='%s' % self.mid_img, base='%s' % self.mid_img)
1866bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
1876bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % self.mid_img)
1886bf0d1f4SJeff Cody
1896bf0d1f4SJeff Cody    def test_top_invalid(self):
1906bf0d1f4SJeff Cody        self.assert_no_active_commit()
1916bf0d1f4SJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='badfile', base='%s' % self.backing_img)
1926bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
1936bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/desc', 'Top image file badfile not found')
1946bf0d1f4SJeff Cody
1956bf0d1f4SJeff Cody    def test_base_invalid(self):
1966bf0d1f4SJeff Cody        self.assert_no_active_commit()
1976bf0d1f4SJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='%s' % self.mid_img, base='badfile')
1986bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
1996bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/desc', 'Base \'badfile\' not found')
2006bf0d1f4SJeff Cody
2016bf0d1f4SJeff Cody    def test_top_is_active(self):
202*4de43470SFam Zheng        self.run_commit_test(self.test_img, self.backing_img)
203*4de43470SFam Zheng        self.assertEqual(-1, qemu_io('-c', 'read -P 0xab 0 524288', self.backing_img_abs).find("verification failed"))
204*4de43470SFam Zheng        self.assertEqual(-1, qemu_io('-c', 'read -P 0xef 524288 524288', self.backing_img_abs).find("verification failed"))
2056bf0d1f4SJeff Cody
2066bf0d1f4SJeff Cody    def test_top_and_base_reversed(self):
2076bf0d1f4SJeff Cody        self.assert_no_active_commit()
2086bf0d1f4SJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top='%s' % self.backing_img, base='%s' % self.mid_img)
2096bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/class', 'GenericError')
2106bf0d1f4SJeff Cody        self.assert_qmp(result, 'error/desc', 'Base \'%s\' not found' % self.mid_img)
2116bf0d1f4SJeff Cody
212747051cdSJeff Cody
213747051cdSJeff Codyclass TestSetSpeed(ImageCommitTestCase):
214747051cdSJeff Cody    image_len = 80 * 1024 * 1024 # MB
215747051cdSJeff Cody
216747051cdSJeff Cody    def setUp(self):
217747051cdSJeff Cody        qemu_img('create', backing_img, str(TestSetSpeed.image_len))
218747051cdSJeff Cody        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, mid_img)
219747051cdSJeff Cody        qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % mid_img, test_img)
220b59b3d57SFam Zheng        qemu_io('-c', 'write -P 0x1 0 512', test_img)
221*4de43470SFam Zheng        qemu_io('-c', 'write -P 0xef 524288 524288', mid_img)
222747051cdSJeff Cody        self.vm = iotests.VM().add_drive(test_img)
223747051cdSJeff Cody        self.vm.launch()
224747051cdSJeff Cody
225747051cdSJeff Cody    def tearDown(self):
226747051cdSJeff Cody        self.vm.shutdown()
227747051cdSJeff Cody        os.remove(test_img)
228747051cdSJeff Cody        os.remove(mid_img)
229747051cdSJeff Cody        os.remove(backing_img)
230747051cdSJeff Cody
231747051cdSJeff Cody    def test_set_speed(self):
232747051cdSJeff Cody        self.assert_no_active_commit()
233747051cdSJeff Cody
234b59b3d57SFam Zheng        self.vm.pause_drive('drive0')
235747051cdSJeff Cody        result = self.vm.qmp('block-commit', device='drive0', top=mid_img, speed=1024 * 1024)
236747051cdSJeff Cody        self.assert_qmp(result, 'return', {})
237747051cdSJeff Cody
238747051cdSJeff Cody        # Ensure the speed we set was accepted
239747051cdSJeff Cody        result = self.vm.qmp('query-block-jobs')
240747051cdSJeff Cody        self.assert_qmp(result, 'return[0]/device', 'drive0')
241747051cdSJeff Cody        self.assert_qmp(result, 'return[0]/speed', 1024 * 1024)
242747051cdSJeff Cody
243b59b3d57SFam Zheng        self.cancel_and_wait(resume=True)
244747051cdSJeff Cody
245747051cdSJeff Cody
246747051cdSJeff Codyif __name__ == '__main__':
247747051cdSJeff Cody    iotests.main(supported_fmts=['qcow2', 'qed'])
248