summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README36
1 files changed, 36 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..45e2d11
--- /dev/null
+++ b/README
@@ -0,0 +1,36 @@
+Test cases for testing the new virtio-console functionality that
+exposes multiple ports to guests for generic communication.
+
+Files:
+test-virtserial.c: Standalone test program that can be run in the
+ guest.
+auto-virtserial.c: Runs automated tests. To be run on the host.
+auto-virtserial-guest.c: Runs automated tests, to be run on the guest.
+run-test.sh: Starts qemu and runs the automated tests
+
+Setup:
+In my guest (f11-auto.qcow2), I've put the auto-virtserial-guest
+program in /etc/init.d/ and put a line in /etc/rc.local to invoke it
+upon boot:
+
+<guest /etc/rc.local>:
+/etc/init.d/auto-virtserial-guest &
+
+When run-test.sh is invoked with such a guest, when the guest comes
+up, the tests start running automatically.
+
+Some settings in the run-test.sh script should be tweaked to match
+your environment (especially the guest image file, qemu location,
+etc.).
+
+These programs are sensitive to some details, like the host program
+(auto-virtserial) has to be started before the guest invokes
+auto-virtserial-guest program. Also the parameters passed to the qemu
+invocation in run-test.sh are assumed to be in that order in
+auto-virtserial.c, like the ports which have caching enabled,
+throttling enabled, the byte limits and so on.
+
+More work is needed to make these programs fully ready; if you wish
+you contribute, send me an email at <amit.shah@redhat.com>
+
+Amit