Skip to contentSkip to conversation

qemu-iotests with sample images, vhdx read test

PATCH Superseded Jeff Cody 5 participants 11 messages Sep 20, 2013

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Jeff Cody

author
#0 lore raw

cover qemu-iotests with sample images, vhdx read test

This provides:

Patch 1/2: A basic framework for using sample image files. This is intended
to be sample images created with the image format native tool; e.g. a VHDX image created with Hyper-V.

Patch 2/2: VHDX read test on a sample image created with Hyper-V.

Jeff Cody (2):
block: qemu-iotests - add basic ability to use binary sample images
block: qemu-iotests for vhdx, read sample dynamic image

 tests/qemu-iotests/064                             |  62 +++++++++++++++++++++
 tests/qemu-iotests/064.out                         |  14 +++++
 tests/qemu-iotests/common                          |   6 ++
 tests/qemu-iotests/common.config                   |  11 ++++
 tests/qemu-iotests/common.rc                       |   9 +++
 tests/qemu-iotests/group                           |   1 +
 tests/qemu-iotests/sample_images/MANIFEST          |   7 +++
 tests/qemu-iotests/sample_images/README            |   8 +++
 .../sample_images/iotest-dynamic-1G.vhdx.bz2       | Bin 0 -> 874 bytes
 9 files changed, 118 insertions(+)
 create mode 100755 tests/qemu-iotests/064
 create mode 100644 tests/qemu-iotests/064.out
 create mode 100644 tests/qemu-iotests/sample_images/MANIFEST
 create mode 100644 tests/qemu-iotests/sample_images/README
 create mode 100644 tests/qemu-iotests/sample_images/iotest-dynamic-1G.vhdx.bz2
Signature · 1 line
1.8.3.1
author
#1 lore raw

PATCH 1/2 block: qemu-iotests - add basic ability to use binary sample images

For image formats that are not "QEMU native", but supported for compatibility, it is useful to verify that an image created with the 'gold standard' native tool can be read / written to successfully by QEMU.

In addition to testing non-native images, this could also be useful to test against image files created by older versions of QEMU.

This provides a directory to store small sample images, for use by scripts in tests/qemu-iotests.

The MANIFEST file should be updated when a new image is added to the directory, to give some idea about the nature of the image and the data store therein.

Image files should be compressed with bzip2.

To use a sample image from a bash script, the _use_sample_img function will copy and decompress the image into $TEST_DIR, and set $TEST_IMG to be the decompressed sample image copy. To cleanup, call _cleanup_test_img as normal.

---
 tests/qemu-iotests/common.config          | 11 +++++++++++
 tests/qemu-iotests/common.rc              |  9 +++++++++
 tests/qemu-iotests/sample_images/MANIFEST |  2 ++
 tests/qemu-iotests/sample_images/README   |  8 ++++++++
 4 files changed, 30 insertions(+)
 create mode 100644 tests/qemu-iotests/sample_images/MANIFEST
 create mode 100644 tests/qemu-iotests/sample_images/README
tests/qemu-iotests/common.config +11 -0
index d794e62..d90a8bc 100644
@@ -125,6 +125,17 @@ fi
 
 export TEST_DIR
 
