nbdkit/0007-tests-Test-largest-possible-plugin-size.patch

From 4e1a521228115c04cc7c5a2f625218a9bbd5101f Mon Sep 17 00:00:00 2001
From: "Richard W.M. Jones" <rjones@redhat.com>
Date: Sun, 15 Jul 2018 11:46:12 +0100
Subject: [PATCH 07/12] tests: Test largest possible plugin size.

This test is incomplete because it is too large for qemu to open.
However at least we are testing that nbdkit works.

Implemented using the pattern plugin.
---
 plugins/pattern/nbdkit-pattern-plugin.pod | 13 +++
 tests/Makefile.am                         |  3 +-
 tests/test-pattern-largest.sh             | 99 +++++++++++++++++++++++
 3 files changed, 114 insertions(+), 1 deletion(-)
 create mode 100755 tests/test-pattern-largest.sh

diff --git a/plugins/pattern/nbdkit-pattern-plugin.pod b/plugins/pattern/nbdkit-pattern-plugin.pod
index 7a6b498..425cae6 100644
--- a/plugins/pattern/nbdkit-pattern-plugin.pod
+++ b/plugins/pattern/nbdkit-pattern-plugin.pod
@@ -29,6 +29,19 @@ The size of the virtual disk must be specified using the C<size>
 parameter.  If the size is not a multiple of 8 then the last 8 byte
 offset in the pattern is truncated.
 
+=head2 Largest possible size
+
+nbdkit itself limits plugins to S<2⁶³-1> bytes
+(S<decimal: 9223372036854775807>,
+S<hexadecimal: 0x7fff_ffff_ffff_ffff>).
+
+To test if NBD clients are free of bugs (not to mention nbdkit itself)
+you can use:
+
+ nbdkit pattern size=9223372036854775807
+
+Note this is too large for qemu to open.
+
 =head1 PARAMETERS
 
 =over 4
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 6c3a5a6..9dd451d 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -65,6 +65,7 @@ EXTRA_DIST = \
 	test-parallel-file.sh \
 	test-parallel-nbd.sh \
 	test-pattern.sh \
+	test-pattern-largest.sh \
 	test-python-exception.sh \
 	test.pl \
 	test.py \
@@ -318,7 +319,7 @@ test_memory_CFLAGS = $(WARNINGS_CFLAGS) $(LIBGUESTFS_CFLAGS)
 test_memory_LDADD = libtest.la $(LIBGUESTFS_LIBS)
 
 # pattern plugin test.
-TESTS += test-pattern.sh
+TESTS += test-pattern.sh test-pattern-largest.sh
 
 # nbd plugin test.
 LIBGUESTFS_TESTS += test-nbd
diff --git a/tests/test-pattern-largest.sh b/tests/test-pattern-largest.sh
new file mode 100755
index 0000000..5ff891f
--- /dev/null
+++ b/tests/test-pattern-largest.sh
@@ -0,0 +1,99 @@
+#!/bin/bash -
+# nbdkit
+# Copyright (C) 2018 Red Hat Inc.
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+#
+# * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+#
+# * Neither the name of Red Hat nor the names of its contributors may be
+# used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS ''AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+# OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+
+# Test the pattern plugin with the largest possible size supported
+# by nbdkit.
+
+set -e
+
+files="pattern-largest.out pattern-largest.pid pattern-largest.sock"
+rm -f $files
+
+# Test that qemu-io works
+if ! qemu-io --help >/dev/null; then
+    echo "$0: missing or broken qemu-io"
+    exit 77
+fi
+
+# Run nbdkit with pattern plugin.
+# size = 2^63-1
+nbdkit -P pattern-largest.pid -U pattern-largest.sock \
+       pattern size=9223372036854775807
+
+# We may have to wait a short time for the pid file to appear.
+for i in `seq 1 10`; do
+    if test -f pattern-largest.pid; then
+        break
+    fi
+    sleep 1
+done
+if ! test -f pattern-largest.pid; then
+    echo "$0: PID file was not created"
+    exit 1
+fi
+
+pid="$(cat pattern-largest.pid)"
+
+# Kill the nbdkit process on exit.
+cleanup ()
+{
+    status=$?
+
+    kill $pid
+    rm -f $files
+
+    exit $status
+}
+trap cleanup INT QUIT TERM EXIT ERR
+
+# qemu cannot open this image!
+#
+#   can't open device nbd+unix://?socket=pattern-largest.sock: Could not get image size: File too large
+#
+# Therefore we skip the remainder of this test (in effect, testing
+# only that nbdkit can create the file).
+exit 77
+
+# XXX Unfortunately qemu-io can only issue 512-byte aligned requests,
+# and the final block is only 511 bytes, so we have to request the 512
+# bytes before that block.
+qemu-io -r -f raw 'nbd+unix://?socket=pattern-largest.sock' \
+        -c 'r -v 9223372036854774784 512' | grep -E '^[[:xdigit:]]+:' > pattern-largest.out
+if [ "$(cat pattern-largest.out)" != "XXX EXPECTED PATTERN HERE" ]
+then
+    echo "$0: unexpected pattern:"
+    cat pattern-largest.out
+    exit 1
+fi
+
+# The cleanup() function is called implicitly on exit.
-- 
2.17.1