3 # Tests for image streaming.
5 # Copyright (C) 2012 IBM Corp.
7 # This program is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
23 from iotests import qemu_img, qemu_io
25 backing_img = os.path.join(iotests.test_dir, 'backing.img')
26 test_img = os.path.join(iotests.test_dir, 'test.img')
28 class ImageStreamingTestCase(iotests.QMPTestCase):
29 '''Abstract base class for image streaming test cases'''
31 def assert_no_active_streams(self):
32 result = self.vm.qmp('query-block-jobs')
33 self.assert_qmp(result, 'return', [])
35 def cancel_and_wait(self, drive='drive0'):
36 '''Cancel a block job and wait for it to finish'''
37 result = self.vm.qmp('block-job-cancel', device=drive)
38 self.assert_qmp(result, 'return', {})
42 for event in self.vm.get_qmp_events(wait=True):
43 if event['event'] == 'BLOCK_JOB_CANCELLED':
44 self.assert_qmp(event, 'data/type', 'stream')
45 self.assert_qmp(event, 'data/device', drive)
48 self.assert_no_active_streams()
50 class TestSingleDrive(ImageStreamingTestCase):
51 image_len = 1 * 1024 * 1024 # MB
54 qemu_img('create', backing_img, str(TestSingleDrive.image_len))
55 qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, test_img)
56 self.vm = iotests.VM().add_drive(test_img)
62 os.remove(backing_img)
64 def test_stream(self):
65 self.assert_no_active_streams()
67 result = self.vm.qmp('block-stream', device='drive0')
68 self.assert_qmp(result, 'return', {})
72 for event in self.vm.get_qmp_events(wait=True):
73 if event['event'] == 'BLOCK_JOB_COMPLETED':
74 self.assert_qmp(event, 'data/type', 'stream')
75 self.assert_qmp(event, 'data/device', 'drive0')
76 self.assert_qmp(event, 'data/offset', self.image_len)
77 self.assert_qmp(event, 'data/len', self.image_len)
80 self.assert_no_active_streams()
83 self.assertFalse('sectors not allocated' in qemu_io('-c', 'map', test_img),
84 'image file not fully populated after streaming')
86 def test_device_not_found(self):
87 result = self.vm.qmp('block-stream', device='nonexistent')
88 self.assert_qmp(result, 'error/class', 'DeviceNotFound')
90 class TestStreamStop(ImageStreamingTestCase):
91 image_len = 8 * 1024 * 1024 * 1024 # GB
94 qemu_img('create', backing_img, str(TestStreamStop.image_len))
95 qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, test_img)
96 self.vm = iotests.VM().add_drive(test_img)
102 os.remove(backing_img)
104 def test_stream_stop(self):
107 self.assert_no_active_streams()
109 result = self.vm.qmp('block-stream', device='drive0')
110 self.assert_qmp(result, 'return', {})
113 events = self.vm.get_qmp_events(wait=False)
114 self.assertEqual(events, [], 'unexpected QMP event: %s' % events)
116 self.cancel_and_wait()
118 class TestSetSpeed(ImageStreamingTestCase):
119 image_len = 80 * 1024 * 1024 # MB
122 qemu_img('create', backing_img, str(TestSetSpeed.image_len))
123 qemu_img('create', '-f', iotests.imgfmt, '-o', 'backing_file=%s' % backing_img, test_img)
124 self.vm = iotests.VM().add_drive(test_img)
130 os.remove(backing_img)
132 # This is a short performance test which is not run by default.
133 # Invoke "IMGFMT=qed ./030 TestSetSpeed.perf_test_throughput"
134 def perf_test_throughput(self):
135 self.assert_no_active_streams()
137 result = self.vm.qmp('block-stream', device='drive0')
138 self.assert_qmp(result, 'return', {})
140 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=8 * 1024 * 1024)
141 self.assert_qmp(result, 'return', {})
145 for event in self.vm.get_qmp_events(wait=True):
146 if event['event'] == 'BLOCK_JOB_COMPLETED':
147 self.assert_qmp(event, 'data/type', 'stream')
148 self.assert_qmp(event, 'data/device', 'drive0')
149 self.assert_qmp(event, 'data/offset', self.image_len)
150 self.assert_qmp(event, 'data/len', self.image_len)
153 self.assert_no_active_streams()
155 def test_set_speed(self):
156 self.assert_no_active_streams()
158 result = self.vm.qmp('block-stream', device='drive0')
159 self.assert_qmp(result, 'return', {})
162 result = self.vm.qmp('query-block-jobs')
163 self.assert_qmp(result, 'return[0]/device', 'drive0')
164 self.assert_qmp(result, 'return[0]/speed', 0)
166 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=8 * 1024 * 1024)
167 self.assert_qmp(result, 'return', {})
169 # Ensure the speed we set was accepted
170 result = self.vm.qmp('query-block-jobs')
171 self.assert_qmp(result, 'return[0]/device', 'drive0')
172 self.assert_qmp(result, 'return[0]/speed', 8 * 1024 * 1024)
174 self.cancel_and_wait()
176 # Check setting speed in block-stream works
177 result = self.vm.qmp('block-stream', device='drive0', speed=4 * 1024 * 1024)
178 self.assert_qmp(result, 'return', {})
180 result = self.vm.qmp('query-block-jobs')
181 self.assert_qmp(result, 'return[0]/device', 'drive0')
182 self.assert_qmp(result, 'return[0]/speed', 4 * 1024 * 1024)
184 self.cancel_and_wait()
186 def test_set_speed_invalid(self):
187 self.assert_no_active_streams()
189 result = self.vm.qmp('block-stream', device='drive0', speed=-1)
190 self.assert_qmp(result, 'error/class', 'InvalidParameter')
191 self.assert_qmp(result, 'error/data/name', 'speed')
193 self.assert_no_active_streams()
195 result = self.vm.qmp('block-stream', device='drive0')
196 self.assert_qmp(result, 'return', {})
198 result = self.vm.qmp('block-job-set-speed', device='drive0', speed=-1)
199 self.assert_qmp(result, 'error/class', 'InvalidParameter')
200 self.assert_qmp(result, 'error/data/name', 'speed')
202 self.cancel_and_wait()
204 if __name__ == '__main__':
205 iotests.main(supported_fmts=['qcow2', 'qed'])