+if [ -z "$SAMPLE_IMG_DIR" ]; then
+        SAMPLE_IMG_DIR=`pwd`/sample_images
+fi
+
+if [ ! -d "$SAMPLE_IMG_DIR" ]; then
+    echo "common.config: Error: \$SAMPLE_IMG_DIR ($SAMPLE_IMG_DIR) is not a directory"
+    exit 1
+fi
+
+export SAMPLE_IMG_DIR
+
 _readlink()
 {
     if [ $# -ne 1 ]; then
tests/qemu-iotests/common.rc +9 -0
index 28b39e4..d52f344 100644
@@ -91,6 +91,14 @@ _set_default_imgopts()
     fi
 }
 
+_use_sample_img()
+{
+    cp $SAMPLE_IMG_DIR/"$1" $TEST_DIR
+    bunzip2 $TEST_DIR/"$1"
+    SAMPLE_IMG_FILE="${1%\.bz2}"
+    TEST_IMG=$TEST_DIR/$SAMPLE_IMG_FILE
+}
+
 _make_test_img()
 {
     # extra qemu-img options can be added by tests
@@ -158,6 +166,7 @@ _cleanup_test_img()
             rm -f $TEST_DIR/t.$IMGFMT
             rm -f $TEST_DIR/t.$IMGFMT.orig
             rm -f $TEST_DIR/t.$IMGFMT.base
+            rm -f $TEST_DIR/$SAMPLE_IMG_FILE
             ;;
 
         rbd)
tests/qemu-iotests/sample_images/MANIFEST new file +2 -0
new file mode 100644
index 0000000..7abf287
@@ -0,0 +1,2 @@
+   Image Filename           |                  Description
+------------------------------------------------------------------------------
tests/qemu-iotests/sample_images/README new file +8 -0
new file mode 100644
index 0000000..9321b00
@@ -0,0 +1,8 @@
+This is for small sample images to be used with qemu-iotests, intended for
+non-native formats that QEMU supports for compatibility.  The idea is to use
+the native tool to create the sample image.
+
+For instance, a VHDX image in this directory would be an image created not by
+QEMU itself, but rather created by Hyper-V.
+
+Sample images added here should be described in the MANIFEST file.
Signature · 1 line
1.8.3.1
#2 lore raw

Re: [Qemu-devel] [PATCH 1/2] block: qemu-iotests - add basic ability to use binary sample images

Quoted 8 lines · Jeff Cody

For image formats that are not "QEMU native", but supported for compatibility, it is useful to verify that an image created with the 'gold standard' native tool can be read / written to successfully by QEMU.

In addition to testing non-native images, this could also be useful to test against image files created by older versions of QEMU.

Quoted 6 lines

This provides a directory to store small sample images, for use by scripts in tests/qemu-iotests.

The MANIFEST file should be updated when a new image is added to the directory, to give some idea about the nature of the image and the data store therein.

I'd drop the MANIFEST because metadata tends to get out-of-sync or is ignored. The MANIFEST file can cause patch conflicts. Test code or the commit message can describe the contents of the image so I don't see the need to create another copy of this information.

tests/qemu-iotests/common.rc _set_default_imgopts() · line 97

Quoted 12 lines
tests/qemu-iotests/common.rc +4 -0
index 28b39e4..d52f344 100644
@@ -91,6 +91,14 @@ _set_default_imgopts()
     fi
 }
 
+_use_sample_img()
+{
+    cp $SAMPLE_IMG_DIR/"$1" $TEST_DIR
+    bunzip2 $TEST_DIR/"$1"

bzcat? It eliminates the temporary copy.

tests/qemu-iotests/common.rc _cleanup_test_img() · line 169

Quoted 5 lines
tests/qemu-iotests/common.rc +1 -0
@@ -158,6 +166,7 @@ _cleanup_test_img()
             rm -f $TEST_DIR/t.$IMGFMT
             rm -f $TEST_DIR/t.$IMGFMT.orig
             rm -f $TEST_DIR/t.$IMGFMT.base
+            rm -f $TEST_DIR/$SAMPLE_IMG_FILE

It seems that qemu-iotests doesn't care for paths with spaces.

author
#3 lore raw

Re: [Qemu-devel] [PATCH 1/2] block: qemu-iotests - add basic ability to use binary sample images

Quoted 12 lines · Stefan Hajnoczi
Quoted 11 lines · Jeff Cody

For image formats that are not "QEMU native", but supported for compatibility, it is useful to verify that an image created with the 'gold standard' native tool can be read / written to successfully by QEMU.

In addition to testing non-native images, this could also be useful to test against image files created by older versions of QEMU.

This provides a directory to store small sample images, for use by scripts in tests/qemu-iotests.

Quoted 9 lines
Quoted 3 lines

The MANIFEST file should be updated when a new image is added to the directory, to give some idea about the nature of the image and the data store therein.

I'd drop the MANIFEST because metadata tends to get out-of-sync or is ignored. The MANIFEST file can cause patch conflicts. Test code or the commit message can describe the contents of the image so I don't see the need to create another copy of this information.

OK, good point.

Quoted 8 lines
Quoted 8 lines
tests/qemu-iotests/common.rc +0 -0
index 28b39e4..d52f344 100644
@@ -91,6 +91,14 @@ _set_default_imgopts()
     fi
 }
 
