[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 20/22] Acceptance Tests: add basic documentation on LinuxTest bas
From: |
Cleber Rosa |
Subject: |
[PATCH 20/22] Acceptance Tests: add basic documentation on LinuxTest base class |
Date: |
Wed, 3 Feb 2021 12:23:55 -0500 |
Signed-off-by: Cleber Rosa <crosa@redhat.com>
---
docs/devel/testing.rst | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index 209f9d8172..fe0112b21c 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -790,6 +790,32 @@ and hypothetical example follows:
At test "tear down", ``avocado_qemu.Test`` handles all the QEMUMachines
shutdown.
+The ``avocado_qemu.LinuxTest`` base test class
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``avocado_qemu.LinuxTest`` is further specialization of the
+``avocado_qemu.Test`` class, so it contains all the characteristics of
+the later plus some extra features.
+
+First of all, this base class is intended for tests that need to
+interact with a fully booted and operational Linux guest. The most
+basic example looks like this:
+
+.. code::
+
+ from avocado_qemu import LinuxTest
+
+
+ class SomeTest(LinuxTest):
+
+ def test(self):
+ self.launch_and_wait()
+ self.ssh_connect('root', self.ssh_key)
+ self.ssh_command('some_command_to_be_run_in_the_guest')
+
+Please refer to tests that use ``avocado_qemu.LinuxTest`` under
+``tests/acceptance`` for more examples.
+
QEMUMachine
~~~~~~~~~~~
--
2.25.4
- [PATCH 16/22] Acceptance Tests: introduce method for requiring an accelerator, (continued)
- [PATCH 16/22] Acceptance Tests: introduce method for requiring an accelerator, Cleber Rosa, 2021/02/03
- [PATCH 17/22] Acceptance Tests: fix population of public key in cloudinit image, Cleber Rosa, 2021/02/03
- [PATCH 19/22] Acceptance Tests: add port redirection for ssh by default, Cleber Rosa, 2021/02/03
- [PATCH 20/22] Acceptance Tests: add basic documentation on LinuxTest base class,
Cleber Rosa <=
- [PATCH 04/22] tests/acceptance/virtiofs_submounts.py: use workdir property, Cleber Rosa, 2021/02/03
- [PATCH 21/22] Acceptance Tests: introduce CPU hotplug test, Cleber Rosa, 2021/02/03
- [PATCH 22/22] [NOTFORMERGE] Bump Avocado version to latest master, Cleber Rosa, 2021/02/03