Quoted 7 lines

tests/qemu-iotests/common.rc _set_default_imgopts() · line 97

Quoted 4 lines
tests/qemu-iotests/common.rc +4 -0
+_use_sample_img()
+{
+    cp $SAMPLE_IMG_DIR/"$1" $TEST_DIR
+    bunzip2 $TEST_DIR/"$1"

bzcat? It eliminates the temporary copy.

Sure

Quoted 7 lines

tests/qemu-iotests/common.rc _cleanup_test_img() · line 169

Quoted 5 lines
tests/qemu-iotests/common.rc +1 -0
@@ -158,6 +166,7 @@ _cleanup_test_img()
             rm -f $TEST_DIR/t.$IMGFMT
             rm -f $TEST_DIR/t.$IMGFMT.orig
             rm -f $TEST_DIR/t.$IMGFMT.base
+            rm -f $TEST_DIR/$SAMPLE_IMG_FILE

It seems that qemu-iotests doesn't care for paths with spaces.

For v2, I'll go through all the scripts (I think TEST_DIR is used in some of the 0?? scripts as well) and make sure it is quoted (along with SAMPLE_IMG_DIR).

#4 lore raw

Re: [Qemu-devel] [PATCH 1/2] block: qemu-iotests - add basic ability to use binary sample images

In reply to Jeff Cody
Quoted 8 lines · Jeff Cody

For image formats that are not "QEMU native", but supported for compatibility, it is useful to verify that an image created with the 'gold standard' native tool can be read / written to successfully by QEMU.

In addition to testing non-native images, this could also be useful to test against image files created by older versions of QEMU.

Quoted 8 lines

This provides a directory to store small sample images, for use by scripts in tests/qemu-iotests.

The MANIFEST file should be updated when a new image is added to the directory, to give some idea about the nature of the image and the data store therein.

Image files should be compressed with bzip2.

Why bzip2? xz beats bzip2 in both compression ratio and decompression speed; or if you are worried about portability, gzip is present on more machines. bzip2 will probably be around for some time, but it is no longer the compression engine of choice.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
author
#5 lore raw

Re: [Qemu-devel] [PATCH 1/2] block: qemu-iotests - add basic ability to use binary sample images

Quoted 16 lines · Eric Blake
Quoted 15 lines · Jeff Cody

For image formats that are not "QEMU native", but supported for compatibility, it is useful to verify that an image created with the 'gold standard' native tool can be read / written to successfully by QEMU.

In addition to testing non-native images, this could also be useful to test against image files created by older versions of QEMU.

This provides a directory to store small sample images, for use by scripts in tests/qemu-iotests.

The MANIFEST file should be updated when a new image is added to the directory, to give some idea about the nature of the image and the data store therein.

Quoted 7 lines
Quoted 1 line

Image files should be compressed with bzip2.

Why bzip2? xz beats bzip2 in both compression ratio and decompression speed; or if you are worried about portability, gzip is present on more machines. bzip2 will probably be around for some time, but it is no longer the compression engine of choice.

iotest-dynamic-1G.vhdx compressed with gzip, xv, and bzip2:

gzip:   102548 bytes
xv:      15892 bytes
bzip2:     874 bytes

I think bzip2 is particularly well suited for image files with hyper-repetitive consecutive bytes due to its use of RLE. I don't know that all sample images will have data like that, but chances are good many will - and even if they don't, bzip2 is not horrible compared to xz even on normal data.

-Jeff

author
#6 lore raw

PATCH 2/2 block: qemu-iotests for vhdx, read sample dynamic image

In reply to Jeff Cody

This adds the VHDX format to the qemu-iotests format, and adds a read test. The test reads from an existing sample image, that was created with Hyper-V under Windwos Server 2012.

The image file is a 1GB dynamic image, with 32MB blocks.

The pattern 0xa5 exists from 0MB-33MB (past a block size boundary)

The pattern 0x96 exists from 33MB-66MB (past another block boundary, and leaving a partial blank block)

Quoted 1 line

From 66MB-1024MB, all reads should return 0.

Although 1GB dynamic image with 66MB of data, the bzip2'ed image file size is only 874 bytes.

---
 tests/qemu-iotests/064                             |  62 +++++++++++++++++++++
 tests/qemu-iotests/064.out                         |  14 +++++
 tests/qemu-iotests/common                          |   6 ++
 tests/qemu-iotests/group                           |   1 +
 tests/qemu-iotests/sample_images/MANIFEST          |   5 ++
 .../sample_images/iotest-dynamic-1G.vhdx.bz2       | Bin 0 -> 874 bytes
 6 files changed, 88 insertions(+)
 create mode 100755 tests/qemu-iotests/064
 create mode 100644 tests/qemu-iotests/064.out
 create mode 100644 tests/qemu-iotests/sample_images/iotest-dynamic-1G.vhdx.bz2
tests/qemu-iotests/064 new file +62 -0
new file mode 100755
index 0000000..6a17bdb
@@ -0,0 +1,62 @@
+#!/bin/bash
+#
+# Test VHDX read/write from a sample image created with Hyper-V
+#
+# Copyright (C) 2013 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/>.
+#
+
+# creator
[email protected]
+
+seq=`basename $0`
+echo "QA output created by $seq"
+
+here=`pwd`
+tmp=/tmp/$$
+status=1	# failure is the default!
+
+_cleanup()
+{
+    _cleanup_test_img
+}
+trap "_cleanup; exit \$status" 0 1 2 3 15
+
+# get standard environment, filters and checks
+. ./common.rc
+. ./common.filter
+
+_supported_fmt vhdx
+_supported_proto generic
+_supported_os Linux
+
+_use_sample_img iotest-dynamic-1G.vhdx.bz2
+
+echo
+echo "=== Verify pattern 0xa5, 0 - 33MB ==="
+$QEMU_IO -c "read -pP 0xa5 0 33M" $TEST_IMG | _filter_qemu_io
+
+echo
+echo "=== Verify pattern 0x96, 33M - 66M ==="
+$QEMU_IO -c "read -pP 0x96 33M 33M" $TEST_IMG | _filter_qemu_io
+
+echo
+echo "=== Verify pattern 0x00, 66M - 1024M ==="
+$QEMU_IO -c "read -pP 0x00 66M 958M" $TEST_IMG | _filter_qemu_io
+
+# success, all done
+echo "*** done"
+rm -f $seq.full
+status=0
tests/qemu-iotests/064.out new file +14 -0
new file mode 100644
index 0000000..b9e8e4a
@@ -0,0 +1,14 @@
+QA output created by 064
+
+=== Verify pattern 0xa5, 0 - 33MB ===
+read 34603008/34603008 bytes at offset 0
+33 MiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
+
+=== Verify pattern 0x96, 33M - 66M ===
+read 34603008/34603008 bytes at offset 34603008
+33 MiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
+
+=== Verify pattern 0x00, 66M - 1024M ===
+read 1004535808/1004535808 bytes at offset 69206016
+958 MiB, X ops; XX:XX:XX.X (XXX YYY/sec and XXX ops/sec)
+*** done
tests/qemu-iotests/common +6 -0
index fecaf85..311c9e4 100644
@@ -133,6 +133,7 @@ check options
     -qed                test qed
     -vdi                test vdi
     -vpc                test vpc
+    -vhdx               test vhdx
     -vmdk               test vmdk
     -rbd                test rbd
     -sheepdog           test sheepdog
@@ -195,6 +196,11 @@ testlist options
             xpand=false
             ;;
 
+        -vhdx)
+            IMGFMT=vhdx
+            xpand=false
+            ;;
+
         -rbd)
             IMGPROTO=rbd
             xpand=false
tests/qemu-iotests/group +1 -0
index 1ad02e5..9e950fd 100644
@@ -69,3 +69,4 @@
 061 rw auto
 062 rw auto
 063 rw auto
+064 rw auto
tests/qemu-iotests/sample_images/MANIFEST +5 -0
index 7abf287..6e4a7ef 100644
@@ -1,2 +1,7 @@
    Image Filename           |                  Description
 ------------------------------------------------------------------------------
+iotest-dynamic-1G.vhdx.bz2  |  1GB dynamic VHDX image with block size of 32 MB.
+                            |  This image file has a pattern of 33MB of 0xa5,
+                            |  followed by 33MB of 0x96, followed by zeroes.
+                            |  Created with Hyper-V on Windows Server 2012.
+                            |
tests/qemu-iotests/sample_images/iotest-dynamic-1G.vhdx.bz2 new file binary +0 -0
new file mode 100644
index 0000000000000000000000000000000000000000..77d97a0bae2e45b84ad489a77788084cc09331e0
GIT binary patch
Signature · 1 line
1.8.3.1
#7 lore raw

Re: [Qemu-devel] [PATCH 2/2] block: qemu-iotests for vhdx, read sample dynamic imagee

Quoted 8 lines · [email protected] writes:

This adds the VHDX format to the qemu-iotests format, and adds a read test. The test reads from an existing sample image, that was created with Hyper-V under Windwos Server 2012.

The image file is a 1GB dynamic image, with 32MB blocks.

The pattern 0xa5 exists from 0MB-33MB (past a block size boundary)

Quoted 7 lines

The pattern 0x96 exists from 33MB-66MB (past another block boundary, and leaving a partial blank block)

From 66MB-1024MB, all reads should return 0.

Although 1GB dynamic image with 66MB of data, the bzip2'ed image file size is only 874 bytes.

I take it there is additional meta-data in there generated by Windows Server itself? Otherwise I would be tempted to write a tool to generate the image on demand so it could be used to trigger other edge cases when found.

Having said that 874 bytes certainly isn't to heavy a burden for the repository ;-)

I'm currently pondering what the best way of supporting system images (i.e. kernel+rootfs) would be to make system regression testing easier. Unfortunately those images would be far too large to carry in the repo although there may be some sub-module annex type thing I could try.

Signature · 1 line
Alex Bennée
#8 lore raw

Re: [Qemu-devel] [PATCH 2/2] block: qemu-iotests for vhdx, read sample dynamic imagee

Am 20.09.2013 um 11:10 hat Alex Bennée geschrieben:

Quoted 19 lines
Quoted 8 lines · [email protected] writes:

This adds the VHDX format to the qemu-iotests format, and adds a read test. The test reads from an existing sample image, that was created with Hyper-V under Windwos Server 2012.

The image file is a 1GB dynamic image, with 32MB blocks.

The pattern 0xa5 exists from 0MB-33MB (past a block size boundary)

Quoted 7 lines

The pattern 0x96 exists from 33MB-66MB (past another block boundary, and leaving a partial blank block)

From 66MB-1024MB, all reads should return 0.

Although 1GB dynamic image with 66MB of data, the bzip2'ed image file size is only 874 bytes.

Quoted 7 lines

I take it there is additional meta-data in there generated by Windows Server itself? Otherwise I would be tempted to write a tool to generate the image on demand so it could be used to trigger other edge cases when found.

Having said that 874 bytes certainly isn't to heavy a burden for the repository ;-)

Eventually, qemu-img will be able to create VHDX images, but I think the point is that we compare against real Hyper-V VHDX images to ensure that we're really reading the spec the same way as they do.

Quoted 4 lines

I'm currently pondering what the best way of supporting system images (i.e. kernel+rootfs) would be to make system regression testing easier. Unfortunately those images would be far too large to carry in the repo although there may be some sub-module annex type thing I could try.

Sounds like you're looking for qemu-tests?

    http://git.qemu.org/?p=qemu-test.git;a=summary

Kevin

#9 lore raw

Re: [Qemu-devel] [PATCH 2/2] block: qemu-iotests for vhdx, read sample dynamic imagee

Quoted 4 lines · [email protected] writes:

Am 20.09.2013 um 11:10 hat Alex Bennée geschrieben:

Quoted 3 lines

[email protected] writes:

<<snip>>

Quoted 8 lines
Quoted 4 lines

I'm currently pondering what the best way of supporting system images (i.e. kernel+rootfs) would be to make system regression testing easier. Unfortunately those images would be far too large to carry in the repo although there may be some sub-module annex type thing I could try.

Sounds like you're looking for qemu-tests?

    http://git.qemu.org/?p=qemu-test.git;a=summary

Thanks, Stefan H had already pointed me at that. I'm currently thinking of painless ways to integrate those sort of tests in the main tree to further the regression testing stuff I'm looking at.

Anyway I have already diverted enough of topic so I'll save that discussion for another thread ;-)

Signature · 1 line
Alex Bennée
author
#10 lore raw

Re: [Qemu-devel] [PATCH 2/2] block: qemu-iotests for vhdx, read sample dynamic imagee

In reply to Kevin Wolf
Quoted 25 lines · Kevin Wolf

Am 20.09.2013 um 11:10 hat Alex Bennée geschrieben:

Quoted 24 lines
Quoted 8 lines · [email protected] writes:

This adds the VHDX format to the qemu-iotests format, and adds a read test. The test reads from an existing sample image, that was created with Hyper-V under Windwos Server 2012.

The image file is a 1GB dynamic image, with 32MB blocks.

The pattern 0xa5 exists from 0MB-33MB (past a block size boundary)

Quoted 7 lines

The pattern 0x96 exists from 33MB-66MB (past another block boundary, and leaving a partial blank block)

From 66MB-1024MB, all reads should return 0.

Although 1GB dynamic image with 66MB of data, the bzip2'ed image file size is only 874 bytes.

I take it there is additional meta-data in there generated by Windows Server itself? Otherwise I would be tempted to write a tool to generate the image on demand so it could be used to trigger other edge cases when found.

Quoted 7 lines
Quoted 2 lines

Having said that 874 bytes certainly isn't to heavy a burden for the repository ;-)

Eventually, qemu-img will be able to create VHDX images, but I think the point is that we compare against real Hyper-V VHDX images to ensure that we're really reading the spec the same way as they do.

Exactly. If we use qemu-img to generate test images, we aren't really testing QEMU's compatibility with non-native formats.

Also, it may be useful to occasionally put native images (qcow2, qed) in the sample_images directory for some major release, so that we can run some image format regression tests on image format code changes.

Quoted 9 lines
Quoted 4 lines

I'm currently pondering what the best way of supporting system images (i.e. kernel+rootfs) would be to make system regression testing easier. Unfortunately those images would be far too large to carry in the repo although there may be some sub-module annex type thing I could try.

Sounds like you're looking for qemu-tests?

    http://git.qemu.org/?p=qemu-test.git;a=summary

There is also autotest:
https://github.com/autotest/virt-test/wiki